Skip to main content
POST
Create initiative

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

Initiative name.

Required string length: 1 - 255
language
enum<string>
Available options:
en,
es,
pt
objective
string

What the initiative aims to learn.

Maximum string length: 2000
context
string

Background the conversation draws on.

Maximum string length: 5000
maxAttempts
integer

Outreach attempts per participant. Default 3.

Required range: 1 <= x <= 5
isRecurring
boolean

Recurring initiative: keeps processing newly added participants on a schedule instead of ending after one pass. Default false.

flagCondition
string | null

Natural-language condition; conversations matching it get flagged during analysis. Set null to clear.

Maximum string length: 500
identityDeflection
string | null

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

Maximum string length: 1000
channel
enum<string>
default:WHATSAPP

Default WHATSAPP.

Available options:
WHATSAPP,
EMAIL
guidingQuestions
object[]

The questions the conversation aims to answer.

Maximum array length: 50

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