Update Provisioned Route

PUT

https://platform-api.convirza.com/v3/provisioned-routes/{id}

Provisioned Routes

Last modified:2026-04-03 14:27:57

Performs a full update of an existing provisioned route's configuration. All updatable fields must be supplied — any field omitted from the request body will be reset to its system default.

Use PUT when you want to update the entire route configuration in one atomic operation. For targeted changes to individual fields, use PATCH /provisioned-routes/{id} instead.

What Gets Updated

Route name, status, organization unit, ad source, and conversion value

Forwarding number, ring strategy, and simultaneous-ring settings

Voice prompt, whisper message, FTC whisper, and voicemail configuration

Spam protection, SMS forwarding, and AI voice agent settings

Custom source list and webhook assignment

Roles required: Admin or Standard. ReadOnly users cannot update routes.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Route updated successfully — returns the route ID and a confirmation message

Body

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://platform-api.convirza.com/v3/provisioned-routes/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "provisioned_route_name": "Updated Route 1",
    "provisioned_route_status": "active",
    "call_value": 10,
    "repeat_interval": 30,
    "org_unit_id": 70035,
    "webhook_id": 1,
    "sms_enabled": true,
    "spam_enabled": true,
    "sms_settings": {
        "assigned_users": [
            84784,
            7849
        ],
        "sms_notifications": true,
        "email_notifications": true,
        "unclaimed_sms": true
    },
    "customSourceList": [
        {
            "custom_source_id": "1080",
            "custom_source_type": "CS1"
        }
    ],
    "routing_configuration": {
        "routing_type": "simple",
        "config": {
            "ringto": "1111111111",
            "isSimultaneousRing": false,
            "click_to_call_enabled": false,
            "dnis_as_cid": "phone_number",
            "voice_prompt": "Thank you for calling. Please wait while we connect your call.",
            "whisper_enabled": true,
            "whisper_type": "file",
            "whisper_message": "Whisper message 1",
            "ftc_whisper_enabled": "1",
            "ftc_whisper_type": "file",
            "ftc_whisper_message": "qLMcUEqb_1660813454043",
            "message_enabled": "1",
            "message_type": "file",
            "message": "fBiYF5MG_1674141425479",
            "activate_voicemail": false,
            "voicemail_greeting": "Please leave a message after the beep.",
            "activate_voiceagent": true,
            "is_ODN_enabled": false,
            "click_to_call": true,
            "play_disclaimer": "before",
            "play_on_hold_enabled": false,
            "play_on_hold_message": "",
            "play_on_hold_message_type": "",
            "record_call": true,
            "overflowNumbers": [
                {
                    "number": "(111)-111-1110",
                    "rings": "3",
                    "overflow_order": 1,
                    "unmaskNumber": "1111111110",
                    "overflowNumber": "1111111110"
                }
            ],
            "assigned_agent_id": null,
            "route_voice_agent_enabled": true,
            "voice_agent_rings_count": 3,
            "voice_agent_id": 683,
            "voicemail_rings_count": "3",
            "hunt_options": {
                "type": "round_robin",
                "options": [
                    {
                        "destination": "1234567890",
                        "order": 1
                    },
                    {
                        "destination": "0987654321",
                        "order": 2
                    }
                ]
            }
        }
    }
}'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "provisioned_route_id": 12345,
        "message": "Route updated successfully"
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-03-27T10:30:00.000Z"
}

Modified at 2026-04-03 14:27:57

Delete Provisioned Route

Partial Update Provisioned Route