latestOpenAPI 3.1.1Proprietary – Contact us for usage terms2026-08-20173183551.4 KB

9da73dd2f99e

campaigns

Start a campaign

Starts an outbound call campaign. Once started, the system begins distributing contacts from the campaign's queue to assigned users/groups for calling. An optional start date can be specified in the request body to schedule the campaign for later. The campaign must have at least one number in its queue and at least one assigned user or group — otherwise a 403 error is returned.

Permission: No specific permission required. A valid API key is sufficient.

patch/campaigns/call/{campaignscalllistuuid}/start

Path parameters

campaignscalllistuuidstring uuid required

The UUID of the campaign (e.g., 1a7a5639-3818-4b0e-9285-f6b3795f8db4). Use GET /campaigns/call to discover campaign UUIDs.

Request body

start_datestring

Schedule the campaign

Example request

{
  "start_date": "2022-01-13T17:59:05Z"
}

Response

Successful operation