Skip to main content
POST
Create WhatsApp campaign

Authorizations

Authorization
string
header
required

Authorization: Bearer tlv_…

Headers

Idempotency-Key
string

Optional. A unique value (e.g. a UUID) per operation, up to 255 characters. Retrying with the same key and body returns the first response instead of doing it again. Kept 24 hours.

Example:

"5f1c2b0e-8d6a-4c1f-9a43-2b7e0f6d1a90"

Body

application/json
name
string
required

For your reference.

Example:

"November offer"

templateId
string<uuid>
required

An approved template. (Or templateName + language.)

contactListIds
string[]

Send to these contact lists…

tags
string[]

…and/or contacts with these tags.

upload
object[]

Or your own recipients (up to 10,000): { phone, name?, email?, fields?: { column: value } }.

variableMap
object

Where each variable's value comes from, per recipient. { body: { "1": source }, header?: {…}, buttons?: { "0": source } }, where a source is { source: "contact", field: "name" | "first_name" | "phone" | "email" }, { source: "column", column } (from upload[].fields) or { source: "fixed", value }.

headerMedia
object

For a media-header template: { type: "image" | "video" | "document", link, filename? } (a public https link).

scheduledAt
string

Send later. Omit to send now.

Response

Success