--- title: "Update specific campaign" method: PUT path: "/{sub_domain}/api/campaigns/{id}" tags: ["Campaigns"] --- # Update specific campaign `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` 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. ## Path parameters - `id` integer, required: Campaign ID. - `sub_domain` string, required: Dialer Name (subdomain) ## Request body - CampaignUpdateInput - `name` string, nullable: Campaign name. - `description` string, nullable: Campaign description. - `creator_user_id` integer, nullable: Campaign creator user ID. - `is_active` integer, nullable: Campaign active (1 = active, 0 = inactive). - `agent_callerid_name` string, nullable: Agent CallerID name. - `agent_callerid_number` string, nullable: Agent CallerID number. - `client_callerid_name` string, nullable: Client CallerID name. - `client_callerid_number` string, nullable: Client CallerID number. - `default_weight` integer, nullable: Campaign default weight. - `auto_dial` string, nullable: Campaign auto dial. - `auto_dial_delay` integer, nullable: Campaign auto dial delay. - `feedback_timeout` integer, nullable: Campaign feedback page timeout. - `feedback_default_status` string, nullable: Campaign feedback default status. - `created_at` string, nullable: Created at. - `updated_at` string, nullable: Updated at. - `is_deleted` integer, nullable: Is deleted flag (1 = deleted, 0 = active). - `default_permanent_expiration_days` integer, nullable: Default permanent expiration days. - `campaign_type` string, nullable: Campaign type. - `predictive_call_ratio` string, nullable: Predictive call ratio. - `predictive_call_timeout` integer, nullable: Predictive call timeout. - `default_busy_status` string, nullable: Default busy status. - `default_voice_mail_status` string, nullable: Default voice mail status. - `default_fax_status` string, nullable: Default fax status. - `default_timeout_status` string, nullable: Default timeout status. - `default_not_exists_status` string, nullable: Default not exists status. - `predictive_fallback_action` string, nullable: Predictive fallback action (hangup, playback, forward). - `predictive_fallback_action_options` string, nullable: Predictive fallback action options. - `default_error_status` string, nullable: Default error status. - `default_answer_status` string, nullable: Default answer status. - `predictive_fallback_action_timeout` integer, nullable: Predictive fallback action timeout. - `remote_data_url` string, nullable: Remote data url (used for CRM iframe). - `remote_call_screen_enabled` integer, nullable: Remote call screen enabled. - `predictive_ringing_preservation_ratio` string, nullable: Predictive ringing preservation ratio. - `predictive_preservation_min_ringing_duration` integer, nullable: Predictive preservation min ringing duration. - `default_direct_dial_status` string, nullable: Default direct dial status. - `highest_priority_weight` integer, nullable: Highest priority weight. - `voicemail_time_options` string, nullable: Voicemail time options. - `fetch_leads_type` string, nullable: Fetch leads type. - `parent_id` integer, nullable: Parent campaign ID. - `permanent_callback_keepalive` integer, nullable: Permanent callback keepalive. - `permanent_agent_offline_keepalive` integer, nullable: Permanent agent offline keepalive. - `permanent_daily_limit` integer, nullable: Permanent daily limit. - `permanent_total_limit` integer, nullable: Permanent total limit. - `available_agent_search_timeout` integer, nullable: Available agent search timeout. - `custom_call_fields` object, nullable: Custom call fields. - `min_weight` integer, nullable: Min weight. - `advanced_call_fields` object, nullable: Advanced call fields. - `iframe_call_fields` object, nullable: Iframe call fields. - `remote_javascript_code` string, nullable: Remote javascript code. - `default_remote_adapter_channel_id` string, nullable: Default remote adapter channel id. - `redial_limit` string, nullable: Redial limit. - `hide_voicemail_for_no_ratio_permanents` string, nullable: Hide voicemail for no ratio permanents. - `voicemail_button_hide_timeout` string, nullable: Voicemail button hide timeout. - `end_call_show_timeout` string, nullable: End call show timeout. - `notify_user_about_online_lead` string, nullable: Notify user about online lead. - `permanent_expiration_active` string, nullable: Permanent expiration active. - `no_ratio_leads_fetching_method` string, nullable: No ratio leads fetching method. - `highest_priority_weight_ratio_level` string, nullable: Highest priority weight ratio level. - `is_caller_id_random` string, nullable: Is caller id random. - `is_hold_enabled` string, nullable: Is hold enabled. - `show_phone_symbols` string, nullable: Show phone symbols. - `amd_enabled` string, nullable: AMD enabled. - `amd_max_duration` string, nullable: AMD max duration. - `amd_settings` string, nullable: AMD settings. - `phone_mask_mode` string, nullable: Phone mask mode. - `voice_mail_button_status` string, nullable: Default voice mail status when the agent clicks the button manually. - `override_dropped_call_action` string, nullable: Override dropped call action. - `default_caller_id` integer, nullable: Default caller ID. ## Response `204` Successful Response ## Other responses - `404`: Not Found - `422`: Validation Error - `500`: Internal Server Error --- [API](https://skmtc.dev/commpeak/apis/commpeak-dialer-api.md) - [All operations](https://skmtc.dev/commpeak/apis/commpeak-dialer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/commpeak/apis/commpeak-dialer-api/revisions/18c5edc07544?raw)