Skip to main content
POST

Authorizations

X-API-Key
string
header
required

Path Parameters

entityId
string
required

WhatsApp Business Phone Number ID that owns the Meta Business Agent.

Body

application/json
consumer_phone_number
string
required

Consumer phone number in E.164 format.

Minimum string length: 1
Pattern: ^\+[1-9][0-9]{1,14}$
consumer_bsuid
string | null

Ordinary WhatsApp consumer BSUID. Provide exactly one non-null identity.

Pattern: ^[A-Z]{2}\.[A-Za-z0-9]{1,128}$

Response

Operation completed successfully.

A real Meta allowlist entry. Identity fields are optional and mutually exclusive; an ID-only entry is valid. Phone and BSUID entries are independent and share the WhatsApp limit of 20.

id
string
required

Allowlist entry ID.

consumer_phone_number
string

Allowlisted consumer phone number in E.164 format.

Pattern: ^\+[1-9][0-9]{1,14}$
consumer_bsuid
string

Actual BSUID used to create this entry, if returned.

Pattern: ^[A-Z]{2}\.[A-Za-z0-9]{1,128}$
consumer_instagram_username
string

Optional read-only compatibility field. Instagram management is not supported.