Delete Branded Phone Number

API Details

  • This endpoint deletes existing phone numbers in your account.
  • Deletion requirements: phone numbers with active carrier submissions cannot be deleted. You must first opt out of all carrier features and wait for the opt-out to be approved by carriers. Statuses that block deletion include:
    • submitted.optIn / submitted.optOut - submission in progress with carrier. To delete, first submit false through the PATCH endpoint, and wait for the number to be approved for opt out.
    • approved.optIn - feature is live with carrier. To delete, first submit false through the PATCH endpoint, and wait for the number to be approved for opt out.
    • pending.optIn / pending.optOut - opt-in/opt-out change pending submission. Wait for the number to be approved for opt out.
  • Use the GET endpoint to check the status of your numbers.

Rate Limit

Limit TypeValue
Requests per second10

If you exceed this limit, you will receive a 429 Rate Limit Exceeded response.

Path Params
string
required

E.164-formatted phone number to delete.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json