Opt a phone number out of receiving messages

Authorization

x-api-key<token>

Project-scoped API key. Keys carry either the ADMIN or TENANT role; a route additionally requires that the key's role is listed in its x-required-roles. Machine-to-machine callers should use this.

In: header

Path Parameters

phone*string

Phone number in E.164 format (e.g., +12488778283)

Match^\+[1-9]\d{1,14}$

Response Body

`application/json`

curl -X POST "https://example.com/v1/phones/string/opt-out"

{  "phone": "string",  "isOptedOut": true}

Opt a phone number out of receiving messages

Authorization

Path Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`