Update campaign description

Below is an updated Update campaign description article that matches the structure and table style you used for Get campaign description, including:

• Element and Sub element table format for the request body
• Element and Sub element table format for the 200 OK response
• Separate Redial rules and Redial rule object tables
• Corrected email wording and removed the mailto example

The Update campaign endpoint enables you to update an existing Dialer campaign configuration, including dialing parameters, Caller ID settings, local time restrictions, and redial rules.

Prerequisites

• You must have access to your contact center API key.
• The campaign must already exist in your contact center.
• Update is not allowed if the campaign status is stopped or completed.

Making requests

The Update campaign API uses a PUT request. Request and response payloads are formatted as JSON.

Note: Although this endpoint uses PUT, the API allows you to update individual attributes. You can include only the fields you want to change.

Authentication

The Update campaign API requires the Base URL (cluster_id) and the contact center API key as a bearer token in the request header.

Endpoint

PUT /api/dialer/v1/campaigns/{campaign_id}

Path parameters

Request body

The following table describes the elements of the request body.

Redial rules

Redial rule object

Example request

{
  "method": "PUT",
  "url": "https://cluster1.contact_center_name.com/api/dialer/v1/campaigns/12345",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_KEY"
  },
  "body": {
    "name": "Updated Campaign Name",
    "dial_level": 2,
    "max_dial_time": 45,
    "max_wait_time": 5,
    "max_dial_attempts": 3,
    "answering_machine_detection": true,
    "local_time_settings": {
      "call_from": "08:00",
      "call_to": "20:00",
      "week_days": ["Mon", "Tue", "Wed", "Thu", "Fri"]
    },
    "caller_id_sets": [
      { "numbers": ["100"] }
    ],
    "local_caller_id": true,
    "redial_rules": {
      "no_answer": [
        { "units": "s", "wait": 600, "change_callerid": true }
      ]
    },
    "assigned_agents": ["[email protected]", "[email protected]"]
  }
}

Responses

200 OK

Returns the updated campaign object.

Redial rules

Redial rule object

The full structure of the response may vary depending on the dialer mode or campaign type.

{
  "id": 12345,
  "name": "Updated Campaign Name",
  "strategy": "simple",
  "dialing_order": "disabled",
  "dial_level": 2,
  "dial_level_override": {
    "enabled": true,
    "override_value": 1.5,
    "active_agents_threshold": 3
  },
  "max_dial_time": 45,
  "max_wait_time": 5,
  "max_dial_attempts": 3,
  "voice_message": "Voice message (1)",
  "answering_machine_detection": true,
  "live": false,
  "survey_enabled": false,
  "local_time_settings": {
    "call_from": "08:00",
    "call_to": "20:00",
    "week_days": ["Mon", "Tue", "Wed", "Thu", "Fri"]
  },
  "caller_id_sets": [
    { "numbers": ["100"] }
  ],
  "local_caller_id": true,
  "redial_rules": {
    "no_answer": [
      { "units": "s", "wait": 600, "change_callerid": true }
    ]
  },
  "assigned_agents": ["[email protected]", "[email protected]"]
}

401 Unauthorized

{ "error": "The API key specified is invalid" }

403 Forbidden

{ "error": "No access" }

404 Not found

{ "error": "Campaign not found" }

422 Unprocessable Entity

Returned when one or more fields fail validation.

{
  "errors": {
    "name": ["can't be blank"]
  }
}

Use cases

• Renaming a campaign.
• Adjusting dial level or dial level override behavior.
• Updating redial rules and maximum dial attempts.
• Enabling Answering Machine Detection.
• Restricting call times to certain hours or weekdays.
• Updating which agents are assigned to the campaign.