Skip to main content
POST
/
v1
/
whatsapp
/
manage
/
startWhatsAppThread
/
{workspaceId}
/
{assistantId}
Start a WhatsApp Conversation
curl --request POST \
  --url https://catalystapi.superdashhq.com/api/v1/whatsapp/manage/startWhatsAppThread/{workspaceId}/{assistantId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "toNumber": "<string>",
  "templateName": "<string>",
  "language": "<string>",
  "attributes": {}
}
'
{
    "msg": "Outbound WhatsApp Message succesfully sent",
    "data": {
        "contacts": [
            {
                "input": "{toNumber}", // The toNumber of the recipient
                "wa_id": "{toNumber}" // The Whatsapp Id of the recipient
            }
        ],
        "messages": [
            {
                "id": "{whatsapp_message_Id}", // The WhatsApp Message Id of the sent message
                "message_status": "{message_status}" // The status of the sent message
            }
        ],
        "phoneNumberId": "{phoneNumberId}", // The phone number Id
        "conversationId": "{conversationId}" // The conversation Id
    }   
}

​
Authorizations

​
x-api-key
string
required
API key associated with the Workspace

​
Path Parameters

​
workspaceId
string
required
The UUID of the Workspace
​
assistantId
string
required
The UUID of the Assistant

​
Body Parameters

​
toNumber
string
required
The Recipient’s Phone Number with country code
​
templateName
string
required
The name of the WhatsApp Template to be sent
​
language
string
required
The language of the Whatsapp message template specified in templateName
​
attributes
object
The "Named Parameters" if any, to be used in the specified WhatsApp Template

​
Response

{
    "msg": "Outbound WhatsApp Message succesfully sent",
    "data": {
        "contacts": [
            {
                "input": "{toNumber}", // The toNumber of the recipient
                "wa_id": "{toNumber}" // The Whatsapp Id of the recipient
            }
        ],
        "messages": [
            {
                "id": "{whatsapp_message_Id}", // The WhatsApp Message Id of the sent message
                "message_status": "{message_status}" // The status of the sent message
            }
        ],
        "phoneNumberId": "{phoneNumberId}", // The phone number Id
        "conversationId": "{conversationId}" // The conversation Id
    }   
}