WhatsApp agentsWhatsApp accounts
WhatsApp accounts
The WhatsApp Business numbers connected to your workspace.
A WhatsApp account is one phone number connected through Meta's WhatsApp Business Platform. Your WhatsApp agent answers the messages that arrive on it.
Numbers are connected in the dashboard through Meta's signup flow, so accounts are read-only in the API. Use an account's phone_number_id as an agent's set_inbound_whatsapp_number to route its messages to that agent.
Endpoints
The WhatsApp account object
idstring (uuid)WhatsApp account id.
waba_idstringMeta WhatsApp Business Account id.
phone_number_idstringMeta phone number id. Use it as an agent's
set_inbound_whatsapp_number.display_e164stringnullableThe number in E.164 format.
statusstringConnection status, e.g.
active.modestringcloud_apiorcoexistence(number also used in the WhatsApp Business app).Allowed:cloud_apicoexistencecreated_atstring (date-time)nullableWhen the number was connected.
updated_atstring (date-time)nullableWhen it was last changed.