Delete a WhatsApp Inbox
Delete an inbox removed and delete the inbox from your online account.
Please read carefully!
1. The inbox ID will be canceled and removed immediately.
2. All messages, conversations, contacts, files, webhooks, labels - everything will be deleted inside that inbox.
3. All studio data, reports and saved information within this inbox will be removed. make sure you backup all data from within the inbox if you need.
4. The WhatsApp number connected to this inbox will be released in case you want to connect them to other account. This operation does not cancel or disable a WhatsApp number. this only removed a WhatsApp inbox.
5. This operation is irreversible! make sure this is really what you want.
Settings:
URL | |
Method | JSON via DELETE |
Header | Authorization: Bearer {{access_token}} *The access_token can be received from settings->get access token API. |
Body:
Parameter | Description / Example |
|---|---|
accountID | The account ID where the inbox is located |
server | The server subdomain of the account id. the default is 'online'. |
inboxID | The WhatsApp inbox ID within the account. you can get this value from Partners - WhatsApp -> Get WhatsApp Numbers endpoint |
Response:
{
"status": "OK",
"reason": 1
"accountID": 1,
"server": "online",
"inboxID": 10,
"whatsapp_number": "972501234567"
}
Response-Explain:
Parameter | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status | OK or FAIL "OK" means the request was successful. "Fail" means error. | ||||||||||||||
accountID | The account ID you provided | ||||||||||||||
server | The server subdomain where the account is hosted. | ||||||||||||||
inboxID | The inbox ID you requested to delete | ||||||||||||||
whatsapp_number | The WhatsApp number that was connected to this inbox | ||||||||||||||
reason | 'reason' is the status explanation in case of FAIL
|
Note: you can only remove a WhatsApp inbox using this endpoint.