Change campaign status description

Please refer to the detailed API endpoint specification: Change campaign status

What you can achieve with the Change campaign status API

This API enables you to start, pause, or stop an outbound Dialer campaign programmatically.

This operation is especially useful for automating campaign control in response to internal business logic, schedules, or platform events.

User permissions required

• Edit all campaigns, or
• Edit own campaigns (for campaigns the user created)

Prerequisites

• The campaign ID must correspond to an existing Dialer campaign.
• The campaign must meet required conditions for the requested operation:
  • start requires at least one agent and one lead assigned.
  • pause and stop are valid only for active campaigns.
• Your API user must be authorized to manage the specified campaign.

Making requests

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

The following parameter must be included in the request URL:

Tip: Use List campaigns to review the current state of the campaign

The request body must contain the desired operation to perform:

Request example

POST {
  "method": "POST",
  "url": "https://cluster1.voiso.com/api/dialer/v1/campaigns/12345/operation",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_KEY"
  },
  "body": {
    "operation": "start"
  }
}

Response

A successful response includes confirmation of the action performed.

Response sample

{
  "id": 12345,
  "operation": "start",
  "success": true,
  "message": "Campaign started successfully"
}

Troubleshooting

Invalid Key

If you receive "error": "Invalid Key", verify that you are using the correct bearer token. Refer to Authentication for help.

Campaign not found

If the specified campaign ID does not exist or is not accessible to the user, you may receive the following error:

{
  "success": false,
  "errors": ["Campaign not found"]
}

Campaign missing required resources

To start a campaign, it must have at least one assigned agent and one assigned lead. Otherwise, you may receive:

{
  "success": false,
  "errors": ["Campaign must have at least one agent to start"]
}

or

{
  "success": false,
  "errors": ["Campaign must have at least one lead to start"]
}

Invalid operation

If an unsupported operation is specified or the campaign is not in a state that allows the requested change, the response may include:

{
  "success": false,
  "errors": ["Operation not allowed"]
}

or

{
  "success": false,
  "errors": ["Operation is not included in the list"]
}

To check campaign eligibility and available status transitions, consult the Dialer campaigns documentation or use List campaigns to review the current state of the campaign.