Facebook
LinkedIn
YouTube
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
Dialer SDK
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
Dialer SDK
  1. DNI
  • Platform
    • Users
      • List Users
      • Create User
      • Get User Details
      • Update User
      • Partial Update User
      • Delete User
    • Groups
      • Get Group Tree
      • List Child Groups
      • Get Group Details
      • List Groups
      • Get Org Unit Hierarchy
      • Update Group
      • Partial Update Group
      • Delete Group
      • Create Group
    • Webhooks
      • Create Webhook
      • Get Webhook Details
      • List Webhooks
      • Update Webhook
      • Partial Update Webhook
      • Delete Webhook
    • Media Prompts
      • List Prompts
      • Get Prompt by ID
      • Upload Prompt
      • Delete Prompt
  • AI Voice Agents
    • List AI Voice Agents
      GET
    • Get Agent Details
      GET
    • 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
      • Email Call Data
      • Move Call to Another Group
      • Add Notes to Calls
      • Upload Call Recording
      • Add Tags to Call
    • SMS
      • Get SMS Conversations
      • Get SMS Conversation By ID
    • Opportunity Recovery
      • Get Conversations By Custom Insights
    • Agent Performance
      • Get Agent Performance Metrics
    • Attribution Engine
      • Get Marketing Attribution Data
  • Blacklist
    • List blacklisted numbers
    • Add numbers to blacklist
    • Delete numbers from blacklist
  • Call Action Templates
    • Create Call Action Template
    • Update Call Action Template
  • Campaigns
    • List Campaigns
    • Create Campaign
    • Get Campaign Details
    • Update Campaign
    • Partial Update Campaign
    • Delete Campaign
  • Custom Insights
    • Get Custom Insights
    • Create New Custom Insight
    • Get Custom Insight By Id
    • Update Custom Insight
    • Partial Update Custom Insight
    • Delete Custom Insight
  • Custom Source
    • Get Custom Sources
    • Create Custom Source
    • Delete Custom Sources (Single or Multiple)
  • DNI
    • List DNI Settings
      GET
    • Update DNI Setting
      PUT
    • Delete DNI Setting
      DELETE
    • Create DNI Setting
      POST
  • Geo Locations
    • List Geo Locations
    • Create Geo Location
    • Get Geo Location
    • Update Geo Location
    • Partially Update Geo Location
    • Delete Geo Location
    • List Geo Location Routes
    • Create Geo Location Route
    • Get Geo Location Route
    • Update Geo Location Route
    • Partially Update Geo Location Route
    • Delete Geo Location Route
    • Import Geo Location Routes from CSV
  • Insights
    • List Insights
    • Create Insight
    • Get Insight Details
    • Delete Insight
  • Scorecards
    • List Scorecards
    • Get Scored Calls Report
    • Create Scorecard
    • Add or Update Call Title
    • Duplicate Scorecard
    • Archive Scorecard
  • Miscellaneous
    • List Ad Sources
    • List Industries
    • List Tags
    • Create Tag
    • Update Tag
    • Delete Tag
  • Subscriptions
    • List Webhook Subscriptions
    • Create Webhook Subscription
    • Delete Webhook Subscription
  1. DNI

Update DNI Setting

PUT
https://platform-api.convirza.com/v3/dni/{dni_setting_id}
DNI
Last modified:2026-07-24 13:10:44
Updates an existing Dynamic Number Insertion (DNI) setting.
Access Control
Requires valid JWT authentication
User must have access to the specified group and provisioned route
DNI setting must exist and be active
Provisioned route must be active
Behavior
Updates the DNI setting with provided values
Updates custom_params in dni_org_unit if custom_cookie is provided
For number pools with TTL, updates phone_pool keep_alive_mins
Sets dni_setting_modified to current timestamp
DNI Types
session: Typically used for number pools
source: Typically used for tracking numbers
url: Typically used for tracking numbers with lmc_track element
Required Fields
org_unit_id — Org unit ID
provisioned_route_id — Tracking number or number pool ID
destination_url — Host domain (e.g., example.com)
dni_type — DNI type (session/source/url)
dni_element — CSS selector/HTML class (e.g., .phone-number)
referrer — Referring website (e.g., google.com)
Optional Fields
dni_setting_name — Display name for this DNI configuration
referrer_type — paid/organic (only for Google/Yahoo)
custom_cookie — Custom tracking parameters
identifier — Text placeholder to replace with tracking number
dni_keywords — Keywords for categorization
dni_number_format — Phone number display format
TTL — Time to live in minutes (only for number pools)
Validation Rules
destination_url and referrer must be valid domain format
dni_element for 'url' type must be 'lmc_track'
dni_element for 'session'/'source' cannot be 'lmc_track' or empty
referrer_type (paid/organic) only applies to Google or Yahoo referrers
TTL must be between 1 and 525600 minutes (optional field)
Referrer-element-destination combination must be unique (excluding current setting)

Request

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

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
DNI setting updated successfully
Bodyapplication/json

🟠400
🟠401
🟠403
🟠404
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --globoff --request PUT 'https://platform-api.convirza.com/v3/dni/{dni_setting_id}' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "dni_setting_name": "Google Paid Campaign - Updated",
    "org_unit_id": 70035,
    "provisioned_route_id": 123,
    "destination_url": "example.com",
    "dni_type": "source",
    "dni_element": ".phone-number-updated",
    "referrer": "google.com",
    "referrer_type": "paid",
    "custom_cookie": "utm_source,utm_campaign,utm_medium",
    "identifier": "PHONE_NUMBER",
    "dni_keywords": "google,paid,ppc,updated",
    "dni_number_format": "(xxx) xxx-xxxx"
}'
Response Response Example
200 - Example 1
{
    "code": 200,
    "message": "success",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-04-22T10:30:00.000Z",
    "data": {
        "message": "DNI setting updated successfully"
    }
}
Modified at 2026-07-24 13:10:44
Previous
List DNI Settings
Next
Delete DNI Setting
Built with