Skip to main content
POST
/
h
/
v2
/
campaigns
Create a campaign
curl --request POST \
  --url https://api.openmic.ai/h/v2/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Q1 Sales Blitz",
  "type": "outbound",
  "agent_uid": "agent_abc123",
  "from_number": "+12025551234",
  "contact_list_id": 42,
  "time_start": "09:00",
  "time_end": "17:00",
  "timezone": "America/New_York",
  "days": [
    "Monday",
    "Tuesday",
    "Wednesday",
    "Thursday",
    "Friday"
  ]
}
'
{
  "id": 123,
  "name": "<string>",
  "type": "outbound",
  "status": "Running",
  "agent_uid": "<string>",
  "from_number": "<string>",
  "contact_list_id": 123,
  "time_start": "09:00",
  "time_end": "17:00",
  "timezone": "America/New_York",
  "days": [
    "Monday"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key obtained from the OpenMic dashboard.

Body

application/json
​
name
string
required
Required string length: 1 - 255
​
type
enum<string>
required
Available options:
outbound
​
agent_uid
string
required
​
from_number
string
required

E.164 format.

Pattern: ^\+[1-9]\d{1,14}$
​
contact_list_id
integer
required
​
time_start
string
required

HH:MM format.

Pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$
Example:

"09:00"

​
time_end
string
required

HH:MM format.

Pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$
Example:

"17:00"

​
timezone
string
Example:

"America/New_York"

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

Response

Campaign created.

​
id
integer
required
​
name
string
required
​
type
enum<string>
required
Available options:
outbound
​
status
enum<string>
required
Available options:
Running,
Scheduled,
Stopped,
Completed,
Failed,
Expired,
Paused
​
agent_uid
string
​
from_number
string
​
contact_list_id
integer
​
time_start
string

HH:MM (24-hour) daily window start.

Example:

"09:00"

​
time_end
string

HH:MM (24-hour) daily window end.

Example:

"17:00"

​
timezone
string
Example:

"America/New_York"

​
days
enum<string>[]
Available options:
Monday,
Tuesday,
Wednesday,
Thursday,
Friday,
Saturday,
Sunday
​
created_at
string<date-time>
​
updated_at
string<date-time>