Phone & voice · Branded Calling

Detach numbers from an identity

Detaches numbers from an identity.

DELETEhttps://api.pozy.ai/v1/branded-calling/identities/{id}/numbers
detachBrandedCallingNumbers

Guide: Branded calling

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the telephony resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
idrequiredstring

Request body

application/json, required

  • phoneNumbersarray of stringrequired

    At least 1 item. Up to 100 items.

Example

curl -X DELETE "https://api.pozy.ai/v1/branded-calling/identities/6bfebd43ddc270f6d2c56fc5/numbers" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phoneNumbers": [
    "+14155550123"
  ]
}'

Response

200 on success

  • removedarray of string
200 response
{
  "removed": [
    "string"
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Branded Calling