Compliance / CASL

Manually record an opt-out for a phone number

Requires compliance:w.

post/v1/compliance/opt-outs

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/compliance/opt-outs
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

phone_numberstring required

Number that is opting out (subscriber)

from_numberstring required

Your sending number they are opting out from

Response

Opted out.

status'opted_out' required

Changes

No recorded changes to this operation across all 1 revision of this API.