DELETE · Bearer

DELETE /api/v1/inboxes/:id/phone-number

Summary

Release the inbox phone number Requires inbox_update. Releases the number at the provider and marks it released. With COOPER_SMS_BILLING=stripe, the subscription quantity is lowered and Stripe prorates the charge. A failure to update Stripe is retried by the next provision or release, which recompute the quantity from the database. The same account waits 30 days before provisioning that E.164 again. HTTP 404 phone_number_not_found when there is no active number. HTTP 404 not_found when SMS is off.

Request

This call has no JSON body.

Response

HTTP 200. Sample values illustrate the schema.

{
  "object": "phone_number",
  "id": "inb_example",
  "account_id": "acc_example",
  "e164": "+14155550100",
  "provider": "string",
  "provider_sid": "string",
  "number_type": "string",
  "capabilities": [
    "string"
  ],
  "status": "pending",
  "outbound": "string",
  "created_at": "2026-10-18T12:00:00.000Z"
}

Errors

  • HTTP 404 phone_number_not_found
  • HTTP 404 not_found
  • HTTP 404 inbox_not_found

Idempotency

This route does not document Idempotency-Key or client_id.