Get template with contact data placeholders resolved

curl --request POST \
  --url https://your-instance.example.com/api/user/sms-templates/{templateId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "+14155550133",
  "selectedUser": {
    "channelType": "sms",
    "messengerId": "+14155550133"
  }
}
'

{
  "message": "Hi Alex! Confirming your tour for Friday at 2:00pm.",
  "type": "sms",
  "category": "tours"
}

POST

api

user

sms-templates

{templateId}

Get template with contact data placeholders resolved

curl --request POST \
  --url https://your-instance.example.com/api/user/sms-templates/{templateId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "+14155550133",
  "selectedUser": {
    "channelType": "sms",
    "messengerId": "+14155550133"
  }
}
'

{
  "message": "Hi Alex! Confirming your tour for Friday at 2:00pm.",
  "type": "sms",
  "category": "tours"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

templateId

string

required

Body

application/json

phoneNumber

string

Contact phone number used to locate the contact record for SMS/voice placeholder resolution; formatted before lookup.

selectedUser

object

Channel target used to locate the contact when not addressing them by phone (e.g., Facebook Messenger).

Show child attributes

Response

Resolved template returned

Template body with placeholders resolved against the supplied contact context. Returned by POST /api/user/sms-templates/{templateId}.

message

string

required

The fully-resolved message body.

type

enum<string>

required

Available options:

sms,

email,

automation