Pular para o conteúdo principal
GET
Buscar campanha por ID

Autorizações

Authorization
string
header
obrigatório

Token JWT de autenticação

Cabeçalhos

x-company-id
string

Identificador da empresa-alvo. Obrigatório apenas para API Keys globais (type=global). Ignorado para API Keys de empresa e usuários humanos.

Parâmetros de caminho

id
string
obrigatório

ID da campanha

Resposta

200 - application/json
_id
object
obrigatório
company
object
obrigatório
name
string
obrigatório
channel_type
object
obrigatório
trigger_type
enum<string>
obrigatório
Opções disponíveis:
MANUAL,
SCHEDULED,
RECURRING,
EXTERNAL_TRIGGER
trigger_config
object
obrigatório
audience_config
object
obrigatório
status
enum<string>
obrigatório
Opções disponíveis:
DRAFT,
ACTIVE,
PAUSED,
COMPLETED,
ARCHIVED
metrics
object
obrigatório
description
string
behavior_config
object
linkedin_config
object
sender_config
object
voice_config
object
exclusion_lists
object[]

ISSUE-5620: listas de exclusão, verificadas antes de CADA envio com o conteúdo da lista naquela hora. Só muda enquanto a campanha é rascunho.

launched_at
string<date-time>

Data do primeiro envio real desta campanha. Ausente enquanto nenhuma mensagem saiu; gravada uma única vez e nunca reescrita.

launch_snapshot
object
last_execution_at
string<date-time>
createdAt
string<date-time>
updatedAt
string<date-time>