Update an outbound profile
PUT/termination/endpoints/:id
Updates the specified outbound profile with the values of the parameters passed. Any parameters not included in the request will be left unchanged.
Request
Path Parameters
ID of Outbound Profile to update
- application/json
Body
required
Updated Outbound Profile object
A user-supplied name to help with organization
Possible values: [1, 2]
Default value: 1
Conversational = 1, Short Duration = 2
Possible values: [1, 2, 4]
Default value: 4
Indicates the coverage of the termination regions. International and Global are the same but International may only be used for high volume/short duration outbound profiles. 3 (EEA originated) has been retired and is now covered by Global. Possible values are: US = 1, International = 2, Global = 4
Defaults to true
Only configure if advised by Telnyx support
Must be no more than your concurrent call limit. Null means no limit.
Possible values: [tariff, rate-deck]
Default value: rate-deck
Setting for how costs for outbound profile are calculated.
Possible values: [alpha2, alpha3, iso_numeric]
Format of your whitelisted destinations.
Default value: US,CA
The list of destinations you want to be able to call using this outbound profile.
Maximum rate at which you can make a call using this outbound profile
Possible values: [all, none, by_call_phone_number]
Defines how to filter which calls are recorded.
When call_recording_type is set to by_caller_phone_number, only outbound calls using one of these numbers will be recorded. Numbers must be specified in E164 format.
Possible values: [wav, mp3]
Default value: wav
The audio file format for calls being recorded.
Possible values: [single, dual]
Default value: single
When using 'dual' channels, final audio file will be stereo recorded with the first leg on channel A, and the rest on channel B.
The maximum amount of usage charges, in USD, you want Telnyx to allow on this outbound profile in a day before disallowing new calls. Example: 100.00.
Specifies whether to enforce the daily_spend_limit on this outbound profile.
The ID of the billing group to which the outbound profile is assigned. Defaults to null (for no group assigned).
Responses
200: Outbound Profile updated response
- application/json
400: Bad request
401: Unauthorized
Request samples
curl -L -X PUT 'https://api.telnyx.com/termination/endpoints/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"connection_ids": [
"string"
],
"name": "string",
"traffic_type": 1,
"service_plan": 4,
"active": true,
"translation_rule": "string",
"cps_limit_increase": 0,
"ports": 0,
"tag_list": [
"string"
],
"usage_payment_method": "rate-deck",
"whitelisted_destination_format": "alpha2",
"whitelisted_destinations": [
"US",
"BR",
"AU"
],
"max_destination_rate": 0,
"call_recording_type": "all",
"call_recording_phone_numbers": [
"string"
],
"call_recording_format": "wav",
"call_recording_channels": "single",
"daily_spend_limit": "string",
"daily_spend_limit_enabled": false,
"billing_group_id": "string"
}'
Response samples
{
"id": "string",
"user_id": "string",
"connections": [
{}
],
"name": "string",
"traffic_type": 1,
"service_plan": 4,
"cps_limit": 100,
"ports": 0,
"translation_rule": "string",
"active": true,
"cps_limit_increase": 0,
"tag_list": [
"string"
],
"usage_payment_method": "rate-deck",
"custom_rate_deck": false,
"rate_deck_url": "string",
"whitelisted_destination_format": "alpha3",
"whitelisted_destinations": [
"US",
"BR",
"AU"
],
"max_destination_rate": 0,
"connection_id": "string",
"call_recording_type": "all",
"call_recording_phone_numbers": [
"string"
],
"call_recording_format": "wav",
"call_recording_channels": "single",
"daily_spend_limit": "string",
"daily_spend_limit_enabled": false,
"billing_group_id": "string"
}