Skip to main content
POST
/
api
/
v1
/
campaigns
Create a campaign
curl --request POST \
  --url https://api.kataven.ai/v1/api/v1/campaigns \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'name=<string>' \
  --data 'agent_id=<string>' \
  --data 'phone_number_id=<string>' \
  --data max_concurrent_calls=123 \
  --data retries_per_contact=123 \
  --data retry_delay_seconds=123 \
  --data 'scheduled_at=<string>' \
  --data 'contacts=<string>'
{
  "agent_id": "<string>",
  "completed_at": "<string>",
  "created_at": "<string>",
  "created_by": "<string>",
  "id": "<string>",
  "max_concurrent_calls": 123,
  "name": "<string>",
  "phone_number_id": "<string>",
  "retries_per_contact": 123,
  "retry_delay_seconds": 123,
  "scheduled_at": "<string>",
  "started_at": "<string>",
  "status": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.kataven.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Headers

X-Account-ID
string

Tenant database. Required when using a Zitadel JWT.

Body

Campaign name | Agent uuid | Phone number uuid | 1-100 (default 5) | 0-5 (default 0) | ≥60 (default 300) | RFC3339 timestamp; rejected if in the past | CSV file

name
string
agent_id
string
phone_number_id
string
max_concurrent_calls
integer
retries_per_contact
integer
retry_delay_seconds
integer
scheduled_at
string
contacts
file

Response

Created

agent_id
string
completed_at
string
created_at
string
created_by
string
id
string
max_concurrent_calls
integer
name
string
phone_number_id
string
retries_per_contact
integer
retry_delay_seconds
integer
scheduled_at
string
started_at
string
status
string