numbers

Release a dedicated number

Releases one of your workspace's dedicated numbers now and stops its recurring charge. Your workspace can no longer use the number after release, and the rest of the current billing period is not refunded. This also releases a number already scheduled for cancellation. While a renewal payment for the number is overdue, the request answers 409 until it is paid. To keep the number until the end of the period you paid for, use DELETE /v1/numbers/{number_id} instead. Shared numbers belong to Bird-managed shared infrastructure and cannot be released from your workspace.

post/v1/numbers/{number_id}/release

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/numbers/{number_id}/release
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Path parameters

number_idstring required

Identifier of a number allocated to your workspace, as returned in the id field of GET /v1/numbers.

Example:nda_01krdgeqcxet5s7t44vh8rt9mg

Identifier of the number to release, as returned in the id field of GET /v1/numbers.

Headers

Idempotency-Keystring

Client-supplied key. On operations supporting request deduplication, a retained response is replayed for duplicate requests with the same key within the idempotency window (3 hours by default). This protection requires a workspace, organization, or staff-account scope. User-only and unscoped unauthenticated operations, streams, and operations with a separate replay contract do not use this response replay.

On a supported operation, if idempotency protection is unavailable before execution, the API returns 503 IdempotencyUnavailable (E01033) without executing this attempt. Retry with backoff using the same key and request. An operation that takes effect before its response is retained can still execute again on retry.

Two distinct 409 errors signal misuse:

  • request_in_progress (E01004): The same key is currently being processed by a concurrent request. Wait briefly and retry. The lock expires within 30 seconds.
  • idempotency_key_reuse (E01005): The same key has already completed against a different request body or method. Generate a new key.

Recommended key format is <event-type>/<entity-id> (for example welcome-user/usr_abc123).

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Number released.

Changes

No recorded changes to this operation across all 2 revisions of this API.