Phone & voice · Phone Numbers

Cancel a port-in

Cancels a port-in.

DELETEhttps://api.pozy.ai/v1/phone-numbers/port-in/{id}
cancelPhoneNumberPortIn

Guides: Port a number in, Phone numbers

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

Example

curl -X DELETE "https://api.pozy.ai/v1/phone-numbers/port-in/6bfebd43ddc270f6d2c56fc5" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success

  • idstring
  • statusstring

    One of draft, pending, foc_confirmed, ported, exception, cancelled.

200 response
{
  "id": "6bfebd43ddc270f6d2c56fc5",
  "status": "draft"
}

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 Phone Numbers