Skip to main content
POST
Send a group message

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

Group message to send

Group message 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

group
string[]
required

Contact phone numbers (E.164) that share one group conversation

id
string
required

Workspace ID the request targets

Maximum string length: 45
mediaUrl
string

Publicly reachable media URL; required when text is omitted

text
string

Message text, up to 1200 characters; required when mediaUrl is omitted

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

conversationId
string
from
string
group
string[]
id
string
text
string
workspaceId
string