API referenceConnect a WhatsApp number

Connect a WhatsApp number

Connect a new WhatsApp number to the project by creating a WhatsApp inbox. Provide the WhatsApp Cloud API credentials and phone details so Nabrah can send and receive messages on that number. The response returns the created inbox summary including its generated id; chatbot_agent_id and chatbot_agent_name are null, since a new number has no agent yet.

POST

https://api.nabrah.ai/api/ext/omni_v2/whatsapp/inboxes

curl --request POST \
  --url 'https://api.nabrah.ai/api/ext/omni_v2/whatsapp/inboxes' \
  --header 'X-API-Key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Support WhatsApp",
  "phone_number": "+966512345678",
  "phone_number_id": "109876543210987",
  "business_account_id": "104958611234567",
  "api_key": "EAAGm0PX4ZCpsBA...",
  "enable_auto_assignment": true
}'

{
  "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"
}

Required connection details

These come from your Meta WhatsApp Cloud API setup.

name

Display name for the inbox.

name

WhatsApp Cloud API credentials

phone_number (human-readable), phone_number_id (Cloud API id), business_account_id (WABA id), and api_key (Meta access token).

phone_numberphone_number_idbusiness_account_idapi_key

enable_auto_assignment

Set true to automatically assign new conversations on this inbox to agents.

enable_auto_assignment

The created inbox's id becomes the inbox_id used by other endpoints. Re-list with GET /api/ext/omni_v2/whatsapp/inboxes. Numbers can also be connected through Meta sign-in in the app, without entering these details; that flow is not available through the API.

Limits

Number limit

A project can connect up to max_inboxes WhatsApp numbers (GET /api/ext/omni_v2/whatsapp/inboxes). Connecting one more returns 409; contact support to raise the limit.

Already connected

Connecting a number whose phone_number_id or phone_number is already connected to the project returns 409.

phone_number_idphone_number

Authorization

X-API-Keystringheaderrequired

Your workspace API key. Create one in the dashboard under API keys.

Body

application/json

Example

{
  "name": "Support WhatsApp",
  "phone_number": "+966512345678",
  "phone_number_id": "109876543210987",
  "business_account_id": "104958611234567",
  "api_key": "EAAGm0PX4ZCpsBA...",
  "enable_auto_assignment": true
}

Response

200

Successful Response

application/json

422

Validation Error

application/json

API referenceConnect a WhatsApp number

Connect a WhatsApp number

POST

https://api.nabrah.ai/api/ext/omni_v2/whatsapp/inboxes

Connect a WhatsApp number

curl --request POST \
  --url 'https://api.nabrah.ai/api/ext/omni_v2/whatsapp/inboxes' \
  --header 'X-API-Key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Support WhatsApp",
  "phone_number": "+966512345678",
  "phone_number_id": "109876543210987",
  "business_account_id": "104958611234567",
  "api_key": "EAAGm0PX4ZCpsBA...",
  "enable_auto_assignment": true
}'

{
  "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"
}

Required connection details

These come from your Meta WhatsApp Cloud API setup.

name

Display name for the inbox.

name

WhatsApp Cloud API credentials

phone_number (human-readable), phone_number_id (Cloud API id), business_account_id (WABA id), and api_key (Meta access token).

phone_numberphone_number_idbusiness_account_idapi_key

enable_auto_assignment

Set true to automatically assign new conversations on this inbox to agents.

enable_auto_assignment

Limits

Number limit

A project can connect up to max_inboxes WhatsApp numbers (GET /api/ext/omni_v2/whatsapp/inboxes). Connecting one more returns 409; contact support to raise the limit.

Already connected

Connecting a number whose phone_number_id or phone_number is already connected to the project returns 409.

phone_number_idphone_number

Authorization

X-API-Keystringheaderrequired

Your workspace API key. Create one in the dashboard under API keys.

Body

application/json

Example

{
  "name": "Support WhatsApp",
  "phone_number": "+966512345678",
  "phone_number_id": "109876543210987",
  "business_account_id": "104958611234567",
  "api_key": "EAAGm0PX4ZCpsBA...",
  "enable_auto_assignment": true
}

Response

200

Successful Response

application/json

422

Validation Error

application/json