latestSwagger 2.02026-08-101561322.2 MB

3e4029d19684

Contacts

Manually unsubscribe a contact

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/Contacts/unsubscribeContact" target="_blank">Try in sandbox</a><br>> Please note, if you unsubscribe a contact, this action cannot be reversed.

post/api/v2/unsubscribers

Request body

phonestring

Contact phone number.

blockIncoming0 | 1

If set to 1, incoming messages from this number will be blocked.

Example request

{
  "phone": "447860021130"
}

Response

Returned when updated with success.

idinteger required

Resource ID.

hrefstring required

A link to this resource. If you want to fetch it, just GET this address.

Example response

{
  "id": 515,
  "href": "/api/v2/entity_name/1"
}