SMS

Record an SMS opt-out

Changed on

Marks a recipient as opted out on one of your SMS numbers. Use it for opt-outs you collect yourself (for example keywords like UNSUB or REVOKE, which the carrier does not recognize). Sends from that number to the recipient are then refused with 409 recipient_opted_out.

Idempotent. If the recipient is already opted out, the call succeeds and source keeps the original value (inbound_stop when they texted STOP).

post/v1/sms/opt-outs

Request

  • Base URL
    https://zernio.com/api
  • Auth
    HTTP bearer

Request body

accountIdstring required

ID of the SMS number account the opt-out applies to (from GET /v1/accounts).

phonestring required

Recipient phone number in E.164 format, e.g. +13105559999.

Response

Recipient is opted out

accountIdstring
phoneNumberstring
optedOutboolean

Always true.

source'api' | 'inbound_stop'

What set the current opt-out.

Changes