Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
Campaign

Create a new campaign

Creates a new campaign with the provided details and returns the created campaign.

post/campaigns

Request body

namestring required

Name of the campaign

detailstring required

Detailed description of the campaign

type'call' | 'flow' required

Type of campaign.

service_levelinteger required

Service level of the campaign

end_handle'stop' | 'continue' required

Behavior of the campaign after outdial has no more targets.

outplan_idstring required

Outplan ID for the campaign

outdial_idstring required

Outdial ID for the campaign

queue_idstring required

Queue ID for the campaign

next_campaign_idstring required

ID of the next campaign

Example request

{
  "type": "call",
  "end_handle": "stop",
  "actions": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "next_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "talk",
      "tm_execute": "2026-01-15T09:30:00.000000Z"
    }
  ]
}

Response

Successfully subtracted balance from the billing account

idstring uuid

The unique identifier of the campaign.

customer_idstring uuid

The unique identifier of the customer. Returned from the GET /customers response.

type'call' | 'flow'

Type of campaign.

namestring

Display name of the campaign.

detailstring

Additional details about the campaign.

status'stop' | 'stopping' | 'run'

Status of the campaign.

service_levelinteger

Target service level percentage.

end_handle'stop' | 'continue'

Behavior of the campaign after outdial has no more targets.

outplan_idstring uuid

The unique identifier of the outplan. Returned from the POST /outplans or GET /outplans response.

outdial_idstring uuid

The unique identifier of the outdial. Returned from the POST /outdials or GET /outdials response.

queue_idstring uuid

The unique identifier of the queue. Returned from the POST /queues or GET /queues response.

next_campaign_idstring uuid

The unique identifier of the next campaign to execute after this one completes. Returned from the POST /campaigns or GET /campaigns response.

tm_createstring date-time

Timestamp when the campaign was created.

tm_updatestring date-time

Timestamp when the campaign was last updated.

tm_deletestring date-time

Timestamp when the campaign was deleted.

Example response

{
  "id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "type": "call",
  "name": "Q1 Outbound Campaign",
  "detail": "Quarterly customer outreach campaign",
  "status": "run",
  "service_level": 80,
  "end_handle": "stop",
  "actions": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "next_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "talk",
      "tm_execute": "2026-01-15T09:30:00.000000Z"
    }
  ],
  "outplan_id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  "outdial_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  "queue_id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
  "next_campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}