Skip to main content
POST
/
api
/
sms
/
send
Send a single SMS to a contact
curl --request POST \
  --url http://localhost:3000/api/sms/send \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactId": "<string>",
  "senderId": "<string>",
  "messageTemplate": "Hello {{ $contact.firstName }}, your loyalty tier is {{ $contact.customAttributes.loyalty_tier }}."
}
'

Body

application/json
​
contactId
string
required

UUID of the contact to send SMS to

​
senderId
string
required

UUID of the sender ID to use

​
messageTemplate
string
required

Message template with optional {{ $contact.* }} placeholders

Example:

"Hello {{ $contact.firstName }}, your loyalty tier is {{ $contact.customAttributes.loyalty_tier }}."

Response

SMS sent successfully