> This is a page from the ElevenLabs documentation. For a complete page index, fetch https://elevenlabs.io/docs/llms.txt. For the full documentation in a single file, fetch https://elevenlabs.io/docs/llms-full.txt.

# Substituir a configuração da campanha de chamadas ativas

PUT https://api.elevenlabs.io/v1/convai/outbound-campaigns/config
Content-Type: application/json

Crie ou substitua a configuração de campanhas ativas do espaço de trabalho. Envie a última `version` lida como `expected_version` ou omita-a para criar a primeira configuração. Uma configuração alterada desde a sua leitura não será substituída. As campanhas mantêm a política com a qual foram iniciadas.

Reference: https://elevenlabs.io/docs/api-reference/campaigns/config/update

## Servers

- `https://api.elevenlabs.io` (Production, default)
- `https://api.us.elevenlabs.io` (Production US)
- `https://api.eu.residency.elevenlabs.io` (Production EU)
- `https://api.in.residency.elevenlabs.io` (Production India)
- `https://api.sg.residency.elevenlabs.io` (Production Singapore)

## Request

### Body (application/json)

This endpoint expects a ReplaceWorkspaceConfigRequest.

- `config` (CampaignConfig-Input, required)
- `expected_version` (integer, optional, nullable) — A `version` da configuração que está sendo substituída. Omita-a somente para criar a primeira configuração.

## Response

### 200

Resposta bem-sucedida

- `version` (integer, required) — Aumenta a cada substituição; envie-o como `expected_version`.
- `config` (CampaignConfig-Output, required)

## Errors

### 422 Unprocessable Entity Error

Erro de validação

- `detail` (list of ValidationError, optional)

## Types

### CampaignConfig-Input

- `policy` (PolicyConfig-Input, optional) — A política usada pelas campanhas, a menos que definam a própria.
- `agent_policies` (map from string to AgentPolicyOverride-Input, optional) — Substituições de `policy`, indexadas por ID de agente.
- `whatsapp_voice_policy` (AgentPolicyOverride-Input, optional, nullable) — Substituições para campanhas de voz no WhatsApp, aplicadas entre a política do espaço de trabalho e as substituições de um agente. As seções omitidas seguem os padrões integrados da voz do WhatsApp.

### CampaignConfig-Output

- `policy` (PolicyConfig-Output, optional) — A política usada pelas campanhas, a menos que definam a própria.
- `agent_policies` (map from string to AgentPolicyOverride-Output, optional) — Substituições de `policy`, indexadas por ID de agente.
- `whatsapp_voice_policy` (AgentPolicyOverride-Output, optional, nullable) — Substituições para campanhas de voz no WhatsApp, aplicadas entre a política do espaço de trabalho e as substituições de um agente. As seções omitidas seguem os padrões integrados da voz do WhatsApp.

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)

### PolicyConfig-Input

- `timezone` (string, optional, default: UTC) — Fuso horário IANA no qual os períodos de chamada são interpretados.
- `retry` (RetryPolicy, optional)
- `calling_periods` (list of CallingPeriod, optional) — As janelas semanais em que as chamadas podem ser feitas.
- `data_collection` (DataCollectionConfig, optional) — Os itens de coleta de dados do agente que orientam chamadas de acompanhamento. Cada um usa por padrão o item integrado para sua finalidade; `null` o desativa.
- `followup_context` (FollowupContextPolicy, optional) — Quais variáveis dinâmicas `campaign__` as chamadas de acompanhamento recebem.

### AgentPolicyOverride-Input

Cada seção definida aqui substitui toda a seção correspondente da política.

- `timezone` (string, optional, nullable)
- `retry` (RetryPolicy, optional, nullable)
- `calling_periods` (list of CallingPeriod, optional, nullable)
- `data_collection` (DataCollectionConfig, optional, nullable) — Os itens de coleta de dados do agente que orientam chamadas de acompanhamento. Cada um usa por padrão o item integrado para sua finalidade; `null` o desativa.
- `followup_context` (FollowupContextPolicy, optional, nullable) — Quais variáveis dinâmicas `campaign__` as chamadas de acompanhamento recebem.

### PolicyConfig-Output

- `timezone` (string, optional, default: UTC) — Fuso horário IANA no qual os períodos de chamada são interpretados.
- `retry` (RetryPolicy, optional)
- `calling_periods` (list of CallingPeriod, optional) — As janelas semanais em que as chamadas podem ser feitas.
- `data_collection` (DataCollectionConfig, optional) — Os itens de coleta de dados do agente que orientam chamadas de acompanhamento. Cada um usa por padrão o item integrado para sua finalidade; `null` o desativa.
- `followup_context` (FollowupContextPolicy, optional) — Quais variáveis dinâmicas `campaign__` as chamadas de acompanhamento recebem.

### AgentPolicyOverride-Output

Cada seção definida aqui substitui toda a seção correspondente da política.

- `timezone` (string, optional, nullable)
- `retry` (RetryPolicy, optional, nullable)
- `calling_periods` (list of CallingPeriod, optional, nullable)
- `data_collection` (DataCollectionConfig, optional, nullable) — Os itens de coleta de dados do agente que orientam chamadas de acompanhamento. Cada um usa por padrão o item integrado para sua finalidade; `null` o desativa.
- `followup_context` (FollowupContextPolicy, optional, nullable) — Quais variáveis dinâmicas `campaign__` as chamadas de acompanhamento recebem.

### ValidationErrorLocItems

- string
- integer

### RetryPolicy

