Skip to main content

RetirePoolItem permanently retires a DID from the pool.

POST 
/api/v1/voice/admin/did-pool/:id/retire

Marks the DID as retired. Cannot be undone. Use when a number is no longer available from the provider.

Parameters​

  • id: Required, pool item to retire

Prerequisites​

  • DID must not be currently allocated

Errors​

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

Request​

Responses​

A successful response.