Update campaign

curl --request PATCH \
  --url http://localhost:8787/api/v1/campaigns/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "agentId": "<string>",
  "voiceNumberId": "<string>",
  "contactListId": "<string>",
  "description": "<string>",
  "scheduledAt": "<string>",
  "timezone": "<string>",
  "callWindowStart": "<string>",
  "callWindowEnd": "<string>",
  "callDays": [
    123
  ],
  "dialTimeout": 123,
  "maxAttempts": 123,
  "redialDelayMin": 123,
  "metadata": {}
}
'

import requests

url = "http://localhost:8787/api/v1/campaigns/{id}"

payload = {
    "name": "<string>",
    "agentId": "<string>",
    "voiceNumberId": "<string>",
    "contactListId": "<string>",
    "description": "<string>",
    "scheduledAt": "<string>",
    "timezone": "<string>",
    "callWindowStart": "<string>",
    "callWindowEnd": "<string>",
    "callDays": [123],
    "dialTimeout": 123,
    "maxAttempts": 123,
    "redialDelayMin": 123,
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    agentId: '<string>',
    voiceNumberId: '<string>',
    contactListId: '<string>',
    description: '<string>',
    scheduledAt: '<string>',
    timezone: '<string>',
    callWindowStart: '<string>',
    callWindowEnd: '<string>',
    callDays: [123],
    dialTimeout: 123,
    maxAttempts: 123,
    redialDelayMin: 123,
    metadata: {}
  })
};

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

PATCH

campaigns

{id}

Update campaign

curl --request PATCH \
  --url http://localhost:8787/api/v1/campaigns/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "agentId": "<string>",
  "voiceNumberId": "<string>",
  "contactListId": "<string>",
  "description": "<string>",
  "scheduledAt": "<string>",
  "timezone": "<string>",
  "callWindowStart": "<string>",
  "callWindowEnd": "<string>",
  "callDays": [
    123
  ],
  "dialTimeout": 123,
  "maxAttempts": 123,
  "redialDelayMin": 123,
  "metadata": {}
}
'

import requests

url = "http://localhost:8787/api/v1/campaigns/{id}"

payload = {
    "name": "<string>",
    "agentId": "<string>",
    "voiceNumberId": "<string>",
    "contactListId": "<string>",
    "description": "<string>",
    "scheduledAt": "<string>",
    "timezone": "<string>",
    "callWindowStart": "<string>",
    "callWindowEnd": "<string>",
    "callDays": [123],
    "dialTimeout": 123,
    "maxAttempts": 123,
    "redialDelayMin": 123,
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    agentId: '<string>',
    voiceNumberId: '<string>',
    contactListId: '<string>',
    description: '<string>',
    scheduledAt: '<string>',
    timezone: '<string>',
    callWindowStart: '<string>',
    callWindowEnd: '<string>',
    callDays: [123],
    dialTimeout: 123,
    maxAttempts: 123,
    redialDelayMin: 123,
    metadata: {}
  })
};

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

Updates configuration fields on an existing campaign.

Only campaigns in DRAFT status can be modified. Once a campaign is running or completed, its core parameters cannot be altered.

Path parameters

string

required

The unique UUID of the campaign to update.

Body parameters

string

New campaign name (must remain unique within tenant).

string

UUID of the voice agent.

string

UUID of the voice number.

string

UUID of the contact list to attach. Must have at least 2 contacts.

string

Updated campaign description.

string

ISO-8601 timestamp to set or update scheduled start time. Setting this transitions the status to SCHEDULED.

string

IANA timezone identifier (e.g. America/New_York).

string

Earliest dial time in HH:mm format.

string

Latest dial time in HH:mm format.

integer[]

Allowed days of the week (1 = Mon … 7 = Sun).

integer

Dial timeout in seconds (10 to 300).

integer

Max attempts per contact (1 to 10).

integer

Delay before redialing in minutes (minimum 1).

object

Updated key-value metadata.

curl -X PATCH https://api.agentic-os.com/api/v1/campaigns/770e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer $AGENTIC_OS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "callWindowStart": "10:00",
    "callWindowEnd": "17:00",
    "maxAttempts": 4,
    "redialDelayMin": 45
  }'

import requests

response = requests.patch(
    "https://api.agentic-os.com/api/v1/campaigns/770e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": f"Bearer {API_KEY}",
        "Content-Type": "application/json",
    },
    json={
        "callWindowStart": "10:00",
        "callWindowEnd": "17:00",
        "maxAttempts": 4,
        "redialDelayMin": 45,
    },
)
print(response.json())

const response = await fetch(
  "https://api.agentic-os.com/api/v1/campaigns/770e8400-e29b-41d4-a716-446655440000",
  {
    method: "PATCH",
    headers: {
      Authorization: `Bearer ${API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      callWindowStart: "10:00",
      callWindowEnd: "17:00",
      maxAttempts: 4,
      redialDelayMin: 45,
    }),
  },
);
const data = await response.json();
console.log(data);

Response

{
  "id": "770e8400-e29b-41d4-a716-446655440000",
  "name": "Q3 Renewal Outreach",
  "status": "DRAFT",
  "callWindowStart": "10:00",
  "callWindowEnd": "17:00",
  "maxAttempts": 4,
  "redialDelayMin": 45,
  "updatedAt": "2026-06-01T10:15:00.000Z"
}

⌘I

Overview

Account

Integrations

Configuration

Agents

Numbers

Calls

Campaigns

Knowledge Bases

WhatsApp

Logs

Analytics

Update campaign

Path parameters

Body parameters

Response

​Path parameters

​Body parameters

​Response

Path parameters

Body parameters

Response