Saltar al contenido principal
GET
Consultar campaña por ID

Autorizaciones

Authorization
string
header
requerido

Token JWT de autenticación

Encabezados

x-company-id
string

Identificador de la empresa objetivo. Obligatorio solo para API keys globales (type=global). Se ignora para API keys de empresa y usuarios humanos.

Parámetros de ruta

id
string
requerido

ID de la campaña

Respuesta

200 - application/json
_id
object
requerido
company
object
requerido
name
string
requerido
channel_type
object
requerido
trigger_type
enum<string>
requerido
Opciones disponibles:
MANUAL,
SCHEDULED,
RECURRING,
EXTERNAL_TRIGGER
trigger_config
object
requerido
audience_config
object
requerido
status
enum<string>
requerido
Opciones disponibles:
DRAFT,
ACTIVE,
PAUSED,
COMPLETED,
ARCHIVED
metrics
object
requerido
description
string
behavior_config
object
linkedin_config
object
sender_config
object
exclusion_lists
object[]

Listas de exclusión, verificadas antes de CADA envío con el contenido de la lista en ese momento. Solo cambian mientras la campaña es un borrador.

launched_at
string<date-time>

Fecha del primer envío real de esta campaña. Ausente mientras no haya salido ningún mensaje. Se escribe una sola vez y nunca se reescribe.

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