Campaign Control — POST /api/v1/campaigns/{id}/control

Use this endpoint to change the running state of an existing campaign. After you create a campaign, it sits in a not_started state until you explicitly start it. You can also pause a running campaign mid-flight — for example, to adjust capacity or investigate an issue — and then resume it when you are ready. All three operations are issued through this single endpoint using the action field. Endpoint

POST https://app.scalysis.com/api/v1/campaigns/{campaign_id}/control

Authentication Include your API key in the request using either the Authorization header as a Bearer token or the X-API-Key header.

Authorization: Bearer <your_api_key>

X-API-Key: <your_api_key>

Path Parameter

number

required

The unique numeric ID of the campaign you want to control. This is the campaign_id returned when you created the campaign.

Request Body

string

required

The control action to apply to the campaign. Accepted values:

Value	Description
`"start"`	Begins dialling contacts. Valid from the `not_started` state.
`"pause"`	Halts dialling without discarding progress. Valid from the `running` state.
`"resume"`	Continues dialling from where the campaign left off. Valid from the `paused` state.

Campaign States

A campaign moves through the following states during its lifecycle:

State	Description
`not_started`	Campaign has been created but not yet started.
`running`	Campaign is actively dialling contacts.
`paused`	Campaign has been paused; progress is preserved.
`completed`	All contacts have been attempted; campaign is finished.
`stopped`	Campaign was stopped and cannot be resumed.

Example Requests

curl --request POST \
  --url https://app.scalysis.com/api/v1/campaigns/42/control \
  --header 'Authorization: Bearer <your_api_key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "action": "start"
  }'

curl --request POST \
  --url https://app.scalysis.com/api/v1/campaigns/42/control \
  --header 'Authorization: Bearer <your_api_key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "action": "pause"
  }'

curl --request POST \
  --url https://app.scalysis.com/api/v1/campaigns/42/control \
  --header 'Authorization: Bearer <your_api_key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "action": "resume"
  }'

Response Fields

boolean

true when the control action was successfully applied.

string

The action that was performed — one of "start_campaign", "pause_campaign", or "resume_campaign".

number

The ID of the campaign that was updated, echoed back from the path parameter.

string

The new state of the campaign after applying the action (e.g. "running", "paused").

string

A human-readable message confirming what happened (e.g. "Campaign started").

Example Success Response

{
  "success": true,
  "action": "start_campaign",
  "campaign_id": 42,
  "state": "running",
  "message": "Campaign started"
}

Pause before you stop. If you need to halt a campaign permanently, prefer using "pause" first so you can review progress in the dashboard before deciding. A stopped campaign cannot be resumed, so only stop a campaign when you are certain you want to end it entirely.

Calls

Orders

Campaigns

Campaign Control — POST /api/v1/campaigns/{id}/control

Path Parameter

Request Body

Campaign States

Example Requests

Response Fields

Example Success Response

​Path Parameter

​Request Body

​Campaign States

​Example Requests

​Response Fields

​Example Success Response

Path Parameter

Request Body

Campaign States

Example Requests

Response Fields

Example Success Response