voice-numbers

Update the voice settings

Changes your workspace's voice settings. Omit a field to leave it as it is.

inbound_configuration.route applies to every Bird number that has no inbound route of its own, from the next call it receives. A number with its own route keeps it, and verified caller IDs receive no calls. The route is checked the same way as a number's: a trunk must be yours and have inbound calling enabled, and a forward target must be one of your verified caller IDs, otherwise the update returns 412. A trunk_id that is not one of your trunks returns 404. Deleting the trunk, or turning off its inbound calling, sets the default back to "reject".

daily_spend_limit.workspace_limit sets your workspace's own daily spend limit. It can be above or below default_limit, up to max_limit, and must be in your organization's wallet currency, otherwise the update returns 422. An organization without a wallet cannot set a limit yet and gets 422 until it has one. Null removes it so the default applies. Calls already in progress are never ended; the limit applies from the next call.

patch/v1/voice/settings

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/voice/settings
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

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

Example request

{
  "inbound_configuration": {
    "route": {
      "type": "reject"
    }
  },
  "daily_spend_limit": {
    "workspace_limit": {
      "amount": "0.00995",
      "currency_code": "EUR"
    }
  }
}

Response

The workspace's voice settings after the update.

Example response

{
  "inbound_configuration": {
    "route": {
      "type": "reject"
    }
  },
  "daily_spend_limit": {
    "currency_code": "EUR",
    "limit": {
      "amount": "0.00995",
      "currency_code": "EUR"
    },
    "used": {
      "amount": "0.00995",
      "currency_code": "EUR"
    },
    "remaining": {
      "amount": "0.00995",
      "currency_code": "EUR"
    },
    "default_limit": {
      "amount": "0.00995",
      "currency_code": "EUR"
    },
    "max_limit": {
      "amount": "0.00995",
      "currency_code": "EUR"
    },
    "workspace_limit": {
      "amount": "0.00995",
      "currency_code": "EUR"
    }
  }
}

Changes

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