GuidesAPI EndpointsKnowledge BaseSupportTalkdesk WebsiteMarketplaceDiscussions API Change LogOpenAPI Specification Download
API Endpoints
Home
  1. Public API
  2. Outbound Notifications API

Send outbound notification messages

post
https://api.talkdeskapp.com/outbound/notifications

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

outbound-notifications:write

Body Params
string
enum
required

Channel to send the message through

Allowed:
string
required
length between 1 and 255

WhatsApp Business sender identifier (phone number)

messages
array of objects
required
length between 1 and 500

Array of WhatsApp messages to send

messages*
destinations
array of objects
required
length ≥ 1

Message destinations

destinations*
string
required
length between 1 and 255

Recipient destination identifier (phone number, email, etc.)

string
length between 1 and 100

Optional client-provided message ID for tracking

content
object
required
template

Template message details that differ by channel

options
object

Options for WhatsApp notification requests

Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?