Release or delete a phone number
Release a phone number. Paid marketplace numbers are soft-scheduled: Stripe cancels at period end, the number stays active until then (release_scheduled_at), then the provider number is returned and status becomes released. Complimentary plan numbers and unpaid purchases are released immediately. Customer-provided numbers are deleted together with their dispatch rule. Required scope: phone_numbers:write (keys without scope restrictions have full access).
Authorizations
API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.
Path Parameters
Phone number ID.
Response
Release/delete confirmation.
Paid marketplace soft-release returns the updated number row (status still active, release_scheduled_at set). Immediate marketplace release returns status=released. Customer-provided numbers return { id, deleted: true }.