Skip to main content
POST
/
v1
/
campaigns
Create a campaign
curl --request POST \
  --url https://api.openmic.ai/v1/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "outbound",
  "bot_uid": "<string>",
  "from_number": "<string>",
  "contact_list_id": 123,
  "time_start": "<string>",
  "time_end": "<string>",
  "timezone": "<string>",
  "days": [
    "Monday"
  ]
}
'
{
  "id": 123,
  "name": "<string>",
  "type": "outbound",
  "status": "Scheduled",
  "bot_uid": "<string>",
  "from_number": "<string>",
  "contact_list_id": 123,
  "time_start": "<string>",
  "time_end": "<string>",
  "timezone": "<string>",
  "days": [
    "Monday"
  ],
  "schedule_type": "single",
  "current_index": 123,
  "total_contacts": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key authentication. Include your API key in the Authorization header as: Authorization: Bearer <your-api-key>

Body

application/json
​
name
string
required

Campaign name.

Maximum string length: 255
​
type
enum<string>
required

Campaign type. Only outbound campaigns are supported (dials contacts from a contact list).

Available options:
outbound
​
bot_uid
string
required

UID of the bot that handles calls for this campaign.

​
from_number
string
required

Phone number to dial from in E.164 format (e.g. "+12025551234").

​
contact_list_id
integer
required

ID of the contact list to dial.

​
time_start
string
required

Start time for the daily calling window in HH:MM format (e.g. "09:00").

​
time_end
string
required

End time for the daily calling window in HH:MM format (e.g. "17:00").

​
timezone
string

IANA timezone for the calling window (e.g. "America/New_York"). Defaults to UTC if not specified.

​
days
enum<string>[]

Days of week to run the campaign (e.g. ["Monday", "Wednesday", "Friday"]). If not provided, campaign runs as single-day. Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.

Available options:
Monday,
Tuesday,
Wednesday,
Thursday,
Friday,
Saturday,
Sunday

Response

Campaign created

​
id
integer

Unique identifier.

​
name
string

Campaign name.

​
type
enum<string>

Campaign type (always outbound).

Available options:
outbound
​
status
enum<string>

Current campaign status.

Available options:
Scheduled,
Running,
Stopped,
Completed,
Failed,
Expired,
Paused
​
bot_uid
string

Bot UID for API reference.

​
from_number
string

Phone number used to dial from (E.164 format).

​
contact_list_id
integer

Associated contact list ID.

​
time_start
string

Daily calling window start time in HH:MM format.

​
time_end
string

Daily calling window end time in HH:MM format.

​
timezone
string

Calling window timezone (IANA format).

​
days
enum<string>[]

Days of week the campaign runs on (for recurring campaigns).

Available options:
Monday,
Tuesday,
Wednesday,
Thursday,
Friday,
Saturday,
Sunday
​
schedule_type
enum<string>

Schedule type: single (one-time) or multi (recurring on specific days).

Available options:
single,
multi
​
current_index
integer

Number of contacts already called.

​
total_contacts
integer

Total number of contacts in the campaign's contact list.

​
created_at
string<date-time>
​
updated_at
string<date-time>