TAtalkdesk
Outbound Notifications API

Send outbound notification messages

Changed on

Send outbound notification messages at scale through multiple channels (WhatsApp, SMS), utilizing various message types. The request body is polymorphic — the channel field determines which message schema applies. WhatsApp supports rich media content and template messages; SMS supports plain text body messages. A request can contain at most 600 messages, and each message can contain at most 600 destinations; requests that exceed either limit are rejected with a 400 Bad Request.

post/outbound/notifications

Request

  • Base URL
    https://api.talkdeskapp.com
  • URL
    https://api.talkdeskapp.com/outbound/notifications
  • Auth
    OAuth 2
    Authorization code: https://{account_name}.talkdeskid.com/oauth/authorize
    Token URL: https://{account_name}.talkdeskid.com/oauth/token scopes: outbound-notifications:write

Request body

OR

Example request

{
  "messages": [
    {
      "template": {
        "variables": {
          "1": "Jane",
          "2": "Doe"
        },
        "header_variables": {
          "1": "your order"
        },
        "carousel": [
          {
            "variables": {
              "1": "Giraffe plush",
              "2": "$29.99"
            }
          }
        ]
      }
    }
  ],
  "options": {
    "bind_conversation": {
      "ttl_in_minutes": 60
    }
  }
}

Response

Accepted

bulk_idstring required

Unique bulk identifier

Changes