Skip to main content
POST
/
campaigns
Create Campaign
curl --request POST \
  --url https://api.example.com/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "targets": [
    {
      "to_number": "<string>",
      "from_number": "<string>",
      "context": {}
    }
  ],
  "schedule_at": "2023-11-07T05:31:56Z",
  "concurrent_calls": 1,
  "retry_failed": false,
  "retry_attempts": 0,
  "context": {},
  "webhook_url": "<string>",
  "webhook_secret": "<string>",
  "notify_on_call_complete": false
}
'
{
  "campaign_id": "<string>",
  "agent_id": "<string>",
  "name": "<string>",
  "total_targets": 123,
  "status": "<string>",
  "scheduled_at": "<string>",
  "started_at": "<string>",
  "calls_initiated": 123,
  "calls_completed": 123,
  "calls_failed": 123
}

Documentation Index

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

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

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Campaign/batch calling request.

​
agent_id
string<uuid>
required
​
name
string
required
Required string length: 1 - 255
​
targets
CallTarget · object[]
required
Required array length: 1 - 1000 elements
​
schedule_at
string<date-time> | null
​
concurrent_calls
integer
default:1
Required range: 1 <= x <= 10
​
retry_failed
boolean
default:false
​
retry_attempts
integer
default:0
Required range: 0 <= x <= 3
​
context
Context · object
​
webhook_url
string | null

URL for campaign progress webhooks

​
webhook_secret
string | null

Secret for webhook signature verification

​
notify_on_call_complete
boolean
default:false

Send webhook for each call completion

Response

Successful Response

Campaign response.

​
campaign_id
string
required
​
agent_id
string
required
​
name
string
required
​
total_targets
integer
required
​
status
string
required
​
scheduled_at
string | null
required
​
started_at
string | null
required
​
calls_initiated
integer
required
​
calls_completed
integer
required
​
calls_failed
integer
required