Delete WhatsApp inbox

Delete one of the project's WhatsApp inboxes, disconnecting that WhatsApp number from the project. Choose the number with inbox_id. The response is a boolean indicating whether the deletion succeeded.

DELETE

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

curl --request DELETE \
  --url 'https://api.nabrah.ai/api/ext/omni_v2/whatsapp/inboxes' \
  --header 'X-API-Key: <your-api-key>'

false

Irreversible

Deleting an inbox removes the WhatsApp channel connection.

Agents

An agent that answered on the deleted number stays configured and keeps answering on its other numbers.

Use GET /api/ext/omni_v2/whatsapp/inboxes to confirm which inbox(es) exist before deleting.

Choosing the WhatsApp number

A project can connect more than one WhatsApp number. inbox_id selects the number this call works on.

One number

inbox_id is optional; the project's only WhatsApp number is used.

More than one number

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_id

List the numbers and their ids with GET /api/ext/omni_v2/whatsapp/inboxes.

Authorization

X-API-Keystringheaderrequired

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

Query parameters

inbox_idstring

The 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.

Response

200

Successful Response

application/json

422

Validation Error

application/json