Skip to main content
POST
Send a message

Authorizations

apiKey
string
header
required

Body

application/json
sender
string
required

The Clerk phone number or identifier the message should be sent from

Example:

"+1415456789"

mediaUrls
string[]
required

The media URLs to send with the message

Example:
recipients
string[]
required

The recipients of the message

Example:
body
string
required

The message text

Example:

"Hello, world!"

sentByName
string

The name of the sender displayed in the UI

Example:

"Clerk"

templateId
number

The ID of the template to use for the message

Example:

123

Response

The sent message

data
object
required

Represents a message resource