Create campaign

Creates a new outbound calling campaign. The campaign is created with draft status and does not start calling until you update its status to start.

Endpoint

POST /user/campaign

Request

string

required

Name of the campaign. Maximum 255 characters.

integer

required

ID of the outbound assistant to use for this campaign.

string

Timezone for the campaign (e.g., America/New_York). Defaults to your account timezone.

integer

default:"3"

Maximum simultaneous calls. Minimum: 1. Maximum depends on your plan.

string

default:"00:00"

Start of the allowed calling window. Format: H:i (e.g., 09:00).

string

default:"23:59"

End of the allowed calling window. Format: H:i (e.g., 17:00).

array

default:"all 7 days"

Days when calls are allowed. Valid values: monday, tuesday, wednesday, thursday, friday, saturday, sunday.

integer

default:"3"

Maximum retry attempts for failed calls. Range: 1–5.

integer

default:"60"

Minutes between retry attempts. Range: 10–4320.

boolean

Whether to retry calls that reached voicemail.

boolean

Whether to retry calls where the goal was not completed.

string

Name of a boolean variable from your assistant’s post-call schema to track goal completion. Maximum 255 characters.

boolean

default:"true"

Whether to automatically mark the campaign complete when no leads remain.

array

Array of phone number IDs to use for outbound calls. Each ID must be distinct and belong to your account.

Response

string

Confirmation message.

object

The created campaign.

Show properties

integer

Campaign ID.

string

Campaign name.

string

Status — always draft for new campaigns.

integer

Maximum simultaneous calls.

boolean

Auto-complete when no leads remain.

string

Start of calling window.

string

End of calling window.

array

Allowed calling days.

integer

Maximum retries.

integer

Minutes between retries.

string

Creation timestamp.

string

Last update timestamp.

Example

curl -X POST "https://portal.intellixent.ai/api/user/campaign" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Product Demo Campaign",
    "assistant_id": 127,
    "timezone": "America/New_York",
    "max_calls_in_parallel": 3,
    "allowed_hours_start_time": "09:00",
    "allowed_hours_end_time": "17:00",
    "allowed_days": ["monday", "tuesday", "wednesday", "thursday", "friday"],
    "max_retries": 3,
    "retry_interval": 60
  }'

const response = await fetch('https://portal.intellixent.ai/api/user/campaign', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Product Demo Campaign',
    assistant_id: 127,
    timezone: 'America/New_York',
    max_calls_in_parallel: 3,
    allowed_hours_start_time: '09:00',
    allowed_hours_end_time: '17:00',
    allowed_days: ['monday', 'tuesday', 'wednesday', 'thursday', 'friday'],
    max_retries: 3,
    retry_interval: 60
  })
});

const data = await response.json();
console.log(data.data.id); // New campaign ID

201 Created

{
  "message": "Campaign created successfully",
  "data": {
    "id": 1,
    "name": "Product Demo Campaign",
    "status": "draft",
    "max_calls_in_parallel": 3,
    "mark_complete_when_no_leads": true,
    "allowed_hours_start_time": "09:00:00",
    "allowed_hours_end_time": "17:00:00",
    "allowed_days": ["monday", "tuesday", "wednesday", "thursday", "friday"],
    "max_retries": 3,
    "retry_interval": 60,
    "created_at": "2026-02-23T10:00:00.000000Z",
    "updated_at": "2026-02-23T10:00:00.000000Z"
  }
}

403 Plan limit reached

{
  "message": "You have reached the maximum number of campaigns allowed by your plan."
}

404 Assistant not found

{
  "message": "Assistant not found or not an outbound assistant."
}

Overview

Assistants

Calls

Campaigns & Leads

Conversations

Messaging

Phone Numbers

Knowledge & Tools

Webhooks

Endpoint

Request

Response

Example

​Endpoint

​Request

​Response

​Example

Endpoint

Request

Response

Example