Recipients

Who unsubscribed

Recipients who unsubscribed from the campaign, in alphabetical order.

An unknown subject returns an empty list. Requires an API key with the recipients:read permission.

get/v1/domains/{domain}/campaigns/unsubscribes

Request

domainstring required

One of your sending domains (the part after @ in your From address).

subjectstring required

The exact subject line of the campaign, as returned by the campaigns list.

fromstring date

First day to include, YYYY-MM-DD (UTC). Defaults to 6 days before to.

tostring date

Last day to include, YYYY-MM-DD (UTC). Defaults to today. The range can span at most 90 days.

pageinteger

Page number, starting at 1.

page_sizeinteger

Rows per page (max 100).

Default Response

domainstring required

subjectstring required

bots_excludedboolean required

data_as_ofstring date-time required

Numbers include activity up to this moment. Recent hours may still change slightly.

{
  "recipients": [
    {
      "email": "jane@example.org"
    }
  ]
}

No recorded changes to this operation across all 1 revision of this API.