API Reference

Schedule template messages

post
https://example.com/api/ext/v3/messageTemplates/schedule
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

BSUID Support: The phone_number field in the recipient object is now optional (was required). A new target field has been added.

FieldRequiredDescription
phone_numberOptional (was required)WhatsApp phone number of the recipient
targetOptional (new)Polymorphic identifier: Phone Number, Contact ID, or BSUID

Validation: Each recipient must have at least one of phone_number or target. Returns 400 if neither is provided.

Target formats: 14155552671 (phone), 507f1f77bcf86cd799439011 (Contact ID), US.123124141512 (BSUID)

Body Params

Request model for scheduling template messages.

string | null

The channel name or number from which the template messages will be sent (null for default channel).

string
required

The name of the template to be used for sending messages.

string
required

The name of the broadcast to be created.

date-time
required

The scheduled time to send the template messages in UTC.

recipients
array of objects
required

List of recipients to send the template message to. (1 to 10,000 items)

recipients*
Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

401

The request is unauthorized.

429

Too many requests. Either the rate limit has been exceeded or usage limits have been reached.

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago