Skip to main content
POST
Create a WhatsApp Official campaign as a draft

Authorizations

Authorization
string
header
required

API key created in the organization settings.

Headers

Idempotency-Key
string

Unique key for the operation. Repeating the same key with the same body returns the original response instead of running it again.

Body

application/json
name
string
required

Campaign name shown in Bevits; it also names the template.

Required string length: 1 - 120
template
object
required
official_account_id
string

WhatsApp number that sends the campaign. Needed only when the store has several numbers and none is the default; in that case, the error lists the options.

Pattern: ^waa_[A-Za-z0-9_-]+$
validate_only
boolean
default:false

When true, only validates the campaign and its template, saving nothing and without contacting Meta.

Response

Campaign validated or saved as a draft, with its template submitted to Meta for review.

object
string
required
Allowed value: "whatsapp_campaign_draft"
validate_only
boolean
required

true when the campaign was only validated; nothing was saved or sent to Meta.

name
string
required
status
string
required
Allowed value: "draft"
template
object
required
pending
string[]
required

What is still missing before sending, such as Meta's approval and choosing the audience.

next_step
string
required
id
string
Pattern: ^tcp_[A-Za-z0-9_-]+$
html_url
string<uri>

Link to the campaign in Bevits, where a person picks the audience and sends it.