Skip to main content
GET
Sample opt outs

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.

Query Parameters

workspaceId
string
required

Workspace ID

developerProvider
enum<string>
required

Integration provider making the request

Available options:
zapier

Response

OK

conversationId
string
required

The conversation ID

createdAt
string
required

The created at timestamp

inboundAddress
string
required

The phone number of the opt out

optOutReason
string
required

The reason for the opt out

workspaceId
string
required

The workspace ID