- `retry_delay_seconds` (integer, optional, default: 600) — Quanto tempo aguardar antes de uma nova tentativa curta.
- `max_short_retries` (integer, optional, default: 1) — Novas tentativas permitidas por uma janela de chamada após uma chamada com falha. Quando esgotadas, a próxima tentativa aguarda a janela seguinte, que começa do zero.
- `max_total_calls` (integer, optional, default: 6) — O número máximo de chamadas que um lead recebe, incluindo a primeira.
- `max_callbacks` (integer, optional, default: 2) — O número máximo de retornos de chamada a atender para um número.
- `max_redirects` (integer, optional, default: 2) — O número máximo de vezes que um lead atende a uma solicitação para ligar para outro número.
- `interval_placement` (enum, optional, default: start) — Em que ponto de uma janela de chamadas posterior uma chamada adiada será realizada: no `start`, em um horário `random` ou com `rotate` de `rotate_step_seconds` após o ponto em que a última chamada nessa janela falhou.
  - Allowed values: `start`, `random`, `rotate`
- `rotate_step_seconds` (integer, optional, default: 900) — Quanto o posicionamento `rotate` desloca cada chamada. Usado somente por `rotate`.
- `max_consecutive_failures_per_number` (integer, optional, nullable) — Quantidade de chamadas consecutivas para um número que podem falhar antes de o lead passar para o próximo número listado ou encerrar, caso não haja outro. Uma chamada atendida ou um redirecionamento para um novo número reinicia a contagem. Se não for definido, apenas `max_total_calls` será aplicado.

### CallingPeriod

- `weekdays` (list of integer, required) — Dias aos quais os intervalos se aplicam, de `0` (segunda-feira) a `6` (domingo).
- `intervals` (list of CallingIntervalPolicy, required) — Janelas em cada um desses dias. Elas não podem se sobrepor em nenhum dia.

### DataCollectionConfig

Os itens de coleta de dados do agente que orientam chamadas de acompanhamento. Cada um usa por padrão o item integrado para sua finalidade; `null` o desativa.

- `callback_time` (string, optional, nullable, default: __system_data_collection_callback_time) — O item que contém quando o contato pediu para receber um retorno de chamada.
- `redirect_phone_number` (string, optional, nullable, default: __system_data_collection_redirect_phone_number) — O item que contém outro número para o qual o contato pediu que ligássemos.
- `stop` (string, optional, nullable, default: __system_data_collection_do_not_call) — O item que é verdadeiro quando o contato pede para não receber novas chamadas.
- `mappings` (map from string to string, optional) — Copia os resultados da coleta de dados para variáveis dinâmicas usadas em chamadas posteriores: cada chave é um ID de item de coleta de dados e seu valor é o nome da variável.

### FollowupContextPolicy

Quais variáveis dinâmicas `campaign__` as chamadas de acompanhamento recebem.

- `call_type` (boolean, optional, default: true) — Passe o tipo de chamada como `campaign__call_type`.
- `previous_conversation_id` (boolean, optional, default: true) — Passe o ID da última conversa como `campaign__previous_conversation_id`.
- `previous_summary` (boolean, optional, default: true) — Passe o resumo da última conversa como `campaign__previous_summary`.
- `previous_transcript` (boolean, optional, default: true) — Passe a transcrição da última conversa como `campaign__previous_transcript`.

### CallingIntervalPolicy

- `start` (string, required) — Horário local de início, como `HH:MM`.
- `end` (string, required) — Horário local de término, como `HH:MM`; `24:00` termina à meia-noite.

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "version": 1,
  "config": {
    "policy": {
      "timezone": "UTC",
      "retry": {
        "retry_delay_seconds": 600,
        "max_short_retries": 1,
        "max_total_calls": 6,
        "max_callbacks": 2,
        "max_redirects": 2,
        "interval_placement": "start",
        "rotate_step_seconds": 900,
        "max_consecutive_failures_per_number": 1
      },
      "calling_periods": [
        {
          "weekdays": [
            1
          ],
          "intervals": [
            {
              "start": "string",
              "end": "string"
            }
          ]
        }
      ],
      "data_collection": {
        "callback_time": "string",
        "redirect_phone_number": "string",
        "stop": "string",
        "mappings": {}
      },
      "followup_context": {
        "call_type": true,
        "previous_conversation_id": true,
        "previous_summary": true,
        "previous_transcript": true
      }
    },
    "agent_policies": {},
    "whatsapp_voice_policy": {
      "timezone": "string",
      "retry": {
        "retry_delay_seconds": 600,
        "max_short_retries": 1,
        "max_total_calls": 6,
        "max_callbacks": 2,
        "max_redirects": 2,
        "interval_placement": "start",
        "rotate_step_seconds": 900,
        "max_consecutive_failures_per_number": 1
      },
      "calling_periods": [
        {
          "weekdays": [
            1
          ],
          "intervals": [
            {
              "start": "string",
              "end": "string"
            }
          ]
        }
      ],
      "data_collection": {
        "callback_time": "string",
        "redirect_phone_number": "string",
        "stop": "string",
        "mappings": {}
      },
      "followup_context": {
        "call_type": true,
        "previous_conversation_id": true,
        "previous_summary": true,
        "previous_transcript": true
      }
    }
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/convai/outbound-campaigns/config"

payload = {}
headers = {"Content-Type": "application/json"}

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

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/outbound-campaigns/config';
const options = {method: 'PUT', headers: {'Content-Type': 'application/json'}, body: '{}'};

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.elevenlabs.io/v1/convai/outbound-campaigns/config"

	payload := strings.NewReader("{}")

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

	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.elevenlabs.io/v1/convai/outbound-campaigns/config")

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"

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.elevenlabs.io/v1/convai/outbound-campaigns/config")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.elevenlabs.io/v1/convai/outbound-campaigns/config', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/outbound-campaigns/config");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/outbound-campaigns/config")! 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()
```