Skip to main content

ReleaseDID releases a DID allocation.

POST 
/api/v1/voice/admin/did-pool/:didPoolId/release

Removes DID from organization. Can specify immediate release or start a grace period for potential reactivation.

Parameters​

  • did_pool_id: Required, pool item to release
  • reason: Required, release reason
  • immediate: Optional, skip grace period if true

Release Reasons​

  • subscription_cancelled: Customer cancelled
  • downgrade: Customer downgraded plan
  • manual: Admin action
  • expired: Subscription expired

Grace Period​

If not immediate, DID enters pending_release status. Customer can reactivate during grace period.

Side Effects​

  • Changes status to pending_release or available
  • Removes DID from organization if immediate
  • Records release in audit log

Errors​

  • NOT_FOUND: Pool item does not exist
  • FAILED_PRECONDITION: DID not currently allocated
  • PERMISSION_DENIED: Caller lacks voice:admin permission

Request​

Responses​

A successful response.