Update WhatsApp inbox
Update the configuration of one of the project's WhatsApp inboxes, such as its WhatsApp Cloud API credentials, phone number details, webhook verify token, auto-assignment behavior, and display name. api_key, business_account_id, phone_number_id and phone_number are required on every update; leave out name or enable_auto_assignment to keep their current values. Leave out webhook_verify_token to keep the current token, or send a new value to change it. The response returns the updated inbox summary (id, inbox_type, project_id, name, config, created_at) and the agent answering on it (chatbot_agent_id, chatbot_agent_name).
curl --request PATCH \
--url 'https://api.nabrah.ai/api/ext/omni_v2/whatsapp/inboxes' \
--header 'X-API-Key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"api_key": "EAAGm0PX4ZCpsBA...",
"business_account_id": "104958611234567",
"phone_number_id": "109876543210987",
"phone_number": "+966512345678",
"webhook_verify_token": "my-verify-token",
"enable_auto_assignment": true,
"name": "Support WhatsApp"
}'{
"id": "00000000-0000-4000-8000-000000000000",
"inbox_type": "whatsapp",
"project_id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"config": {},
"created_at": "2026-01-15T12:00:00.000Z",
"inbox_id": 0,
"chatbot_agent_id": "00000000-0000-4000-8000-000000000000",
"chatbot_agent_name": "string"
}Configuration fields
These map to the WhatsApp Cloud API connection for the inbox.
api_key is the Meta access token, business_account_id is the WhatsApp Business Account (WABA) id, phone_number_id is the Cloud API phone number id, and phone_number is the human-readable number.
api_keybusiness_account_idphone_number_idphone_numberwebhook_verify_tokenThe verify token used when Meta validates the webhook subscription. Leave it out to keep the current token, or send a new value to change it.
webhook_verify_tokenBehaviorenable_auto_assignment toggles automatic assignment of new conversations to agents; name sets the inbox display name. Leave enable_auto_assignment out to keep the current setting.
enable_auto_assignmentnameChanging phone_number_id or phone_number to a number already connected to another WhatsApp inbox of the project returns 409.
phone_number_idphone_numberChoosing the WhatsApp number
A project can connect more than one WhatsApp number. inbox_id selects the number this call works on.
inbox_id is optional; the project's only WhatsApp number is used.
inbox_id is required and the call returns 400 without it. An id that is not one of the project's WhatsApp numbers returns 404.
inbox_idList the numbers and their ids with GET /api/ext/omni_v2/whatsapp/inboxes.
Authorization
X-API-KeystringheaderrequiredYour workspace API key. Create one in the dashboard under API keys.
Query parameters
inbox_idstringThe id of the WhatsApp number to use, from GET /api/ext/omni_v2/whatsapp/inboxes.
Use inboxes[].id (a UUID), not the numeric inboxes[].inbox_id. Optional while the project has one WhatsApp number; required once it has more than one.
Body
application/json{
"api_key": "EAAGm0PX4ZCpsBA...",
"business_account_id": "104958611234567",
"phone_number_id": "109876543210987",
"phone_number": "+966512345678",
"webhook_verify_token": "my-verify-token",
"enable_auto_assignment": true,
"name": "Support WhatsApp"
}Response
Successful Response
application/json
Validation Error
application/json