v1

latestOpenAPI 3.0.32026-07-24156161.2 MB

Campaigns

Update specific campaign

The Update specific campaign method enables you to update the details of a specific campaign specified by the campaign id.

put/campaigns/{id}

Request body

agent_callerid_namestring

agent_callerid_numberstring

audio_agent_playbackstring

auto_dialstring

auto_dial_delaystring

available_agent_search_timeoutstring

call_hoursstring

campaign_typestring

client_callerid_namestring

client_callerid_numberstring

created_atstring

creator_user_idstring

custom_call_fieldsstring

default_answer_statusstring

default_busy_statusstring

default_direct_dial_statusstring

default_error_statusstring

default_fax_statusstring

default_not_exists_statusstring

default_permanent_expiration_daysstring

default_timeout_statusstring

default_voice_mail_statusstring

default_weightstring

descriptionstring

feedback_default_statusstring

feedback_timeoutstring

fetch_leads_typestring

highest_priority_weightstring

is_activestring

is_deletedstring

lead_status_workflowstring

min_weightstring

namestring

{"stackTrail":"paths:/campaigns/{id}:put:requestBody:content:application/json:schema:properties:parent_id","oasType":"schema","type":"unknown","example":null,"nullable":true}

permanent_agent_offline_keepalivestring

permanent_callback_keepalivestring

permanent_daily_limitstring

permanent_total_limitstring

predictive_call_ratiostring

predictive_call_timeoutstring

predictive_fallback_actionstring

predictive_fallback_action_optionsstring

predictive_fallback_action_timeoutstring

predictive_preservation_min_ringing_durationstring

predictive_ringing_preservation_ratiostring

remote_call_screen_enabledstring

remote_data_urlstring

updated_atstring

voice_mail_button_statusstring

voicemail_playback_filestring

voicemail_time_optionsstring

Example request

{
  "agent_callerid_name": "AgentId",
  "agent_callerid_number": "11223344",
  "auto_dial": "0",
  "auto_dial_delay": "0",
  "available_agent_search_timeout": "10",
  "call_hours": "[{\"start\":\"0\",\"end\":\"0\",\"country\":\"0\"}]",
  "campaign_type": "predictive",
  "client_callerid_name": "Client",
  "client_callerid_number": "777777777777",
  "created_at": "2012-04-22 11:16:22",
  "creator_user_id": "2",
  "custom_call_fields": "[\"campaignleadid\",\"original_identifier\",\"first_name\",\"last_name\"]",
  "default_answer_status": "2",
  "default_busy_status": "45",
  "default_direct_dial_status": "0",
  "default_error_status": "0",
  "default_fax_status": "44",
  "default_not_exists_status": "46",
  "default_permanent_expiration_days": "5",
  "default_timeout_status": "43",
  "default_voice_mail_status": "42",
  "default_weight": "0",
  "description": "Test Campaign123",
  "feedback_default_status": "2",
  "feedback_timeout": "3000",
  "fetch_leads_type": "priority",
  "highest_priority_weight": "10000",
  "is_active": "1",
  "is_deleted": "0",
  "lead_status_workflow": "{\"45\":{2:[],6:[]},\"3\":{45:[],2:[]}}",
  "min_weight": "0",
  "name": "Test Campaign44",
  "permanent_agent_offline_keepalive": "3",
  "permanent_callback_keepalive": "1",
  "permanent_daily_limit": "0",
  "permanent_total_limit": "0",
  "predictive_call_ratio": "3",
  "predictive_call_timeout": "30",
  "predictive_fallback_action": "playback",
  "predictive_fallback_action_options": "test.wav",
  "predictive_fallback_action_timeout": "0",
  "predictive_preservation_min_ringing_duration": "40",
  "predictive_ringing_preservation_ratio": "1",
  "remote_call_screen_enabled": "0",
  "remote_data_url": "http://localhost/lead.php",
  "updated_at": "2014-08-18 11:28:08",
  "voice_mail_button_status": "9",
  "voicemail_playback_file": "test.wav",
  "voicemail_time_options": "once"
}

Response

Successful operation