> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.youratlas.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.youratlas.com/_mcp/server.

# Update full campaign

PUT https://api.youratlas.com/v1/api/campaign/{id}/all
Content-Type: application/json

Update campaign with all associated data

Reference: https://docs.youratlas.com/api-reference/atlas-api/campaigns/update-full-campaign

## Authentication

- `api-key` header (required) — Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

## Request

### Path parameters

- `id` (string, required) — The campaign ID

### Body (application/json)

This endpoint expects an UpdateFullCampaignBody.

- `campaign` (CampaignBody, required)
- `agent` (AgentBody, optional)

## Response

### 200

Campaign updated

- `PartitionKey` (string, optional)
- `RowKey` (string, optional)
- `Timestamp` (datetime, optional)
- `odata.etag` (string, optional)
- `name` (string, optional)
- `campaignType` (string, optional)
- `Mode` (boolean, optional)
- `BusinessName` (string, optional)
- `CallType` (string, optional)
- `CompanyName` (string, optional)
- `FirstMessage` (string, optional)
- `IsActive` (boolean, optional)
- `PhoneNumberId` (string, optional)
- `Position` (string, optional)
- `ScriptBase` (string, optional)
- `ScriptNotes` (string, optional)
- `StartDate` (datetime, optional)
- `TimeWindows` (string, optional) — JSON-encoded array of time-window objects. Each object contains startHour (0–23), startMinute (0–59), endHour (0–23), and endMinute (0–59).
- `SuccessRequest` (integer, optional)
- `TemplateId` (string, optional)
- `TotalRequest` (integer, optional)
- `TotalTransfers` (integer, optional)
- `DailyCallLimit` (integer, optional)
- `KnowledgeBaseId` (string, optional)
- `KnowledgeBaseDataSetId` (string, optional) — Knowledge base dataset identifier
- `FeatureAppendPreviousSummaryEnabled` (boolean, optional)
- `PhoneNumberProvider` (string, optional)
- `FeatureRescheduleCallEnabled` (boolean, optional)
- `EnrichmentInfoSettings` (string, optional)
- `EnrichmentInfoProvider` (string, optional)
- `FeatureEnrichmentInfoEnabled` (boolean, optional)
- `EndCallMessage` (string, optional)
- `VoicemailMessage` (string, optional)
- `AnalysisPlanSummaryPrompt` (string, optional)
- `AnalysisPlanSuccessEvaluationPrompt` (string, optional)
- `AnalysisPlanStructuredDataPrompt` (string, optional)
- `FeatureEndCallWhenVoicemail` (boolean, optional)
- `VoicemailDropMechanism` (enum, optional) — Voicemail drop strategy. `audio-detection` detects voicemail via audio analysis and drops a pre-recorded message. `ringless` delivers a voicemail without ringing the recipient's phone.
  - Allowed values: `audio-detection`, `ringless`
- `FeatureRedialOnNoResponse` (boolean, optional)
- `RedialSettings` (string, optional) — JSON string of redial attempt configuration
- `FeatureDoubleCall` (boolean, optional)
- `Timezone` (string, optional)
- `TimezoneFriendlyName` (string, optional)
- `Status` (enum, optional)
  - Allowed values: `archived`, `active`, `draft`
- `Collection` (string, optional)
- `IdleMessages` (string, optional)
- `ToolIds` (string, optional)
- `SMSTrigger` (string, optional)
- `SMSBody` (string, optional)
- `ForwardingPhoneNumber` (string, optional)
- `PreScript` (string, optional)
- `PostScript` (string, optional)
- `FirstMessageMode` (enum, optional)
  - Allowed values: `assistant-speaks-first`, `assistant-waits-for-user`, `assistant-speaks-first-with-model-generated-message`
- `ChatPhoneNumberId` (string, optional)
- `IsOutboundChatActive` (boolean, optional)
- `ChatReplyPacingEnabled` (boolean, optional) — Whether AI chat reply pacing is enabled. When true, reply bubbles are sent with a typing indicator and a short delay, making conversations feel more natural. Messages campaigns only.
- `ChatReplyPacingSeconds` (integer, optional) — Fixed per-bubble typing duration in seconds (1–60). When absent or 0 the duration is auto-calculated based on message length. Messages campaigns only.
- `AIAssistantProvider` (enum, optional, nullable) — AI assistant runtime powering this campaign. Returns "atlas" when the campaign uses the Atlas runtime, or null otherwise.
  - Allowed values: `atlas`
