Update a DNI campaign by ID

Partial update of a DNI campaign; returns a DniCampaign object.
May update routing (campaignName, staticNumber, ringToNumber), call settings (callShieldEnabled, callRecordingEnabled, callRecordingDisclaimerLanguage), and autoscale settings (autoscaleEnabled, autoscaleMaxSize, poolDidMatchingMethod).
After a successful update, the response may include resolved ringToNumber when targetId is set (same behavior as GET /campaigns/dni/{id}).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

Campaign ID

Body Params

Partial update body for PUT /campaigns/dni/{id}. At least one property is required. May update routing (campaignName, staticNumber, ringToNumber), call settings (callShieldEnabled, callRecordingEnabled, callRecordingDisclaimerLanguage), and autoscale settings (autoscaleEnabled, autoscaleMaxSize, poolDidMatchingMethod for persisted autoscale matching when enabled).

string

Campaign name

integer
1000000000 to 9999999999

DNI campaign static number as a 10-digit NPANXXXXXX integer (Asterisk extensions.conf _NXXNXXXXXX; N=2-9, X=0-9). No formatting or country code. On create/update, numeric strings are accepted and coerced to integer. Detail responses expose an integer via DniCampaignModel.

string

Phone number to ring

boolean

Call shield on/off

boolean

Call recording on/off

string
enum

Recording disclaimer language (special = no standard disclaimer; stored as call_disclaimer 0)

Allowed:
boolean

Enable or disable nightly pool autoscaling

integer
enum

Maximum pool size when autoscale is enabled

Allowed:
string
enum

Updates persisted autoscale DID matching when autoscale is enabled. Does not reprovision the existing pool. Required when enabling autoscale if not already stored.

Allowed:
emailActions
array of objects

Replace-all email actions ([] clears). actionId from GET /sites/{id}/emails.

emailActions
webhookActions
array of objects

Replace-all webhook actions ([] clears). actionId from GET /sites/{id}/webhooks.

webhookActions
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json