Create campaign

curl --request POST \
  --url http://localhost:8787/api/v1/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "agentId": "<string>",
  "voiceNumberId": "<string>",
  "contactListId": "<string>"
}
'

import requests

url = "http://localhost:8787/api/v1/campaigns"

payload = {
    "name": "<string>",
    "agentId": "<string>",
    "voiceNumberId": "<string>",
    "contactListId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    agentId: '<string>',
    voiceNumberId: '<string>',
    contactListId: '<string>'
  })
};

fetch('http://localhost:8787/api/v1/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

POST

campaigns

Create campaign

curl --request POST \
  --url http://localhost:8787/api/v1/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "agentId": "<string>",
  "voiceNumberId": "<string>",
  "contactListId": "<string>"
}
'

import requests

url = "http://localhost:8787/api/v1/campaigns"

payload = {
    "name": "<string>",
    "agentId": "<string>",
    "voiceNumberId": "<string>",
    "contactListId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    agentId: '<string>',
    voiceNumberId: '<string>',
    contactListId: '<string>'
  })
};

fetch('http://localhost:8787/api/v1/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Creates a new outbound voice calling campaign. A campaign requires an agent, a voice number, and a contact list (which must contain at least 2 contacts before starting).

Creating a campaign creates it in DRAFT status (or SCHEDULED if scheduledAt is supplied). Outbound dialing begins once you call POST /campaigns/{id}/start or when the scheduled start time arrives.

Body parameters

string

required

Unique campaign name across your tenant.

string

required

UUID of the AI voice agent that will handle conversations.

string

required

UUID of the purchased voice number to dial from. List numbers via GET /voice-numbers.

string

required

UUID of the contact list to dial. A minimum of 2 contacts in the list is required to start dialing.

string

Optional description or objective of the campaign.

string

ISO-8601 timestamp to automatically start dialing (e.g. 2026-06-10T09:00:00.000Z). If provided, status is set to SCHEDULED.

string

default:"Asia/Kolkata"

IANA timezone identifier used to evaluate calling windows (e.g. America/New_York, UTC, Asia/Kolkata).

string

default:"00:00"

Earliest time of day allowed to place calls in HH:mm format (e.g. 09:00).

string

default:"23:59"

Latest time of day allowed to place calls in HH:mm format (e.g. 18:00).

integer[]

default:"[1,2,3,4,5,6,7]"

Allowed days of the week to place calls (1 = Monday through 7 = Sunday).

integer

default:"60"

Number of seconds to let a call ring before timing out. Must be between 10 and 300 seconds.

integer

default:"3"

Maximum dial attempts per contact before marking as unreached. Must be between 1 and 10.

integer

default:"30"

Minutes to wait before redialing an unanswered or busy contact. Minimum 1 minute.

object

Arbitrary key-value metadata attached to the campaign.

curl -X POST https://api.agentic-os.com/api/v1/campaigns \
  -H "Authorization: Bearer $AGENTIC_OS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Q3 Renewal Outreach",
    "agentId": "11111111-1111-1111-1111-111111111111",
    "voiceNumberId": "22222222-2222-2222-2222-222222222222",
    "contactListId": "33333333-3333-3333-3333-333333333333",
    "callWindowStart": "09:00",
    "callWindowEnd": "18:00",
    "callDays": [1, 2, 3, 4, 5],
    "dialTimeout": 45,
    "maxAttempts": 3,
    "redialDelayMin": 60,
    "timezone": "America/New_York"
  }'

import requests

response = requests.post(
    "https://api.agentic-os.com/api/v1/campaigns",
    headers={
        "Authorization": f"Bearer {API_KEY}",
        "Content-Type": "application/json",
    },
    json={
        "name": "Q3 Renewal Outreach",
        "agentId": "11111111-1111-1111-1111-111111111111",
        "voiceNumberId": "22222222-2222-2222-2222-222222222222",
        "contactListId": "33333333-3333-3333-3333-333333333333",
        "callWindowStart": "09:00",
        "callWindowEnd": "18:00",
        "callDays": [1, 2, 3, 4, 5],
        "dialTimeout": 45,
        "maxAttempts": 3,
        "redialDelayMin": 60,
        "timezone": "America/New_York",
    },
)
print(response.json())

const response = await fetch("https://api.agentic-os.com/api/v1/campaigns", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Q3 Renewal Outreach",
    agentId: "11111111-1111-1111-1111-111111111111",
    voiceNumberId: "22222222-2222-2222-2222-222222222222",
    contactListId: "33333333-3333-3333-3333-333333333333",
    callWindowStart: "09:00",
    callWindowEnd: "18:00",
    callDays: [1, 2, 3, 4, 5],
    dialTimeout: 45,
    maxAttempts: 3,
    redialDelayMin: 60,
    timezone: "America/New_York",
  }),
});
const data = await response.json();
console.log(data);

Response

{
  "id": "770e8400-e29b-41d4-a716-446655440000",
  "tenantId": "990e8400-e29b-41d4-a716-446655440000",
  "name": "Q3 Renewal Outreach",
  "description": null,
  "agentId": "11111111-1111-1111-1111-111111111111",
  "voiceNumberId": "22222222-2222-2222-2222-222222222222",
  "contactListId": "33333333-3333-3333-3333-333333333333",
  "status": "DRAFT",
  "totalContacts": 150,
  "dialedContacts": 0,
  "answeredContacts": 0,
  "dialTimeout": 45,
  "maxAttempts": 3,
  "redialDelayMin": 60,
  "scheduledAt": null,
  "timezone": "America/New_York",
  "callWindowStart": "09:00",
  "callWindowEnd": "18:00",
  "callDays": [1, 2, 3, 4, 5],
  "metadata": {},
  "createdAt": "2026-06-01T10:00:00.000Z",
  "updatedAt": "2026-06-01T10:00:00.000Z"
}

⌘I

Overview

Account

Integrations

Configuration

Agents

Numbers

Calls

Campaigns

Knowledge Bases

WhatsApp

Logs

Analytics

Create campaign

Body parameters

Response

​Body parameters

​Response

Body parameters

Response