Sign in
latestOpenAPI 3.1.02026-08-085123123.9 KB

bf0b51ee8e8a

Mailings

Retrieve recipients for which the mailing was not sent because it was stopped

Retrieve a paginated list of recipients for which the mailing was not sent because it was stopped. If the mailing was not stopped, this will return an empty list.

get/mailings/{id}/recipients/stopped

Path parameters

idinteger required

The mailing's numerical ID

Query parameters

idGroupinteger

Filter to only show recipients that were in the specified group ID

pageinteger

The page of results to view

limitinteger

The number of results per page (max 10 000)

sort'email_asc' | 'email_desc' | 'language_asc' | 'language_desc' | 'fullname_asc' | 'fullname_desc' | 'date_asc' | 'date_desc' | 'updated_asc' | 'updated_desc'

Sort order for results

Response

Paginated list of recipients for which sending was stopped

totalCountinteger
pageinteger
limitinteger
sortstring

Example response

{
  "recipients": [
    {
      "idMember": 1,
      "email": "testing.tester@example.net",
      "firstname": "John",
      "lastname": "Doe",
      "joinedOn": "2020-10-01 15:17:56.403",
      "updatedOn": "2021-12-10 12:41:42.020",
      "consentType": "implied",
      "country": "CA",
      "customFields": {
        "1": "this is a test!",
        "2": 200,
        "3": 1.5,
        "4": "2000-01-01"
      }
    }
  ],
  "totalCount": 2,
  "page": 1,
  "limit": 20,
  "sort": "date_desc"
}