- `TotalBooked` (double, optional)
- `AtlasKnowledgeBaseId` (string, optional)
- `MarketplaceAgentId` (string, optional)
- `AgentType` (string, optional)
- `language` (string, optional)
- `voiceId` (string, optional)

## Errors

### 400 Bad Request Error

Bad request

- `error` (ErrorError, optional)

### 404 Not Found Error

Resource not found

- `error` (ErrorError, optional)

### 500 Internal Server Error

Internal server error

- `error` (ErrorError, optional)

## Types

### CampaignBody

- `name` (string, required) — Required. Human-readable campaign name.
- `campaignType` (enum, required) — Required. Channel family. `"1"` = phone (inbound or outbound — set direction with `CallType`). `"0"` = non-phone (voice bubble or Messages/SMS — distinguished by `MessagesCampaign`).
  - Allowed values: `0`, `1`
- `TemplateId` (string, required) — Required. ID of a starter template. See the catalog tables in the `Create campaign` endpoint description — pick the row matching the user's language and the campaign channel (`outbound`, `inbound`, `web` for voice bubble, `messages` for SMS) and pass its Template ID here.
- `CallType` (enum, optional) — Required when `campaignType` is `"1"`, omit otherwise. Phone direction: `"1"` = inbound, `"2"` = outbound.
  - Allowed values: `1`, `2`
- `MessagesCampaign` (boolean, optional) — Optional. Set `true` (with `campaignType: "0"`) to create a Messages/SMS campaign. Omit for voice bubble.
- `Position` (enum, optional) — Required for voice bubble (`campaignType: "0"` with `MessagesCampaign` omitted). Voice bubble position on the host page. Omit for phone and Messages campaigns.
  - Allowed values: `bottom-right`, `bottom-left`, `bottom-center`, `not-positioned`
- `CompanyName` (string, optional) — Optional. Injected as \{\{companyName}} in the script.
- `BusinessName` (string, optional) — Optional. Display name shown to callers/visitors.
- `IsActive` (boolean, optional) — Optional. Whether the campaign is enabled at creation.
- `Mode` (boolean, optional) — Optional.
- `StartDate` (datetime, optional) — Optional. Outbound-only — first date the agent may begin dialing. Ignored for inbound, voice bubble, and Messages campaigns.
- `TimeWindows` (string, optional) — Optional. Outbound-only. JSON-encoded array of time-window objects. Each object must contain startHour (0–23), startMinute (0–59), endHour (0–23), and endMinute (0–59). Example: \[\{"startHour":9,"startMinute":0,"endHour":17,"endMinute":0}]. Ignored for inbound, voice bubble, and Messages campaigns.
- `FirstMessage` (string, optional) — Optional. Greeting the agent speaks at the start of every call.
- `PreScript` (string, optional) — Optional. Prepended to the agent prompt.
- `PostScript` (string, optional) — Optional. Appended to the agent prompt.
- `ScriptBase` (string, optional) — Optional. The agent's conversation script.
- `ScriptNotes` (string, optional) — Optional. Additional script guidance.
- `FeatureRescheduleCallEnabled` (boolean, optional) — Optional. Outbound-only — allow agent to reschedule calls.
- `FeatureEnrichmentInfoEnabled` (boolean, optional) — Optional. Toggle caller-info enrichment.
- `FeatureAppendPreviousSummaryEnabled` (boolean, optional) — Optional. Inbound-only — append previous call summary to context.
- `EnrichmentInfoProvider` (enum, optional) — Optional. Provider used for caller enrichment.
  - Allowed values: `custom`, `shopify`, `ghl`, `monday`, `hubspot`
