Skip to main content
POST
Create WhatsApp sender

Authorizations

X-API-KEY
string
header
required

Body

application/json
sender
string
required

WhatsApp business number, 8-15 digits (non-digits are stripped).

display_name
string | null

Human-readable label.

phone_number_id
string | null

Meta business phone_number_id; must be globally unique.

waba_id
string | null

Meta WhatsApp Business Account id.

status
enum<string>
default:pending_signup
Available options:
pending_signup,
provisioning,
active,
flagged,
failed,
archived
metadata
object

Arbitrary JSON object.

Response

The sender was created.

id
string
sender
string
display_name
string | null
phone_number_id
string | null
waba_id
string | null
status
enum<string>
Available options:
pending_signup,
provisioning,
active,
flagged,
failed,
archived
quality_rating
string | null
messaging_tier
string | null
provider
string | null
metadata
object
created_at
string<date-time>
updated_at
string<date-time>