Skip to main content
POST
https://catalystapi.superdashhq.com/api
/
v1
/
whatsapp
/
manage
/
sendTemplateMessage
/
{workspaceId}
/
{assistantId}
Send Template Message
curl --request POST \
  --url https://catalystapi.superdashhq.com/api/v1/whatsapp/manage/sendTemplateMessage/{workspaceId}/{assistantId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "toNumber": "<string>",
  "templateName": "<string>",
  "language": "<string>",
  "parameters": {}
}
'
{
    "msg": "Outbound WhatsApp Message succesfully sent",
    "data": {
        "messaging_product": "whatsapp",
        "contacts": [
            {
                "input": "<WHATSAPP_USER_PHONE_NUMBER>",
                "wa_id": "<WHATSAPP_USER_ID>"
            }
        ],
        "messages": [
            {
                "id": "<WHATSAPP_MESSAGE_ID>",
                "message_status": "<PACING_STATUS>"
            }
        ],
        "phoneNumberId": "<PHONE_NUMBER_ID_USED>"
    }
}

Authorizations

x-api-key
string
required
API Key associated with the workspace

Path Parameters

workspaceId
string
required
The ID of the Workspace
assistantId
string
required
The ID of the WhatsApp Assistant

Body Parameters

toNumber
string
required
The Recipient’s Phone Number with country code
templateName
string
required
The Name of the WhatsApp Template
language
string
required
The Language code of the WhatsApp Template
parameters
object
The "Named Parameters" if any, to be used in the specified WhatsApp Template
{
    "msg": "Outbound WhatsApp Message succesfully sent",
    "data": {
        "messaging_product": "whatsapp",
        "contacts": [
            {
                "input": "<WHATSAPP_USER_PHONE_NUMBER>",
                "wa_id": "<WHATSAPP_USER_ID>"
            }
        ],
        "messages": [
            {
                "id": "<WHATSAPP_MESSAGE_ID>",
                "message_status": "<PACING_STATUS>"
            }
        ],
        "phoneNumberId": "<PHONE_NUMBER_ID_USED>"
    }
}