Skip to main content
POST
Create an opt out

Authorizations

Authorization
string
header
required

An OAuth 2.0 access token, sent as Authorization: Bearer <token>. MessageDesk is the OAuth 2.0 provider (backed by AWS Cognito): an integration such as Zapier obtains the token through the authorization-code flow when a user connects their MessageDesk account. Access tokens are valid for 24 hours and are refreshed with the refresh token.

Body

application/json

Opt out to create

Opt out to create

developerProvider
enum<string>
required

Integration provider making the request

Available options:
zapier
id
string
required

Workspace ID the request targets

Maximum string length: 45
phone
string
required

Contact phone number in E.164 format

userId
string

Optional acting user; overwritten with the authenticated user on endpoints that record authorship

Maximum string length: 45

Response

OK

id
string
phone
string
workspaceId
string