Skip to main content
POST
Send one APPROVED WhatsApp template to a customer from the application's number; answers the message (status `accepted`, then poll whatsapp.messages.show for sent, delivered, read or failed). Charges Tawked's fee from the wallet.

Authorizations

Authorization
string
header
required

An account token from Settings › Account API in the Tawked console: Authorization: Bearer tk_acct_…

Headers

Idempotency-Key
string

One per intended change (1 to 128 printable ASCII characters): a retry with the same key and the same request answers the stored 2xx with Idempotent-Replayed: true, for 24 hours. A 428 approval_required is never stored: send the approved request again with the same key or none. An answer that carried a secret shown once is never kept: its replay answers 409 idempotency_secret_not_replayable with the id of what it made.

Required string length: 1 - 128
Tawked-Approval
string<uuid>

The id of an approval its person approved (approvals.show answers approved): the same request then runs, once.

Path Parameters

application
string
required

An application's id (a UUID); list them with applications.applications.list.

Pattern: ^(?:[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12})$

Body

application/json
template
string
required
Maximum string length: 512
to
string
required
Maximum string length: 32
buttons
object[]
Maximum array length: 10
header
string | null
Maximum string length: 1024
lang
string | null
Maximum string length: 15
language
string | null
Maximum string length: 15
params
object
reference
string | null
Maximum string length: 128

Response

Created.

data
object
required