--- title: "Update the voice settings" method: PATCH path: "/v1/voice/settings" tags: ["voice-numbers"] --- # Update the voice settings `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` 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. ## Headers - `Idempotency-Key` string - `X-Workspace-Id` string - `X-Organization-Id` string ## Request body - VoiceSettingsUpdate: Changes to your workspace's voice settings. Omit a field to leave it as it is. - `inbound_configuration` VoiceSettingsInboundConfigurationPut: The route for calls arriving on any of your Bird numbers that has no inbound route of its own; verified caller IDs receive no calls. It takes effect on the next call to each of those numbers. Numbers with their own route keep it. - `route` union, required: What happens to a call arriving for this number. Its `type` selects the shape, and each answer carries its own fields; the variants below are the full set you can set. - VoiceCallRouteReject - `type` 'reject' | 'trunk' | 'forward' | 'sequence', required: Which answer a number carries. - `reject`: refuses the call. - `trunk`: delivers the call to one of your SIP trunks. - `forward`: places a call to one of your verified caller IDs and connects the two. - `sequence`: runs the configured sequence from its selected voice-call entry. It selects the answer's own shape, so a new way to answer a call arrives as a new value alongside a new set of fields. - VoiceCallRouteTrunk - `type` 'reject' | 'trunk' | 'forward' | 'sequence', required: Which answer a number carries. - `reject`: refuses the call. - `trunk`: delivers the call to one of your SIP trunks. - `forward`: places a call to one of your verified caller IDs and connects the two. - `sequence`: runs the configured sequence from its selected voice-call entry. It selects the answer's own shape, so a new way to answer a call arrives as a new value alongside a new set of fields. - `trunk_id` string, required - VoiceCallRouteForward - `type` 'reject' | 'trunk' | 'forward' | 'sequence', required: Which answer a number carries. - `reject`: refuses the call. - `trunk`: delivers the call to one of your SIP trunks. - `forward`: places a call to one of your verified caller IDs and connects the two. - `sequence`: runs the configured sequence from its selected voice-call entry. It selects the answer's own shape, so a new way to answer a call arrives as a new value alongside a new set of fields. - `forward_to` string, required: The number calls are forwarded to, in E.164 format. It has to be one of your verified caller IDs. That is checked when you set it and again on every call it forwards, so a caller ID you later remove stops forwarding rather than carrying on. - `forward_as` 'dialed_number' | 'calling_number', required: Which of a forwarded call's two numbers it shows as the caller. `dialed_number` presents the Bird number the caller dialed. Whoever answers sees which of your numbers was called. Older configurations without a stored choice use this value. Carrier screening can still affect delivery. `calling_number` presents the caller's own number, so the phone rings as though they had dialed it directly and the call can be returned from the call log. Because the number is not one you own, some carriers (most often in the US and parts of Europe) mark such calls as unverified, replace the number, or screen them. - `daily_spend_limit` VoiceDailySpendLimitUpdate - `workspace_limit` Money, required - `amount` string, required: Decimal amount as a string, in major currency units. - `currency_code` string, required: ISO 4217 three-letter currency code. ## Response `200` The workspace's voice settings after the update. - VoiceSettings: The voice settings your workspace controls. Every field carries its effective value, whether or not the workspace has ever changed it. - `inbound_configuration` VoiceSettingsInboundConfiguration, required: What happens to a call arriving for any of your Bird numbers that has no inbound route of its own. - `route` union, required: What happens to a call arriving for this number, as it is configured now. Its `type` selects the shape, and each answer carries its own fields. Setting a route is a separate shape, and it does not offer every variant reported here. - VoiceCallRouteReject - `type` 'reject' | 'trunk' | 'forward' | 'sequence', required: Which answer a number carries. - `reject`: refuses the call. - `trunk`: delivers the call to one of your SIP trunks. - `forward`: places a call to one of your verified caller IDs and connects the two. - `sequence`: runs the configured sequence from its selected voice-call entry. It selects the answer's own shape, so a new way to answer a call arrives as a new value alongside a new set of fields. - VoiceCallRouteTrunk - `type` 'reject' | 'trunk' | 'forward' | 'sequence', required: Which answer a number carries. - `reject`: refuses the call. - `trunk`: delivers the call to one of your SIP trunks. - `forward`: places a call to one of your verified caller IDs and connects the two. - `sequence`: runs the configured sequence from its selected voice-call entry. It selects the answer's own shape, so a new way to answer a call arrives as a new value alongside a new set of fields. - `trunk_id` string, required - VoiceCallRouteForward - `type` 'reject' | 'trunk' | 'forward' | 'sequence', required: Which answer a number carries. - `reject`: refuses the call. - `trunk`: delivers the call to one of your SIP trunks. - `forward`: places a call to one of your verified caller IDs and connects the two. - `sequence`: runs the configured sequence from its selected voice-call entry. It selects the answer's own shape, so a new way to answer a call arrives as a new value alongside a new set of fields. - `forward_to` string, required: The number calls are forwarded to, in E.164 format. It has to be one of your verified caller IDs. That is checked when you set it and again on every call it forwards, so a caller ID you later remove stops forwarding rather than carrying on. - `forward_as` 'dialed_number' | 'calling_number', required: Which of a forwarded call's two numbers it shows as the caller. `dialed_number` presents the Bird number the caller dialed. Whoever answers sees which of your numbers was called. Older configurations without a stored choice use this value. Carrier screening can still affect delivery. `calling_number` presents the caller's own number, so the phone rings as though they had dialed it directly and the call can be returned from the call log. Because the number is not one you own, some carriers (most often in the US and parts of Europe) mark such calls as unverified, replace the number, or screen them. - VoiceCallRouteSequence (unresolved $ref) - `daily_spend_limit` VoiceDailySpendLimit, required - `currency_code` string, required: ISO 4217 three-letter currency code. - `limit` Money, required - `amount` string, required: Decimal amount as a string, in major currency units. - `currency_code` string, required: ISO 4217 three-letter currency code. - `used` Money, required - `amount` string, required: Decimal amount as a string, in major currency units. - `currency_code` string, required: ISO 4217 three-letter currency code. - `remaining` Money, required - `amount` string, required: Decimal amount as a string, in major currency units. - `currency_code` string, required: ISO 4217 three-letter currency code. - `resets_at` string, date-time, required: When usage resets to zero, at midnight UTC. - `default_limit` Money, required - `amount` string, required: Decimal amount as a string, in major currency units. - `currency_code` string, required: ISO 4217 three-letter currency code. - `max_limit` Money, required - `amount` string, required: Decimal amount as a string, in major currency units. - `currency_code` string, required: ISO 4217 three-letter currency code. - `workspace_limit` Money, required - `amount` string, required: Decimal amount as a string, in major currency units. - `currency_code` string, required: ISO 4217 three-letter currency code. ## Other responses - `400`: Bad request - `401`: Authentication required - `403`: Insufficient permissions - `404`: Resource not found - `409`: Resource conflict - `412`: Precondition failed - `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`. - `429`: Rate limit exceeded - `500`: Internal server error - `503`: The service is temporarily unavailable. If `Retry-After` is present, wait for that delay before retrying; otherwise, retry with exponential backoff. Reuse the same idempotency key and request when retrying a mutation. --- [API](https://skmtc.dev/messagebird/apis/bird-api.md) · [All operations](https://skmtc.dev/messagebird/apis/bird-api/llms.txt) · [OpenAPI document](https://skmtc.dev/messagebird/apis/bird-api/revisions/6dfce1179799?raw)