POST
/
v1
/
campaigns
Create Campaign
curl --request POST \
  --url https://api.sigmamind.ai/v1/campaigns \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form 'campaignName=<string>' \
  --form sipPhoneNumber=14155552671 \
  --form agentId=D5D0p7TUs66TTAEAx \
  --form isScheduled=true \
  --form scheduledDate=2023-11-07T05:31:56Z \
  --form scheduledTime=12:00:00 \
  --form scheduledTimezone=America/Los_Angeles \
  --form concurrentCalls=5 \
  --form 'variables={
  "customer_name": "Michael"
}' \
  --form file=@example-file
{
  "campaignId": "XiQEBcj9cc5TFRB4",
  "campaignName": "My Campaign",
  "campaignStatus": "live",
  "scheduledDate": "2023-11-07T05:31:56Z",
  "concurrentCalls": 5,
  "agent": {
    "name": "New AI Agent",
    "agentId": "D5D0p7TUs66TTAEAx",
    "status": "active"
  },
  "phoneNumber": "Object",
  "errors": [
    "<string>"
  ],
  "scheduled": true
}

Authorizations

​
X-API-Key
string
header
required

API Key is required in header. You can find it in the settings

Body

multipart/form-data
​
sipPhoneNumber
string
required

Phone number of the caller in E.164 format. Must be purchased from SigmaMind or SIP trunking with SigmaMind

Example:

14155552671

​
agentId
string
required

Unique id of Agent that will respond to all outbound calls in this campaign

Example:

"D5D0p7TUs66TTAEAx"

​
file
file
required
​
campaignName
string
​
isScheduled
boolean

If campaign is scheduled for launch at given time

Example:

true

​
scheduledDate
string<date-time>

scheduled date is required if scheduled

​
scheduledTime
string<time>

Scheduled time is required if scheduled

Example:

"12:00:00"

​
scheduledTimezone
string<timezone>

Scheduled timezone is required if scheduled

Example:

"America/Los_Angeles"

​
concurrentCalls
integer

Number of outbound calls in progress at a time in a campaign

Example:

5

​
variables
object

Dynamic variables required in Selected Agent

Example:
{ "customer_name": "Michael" }

Response

OK

​
campaignId
string

A unique identifier assigned to the campaign.

Example:

"XiQEBcj9cc5TFRB4"

​
campaignName
string

The name given to the campaign for reference or display purposes.

Example:

"My Campaign"

​
campaignStatus
enum<string>

Indicates the current status of the campaign.

Available options:
live, scheduled, paused, completed
Example:

"live"

​
scheduledDate
string<date-time>

The scheduled date and time when the campaign is set to launch

​
concurrentCalls
integer

Specifies the maximum number of outbound calls allowed to be active simultaneously within the campaign.

Example:

5

​
agent
object

Assigned agent for current campaign

​
phoneNumber
object

Phone number details of the caller

Example:

"Object"

​
errors
string[]
​
scheduled
boolean