Update specific campaign

put

https://{subdomain}.td.commpeak.com/api/campaigns/{id}

Update the settings of the campaign identified by id.

When to use. Change one or more campaign settings, such as its name, caller IDs, dialing behavior or lead handling.

Request body. Any subset of the campaign's editable fields. All fields are optional, and only the fields you send are changed. See the request schema for the full list.

Returns. 204 No Content on success. Returns 404 if no campaign matches the id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Campaign ID.

Body Params

Fields accepted when updating a campaign. All fields are optional; only supplied fields are updated.

name

string

Campaign name.

description

string

Campaign description.

creator_user_id

integer

Campaign creator user ID.

is_active

integer

Campaign active (1 = active, 0 = inactive).

agent_callerid_name

string

Agent CallerID name.

agent_callerid_number

string

Agent CallerID number.

client_callerid_name

string

Client CallerID name.

client_callerid_number

string

Client CallerID number.

default_weight

integer

Campaign default weight.

auto_dial

string

Campaign auto dial.

auto_dial_delay

integer

Campaign auto dial delay.

feedback_timeout

integer

Campaign feedback page timeout.

feedback_default_status

string

Campaign feedback default status.

created_at

date-time

Created at.

updated_at

date-time

Updated at.

is_deleted

integer

Is deleted flag (1 = deleted, 0 = active).

default_permanent_expiration_days

integer

Default permanent expiration days.

campaign_type

string

Campaign type.

predictive_call_ratio

string

Predictive call ratio.

predictive_call_timeout

integer

Predictive call timeout.

default_busy_status

string

Default busy status.

default_voice_mail_status

string

Default voice mail status.

default_fax_status

string

Default fax status.

default_timeout_status

string

Default timeout status.

default_not_exists_status

string

Default not exists status.

predictive_fallback_action

string

Predictive fallback action (hangup, playback, forward).

predictive_fallback_action_options

string

Predictive fallback action options.

default_error_status

string

Default error status.

default_answer_status

string

Default answer status.

predictive_fallback_action_timeout

integer

Predictive fallback action timeout.

remote_data_url

string

Remote data url (used for CRM iframe).

remote_call_screen_enabled

integer

Remote call screen enabled.

predictive_ringing_preservation_ratio

string

Predictive ringing preservation ratio.

predictive_preservation_min_ringing_duration

integer

Predictive preservation min ringing duration.

default_direct_dial_status

string

Default direct dial status.

highest_priority_weight

integer

Highest priority weight.

voicemail_time_options

string

Voicemail time options.

fetch_leads_type

string

Fetch leads type.

parent_id

integer | null

Parent campaign ID.

permanent_callback_keepalive

integer

Permanent callback keepalive.

permanent_agent_offline_keepalive

integer

Permanent agent offline keepalive.

permanent_daily_limit

integer

Permanent daily limit.

permanent_total_limit

integer

Permanent total limit.

available_agent_search_timeout

integer

Available agent search timeout.

custom_call_fields

object

Custom call fields.

min_weight

integer

Min weight.

advanced_call_fields

object

Advanced call fields.

iframe_call_fields

object

Iframe call fields.

remote_javascript_code

string

Remote javascript code.

default_remote_adapter_channel_id

string

Default remote adapter channel id.

redial_limit

string

Redial limit.

hide_voicemail_for_no_ratio_permanents

string

Hide voicemail for no ratio permanents.

voicemail_button_hide_timeout

string

Voicemail button hide timeout.

end_call_show_timeout

string

End call show timeout.

notify_user_about_online_lead

string

Notify user about online lead.

permanent_expiration_active

string

Permanent expiration active.

no_ratio_leads_fetching_method

string

No ratio leads fetching method.

highest_priority_weight_ratio_level

string

Highest priority weight ratio level.

is_caller_id_random

string

Is caller id random.

is_hold_enabled

string

Is hold enabled.

show_phone_symbols

string

Show phone symbols.

amd_enabled

string

AMD enabled.

amd_max_duration

string

AMD max duration.

amd_settings

string

AMD settings.

phone_mask_mode

string

Phone mask mode.

voice_mail_button_status

string

Default voice mail status when the agent clicks the button manually.

override_dropped_call_action

string

Override dropped call action.

default_caller_id

integer | null

Default caller ID.

Responses

204

Campaign updated.

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

404Campaign not found.