Initiatives
Update initiative
Edit an initiative. A launched one still takes its agent-facing content (name, objective, context, guidingQuestions, flagCondition, identityDeflection) and its smartSendingMode and serves the edit on the next turn; the structural fields are draft-only, and a completed or canceled initiative is frozen. Send only the fields you change; context and objective replace the whole value, so read the current value first and send it back with your addition.
PATCH
/
api
/
v1
/
initiatives
/
{id}
Update initiative
curl --request PATCH \
--url https://www.useboom.ai/api/v1/initiatives/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"objective": "<string>",
"context": "<string>",
"maxAttempts": 3,
"isRecurring": true,
"flagCondition": "<string>",
"identityDeflection": "<string>",
"guidingQuestions": [
{
"questionText": "<string>",
"id": "<string>",
"priority": 4503599627370496,
"scaleMin": 0,
"scaleMax": 0,
"options": [
"<string>"
]
}
]
}
'import requests
url = "https://www.useboom.ai/api/v1/initiatives/{id}"
payload = {
"name": "<string>",
"objective": "<string>",
"context": "<string>",
"maxAttempts": 3,
"isRecurring": True,
"flagCondition": "<string>",
"identityDeflection": "<string>",
"guidingQuestions": [
{
"questionText": "<string>",
"id": "<string>",
"priority": 4503599627370496,
"scaleMin": 0,
"scaleMax": 0,
"options": ["<string>"]
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
objective: '<string>',
context: '<string>',
maxAttempts: 3,
isRecurring: true,
flagCondition: '<string>',
identityDeflection: '<string>',
guidingQuestions: [
{
questionText: '<string>',
id: '<string>',
priority: 4503599627370496,
scaleMin: 0,
scaleMax: 0,
options: ['<string>']
}
]
})
};
fetch('https://www.useboom.ai/api/v1/initiatives/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.useboom.ai/api/v1/initiatives/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'objective' => '<string>',
'context' => '<string>',
'maxAttempts' => 3,
'isRecurring' => true,
'flagCondition' => '<string>',
'identityDeflection' => '<string>',
'guidingQuestions' => [
[
'questionText' => '<string>',
'id' => '<string>',
'priority' => 4503599627370496,
'scaleMin' => 0,
'scaleMax' => 0,
'options' => [
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.useboom.ai/api/v1/initiatives/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"objective\": \"<string>\",\n \"context\": \"<string>\",\n \"maxAttempts\": 3,\n \"isRecurring\": true,\n \"flagCondition\": \"<string>\",\n \"identityDeflection\": \"<string>\",\n \"guidingQuestions\": [\n {\n \"questionText\": \"<string>\",\n \"id\": \"<string>\",\n \"priority\": 4503599627370496,\n \"scaleMin\": 0,\n \"scaleMax\": 0,\n \"options\": [\n \"<string>\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://www.useboom.ai/api/v1/initiatives/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"objective\": \"<string>\",\n \"context\": \"<string>\",\n \"maxAttempts\": 3,\n \"isRecurring\": true,\n \"flagCondition\": \"<string>\",\n \"identityDeflection\": \"<string>\",\n \"guidingQuestions\": [\n {\n \"questionText\": \"<string>\",\n \"id\": \"<string>\",\n \"priority\": 4503599627370496,\n \"scaleMin\": 0,\n \"scaleMax\": 0,\n \"options\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.useboom.ai/api/v1/initiatives/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"objective\": \"<string>\",\n \"context\": \"<string>\",\n \"maxAttempts\": 3,\n \"isRecurring\": true,\n \"flagCondition\": \"<string>\",\n \"identityDeflection\": \"<string>\",\n \"guidingQuestions\": [\n {\n \"questionText\": \"<string>\",\n \"id\": \"<string>\",\n \"priority\": 4503599627370496,\n \"scaleMin\": 0,\n \"scaleMax\": 0,\n \"options\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"channel": "WHATSAPP",
"sendChannels": [
"WHATSAPP"
],
"status": "DRAFT",
"language": "<string>",
"objective": "<string>",
"isRecurring": true,
"isTransactional": true,
"flagCondition": "<string>",
"identityDeflection": "<string>",
"smartSendingMode": "DEFER",
"createdAt": "<string>",
"updatedAt": "<string>",
"activatedAt": "<string>",
"completedAt": "<string>",
"canceledAt": "<string>",
"pausedAt": "<string>",
"context": "<string>",
"maxAttempts": 0,
"guidingQuestions": [
{
"id": "<string>",
"questionText": "<string>",
"answerType": "<string>",
"priority": 0,
"scaleMin": 0,
"scaleMax": 0,
"options": [
{
"id": "<string>",
"label": "<string>",
"position": 0
}
]
}
]
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Organization API key, sent as Authorization: Bearer boom_org_....
Path Parameters
The initiative id.
Minimum string length:
1Body
application/json
Initiative name.
Required string length:
1 - 255Available options:
en, es, pt What the initiative aims to learn.
Maximum string length:
2000Background the conversation draws on.
Maximum string length:
20000Outreach attempts per participant. Default 3.
Required range:
1 <= x <= 5Splits campaigns from initiatives: false is a campaign (one-time outreach, listed under Campaigns), true is an initiative (ongoing work, listed under Initiatives). A Transactional is a third kind, set with transactional on create, and cannot be recurring. 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.
Maximum string length:
500Smart Sending for this initiative's template, SMS and email sends, when the org has a frequency cap. FORCE always sends (and still counts toward the cap); DROP skips a send that would exceed it; DEFER currently behaves as DROP.
Available options:
DEFER, DROP, FORCE Custom reply when a contact asks whether they are talking to a bot. Set null to clear.
Maximum string length:
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.
Maximum array length:
50Show child attributes
Show child attributes
Response
Success
Initiative id.
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 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 Available options:
DRAFT, ACTIVE, PAUSED, COMPLETED, CANCELED Conversation language, e.g. es.
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.
True for a Transactional (one event, one message per channel; listed under Transactional).
Natural-language condition; matching conversations get flagged during analysis.
Custom reply when a contact asks whether they are talking to a bot.
Smart Sending mode: DEFER, DROP or FORCE.
Available options:
DEFER, DROP, FORCE ISO 8601 timestamp.
ISO 8601 timestamp.
Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
Was this page helpful?
⌘I
Update initiative
curl --request PATCH \
--url https://www.useboom.ai/api/v1/initiatives/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"objective": "<string>",
"context": "<string>",
"maxAttempts": 3,
"isRecurring": true,
"flagCondition": "<string>",
"identityDeflection": "<string>",
"guidingQuestions": [
{
"questionText": "<string>",
"id": "<string>",
"priority": 4503599627370496,
"scaleMin": 0,
"scaleMax": 0,
"options": [
"<string>"
]
}
]
}
'import requests
url = "https://www.useboom.ai/api/v1/initiatives/{id}"
payload = {
"name": "<string>",
"objective": "<string>",
"context": "<string>",
"maxAttempts": 3,
"isRecurring": True,
"flagCondition": "<string>",
"identityDeflection": "<string>",
"guidingQuestions": [
{
"questionText": "<string>",
"id": "<string>",
"priority": 4503599627370496,
"scaleMin": 0,
"scaleMax": 0,
"options": ["<string>"]
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
objective: '<string>',
context: '<string>',
maxAttempts: 3,
isRecurring: true,
flagCondition: '<string>',
identityDeflection: '<string>',
guidingQuestions: [
{
questionText: '<string>',
id: '<string>',
priority: 4503599627370496,
scaleMin: 0,
scaleMax: 0,
options: ['<string>']
}
]
})
};
fetch('https://www.useboom.ai/api/v1/initiatives/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.useboom.ai/api/v1/initiatives/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'objective' => '<string>',
'context' => '<string>',
'maxAttempts' => 3,
'isRecurring' => true,
'flagCondition' => '<string>',
'identityDeflection' => '<string>',
'guidingQuestions' => [
[
'questionText' => '<string>',
'id' => '<string>',
'priority' => 4503599627370496,
'scaleMin' => 0,
'scaleMax' => 0,
'options' => [
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.useboom.ai/api/v1/initiatives/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"objective\": \"<string>\",\n \"context\": \"<string>\",\n \"maxAttempts\": 3,\n \"isRecurring\": true,\n \"flagCondition\": \"<string>\",\n \"identityDeflection\": \"<string>\",\n \"guidingQuestions\": [\n {\n \"questionText\": \"<string>\",\n \"id\": \"<string>\",\n \"priority\": 4503599627370496,\n \"scaleMin\": 0,\n \"scaleMax\": 0,\n \"options\": [\n \"<string>\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://www.useboom.ai/api/v1/initiatives/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"objective\": \"<string>\",\n \"context\": \"<string>\",\n \"maxAttempts\": 3,\n \"isRecurring\": true,\n \"flagCondition\": \"<string>\",\n \"identityDeflection\": \"<string>\",\n \"guidingQuestions\": [\n {\n \"questionText\": \"<string>\",\n \"id\": \"<string>\",\n \"priority\": 4503599627370496,\n \"scaleMin\": 0,\n \"scaleMax\": 0,\n \"options\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.useboom.ai/api/v1/initiatives/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"objective\": \"<string>\",\n \"context\": \"<string>\",\n \"maxAttempts\": 3,\n \"isRecurring\": true,\n \"flagCondition\": \"<string>\",\n \"identityDeflection\": \"<string>\",\n \"guidingQuestions\": [\n {\n \"questionText\": \"<string>\",\n \"id\": \"<string>\",\n \"priority\": 4503599627370496,\n \"scaleMin\": 0,\n \"scaleMax\": 0,\n \"options\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"channel": "WHATSAPP",
"sendChannels": [
"WHATSAPP"
],
"status": "DRAFT",
"language": "<string>",
"objective": "<string>",
"isRecurring": true,
"isTransactional": true,
"flagCondition": "<string>",
"identityDeflection": "<string>",
"smartSendingMode": "DEFER",
"createdAt": "<string>",
"updatedAt": "<string>",
"activatedAt": "<string>",
"completedAt": "<string>",
"canceledAt": "<string>",
"pausedAt": "<string>",
"context": "<string>",
"maxAttempts": 0,
"guidingQuestions": [
{
"id": "<string>",
"questionText": "<string>",
"answerType": "<string>",
"priority": 0,
"scaleMin": 0,
"scaleMax": 0,
"options": [
{
"id": "<string>",
"label": "<string>",
"position": 0
}
]
}
]
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}