Boom Ai Initiatives API
The Initiatives API from Boom Ai — 14 operation(s) for initiatives.
Operations 23
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“Which initiatives does my organization have running right now?”
“Can I list only the active initiatives and leave out the drafts?”
Tell an agent
List my initiatives, newest first.
Show me every initiative with status {status}.
Ask an LLM
“How do I start a new WhatsApp outreach initiative in Boom?”
“What is the minimum I need to create a draft initiative — just a name?”
Tell an agent
Create a draft initiative called {name}.
Create a new initiative named {name} whose objective is {objective}, asking {guidingQuestions}.
Ask an LLM
“What is the current status and objective of a specific initiative?”
“Can I look up one initiative by its id to see how it is configured?”
Tell an agent
Show me initiative {id}.
Pull up the settings of initiative {id}.
Ask an LLM
“Can I change the objective or guiding context of an initiative that is still a draft?”
“Why can't I edit an initiative after it has launched?”
Tell an agent
Rename draft initiative {id} to {name}.
Change the flag condition on draft initiative {id} to {flagCondition}.
Ask an LLM
“How do I hide a completed initiative from my initiatives list?”
“Can I archive an initiative that was canceled?”
Tell an agent
Archive initiative {id}.
Move completed initiative {id} out of the default list by archiving it.
Ask an LLM
“How do I permanently cancel an initiative and stop all its conversations?”
“Is canceling an initiative reversible, and who is allowed to do it?”
Tell an agent destructive · confirm first
Cancel initiative {id} and stop every conversation it is running.
Terminate initiative {id} permanently.
Ask an LLM
“How many participants does an initiative have, and how well is each captured variable covered?”
“What does the rollup of answers look like across an initiative?”
Tell an agent
Summarize the captured data for initiative {id}.
Give me participant count and per-variable coverage for initiative {id}.
GET
/api/v1/initiatives/{id}/extraction-schema
Read an initiative's extraction schema · Get extraction schema
#
Ask an LLM
“Which typed fields is an initiative currently pulling out of each conversation?”
“Does this initiative have an extraction schema configured at all?”
Tell an agent
Show me the extraction schema for initiative {id}.
Fetch the current extraction fields of initiative {id} so I can edit them.
POST
/api/v1/initiatives/{id}/extraction-schema
Replace an initiative's extraction schema · Set extraction schema
#
Ask an LLM
“How do I define which yes/no, number or choice answers get extracted from conversations?”
“Do I send only the changed fields or the whole extraction schema when replacing it?”
Tell an agent
Set the extraction schema of initiative {id} to {schema}.
Replace initiative {id}'s extraction fields with {schema} and note {notes} on the new version.
Ask an LLM
“What has to be in place before a WhatsApp initiative can go live?”
“Does launching an initiative start messaging people straight away?”
Tell an agent
Launch initiative {id} and start outreach.
Take draft initiative {id} live.
Ask an LLM
“Who has been enrolled in an initiative and what did Boom capture from each of them?”
“Can I find every run a particular person has had in an initiative, including the live one?”
Tell an agent
List the participants of initiative {id}.
Find the runs for person {personExternalId} in initiative {id}.
POST
/api/v1/initiatives/{id}/participants
Enroll people in a WhatsApp initiative · Add participants
#
Ask an LLM
“How do I add contacts to an active initiative so they get the WhatsApp outreach?”
“Will people on the do-not-contact list be messaged if I add them to an initiative?”
Tell an agent
Add {people} to initiative {id} and start messaging them.
Enroll these contacts in active initiative {id}: {people}.
GET
/api/v1/initiatives/{id}/participants/{participantId}
Get one participant's status and answers · Get participant
#
Ask an LLM
“What status is a single participant in, and what answers have they given so far?”
“Can I check one person's captured answers without pulling the whole participant list?”
Tell an agent
Show participant {participantId} in initiative {id}.
Get the captured answers for participant {participantId} of initiative {id}.
GET
/api/v1/initiatives/{id}/participants/{participantId}/messages
Read a participant's conversation transcript · Participant messages
#
Ask an LLM
“Did this person ever reply to us, in any initiative?”
“Where can I read the full WhatsApp back-and-forth with one participant?”
Tell an agent
Show me the messages exchanged with participant {participantId} in initiative {id}.
Get everything participant {participantId} of initiative {id} has said to us, using scope {scope}.
GET
/api/v1/initiatives/{id}/participants/{participantId}/steps
Trace a participant's journey run steps · Participant run steps
#
Ask an LLM
“Which journey nodes ran for a participant and what signal did each one emit?”
“Why did a participant's journey run stop or error at a certain node?”
Tell an agent
Show the node-by-node run timeline for participant {participantId} in initiative {id}.
List the last {limit} journey steps for participant {participantId} of initiative {id}.
POST
/api/v1/initiatives/{id}/participants/{participantId}/stop
Stop messaging one participant · Stop participant
#
Ask an LLM
“How do I stop all messages to one person and close their conversation?”
“If I stop a participant, do I lose their answers and transcript?”
Tell an agent destructive · confirm first
Stop messaging participant {participantId} in initiative {id}.
Close the conversation with participant {participantId} of initiative {id}.
Ask an LLM
“Can I stop new people from being enrolled while ongoing conversations keep going?”
“What happens to people already enrolled when an initiative is paused?”
Tell an agent
Pause initiative {id}.
Stop enrolling new people into initiative {id} for now.
POST
/api/v1/initiatives/{id}/reextract
Re-run extraction over past conversations · Re-extract conversations
#
Ask an LLM
“How do I pull answers out of conversations that happened before I wrote the extraction schema?”
“Can I see how many conversations would be re-extracted before spending anything?”
Tell an agent
Re-extract the conversations of initiative {id}.
Do a dry run of re-extraction on initiative {id} and tell me the counts.
Ask an LLM
“How do I get a paused initiative enrolling people again?”
“Can a paused initiative be restarted?”
Tell an agent
Resume initiative {id}.
Start enrolling people into paused initiative {id} again.
GET
/api/v1/initiatives/{id}/templates
See which templates each outreach round sends · Get templates
#
Ask an LLM
“Which WhatsApp template is linked to each outreach round of an initiative?”
“Is round 1 linked yet, so my initiative can launch?”
Tell an agent
Show the round-by-round templates linked to initiative {id}.
Check which outreach templates initiative {id} will send.
POST
/api/v1/initiatives/{id}/templates
Link a WhatsApp template to an outreach round · Set template
#
Ask an LLM
“How do I attach an approved WhatsApp template as an initiative's first message?”
“Can I use a different template for the follow-up outreach rounds?”
Tell an agent
Link template {templateId} to initiative {id} as its first outreach message.
Use template {templateId} for outreach round {round} of initiative {id}.
Ask an LLM
“How can I export every conversation from an initiative without fetching participants one at a time?”
“What is the most participants' transcripts I can get per page?”
Tell an agent
Export all conversation transcripts for initiative {id}.
Get the next page of transcripts for initiative {id} after cursor {cursor}.
Ask an LLM
“How do I bring an archived initiative back into my list?”
“Does unarchiving an initiative change its status?”
Tell an agent
Unarchive initiative {id}.
Restore archived initiative {id} to the default list.