Skip to main content
GET
Get campaign by ID

Authorizations

Authorization
string
header
required

Token JWT de autenticação

Headers

x-company-id
string

Target company identifier. Required only for global API keys (type=global). Ignored for company API keys and human users.

Path Parameters

id
string
required

Campaign ID

Response

200 - application/json
_id
object
required
company
object
required
name
string
required
channel_type
object
required
trigger_type
enum<string>
required
Available options:
MANUAL,
SCHEDULED,
RECURRING,
EXTERNAL_TRIGGER
trigger_config
object
required
audience_config
object
required
status
enum<string>
required
Available options:
DRAFT,
ACTIVE,
PAUSED,
COMPLETED,
ARCHIVED
metrics
object
required
description
string
behavior_config
object
linkedin_config
object
sender_config
object
launched_at
string<date-time>

First actual send of this campaign (ISSUE-6074). Exists to give BUSINESS idempotency to the campaign_launched event: once per campaign, forever — neither event_id nor Bull's retry solve this, because the campaign runs thousands of times over its life.

Born ABSENT (no default) on purpose: the conditional update { launched_at: { $exists: false } } is what guarantees exactly-once, and a default null would break that condition.

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