Create a campaign

curl --request POST \
  --url https://sandbox.voice.miraiminds.co/v2/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "सर्विस रिमाइंडर — अक्टूबर",
  "agent_id": "agt_01K2M4P7QRSTVWXYZ0A1B2C3",
  "timezone": "Asia/Kolkata",
  "start_date": "2026-10-12",
  "end_date": "2026-10-16",
  "slots": [
    {
      "start": "10:00",
      "end": "13:00"
    },
    {
      "start": "16:00",
      "end": "19:00"
    }
  ]
}
'

import requests

url = "https://sandbox.voice.miraiminds.co/v2/campaigns"

payload = {
    "name": "सर्विस रिमाइंडर — अक्टूबर",
    "agent_id": "agt_01K2M4P7QRSTVWXYZ0A1B2C3",
    "timezone": "Asia/Kolkata",
    "start_date": "2026-10-12",
    "end_date": "2026-10-16",
    "slots": [
        {
            "start": "10:00",
            "end": "13:00"
        },
        {
            "start": "16:00",
            "end": "19:00"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const url = 'https://sandbox.voice.miraiminds.co/v2/campaigns';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'सर्विस रिमाइंडर — अक्टूबर',
    agent_id: 'agt_01K2M4P7QRSTVWXYZ0A1B2C3',
    timezone: 'Asia/Kolkata',
    start_date: '2026-10-12',
    end_date: '2026-10-16',
    slots: [{start: '10:00', end: '13:00'}, {start: '16:00', end: '19:00'}]
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "agent_revision": 1,
  "id": "cmp_01K79Q4T6W8XZ2B5D7F9H3JKMN",
  "object": "campaign",
  "name": "सर्विस रिमाइंडर — अक्टूबर",
  "agent_id": "agt_01K2M4P7QRSTVWXYZ0A1B2C3",
  "tier": "t5",
  "status": "draft",
  "pause_reason": null,
  "timezone": "Asia/Kolkata",
  "start_date": "2026-10-12",
  "end_date": "2026-10-16",
  "slots": [
    {
      "start": "10:00",
      "end": "13:00"
    },
    {
      "start": "16:00",
      "end": "19:00"
    }
  ],
  "max_concurrent": 2,
  "retry_count": 1,
  "re_attempt_period_secs": 3600,
  "max_duration_secs": 300,
  "budget_paise": 50000,
  "spent_paise": 0,
  "skip_called_before": false,
  "final_results": true,
  "created_at": "2026-10-09T06:12:40Z",
  "updated_at": "2026-10-09T06:12:40Z",
  "archived": false,
  "archived_at": null,
  "contacts_accepted": 2,
  "contacts_duplicate": 0,
  "contacts_rejected": []
}

{
  "error": {
    "code": "invalid_request",
    "message": "end_date 2026-10-10 is before start_date 2026-10-12"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "agent agt_01K2M4P7QRSTVWXYZ0A1B9C4 was refused by the dialer: no agent agt_01K2M4P7QRSTVWXYZ0A1B9C4",
    "agent_id": "agt_01K2M4P7QRSTVWXYZ0A1B9C4"
  }
}

Campaigns

Create a campaign

Makes a draft campaign. Nothing rings until you start it.

Required: name, agent_id, timezone, start_date, end_date and slots. Dates are YYYY-MM-DD and slots are HH:MM, both in the campaign’s own timezone; up to 4 slots, and a slot may cross midnight. Set the dates to the days you actually want to call. A campaign whose dates have passed finishes as soon as it starts.

Optional: max_concurrent (1–50, default 1), retry_count (0–5 retries after the first attempt, default 0), re_attempt_period_secs (60–86400, default 900), max_duration_secs (defaults to the agent’s), budget_paise (leave it out for no cap), webhook_url, skip_called_before (skip numbers another campaign has already reached), final_results (default true: each call ends with one call.processed carrying the transcript, the results and the contact’s metadata) and tier (defaults to your plan).

contacts is optional here: up to 1000 rows per request, each {id?, phone, variables?, metadata?}. variables fill the placeholders in the agent’s prompt for that person, the same way they do on a single call. metadata is your own fields the agent doesn’t need (a CRM id, a branch): kept with the contact and sent on each of its calls’ webhooks, never given to the agent. Every campaign call’s webhooks also name its campaign_id and contact_id. A bad row doesn’t sink the upload. It comes back in contacts_rejected with its index, and the good rows are stored.

There is no idempotency key on this route. If a create times out, list your campaigns before you retry, or you may end up with two.

POST

campaigns

Create a campaign

curl --request POST \
  --url https://sandbox.voice.miraiminds.co/v2/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "सर्विस रिमाइंडर — अक्टूबर",
  "agent_id": "agt_01K2M4P7QRSTVWXYZ0A1B2C3",
  "timezone": "Asia/Kolkata",
  "start_date": "2026-10-12",
  "end_date": "2026-10-16",
  "slots": [
    {
      "start": "10:00",
      "end": "13:00"
    },
    {
      "start": "16:00",
      "end": "19:00"
    }
  ]
}
'

import requests

url = "https://sandbox.voice.miraiminds.co/v2/campaigns"

payload = {
    "name": "सर्विस रिमाइंडर — अक्टूबर",
    "agent_id": "agt_01K2M4P7QRSTVWXYZ0A1B2C3",
    "timezone": "Asia/Kolkata",
    "start_date": "2026-10-12",
    "end_date": "2026-10-16",
    "slots": [
        {
            "start": "10:00",
            "end": "13:00"
        },
        {
            "start": "16:00",
            "end": "19:00"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const url = 'https://sandbox.voice.miraiminds.co/v2/campaigns';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'सर्विस रिमाइंडर — अक्टूबर',
    agent_id: 'agt_01K2M4P7QRSTVWXYZ0A1B2C3',
    timezone: 'Asia/Kolkata',
    start_date: '2026-10-12',
    end_date: '2026-10-16',
    slots: [{start: '10:00', end: '13:00'}, {start: '16:00', end: '19:00'}]
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "agent_revision": 1,
  "id": "cmp_01K79Q4T6W8XZ2B5D7F9H3JKMN",
  "object": "campaign",
  "name": "सर्विस रिमाइंडर — अक्टूबर",
  "agent_id": "agt_01K2M4P7QRSTVWXYZ0A1B2C3",
  "tier": "t5",
  "status": "draft",
  "pause_reason": null,
  "timezone": "Asia/Kolkata",
  "start_date": "2026-10-12",
  "end_date": "2026-10-16",
  "slots": [
    {
      "start": "10:00",
      "end": "13:00"
    },
    {
      "start": "16:00",
      "end": "19:00"
    }
  ],
  "max_concurrent": 2,
  "retry_count": 1,
  "re_attempt_period_secs": 3600,
  "max_duration_secs": 300,
  "budget_paise": 50000,
  "spent_paise": 0,
  "skip_called_before": false,
  "final_results": true,
  "created_at": "2026-10-09T06:12:40Z",
  "updated_at": "2026-10-09T06:12:40Z",
  "archived": false,
  "archived_at": null,
  "contacts_accepted": 2,
  "contacts_duplicate": 0,
  "contacts_rejected": []
}

{
  "error": {
    "code": "invalid_request",
    "message": "end_date 2026-10-10 is before start_date 2026-10-12"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "agent agt_01K2M4P7QRSTVWXYZ0A1B9C4 was refused by the dialer: no agent agt_01K2M4P7QRSTVWXYZ0A1B9C4",
    "agent_id": "agt_01K2M4P7QRSTVWXYZ0A1B9C4"
  }
}

Authorizations

Authorization

string

header

required

Your workspace secret key, sk_live_ followed by 32 hex characters. Create one in the console under Developers.

Body

application/json

agent_id

string

required

end_date

string

required

name

string

required

slots

object[]

required

Show child attributes

start_date

string

required

timezone

string

required

always_on

boolean

budget_paise

integer

caller_id_max_per_hour

integer

caller_ids

string[]

caller_name

string

contacts

object[]

Show child attributes

dial_cps

number

final_results

boolean

max_concurrent

integer

max_duration_secs

integer

phone_number_id

string | null

One of your phone numbers (GET /v2/phone-numbers) that every call of this campaign rings from, through its own provider connection. null clears it. Exclusive with caller_ids.

pool_id

string | null

One of your phone pools (GET /v2/phone-pools): each contact rings from the number the pool picks. null clears it. Exclusive with phone_number_id and caller_ids.

re_attempt_period_secs

integer

retry_count

integer

skip_called_before

boolean

tier

string

webhook_url

string

worker_pool

string[]

Response

Draft created

Get started

Agents

Calls

Flows

Tools and secrets

Campaigns

Do-not-call list

Phone numbers

Phone pools

Telephony

Transcriptions

Speech to text

Text to speech

Wallet

Reference

Create a campaign

Authorizations

Body

Response