v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-181,0851,7264.5 MB

Outbound Voice Profiles

Updates an existing outbound voice profile.

patch/outbound_voice_profiles/{id}

Path parameters

idstring required

Example:1293384261075731499

Identifies the resource.

Request body

namestring required

A user-supplied name to help with organization.

traffic_type'conversational'

Specifies the type of traffic allowed in this profile.

service_plan'global'

Indicates the coverage of the termination regions.

concurrent_call_limitinteger nullable

Must be no more than your global concurrent call limit. Null means no limit.

enabledboolean

Specifies whether the outbound voice profile can be used. Disabled profiles will result in outbound calls being blocked for the associated Connections.

tagsstring[]

usage_payment_method'rate-deck'

Setting for how costs for outbound profile are calculated.

whitelisted_destinationsstring[]

The list of destinations you want to be able to call using this outbound voice profile formatted in alpha2.

max_destination_ratenumber

Maximum rate (price per minute) for a Destination to be allowed when making outbound calls.

daily_spend_limitstring

The maximum amount of usage charges, in USD, you want Telnyx to allow on this outbound voice profile in a day before disallowing new calls.

daily_spend_limit_enabledboolean

Specifies whether to enforce the daily_spend_limit on this outbound voice profile.

billing_group_idstring uuid nullable

The ID of the billing group associated with the outbound proflile. Defaults to null (for no group assigned).

Example request

{
  "name": "office",
  "traffic_type": "conversational",
  "service_plan": "global",
  "concurrent_call_limit": 10,
  "enabled": true,
  "tags": [
    "office-profile"
  ],
  "usage_payment_method": "rate-deck",
  "whitelisted_destinations": [
    "US",
    "BR",
    "AU"
  ],
  "max_destination_rate": 10,
  "daily_spend_limit": "100.00",
  "daily_spend_limit_enabled": true,
  "billing_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "calling_window": {
    "start_time": "08:00:00.00Z",
    "end_time": "20:00:00.00Z",
    "calls_per_cld": 5
  }
}

Response

Successful response

Example response

{
  "data": {
    "id": "1293384261075731499",
    "record_type": "outbound_voice_profile",
    "name": "office",
    "connections_count": 12,
    "traffic_type": "conversational",
    "service_plan": "global",
    "concurrent_call_limit": 10,
    "enabled": true,
    "tags": [
      "office-profile"
    ],
    "usage_payment_method": "rate-deck",
    "whitelisted_destinations": [
      "US",
      "BR",
      "AU"
    ],
    "max_destination_rate": 10,
    "daily_spend_limit": "100.00",
    "daily_spend_limit_enabled": true,
    "call_recording": {
      "call_recording_type": "by_caller_phone_number",
      "call_recording_caller_phone_numbers": [
        "+19705555098"
      ],
      "call_recording_channels": "dual",
      "call_recording_format": "mp3"
    },
    "billing_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "calling_window": {
      "start_time": "08:00:00.00Z",
      "end_time": "20:00:00.00Z",
      "calls_per_cld": 5
    },
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}