numbers

Update an allocated number

Updates the name and reference for a number allocated to your workspace. Omit a field to keep its current value, or send null to clear it. Leading and trailing whitespace is removed. References need not be unique.

patch/v1/numbers/{number_id}

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/numbers/{number_id}
  • 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 returned by the allocated-number list.

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.

Request body

namestring nullable

A name for this number in your workspace, such as Support line. Send null to clear it, or omit it to keep the current name.

referencestring nullable

Your own reference for this number, such as an identifier from your records. References need not be unique. Send null to clear it, or omit it to keep the current reference.

Example request

{
  "name": "Support line",
  "reference": "STORE-042"
}

Response

The updated number.

namestring nullable required

The name you gave this number in your workspace. Null when no name is set.

referencestring nullable required

Your own reference for this number in your workspace. Null when no reference is set.

idstring required

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

kind'dedicated' | 'shared' required

How this number is allocated. dedicated belongs to your workspace and is billed as a subscription. shared is provided through Bird-managed shared infrastructure and is not owned or billed as a workspace subscription.

numberstring required

Phone number in E.164 format.

country_codestring required

ISO 3166-1 alpha-2 country code.

number_typestring required

Physical type of a phone number. New number types may be added over time, so treat unrecognized values as supported types rather than errors.

capabilitiesNumberCapability[] required

Capabilities supported by this number.

status'active' | 'pending_ownership_registration' | 'released' required

The allocation and ownership-approval status of this number.

  • active means this number is allocated to your workspace and usable.
  • pending_ownership_registration means this number is allocated to your workspace and billed, but outbound SMS and both inbound and outbound voice calls are blocked until ownership registration is approved and activation completes, or the ownership requirement is withdrawn. This ownership status does not gate inbound SMS or WhatsApp. Read ownership.status and ownership.next for the current decision and remaining work.
  • released means this number is no longer allocated to your workspace.

An allocated number is not always enough to send from it: some destination countries also require an approved registration for the sender.

allocated_atstring date-time required

When this number was allocated to your workspace.

releases_atstring date-time nullable required

When a scheduled release of this number takes effect, at the end of its current billing period. The number stays allocated, with its current status, until then. null when no release is scheduled.

released_atstring date-time nullable required

When this number was released. null while it is still allocated to your workspace.

Example response

{
  "id": "nda_01krdgeqcxet5s7t44vh8rt9mg",
  "country_code": "US",
  "ownership": {
    "submission_id": "csb_01krdgeqcxet5s7t44vh8rt9mg"
  },
  "pricing": {
    "recurring_price": {
      "amount": "0.00995",
      "currency_code": "EUR"
    },
    "recurring_period": {
      "unit": "month",
      "count": 3
    },
    "intervals_per_charge": 12
  }
}

Changes

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