Skip to main content
POST
/
v1
/
sms
/
startSMSThread
/
{assistantId}
Start a New SMS Conversation
curl --request POST \
  --url https://catalystapi.superdashhq.com/api/v1/sms/startSMSThread/{assistantId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "workspaceId": "<string>",
  "toNumber": "<string>",
  "fromNumber": "<string>",
  "message": "<string>",
  "attributes": {
    "customField1": "<string>",
    "customField2": "<string>",
    "customField3": "<string>",
    "customField4": "<string>",
    "customField5": "<string>",
    "customField6": "<string>",
    "customField7": "<string>",
    "customField8": "<string>"
  }
}
'
{
"msg": "Outbound SMS succesfully sent with id: messageId",
}

Authorizations

x-api-key
string
required
API key associated with your workspace

Path Parameters


assistantId
string
required
The UUID associated with an assistant

Body Parameters


workspaceId
string
required
The UUID associated with a workspace.
toNumber
string
required
The number to which the sms will be sent
fromNumber
string
required
The number from which the sms will be sent and it should be linked to the assistant.
message
string
required
The SMS content.
attributes
object
Additional attributes for the SMS

Response


msg
string
The response message
{
"msg": "Outbound SMS succesfully sent with id: messageId",
}