Delete Onboarding Account
Delete onboarding account allows you to remove an onboarding link that you don't need anymore.
Important Remarks
After sending a request to delete the account, the link will be removed and won't be available anymore. This step is irreversible.
You can only remove a link that was not finished the onboarding process (from Get Accounts list API, link->status must be 0).
After deleting an account, the WhatsApp number will be released for you to create a new onboarding link with that number.
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 | Remarks |
|---|---|---|
The WhatsApp number that was associated with this onboarding link | use country code and the following numbers. no + for example: 972501234567 |
Response:
{
"status": "OK",
"whatsapp": "972501234567",
"reason": 1
}
Response-Explain:
Parameter | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status | OK or FAIL "OK" means the request has been sent to our team. "Fail" means error. | ||||||||||||||
The WhatsApp number you provided. | |||||||||||||||
reason | 'reason' is the status explanation in case of FAIL
|