- `EnrichmentInfoSettings` (string, optional) — Optional. JSON string of enrichment settings.
- `Timezone` (string, optional) — Optional. IANA timezone, e.g. `America/New_York`.
- `TimezoneFriendlyName` (string, optional) — Optional. Human-readable timezone label.
- `Status` (enum, optional) — Optional. Lifecycle state.
  - Allowed values: `archived`, `active`, `draft`
- `Collection` (string, optional) — Optional. Collection/group identifier.
- `ToolIds` (string, optional) — Optional. Comma-separated tool IDs.
- `SMSTrigger` (string, optional) — Optional. Trigger phrase that fires an SMS during a call.
- `SMSBody` (string, optional) — Optional. SMS body associated with the trigger.
- `FirstMessageMode` (enum, optional) — Optional. Who speaks first at call start.
  - Allowed values: `assistant-speaks-first`, `assistant-waits-for-user`, `assistant-speaks-first-with-model-generated-message`
- `EndCallMessage` (string, optional) — Optional. Message the agent says before hanging up.
- `VoicemailMessage` (string, optional) — Optional. Message left on voicemail.
- `AnalysisPlanSummaryPrompt` (string, optional) — Optional. Prompt used to summarize calls for analysis.
- `AnalysisPlanSuccessEvaluationPrompt` (string, optional) — Optional. Prompt used to evaluate whether the call achieved its goal.
- `AnalysisPlanStructuredDataPrompt` (string, optional) — Optional. Prompt used to extract structured data from calls.
- `FeatureEndCallWhenVoicemail` (boolean, optional) — Optional. End the call when voicemail is detected.
- `VoicemailDropMechanism` (enum, optional) — Optional. Voicemail drop strategy. `audio-detection` detects voicemail via audio analysis and drops a pre-recorded message. `ringless` delivers a voicemail without ringing the recipient's phone.
  - Allowed values: `audio-detection`, `ringless`
- `FeatureRedialOnNoResponse` (boolean, optional) — Optional. Retry call when there's no answer.
- `RedialSettings` (string, optional) — Optional. JSON string of redial settings.
- `FeatureDoubleCall` (boolean, optional) — Optional. Place two concurrent attempts.
- `DailyCallLimit` (integer, optional) — Optional. Maximum calls per day.
- `IdleMessages` (string, optional) — Optional. JSON string of idle messages.
- `IsOutboundChatActive` (boolean, optional) — Optional. Whether outbound chat is enabled.
- `ChatReplyPacingEnabled` (boolean, optional) — Optional. Messages campaigns only. When true, AI chat reply bubbles are paced with a typing indicator and a short delay before each send, making conversations feel more natural.
- `ChatReplyPacingSeconds` (integer, optional) — Optional. Messages campaigns only. Fixed per-bubble typing duration in seconds (1–60). When absent or 0 the duration is auto-calculated based on message length.

### AgentBody

- `Name` (string, required)
- `Language` (string, required)
- `VoiceId` (string, required)
- `AgentTypeName` (string, optional)
- `PreScript` (string, optional)
- `PostScript` (string, optional)
- `AtlasVoiceId` (string, optional)
- `Model` (string, optional)
- `Provider` (enum, optional)
  - Allowed values: `11labs`, `cartesia`, `deepgram`, `internal`, `minimax`
- `Stability` (double, optional)
- `SimilarityBoost` (double, optional)
- `BackgroundSound` (string, optional)
- `Pitch` (double, optional) — Request-only — accepted on create/update but not returned in GET responses.
- `Speed` (double, optional)
- `Region` (string, optional) — Request-only — accepted on create/update but not returned in GET responses.
- `Volume` (double, optional) — Request-only — accepted on create/update but not returned in GET responses.
- `LanguageBoost` (string, optional) — Request-only — accepted on create/update but not returned in GET responses.
- `FillerInjectionEnabled` (boolean, optional) — Request-only — accepted on create/update but not returned in GET responses.
- `TextNormalizationEnabled` (boolean, optional) — Request-only — accepted on create/update but not returned in GET responses.

### ErrorError

- `message` (string, optional)
- `code` (string, optional)
- `requestId` (string, optional)

## Examples

**Request**

```json
{
  "campaign": {
    "name": "string",
    "campaignType": "0",
    "TemplateId": "string"
  }
}
```

**Response**

