Partial Update Provisioned Route

PATCH

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

Provisioned Routes

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

Applies a selective update to an existing provisioned route. Only fields included in the request body are modified — all unspecified fields retain their current values.

Use PATCH for targeted, surgical changes without needing to supply the full route configuration. For a full update of all fields, use PUT /provisioned-routes/{id}.

Common Use Cases

Toggle provisioned_route_status between active and inactive without altering routing logic

Swap the forwarding number or ring strategy while keeping all other settings intact

Enable or disable spam protection, SMS forwarding, or AI voice agent independently

Update ad source attribution or webhook assignment in isolation

Adjust call conversion value or repeat interval for reporting

Roles required: Admin or Standard. ReadOnly users cannot modify 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 partially updated successfully — returns the route ID and a confirmation message

Body

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

cURL

Partial Update - Name OnlyPartial Update - Status and Call ValuePartial Update - Routing Configuration

curl --location --request PATCH 'https://platform-api.convirza.com/v3/provisioned-routes/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "provisioned_route_name": "Updated Route Name"
}'

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

Update Provisioned Route

List Broadcasts