PATCH
/
v1
/
campaigns
/
{campaignId}
Update Campaign
curl --request PATCH \
  --url https://api.sigmamind.ai/v1/campaigns/{campaignId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "campaignName": "<string>",
  "sipPhoneNumber": "<string>",
  "agentId": "<string>",
  "isScheduled": true,
  "scheduledDate": "<string>",
  "scheduledTime": "<string>",
  "scheduledTimezone": "<string>",
  "concurrentCalls": 123,
  "variables": {}
}'
{
  "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

Path Parameters

​
campaignId
string
required

A unique identifier assigned to the campaign.

Body

application/json
​
campaignName
string
​
sipPhoneNumber
string
​
agentId
string
​
isScheduled
boolean
​
scheduledDate
string
​
scheduledTime
string
​
scheduledTimezone
string
​
concurrentCalls
integer
​
variables
object

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