Update specific campaign

put

https://api.commpeak.com/dialer/{sub_domain}/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.

sub_domain

string

required

Dialer Name (subdomain)

Body Params

name

Campaign name.

description

Campaign description.

creator_user_id

Campaign creator user ID.

is_active

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

agent_callerid_name

Agent CallerID name.

agent_callerid_number

Agent CallerID number.

client_callerid_name

Client CallerID name.

client_callerid_number

Client CallerID number.

default_weight

Campaign default weight.

auto_dial

Campaign auto dial.

auto_dial_delay

Campaign auto dial delay.

feedback_timeout

Campaign feedback page timeout.

feedback_default_status

Campaign feedback default status.

created_at

Created at.

updated_at

Updated at.

is_deleted

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

default_permanent_expiration_days

Default permanent expiration days.

campaign_type

Campaign type.

predictive_call_ratio

Predictive call ratio.

predictive_call_timeout

Predictive call timeout.

default_busy_status

Default busy status.

default_voice_mail_status

Default voice mail status.

default_fax_status

Default fax status.

default_timeout_status

Default timeout status.

default_not_exists_status

Default not exists status.

predictive_fallback_action

Predictive fallback action (hangup, playback, forward).

predictive_fallback_action_options

Predictive fallback action options.

default_error_status

Default error status.

default_answer_status

Default answer status.

predictive_fallback_action_timeout

Predictive fallback action timeout.

remote_data_url

Remote data url (used for CRM iframe).

remote_call_screen_enabled

Remote call screen enabled.

predictive_ringing_preservation_ratio

Predictive ringing preservation ratio.

predictive_preservation_min_ringing_duration

Predictive preservation min ringing duration.

default_direct_dial_status

Default direct dial status.

highest_priority_weight

Highest priority weight.

voicemail_time_options

Voicemail time options.

fetch_leads_type

Fetch leads type.

parent_id

Parent campaign ID.

permanent_callback_keepalive

Permanent callback keepalive.

permanent_agent_offline_keepalive

Permanent agent offline keepalive.

permanent_daily_limit

Permanent daily limit.

permanent_total_limit

Permanent total limit.

available_agent_search_timeout

Available agent search timeout.

custom_call_fields

object | null

Custom call fields.

min_weight

Min weight.

advanced_call_fields

object | null

Advanced call fields.

iframe_call_fields

object | null

Iframe call fields.

remote_javascript_code

Remote javascript code.

default_remote_adapter_channel_id

Default remote adapter channel id.

redial_limit

Redial limit.

hide_voicemail_for_no_ratio_permanents

Hide voicemail for no ratio permanents.

voicemail_button_hide_timeout

Voicemail button hide timeout.

end_call_show_timeout

End call show timeout.

notify_user_about_online_lead

Notify user about online lead.

permanent_expiration_active

Permanent expiration active.

no_ratio_leads_fetching_method

No ratio leads fetching method.

highest_priority_weight_ratio_level

Highest priority weight ratio level.

is_caller_id_random

Is caller id random.

is_hold_enabled

Is hold enabled.

show_phone_symbols

Show phone symbols.

amd_enabled

AMD enabled.

amd_max_duration

AMD max duration.

amd_settings

AMD settings.

phone_mask_mode

Phone mask mode.

voice_mail_button_status

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

override_dropped_call_action

Override dropped call action.

default_caller_id

Default caller ID.

Responses

204

Successful Response

Language

Credentials

Header

Loading…

Response

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

application/json

404Not Found

422Validation Error

500Internal Server Error