latestSwagger 2.02026-08-101561322.2 MB

3e4029d19684

Contacts

Get all unsubscribed contacts

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/Contacts/getUnsubscribers" target="_blank">Try in sandbox</a><br>When one of your message recipients sends a request with one of the STOP-words, they will be immediately opted-out of your send lists and their contact status will change to an unsubscribed contact. To retrieve information on all contacts who have unsubscribed status, use:

get/api/v2/unsubscribers

Query parameters

pageinteger

Fetch specified results page.

limitinteger

The number of results per page.

Response

Returned when successful.

pageinteger required

pageCountinteger required

The total number of pages.

limitinteger required

The number of results per page.

Example response

{
  "page": 1,
  "pageCount": 10,
  "limit": 10,
  "resources": [
    {
      "id": 27074,
      "unsubscribeTime": "2015-01-09T18:59:46+0000",
      "firstName": "Charles",
      "lastName": "Conway"
    }
  ]
}