Skip to main content
POST
Archive 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
Available options:
WHATSAPP,
EMAIL
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

Whether the initiative keeps processing newly added participants on a schedule.

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.

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