Skip to main content
POST
Send a broadcast

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

Broadcast to send

Broadcast to send

developerProvider
enum<string>
required

Integration provider making the request

Available options:
zapier
from
string
required

Workspace phone number (outbound channel) in E.164 format

id
string
required

Workspace ID the request targets

Maximum string length: 45
recipients
string[]
required

Contact phone numbers (E.164) that each receive their own copy of the message

mediaUrl
string

Publicly reachable URL of an image or file to attach

text
string

Message text, up to 1200 characters

Maximum string length: 1200
userId
string

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

Maximum string length: 45

Response

OK

from
string
recipients
string[]
text
string
workspaceId
string