COcommpeak
Campaigns

Update specific campaign

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.

put/{sub_domain}/api/campaigns/{id}

Request

  • Base URL
    https://api.commpeak.com/dialer
  • URL
    https://api.commpeak.com/dialer/{sub_domain}/api/campaigns/{id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Campaign ID.

sub_domainstring required

Dialer Name (subdomain)

Request body

namestring nullable

Campaign name.

descriptionstring nullable

Campaign description.

creator_user_idinteger nullable

Campaign creator user ID.

is_activeinteger nullable

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

agent_callerid_namestring nullable

Agent CallerID name.

agent_callerid_numberstring nullable

Agent CallerID number.

client_callerid_namestring nullable

Client CallerID name.

client_callerid_numberstring nullable

Client CallerID number.

default_weightinteger nullable

Campaign default weight.

auto_dialstring nullable

Campaign auto dial.

auto_dial_delayinteger nullable

Campaign auto dial delay.

feedback_timeoutinteger nullable

Campaign feedback page timeout.

feedback_default_statusstring nullable

Campaign feedback default status.

created_atstring nullable

Created at.

updated_atstring nullable

Updated at.

is_deletedinteger nullable

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

default_permanent_expiration_daysinteger nullable

Default permanent expiration days.

campaign_typestring nullable

Campaign type.

predictive_call_ratiostring nullable

Predictive call ratio.

predictive_call_timeoutinteger nullable

Predictive call timeout.

default_busy_statusstring nullable

Default busy status.

default_voice_mail_statusstring nullable

Default voice mail status.

default_fax_statusstring nullable

Default fax status.

default_timeout_statusstring nullable

Default timeout status.

default_not_exists_statusstring nullable

Default not exists status.

predictive_fallback_actionstring nullable

Predictive fallback action (hangup, playback, forward).

predictive_fallback_action_optionsstring nullable

Predictive fallback action options.

default_error_statusstring nullable

Default error status.

default_answer_statusstring nullable

Default answer status.

predictive_fallback_action_timeoutinteger nullable

Predictive fallback action timeout.

remote_data_urlstring nullable

Remote data url (used for CRM iframe).

remote_call_screen_enabledinteger nullable

Remote call screen enabled.

predictive_ringing_preservation_ratiostring nullable

Predictive ringing preservation ratio.

predictive_preservation_min_ringing_durationinteger nullable

Predictive preservation min ringing duration.

default_direct_dial_statusstring nullable

Default direct dial status.

highest_priority_weightinteger nullable

Highest priority weight.

voicemail_time_optionsstring nullable

Voicemail time options.

fetch_leads_typestring nullable

Fetch leads type.

parent_idinteger nullable

Parent campaign ID.

permanent_callback_keepaliveinteger nullable

Permanent callback keepalive.

permanent_agent_offline_keepaliveinteger nullable

Permanent agent offline keepalive.

permanent_daily_limitinteger nullable

Permanent daily limit.

permanent_total_limitinteger nullable

Permanent total limit.

available_agent_search_timeoutinteger nullable

Available agent search timeout.

custom_call_fieldsobject nullable

Custom call fields.

min_weightinteger nullable

Min weight.

advanced_call_fieldsobject nullable

Advanced call fields.

iframe_call_fieldsobject nullable

Iframe call fields.

remote_javascript_codestring nullable

Remote javascript code.

default_remote_adapter_channel_idstring nullable

Default remote adapter channel id.

redial_limitstring nullable

Redial limit.

hide_voicemail_for_no_ratio_permanentsstring nullable

Hide voicemail for no ratio permanents.

voicemail_button_hide_timeoutstring nullable

Voicemail button hide timeout.

end_call_show_timeoutstring nullable

End call show timeout.

notify_user_about_online_leadstring nullable

Notify user about online lead.

permanent_expiration_activestring nullable

Permanent expiration active.

no_ratio_leads_fetching_methodstring nullable

No ratio leads fetching method.

highest_priority_weight_ratio_levelstring nullable

Highest priority weight ratio level.

is_caller_id_randomstring nullable

Is caller id random.

is_hold_enabledstring nullable

Is hold enabled.

show_phone_symbolsstring nullable

Show phone symbols.

amd_enabledstring nullable

AMD enabled.

amd_max_durationstring nullable

AMD max duration.

amd_settingsstring nullable

AMD settings.

phone_mask_modestring nullable

Phone mask mode.

voice_mail_button_statusstring nullable

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

override_dropped_call_actionstring nullable

Override dropped call action.

default_caller_idinteger nullable

Default caller ID.

Response

Successful Response

Changes

No recorded changes to this operation across all 1 revision of this API.