KUkudosity
Contacts & Lists

Opt Out/Unsubscribe Contact

Opt Out List Member

Unsubscribe contact from one or all lists
If sending marketing by law you must enable an unsubscribe method. Anti-Spam Policy

post/optout-list-member.json

Request

  • Base URL
    https://api.transmitsms.com
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

list_idinteger

Numeric ID of list to opt out contact from. If set to 0 (zero), the contact will be opted out from all lists. If your Global Opt Out (GOO) list is switched on, unsubscribing from a single list will unsubscribe from all lists and add to your GOO list. How to manage your Global Opt Out list (GOO)

msisdninteger required

Mobile number of contact being opted out. Number must be defined in E.164 international format.

Example request

{
  "list_id": 12345
}

Response

Successful response.

list_idsinteger[]

One or more list ID's that contact was opted out of.

Example response

{
  "list_ids": [
    123,
    456,
    789
  ],
  "error": {
    "CODE": "NOT_FOUND",
    "HEADER": 400,
    "DESCRIPTION": "Contact with such mobile does not exist in this list."
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.