API ReferenceSend a Message

SMS Message

Send an SMS message to a recipient.

Headers

PINNACLE-API-KeystringRequired

Request

This endpoint expects an object.
tostringRequiredformat: "^\+\d{11}$"

The recipient’s phone number in E.164 format (e.g., +12345678901).

fromstringRequiredformat: "^\+\d{11}$"
The sender's phone number in E.164 format. Must be owned by the user.
textstringRequired<=1600 characters

The SMS message content (max 1600 characters).

statusCallbackstringOptional

Optional URL to receive a POST request when the message status changes. Read more about status callbacks here.

Response

SMS message sent successfully
messageIdstring
The unique ID of the sent message.
messagestring
A message indicating the status of the sent message.

Errors