Schedule template messages

  • Status code 200 means the message was accepted by WATI, not delivered yet.
  • To know if a message is failed, listen to the Template Message Failed webhook.
  • To know if a message is sent successfully, listen to Delivered/Read/Reply webhooks.

Permissions

For API access tokens and OIDC tokens, satisfy at least one of: api, wati_integration:write, messagetemplatev3:write. API access tokens may satisfy a listed scope through the configured scope hierarchy; OIDC tokens are checked against their scope claims. Legacy JWT authentication does not use this scope check. Authentication, role, tenant, and applicable feature or plan checks still apply. For HTTP 403, check the credential type, applicable scopes, roles, and workspace access; 403 does not always mean a missing scope. Authentication/authorization failures do not guarantee a JSON response body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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.

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