Skip to main content
PUT

Atualizar Campanha

Atualiza parcialmente uma campanha existente. Todos os campos são opcionais — apenas os campos que você enviar serão atualizados. Use Atualizar Status da Campanha para alterar apenas o status (draft → active → paused → completed).

Endpoint

Parâmetros de caminho

string
obrigatório
UUID da campanha a ser atualizada.

Cabeçalhos da requisição

string
obrigatório
Token Bearer para autenticação. Formato: Bearer talq_your_environment_token_here
string
obrigatório
Deve ser definido como application/json

Corpo da requisição

Todos os campos são opcionais. Envie apenas o que você quer alterar. As regras de validação e faixas correspondem a Criar Campanha.

Identificação

string
Nome da campanha. Máximo de 255 caracteres.
string
Descrição livre.
string
Categoria da campanha. Opções: sales, follow_up, reminder, custom.
string
UUID do agente. Deve existir em seu ambiente.

Agendamento

string
Formato: YYYY-MM-DD.
string
Data de término opcional. Deve ser após start_date. Formato: YYYY-MM-DD. Envie null para limpar.
array
Array de números de dias da semana (17, onde 1 = Segunda-feira). Mínimo de 1 entrada.
array
Janelas de horário. Array de objetos {start: "HH:MM", end: "HH:MM"} (formato 24h). Mínimo de 1 entrada. O end de cada janela deve ser após seu start.
string
Fuso horário IANA (ex: America/Sao_Paulo). Máximo de 50 caracteres.

Retry e Cooldown

integer
Atraso inicial em segundos. Faixa: 0+.
integer
Faixa: 010.
integer
Faixa: 1168.
boolean
Auto-transição para completed quando todos os contatos forem processados.
boolean
Retenta chamadas que foram completadas sem conversão.
boolean
integer
Faixa: 1168.
integer
Faixa: 1168.
integer
Faixa: 1168.
integer
Faixa: 1168.
integer
Faixa: 1168.
integer
Faixa: 1168.

Do-Not-Call (DNC)

boolean
string
Opções: environment, global, custom.
array
Array de números de telefone (E.164). Usado quando do_not_call_list_source é custom.
boolean
array
array

Exemplos

Resposta

Resposta de Sucesso (200 OK)

Respostas de erro

422 Erro de Validação

404 Não Encontrada

409 Conflict — Chamadas Ativas

Observações

  • Use PATCH /v1/campaigns/{id}/status para alterar o status — é um endpoint separado com sua própria validação.
  • Atualizar call_time_ranges ou timezone enquanto a campanha está active pode atrasar chamadas enfileiradas até que elas voltem a se encaixar nas novas janelas.
  • Enviar "end_date": null limpa uma data de término previamente definida.

Endpoints relacionados