ApiNumbers

Delete a phone number

DELETE
/numbers/{id}

Remove a phone number from your organization.

Authorization

BearerAuth
AuthorizationBearer <token>

API key authentication. Get your key from the dashboard.

In: header

Path Parameters

id*string

Phone number UUID

Formatuuid

Response Body

application/json

application/json

application/json

curl -X DELETE "https://example.com/numbers/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "success": true
}
{
  "error": "Invalid API key",
  "message": "string"
}
{
  "error": "Invalid API key",
  "message": "string"
}

Turn on WhatsApp calling PUT

Give VoiceDock the SIP password Meta generated for this number, so that WhatsApp calls to the number reach your assistant. Do this after you have turned on calling over SIP for the number at Meta; the [WhatsApp calling guide](/docs/integrations/whatsapp-calling) has every step. The change is applied in the background: the response is `202` with status `pending`, and `GET` shows `active` once it is done, usually within a minute. On a number where WhatsApp calling is already set up, this replaces the stored password, for example after you reset it at Meta. The number must be active and must not already receive its calls through another SIP provider, such as your own SIP trunk. An organization can use WhatsApp calling on up to 10 numbers; contact support for more. This endpoint and `DELETE` are limited to 10 requests per minute per API key.

Turn off WhatsApp calling DELETE

Stop taking WhatsApp calls on this number and remove the stored SIP password. The change is applied in the background: the response is `202` with status `disabling`, and `GET` shows `off` once it is done. Turn off calling for the number at Meta as well, or WhatsApp users keep seeing a call button that no longer reaches your assistant. Phone calls to the number are not affected.