Start campaign

curl --request POST \
  --url http://localhost:8787/api/v1/campaigns/{id}/start \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

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

POST

campaigns

{id}

start

Start campaign

curl --request POST \
  --url http://localhost:8787/api/v1/campaigns/{id}/start \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

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

Starts outbound dialing immediately for a campaign in DRAFT or SCHEDULED status.

Starting a campaign triggers live outbound telephone calls to contacts in the attached contact list and incurs wallet balance charges based on connected telephony providers.

Path parameters

string

required

The unique UUID of the campaign to start.

curl -X POST https://api.agentic-os.com/api/v1/campaigns/770e8400-e29b-41d4-a716-446655440000/start \
  -H "Authorization: Bearer $AGENTIC_OS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

import requests

response = requests.post(
    "https://api.agentic-os.com/api/v1/campaigns/770e8400-e29b-41d4-a716-446655440000/start",
    headers={
        "Authorization": f"Bearer {API_KEY}",
        "Content-Type": "application/json",
    },
    json={},
)
print(response.status_code)

const response = await fetch(
  "https://api.agentic-os.com/api/v1/campaigns/770e8400-e29b-41d4-a716-446655440000/start",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({}),
  },
);
console.log(response.status);

Response

202 Accepted indicating that the campaign has transitioned to RUNNING and execution has begun.

⌘I

Overview

Account

Integrations

Configuration

Agents

Numbers

Calls

Campaigns

Knowledge Bases

WhatsApp

Logs

Analytics

Start campaign

Path parameters

Response

​Path parameters

​Response

Path parameters

Response