Skip to main content
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

​
name
string
required
Name of the campaign. Maximum 255 characters.
​
assistant_id
integer
required
ID of the outbound assistant to use for this campaign.
​
timezone
string
Timezone for the campaign (e.g., America/New_York). Defaults to your account timezone.
​
max_calls_in_parallel
integer
default:"3"
Maximum simultaneous calls. Minimum: 1. Maximum depends on your plan.
​
allowed_hours_start_time
string
default:"00:00"
Start of the allowed calling window. Format: H:i (e.g., 09:00).
​
allowed_hours_end_time
string
default:"23:59"
End of the allowed calling window. Format: H:i (e.g., 17:00).
​
allowed_days
array
default:"all 7 days"
Days when calls are allowed. Valid values: monday, tuesday, wednesday, thursday, friday, saturday, sunday.
​
max_retries
integer
default:"3"
Maximum retry attempts for failed calls. Range: 1–5.
​
retry_interval
integer
default:"60"
Minutes between retry attempts. Range: 10–4320.
​
retry_on_voicemail
boolean
Whether to retry calls that reached voicemail.
​
retry_on_goal_incomplete
boolean
Whether to retry calls where the goal was not completed.
​
goal_completion_variable
string
Name of a boolean variable from your assistant’s post-call schema to track goal completion. Maximum 255 characters.
​
mark_complete_when_no_leads
boolean
default:"true"
Whether to automatically mark the campaign complete when no leads remain.
​
phone_number_ids
array
Array of phone number IDs to use for outbound calls. Each ID must be distinct and belong to your account.

​
Response

​
message
string
Confirmation message.
​
data
object
The created campaign.

​
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
  }'
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."
}