Create initiative
Create a draft initiative or campaign — only a name is required. isRecurring decides which: omit it or pass false for a campaign (one-time outreach, lives under Campaigns), true for an initiative (ongoing work, lives under Initiatives). No UI control changes this afterwards, so set it deliberately. For a WhatsApp send, link an approved template before launching.
Authorizations
Organization API key, sent as Authorization: Bearer boom_org_....
Body
Initiative name.
1 - 255en, es, pt What the initiative aims to learn.
2000Background the conversation draws on.
20000Outreach attempts per participant. Default 3.
1 <= x <= 5Which of the two sections owns this row, and the only thing that separates them: 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. No UI control changes this after creation. Default false.
Natural-language condition; conversations matching it get flagged during analysis. Set null to clear.
500Custom reply when a contact asks whether they are talking to a bot. Set null to clear.
1000The questions the conversation aims to answer. On update this is the complete set, not a patch: omit the field to leave the questions alone, and carry each existing question’s id through or it reads as a removal.
50Default WHATSAPP.
WHATSAPP, EMAIL Response
Success
Initiative id.
WHATSAPP, EMAIL DRAFT, ACTIVE, PAUSED, COMPLETED, CANCELED Conversation language, e.g. es.
Which of the two sections owns this row: 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.
Natural-language condition; matching conversations get flagged during analysis.
Custom reply when a contact asks whether they are talking to a bot.
ISO 8601 timestamp.
ISO 8601 timestamp.
-9007199254740991 <= x <= 9007199254740991