curl --request PATCH \
--url https://api.sigmamind.ai/v1/campaigns/{campaignId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"campaignName": "Q4 Outreach Campaign",
"sipPhoneNumber": "+14155552671",
"agentId": "agent_D5D0p7TUs66TTAEAx",
"isScheduled": true,
"scheduledDate": "2025-09-25T00:00:00.000Z",
"scheduledTime": "12:00:00",
"scheduledTimezone": "America/Los_Angeles",
"concurrentCalls": 5,
"dynamicVariables": {
"customer_name": "Michael"
}
}
'import requests
url = "https://api.sigmamind.ai/v1/campaigns/{campaignId}"
payload = {
"campaignName": "Q4 Outreach Campaign",
"sipPhoneNumber": "+14155552671",
"agentId": "agent_D5D0p7TUs66TTAEAx",
"isScheduled": True,
"scheduledDate": "2025-09-25T00:00:00.000Z",
"scheduledTime": "12:00:00",
"scheduledTimezone": "America/Los_Angeles",
"concurrentCalls": 5,
"dynamicVariables": { "customer_name": "Michael" }
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
campaignName: 'Q4 Outreach Campaign',
sipPhoneNumber: '+14155552671',
agentId: 'agent_D5D0p7TUs66TTAEAx',
isScheduled: true,
scheduledDate: '2025-09-25T00:00:00.000Z',
scheduledTime: '12:00:00',
scheduledTimezone: 'America/Los_Angeles',
concurrentCalls: 5,
dynamicVariables: {customer_name: 'Michael'}
})
};
fetch('https://api.sigmamind.ai/v1/campaigns/{campaignId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sigmamind.ai/v1/campaigns/{campaignId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'campaignName' => 'Q4 Outreach Campaign',
'sipPhoneNumber' => '+14155552671',
'agentId' => 'agent_D5D0p7TUs66TTAEAx',
'isScheduled' => true,
'scheduledDate' => '2025-09-25T00:00:00.000Z',
'scheduledTime' => '12:00:00',
'scheduledTimezone' => 'America/Los_Angeles',
'concurrentCalls' => 5,
'dynamicVariables' => [
'customer_name' => 'Michael'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sigmamind.ai/v1/campaigns/{campaignId}"
payload := strings.NewReader("{\n \"campaignName\": \"Q4 Outreach Campaign\",\n \"sipPhoneNumber\": \"+14155552671\",\n \"agentId\": \"agent_D5D0p7TUs66TTAEAx\",\n \"isScheduled\": true,\n \"scheduledDate\": \"2025-09-25T00:00:00.000Z\",\n \"scheduledTime\": \"12:00:00\",\n \"scheduledTimezone\": \"America/Los_Angeles\",\n \"concurrentCalls\": 5,\n \"dynamicVariables\": {\n \"customer_name\": \"Michael\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.sigmamind.ai/v1/campaigns/{campaignId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"campaignName\": \"Q4 Outreach Campaign\",\n \"sipPhoneNumber\": \"+14155552671\",\n \"agentId\": \"agent_D5D0p7TUs66TTAEAx\",\n \"isScheduled\": true,\n \"scheduledDate\": \"2025-09-25T00:00:00.000Z\",\n \"scheduledTime\": \"12:00:00\",\n \"scheduledTimezone\": \"America/Los_Angeles\",\n \"concurrentCalls\": 5,\n \"dynamicVariables\": {\n \"customer_name\": \"Michael\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sigmamind.ai/v1/campaigns/{campaignId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"campaignName\": \"Q4 Outreach Campaign\",\n \"sipPhoneNumber\": \"+14155552671\",\n \"agentId\": \"agent_D5D0p7TUs66TTAEAx\",\n \"isScheduled\": true,\n \"scheduledDate\": \"2025-09-25T00:00:00.000Z\",\n \"scheduledTime\": \"12:00:00\",\n \"scheduledTimezone\": \"America/Los_Angeles\",\n \"concurrentCalls\": 5,\n \"dynamicVariables\": {\n \"customer_name\": \"Michael\"\n }\n}"
response = http.request(request)
puts response.read_body{
"campaignId": "camp_XiQEBcj9cc5TFRB4",
"campaignName": "Q4 Outreach Campaign",
"campaignStatus": "live",
"scheduledDate": "2025-09-25T19:00:00.000Z",
"concurrentCalls": 5,
"agent": {
"name": "New AI Agent",
"agentId": "agent_D5D0p7TUs66TTAEAx",
"status": "Live"
},
"phoneNumber": {
"sipPhoneNumber": "+14155552671",
"provider": "twilio",
"inboundAgentId": "agent_D5D0p7TUs66TTAEAx",
"outboundAgentId": "agent_D5D0p7TUs66TTAEAx",
"outboundPhoneNumber": "+14155552671",
"active": true,
"terminationSipURI": "sip.telnyx.com",
"friendlyName": "Support Line - US"
},
"errors": [
"Row 3: missing required variable 'customer_name'",
"Row 7: invalid phone number '+1234'"
],
"scheduled": true
}{
"error": "Bad Request",
"message": "Invalid request parameters",
"path": "/v1/campaigns",
"status": 400,
"timestamp": "2026-05-05T10:06:45.996Z"
}{
"error": "Unauthorized",
"message": "X-API-Key is missing or invalid",
"path": "/v1/campaigns",
"status": 401,
"timestamp": "2026-05-05T10:06:45.996Z"
}{
"error": "Forbidden",
"message": "Access denied for this resource",
"path": "/v1/campaigns",
"status": 403,
"timestamp": "2026-05-05T10:06:45.996Z"
}{
"error": "Not Found",
"message": "The requested resource was not found",
"path": "/v1/campaigns",
"status": 404,
"timestamp": "2026-05-05T10:06:45.996Z"
}{
"error": "Conflict",
"message": "Conflict with the current state of the resource",
"path": "/v1/campaigns",
"status": 409,
"timestamp": "2026-05-05T10:06:45.996Z"
}{
"error": "Internal Server Error",
"message": "Unexpected server error",
"path": "/v1/campaigns",
"status": 500,
"timestamp": "2026-05-05T10:06:45.996Z"
}Update Campaign
Partially updates an existing campaign by campaignId. Only fields provided in the request body are updated — omitted fields remain unchanged. Returns the updated campaign record.
curl --request PATCH \
--url https://api.sigmamind.ai/v1/campaigns/{campaignId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"campaignName": "Q4 Outreach Campaign",
"sipPhoneNumber": "+14155552671",
"agentId": "agent_D5D0p7TUs66TTAEAx",
"isScheduled": true,
"scheduledDate": "2025-09-25T00:00:00.000Z",
"scheduledTime": "12:00:00",
"scheduledTimezone": "America/Los_Angeles",
"concurrentCalls": 5,
"dynamicVariables": {
"customer_name": "Michael"
}
}
'import requests
url = "https://api.sigmamind.ai/v1/campaigns/{campaignId}"
payload = {
"campaignName": "Q4 Outreach Campaign",
"sipPhoneNumber": "+14155552671",
"agentId": "agent_D5D0p7TUs66TTAEAx",
"isScheduled": True,
"scheduledDate": "2025-09-25T00:00:00.000Z",
"scheduledTime": "12:00:00",
"scheduledTimezone": "America/Los_Angeles",
"concurrentCalls": 5,
"dynamicVariables": { "customer_name": "Michael" }
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
campaignName: 'Q4 Outreach Campaign',
sipPhoneNumber: '+14155552671',
agentId: 'agent_D5D0p7TUs66TTAEAx',
isScheduled: true,
scheduledDate: '2025-09-25T00:00:00.000Z',
scheduledTime: '12:00:00',
scheduledTimezone: 'America/Los_Angeles',
concurrentCalls: 5,
dynamicVariables: {customer_name: 'Michael'}
})
};
fetch('https://api.sigmamind.ai/v1/campaigns/{campaignId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sigmamind.ai/v1/campaigns/{campaignId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'campaignName' => 'Q4 Outreach Campaign',
'sipPhoneNumber' => '+14155552671',
'agentId' => 'agent_D5D0p7TUs66TTAEAx',
'isScheduled' => true,
'scheduledDate' => '2025-09-25T00:00:00.000Z',
'scheduledTime' => '12:00:00',
'scheduledTimezone' => 'America/Los_Angeles',
'concurrentCalls' => 5,
'dynamicVariables' => [
'customer_name' => 'Michael'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sigmamind.ai/v1/campaigns/{campaignId}"
payload := strings.NewReader("{\n \"campaignName\": \"Q4 Outreach Campaign\",\n \"sipPhoneNumber\": \"+14155552671\",\n \"agentId\": \"agent_D5D0p7TUs66TTAEAx\",\n \"isScheduled\": true,\n \"scheduledDate\": \"2025-09-25T00:00:00.000Z\",\n \"scheduledTime\": \"12:00:00\",\n \"scheduledTimezone\": \"America/Los_Angeles\",\n \"concurrentCalls\": 5,\n \"dynamicVariables\": {\n \"customer_name\": \"Michael\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.sigmamind.ai/v1/campaigns/{campaignId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"campaignName\": \"Q4 Outreach Campaign\",\n \"sipPhoneNumber\": \"+14155552671\",\n \"agentId\": \"agent_D5D0p7TUs66TTAEAx\",\n \"isScheduled\": true,\n \"scheduledDate\": \"2025-09-25T00:00:00.000Z\",\n \"scheduledTime\": \"12:00:00\",\n \"scheduledTimezone\": \"America/Los_Angeles\",\n \"concurrentCalls\": 5,\n \"dynamicVariables\": {\n \"customer_name\": \"Michael\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sigmamind.ai/v1/campaigns/{campaignId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"campaignName\": \"Q4 Outreach Campaign\",\n \"sipPhoneNumber\": \"+14155552671\",\n \"agentId\": \"agent_D5D0p7TUs66TTAEAx\",\n \"isScheduled\": true,\n \"scheduledDate\": \"2025-09-25T00:00:00.000Z\",\n \"scheduledTime\": \"12:00:00\",\n \"scheduledTimezone\": \"America/Los_Angeles\",\n \"concurrentCalls\": 5,\n \"dynamicVariables\": {\n \"customer_name\": \"Michael\"\n }\n}"
response = http.request(request)
puts response.read_body{
"campaignId": "camp_XiQEBcj9cc5TFRB4",
"campaignName": "Q4 Outreach Campaign",
"campaignStatus": "live",
"scheduledDate": "2025-09-25T19:00:00.000Z",
"concurrentCalls": 5,
"agent": {
"name": "New AI Agent",
"agentId": "agent_D5D0p7TUs66TTAEAx",
"status": "Live"
},
"phoneNumber": {
"sipPhoneNumber": "+14155552671",
"provider": "twilio",
"inboundAgentId": "agent_D5D0p7TUs66TTAEAx",
"outboundAgentId": "agent_D5D0p7TUs66TTAEAx",
"outboundPhoneNumber": "+14155552671",
"active": true,
"terminationSipURI": "sip.telnyx.com",
"friendlyName": "Support Line - US"
},
"errors": [
"Row 3: missing required variable 'customer_name'",
"Row 7: invalid phone number '+1234'"
],
"scheduled": true
}{
"error": "Bad Request",
"message": "Invalid request parameters",
"path": "/v1/campaigns",
"status": 400,
"timestamp": "2026-05-05T10:06:45.996Z"
}{
"error": "Unauthorized",
"message": "X-API-Key is missing or invalid",
"path": "/v1/campaigns",
"status": 401,
"timestamp": "2026-05-05T10:06:45.996Z"
}{
"error": "Forbidden",
"message": "Access denied for this resource",
"path": "/v1/campaigns",
"status": 403,
"timestamp": "2026-05-05T10:06:45.996Z"
}{
"error": "Not Found",
"message": "The requested resource was not found",
"path": "/v1/campaigns",
"status": 404,
"timestamp": "2026-05-05T10:06:45.996Z"
}{
"error": "Conflict",
"message": "Conflict with the current state of the resource",
"path": "/v1/campaigns",
"status": 409,
"timestamp": "2026-05-05T10:06:45.996Z"
}{
"error": "Internal Server Error",
"message": "Unexpected server error",
"path": "/v1/campaigns",
"status": 500,
"timestamp": "2026-05-05T10:06:45.996Z"
}Authorizations
Authenticate every request by passing your API key in the X-API-Key header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.
Path Parameters
Unique identifier of the campaign to update.
Body
Request body to update a campaign. A campaign dials a list of phone numbers using a selected agent and caller number. The contact list and any per-contact dynamic variables are uploaded as a CSV file. Campaigns can start immediately or be scheduled for a future date and time.
Display name for this campaign. Used to identify the campaign in listings, dashboards, and reports. Must be unique within your account.
1 - 128"Q4 Outreach Campaign"
Caller ID phone number used for all outbound calls in this campaign, in +E.164 format. Must be a number provisioned in SigmaMind or configured via SIP trunking that is enabled for outbound calls. This number appears on the recipient's device as the incoming caller.
^\+[1-9][0-9]{6,14}$"+14155552671"
Unique identifier of the agent that will handle every call in this campaign. The agent controls the conversation flow, scripts, and tools used during each call. All contacts in the uploaded CSV will be called using this agent.
1 - 64"agent_D5D0p7TUs66TTAEAx"
Whether this campaign should be held and launched at a future date and time instead of starting immediately. When true, scheduledDate, scheduledTime, and scheduledTimezone are all required. When false or omitted, the campaign starts as soon as it is created.
true
Date on which the campaign should launch, in YYYY-MM-DD format. Required when isScheduled is true. Ignored when isScheduled is false or omitted. Must be a future date.
"2025-09-25T00:00:00.000Z"
Time at which the campaign should launch on the scheduled date, in HH:mm:ss format. Required when isScheduled is true. Ignored when isScheduled is false or omitted. Interpreted in the timezone specified by scheduledTimezone.
"12:00:00"
IANA timezone name used to interpret scheduledDate and scheduledTime. Required when isScheduled is true. Ignored when isScheduled is false or omitted. Use a valid IANA timezone identifier (e.g., 'America/Los_Angeles', 'Europe/London', 'Asia/Kolkata').
"America/Los_Angeles"
Maximum number of calls the campaign is allowed to have active simultaneously. Controls the dialling throughput — a higher value dials more contacts in parallel. If omitted, the account default is used. Must be a positive integer.
5
Default dynamic variable values applied to every call in the campaign when the CSV does not supply a value for a given variable. Keys must match variable names defined in the agent's configuration. Per-contact values in the CSV take precedence over these defaults. Leave empty if the CSV provides all required variables.
Show child attributes
Show child attributes
{ "customer_name": "Michael" }
Response
OK
Full details of a campaign record. Includes the campaign's identity, current status, schedule configuration, the agent handling calls, and the caller phone number used to dial contacts.
Unique identifier for this campaign. Use this value as campaignId when updating, deleting, or triggering this campaign via the API.
"camp_XiQEBcj9cc5TFRB4"
Display name of this campaign as set at creation time. Used to identify the campaign in listings and dashboards.
"Q4 Outreach Campaign"
Current lifecycle state of the campaign. 'live' means the campaign is actively dialling contacts. 'scheduled' means the campaign is configured to launch at a future date and time. 'paused' means dialling has been suspended and can be resumed. 'completed' means all contacts have been dialled and the campaign has finished.
live, scheduled, paused, completed "live"
The date and time when this campaign is scheduled to launch, including timezone. Present only when isScheduled is true. Null for campaigns that started immediately at creation.
"2025-09-25T19:00:00.000Z"
Maximum number of calls allowed to be active simultaneously in this campaign. Determines dialling throughput — higher values dial more contacts in parallel. Reflects the value set at creation or last updated via the update endpoint.
5
Agent assigned to handle all calls in this campaign. Contains the agent's ID, name, and current status. All contacts in the campaign's contact list will be called using this agent.
Show child attributes
Show child attributes
Caller phone number used to dial contacts in this campaign. This number appears as the caller ID on recipients' devices.
Show child attributes
Show child attributes
List of validation errors encountered when processing the campaign's contact CSV file. Present only when the upload contained rows with invalid phone numbers or missing required variables. Null or empty when the file was processed without errors.
List of validation errors encountered when processing the campaign's contact CSV file. Present only when the upload contained rows with invalid phone numbers or missing required variables. Null or empty when the file was processed without errors.
[
"Row 3: missing required variable 'customer_name'",
"Row 7: invalid phone number '+1234'"
]