Help Documentation 〉API 〉

/projects/:document_identifier/messages/:message_uuid/attachments

This resource supports the GET method.

URL Parameters

Label Description
:document_identifier The project's document identifier
:message_uuid The UUID of the message

GET

Returns an array of all the message attachments.

GET Request Query String Parameters

Name Required Description
fields No A comma-separated list of the keys you want returned for each attachment. Default is to return all keys.

GET Response Status Codes

Code Description
503 Service Unavailable Server is undergoing maintenance and is unavailable
429 Rate Limited Rate limiting in effect, try again later
404 Not Found The resource could not be found or your API key has not been granted access to it
403 Forbidden Direct Mail account is disabled
401 Unauthorized API key, secret, or authentication method is incorrect
200 OK Success

GET Response Headers

Name Description
X-Total-Count The total number of attachments

GET Response Body

JSON representation of an array of objects. Each object in the array represents a message attachment. Please consult the /projects/:document_identifier/messages/:message_uuid/attachments/:attachment_uuid resource for a description of the object keys for each attachment.

GET Example

GET /api/v2/projects/187812f26ba37d9769d8691d2a83c95c/messages/F7ADD5FB-6AB3-49A7-AA2B-233A7C750FE7/attachments HTTP/1.1
Authorization: Basic QzFENDREMjEtNTA4MC00NTM3LUFFOD
Accept: application/json; charset=utf-8
Host: secure.directmailmac.com

HTTP/1.1 200 OK
Date: Wed, 22 Apr 2015 20:57:29 GMT
Content-Type: application/json; charset=utf-8
X-Total-Count: 1

[
    {
        "content_length": 154766,
        "date_modified": "2011-07-11T23:03:48+0000",
        "display_name": "Seating Chart",
        "file_name": "0E03BBC3-97C7-4168-A9B9-B3D4DD9D7088.pages",
        "links": [
            {
                "href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/messages/F7ADD5FB-6AB3-49A7-AA2B-233A7C750FE7/attachments/07846D22-F0F7-4A39-96FD-A7FACC022FB8",
                "rel": "self"
            },
            {
                "href": "https://e3cloud.s3.amazonaws.com/1/187812f26ba37d9769d8691d2a83c95c/4B3E4F34-6177-492E-A1F9-DD99AE6EA839/8d0a639a7b948d41a1998428ef3572f2?AWSAccessKeyId=AKIAWJDNSIENGJQPNWSK&Expires=1429737149&Signature=zF2aiCBhjVI33i%2FO3JaNC0j7cSc%3D",
                "rel": "content"
            }
        ],
        "uuid": "07846D22-F0F7-4A39-96FD-A7FACC022FB8"
    }
]

Did you find this article helpful? Yes | No