Skip to main content
POST
Pause initiative

Authorizations

Authorization
string
header
required

Organization API key, sent as Authorization: Bearer boom_org_....

Path Parameters

id
string
required

The initiative id.

Minimum string length: 1

Response

Success

id
string
required

Initiative id.

name
string
required
channel
enum<string>
required

Which identifier this initiative reaches people by, derived from its journey: EMAIL when the journey only mails, WHATSAPP when anything phone-shaped sends. See sendChannels for what it actually sends on — this field cannot express SMS or the Meta DMs.

Available options:
WHATSAPP,
EMAIL
sendChannels
enum<string>[]
required

Every channel this initiative's journey sends on — the authoritative answer. Empty when it has no journey yet, in which case channel falls back to the value stored at creation.

Available options:
WHATSAPP,
EMAIL,
SMS,
INSTAGRAM,
FACEBOOK_MESSENGER
status
enum<string>
required
Available options:
DRAFT,
ACTIVE,
PAUSED,
COMPLETED,
CANCELED
language
string
required

Conversation language, e.g. es.

objective
string | null
required
isRecurring
boolean
required

Splits campaigns from initiatives (a Transactional is the third kind, see isTransactional): false is a campaign (one-time outreach, listed under Campaigns), true is an initiative (ongoing work, listed under Initiatives). A campaign auto-completes once its outreach run finishes; an initiative stays ACTIVE afterward, though no scheduled process currently re-triggers outreach for it.

isTransactional
boolean
required

True for a Transactional (one event, one message per channel; listed under Transactional).

flagCondition
string | null
required

Natural-language condition; matching conversations get flagged during analysis.

identityDeflection
string | null
required

Custom reply when a contact asks whether they are talking to a bot.

smartSendingMode
enum<string>
required

Smart Sending mode: DEFER, DROP or FORCE.

Available options:
DEFER,
DROP,
FORCE
createdAt
string
required

ISO 8601 timestamp.

updatedAt
string
required

ISO 8601 timestamp.

activatedAt
string | null
required
completedAt
string | null
required
canceledAt
string | null
required
pausedAt
string | null
required
context
string | null
required
maxAttempts
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
guidingQuestions
object[]
required