return to Table of Contents, API


This resource supports the GET method.

URL Parameters

Label Description
:document_identifier The project's document identifier
:report_uuid The UUID of the report
:recipient_uuid The UUID of the recipient


Returns information about the recipient's archived address. This is the state of the address at the time the campaign was sent.

Request Query String Parameters

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

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

Response Body

A JSON object representing the archived address.

Key Value Description
uuid String The UUID of the address
date_created String The date this address was archived, in ISO-8601 format
subscribe_date String The date this address subscribed, in ISO-8601 format
unsubscribe_date String The date this address unsubscribed, in ISO-8601 format
email String The email address
first_name String The first name
last_name String The last name
company_name String The company name
custom_1 String Custom field #1
custom_2 String Custom field #2
custom_3 String Custom field #3
custom_4 String Custom field #4
custom_5 String Custom field #5
custom_6 String Custom field #6
custom_7 String Custom field #7
custom_8 String Custom field #8
custom_9 String Custom field #9
custom_10 String Custom field #10
custom_11 String Custom field #11
custom_12 String Custom field #12
custom_13 String Custom field #13
custom_14 String Custom field #14
custom_15 String Custom field #15
bounced Boolean True if the address is marked as "Hard Bounced"
unsubscribed Boolean True if the address is marked as "Unsubscribed
marked Boolean True if the address is marked with a check mark in the Direct Mail user interface
links Array of Object URLs for the address (rel:self)


GET /api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients/E5A667C9-58AE-4B86-AB6D-DA0D33D7CC00/archived-address HTTP/1.1
Authorization: Basic QzFENDREMjEtNTA4MC00NTM3LUFFOD
Accept: application/json; charset=utf-8

HTTP/1.1 200 OK
Date: Thu, 23 Apr 2015 23:35:39 GMT
Content-Type: application/json; charset=utf-8

    "bounced": false,
    "company_name": null,
    "custom_1": null,
    "custom_10": null,
    "custom_11": null,
    "custom_12": null,
    "custom_13": null,
    "custom_14": null,
    "custom_15": null,
    "custom_2": null,
    "custom_3": null,
    "custom_4": null,
    "custom_5": null,
    "custom_6": null,
    "custom_7": null,
    "custom_8": null,
    "custom_9": null,
    "email": "",
    "first_name": null,
    "last_name": null,
    "links": [
            "href": "",
            "rel": "self"
    "marked": true,
    "subscribe_date": null,
    "unsubscribe_date": null,
    "unsubscribed": false,
    "uuid": "A4437D67-112D-4CF3-9C71-09E636637122"

Did you find this article helpful? Yes | No