```json
{
  "PartitionKey": "string",
  "RowKey": "string",
  "Timestamp": "2024-01-15T09:30:00Z",
  "odata.etag": "string",
  "name": "string",
  "campaignType": "string",
  "Mode": true,
  "BusinessName": "string",
  "CallType": "string",
  "CompanyName": "string",
  "FirstMessage": "string",
  "IsActive": true,
  "PhoneNumberId": "string",
  "Position": "string",
  "ScriptBase": "string",
  "ScriptNotes": "string",
  "StartDate": "2024-01-15T09:30:00Z",
  "TimeWindows": "string",
  "SuccessRequest": 1,
  "TemplateId": "string",
  "TotalRequest": 1,
  "TotalTransfers": 1,
  "DailyCallLimit": 1,
  "KnowledgeBaseId": "string",
  "KnowledgeBaseDataSetId": "string",
  "FeatureAppendPreviousSummaryEnabled": true,
  "PhoneNumberProvider": "string",
  "FeatureRescheduleCallEnabled": true,
  "EnrichmentInfoSettings": "string",
  "EnrichmentInfoProvider": "string",
  "FeatureEnrichmentInfoEnabled": true,
  "EndCallMessage": "string",
  "VoicemailMessage": "string",
  "AnalysisPlanSummaryPrompt": "string",
  "AnalysisPlanSuccessEvaluationPrompt": "string",
  "AnalysisPlanStructuredDataPrompt": "string",
  "FeatureEndCallWhenVoicemail": true,
  "VoicemailDropMechanism": "audio-detection",
  "FeatureRedialOnNoResponse": true,
  "RedialSettings": "string",
  "FeatureDoubleCall": true,
  "Timezone": "string",
  "TimezoneFriendlyName": "string",
  "Status": "archived",
  "Collection": "string",
  "IdleMessages": "string",
  "ToolIds": "string",
  "SMSTrigger": "string",
  "SMSBody": "string",
  "ForwardingPhoneNumber": "string",
  "PreScript": "string",
  "PostScript": "string",
  "FirstMessageMode": "assistant-speaks-first",
  "ChatPhoneNumberId": "string",
  "IsOutboundChatActive": true,
  "ChatReplyPacingEnabled": true,
  "ChatReplyPacingSeconds": 1,
  "AIAssistantProvider": "atlas",
  "TotalBooked": 1.1,
  "AtlasKnowledgeBaseId": "string",
  "MarketplaceAgentId": "string",
  "AgentType": "string",
  "language": "string",
  "voiceId": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.youratlas.com/v1/api/campaign/id/all"

payload = { "campaign": {
        "name": "string",
        "campaignType": "0",
        "TemplateId": "string"
    } }
headers = {
    "api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.youratlas.com/v1/api/campaign/id/all';
const options = {
  method: 'PUT',
  headers: {'api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"campaign":{"name":"string","campaignType":"0","TemplateId":"string"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.youratlas.com/v1/api/campaign/id/all"

	payload := strings.NewReader("{\n  \"campaign\": {\n    \"name\": \"string\",\n    \"campaignType\": \"0\",\n    \"TemplateId\": \"string\"\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.youratlas.com/v1/api/campaign/id/all")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"campaign\": {\n    \"name\": \"string\",\n    \"campaignType\": \"0\",\n    \"TemplateId\": \"string\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.youratlas.com/v1/api/campaign/id/all")
  .header("api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"campaign\": {\n    \"name\": \"string\",\n    \"campaignType\": \"0\",\n    \"TemplateId\": \"string\"\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.youratlas.com/v1/api/campaign/id/all', [
  'body' => '{
  "campaign": {
    "name": "string",
    "campaignType": "0",
    "TemplateId": "string"
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.youratlas.com/v1/api/campaign/id/all");
var request = new RestRequest(Method.PUT);
request.AddHeader("api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"campaign\": {\n    \"name\": \"string\",\n    \"campaignType\": \"0\",\n    \"TemplateId\": \"string\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["campaign": [
    "name": "string",
    "campaignType": "0",
    "TemplateId": "string"
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.youratlas.com/v1/api/campaign/id/all")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```