Facebook
LinkedIn
YouTube
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
  1. Provisioned Routes
  • Platform
    • Users
      • List Users
      • Get User Details
      • Update User
      • Partial Update User
      • Delete User
      • Create User
    • Groups
      • List Child Groups
      • Get Group Tree
      • Get Group Details
      • List Groups
      • Get Org Unit Hierarchy
      • Update Group
      • Partial Update Group
      • Delete Group
      • Create Group
    • Webhooks
      • List Webhooks
      • Get Webhook Details
      • Update Webhook
      • Partial Update Webhook
      • Delete Webhook
      • Create Webhook
    • Media Prompts
      • List Prompts
      • Upload Prompt
      • Delete Prompt
  • AI Voice Agents
    • List AI Voice Agents
      GET
    • Create Agent
      POST
    • Get Agent Details
      GET
    • Update Agent
      PUT
    • Partial Update Agent
      PATCH
    • Delete Agent
      DELETE
  • Phone Numbers
    • Assigned Numbers
      GET
    • Provisioned Numbers
      GET
    • Reserved Numbers
      DELETE
    • Phone Numbers
      POST
    • Available Numbers
      GET
  • Provisioned Routes
    • List Provisioned Routes
      GET
    • Create Provisioned Route
      POST
    • Get Provisioned Route Details
      GET
    • Delete Provisioned Route
      DELETE
    • Update Provisioned Route
      PUT
    • Partial Update Provisioned Route
      PATCH
  • SMS Broadcasts
    • List Broadcasts
      GET
    • Create Broadcast
      POST
    • Get Broadcast Details
      GET
    • Update Broadcast
      PUT
    • Partial Update Broadcast
      PATCH
    • Delete Broadcast
      DELETE
  • Conversation
    • Calls
      • Get Calls List
      • Get Call By ID
    • SMS
      • Get SMS Conversations
  • Miscellaneous
    • List Ad Sources
    • List Industries
    • List Tags
    • Create Tag
    • Update Tag
    • Delete Tag
  1. Provisioned Routes

Delete Provisioned Route

DELETE
https://platform-api.convirza.com/v3/provisioned-routes/{provisioned_route_id}
Provisioned Routes
Last modified:2026-04-03 14:27:57
Permanently deletes a call routing configuration and performs comprehensive cleanup of all associated resources.
What Gets Deleted/Modified:
1.
Route Configuration
Sets provisioned route status to 'deleted'
Clears webhook associations
Nullifies referral end dates
2.
Phone Number Management
Reserves associated phone number (status: 'reserved')
Clears phone detail associations (app_id, org_unit_id, provisioned_route_id)
Marks provisioned_route_number as inactive with removal timestamp
Disables misdial protection
3.
DNI (Dynamic Number Insertion)
Deactivates all DNI settings (dni_active = false)
Updates modification timestamp
4.
Call Flow Configuration
Suspends call flow status
Removes hunt group options and types
Cleans up routing rules
5.
Component Counting
Decrements active number count for active routes (component 18)
Decrements secondary total for inactive routes
Decrements referral count for referral routes (component 28)
Handles premium number components appropriately
Transaction Safety:
All operations execute within a single database transaction
Automatic rollback on any error
Data integrity guaranteed
Validation Rules:
Only routes with routable_type = 'SimpleRoute' can be deleted
Route must exist and not be already deleted
Valid provisioned_route_id required (positive integer)
Authorization:
Admin role: Full access
Standard role: Full access
ReadOnly role: Access denied (cannot delete routes)
Use Cases:
Removing test/demo tracking numbers
Decommissioning expired campaigns
Cleaning up unused routing configurations
Bulk route management and optimization

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Responses

🟢200
application/json
Route and all associated resources deleted successfully — transaction committed
Body

🟠400
🟠401
🟠403
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request DELETE 'https://platform-api.convirza.com/v3/provisioned-routes/' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Example 1
{
    "code": 200,
    "message": "Resource deleted successfully",
    "data": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-03-29T12:00:00.000Z"
}
Modified at 2026-04-03 14:27:57
Previous
Get Provisioned Route Details
Next
Update Provisioned Route
Built with