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. The third kind is a Transactional: pass transactional instead (it cannot be combined with isRecurring: true). To send ONE message to an audience ONCE, pass campaign: its journey is built for you and nobody enrolls on their own. For a WhatsApp send, link an approved template before launching.
Splits 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.
Smart 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.
The 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.
Create a Transactional instead: one event sends this WhatsApp and/or email template: one notification per event, or one per value of parallelRunsBy when set. Pass the whole setup here (event, optional key, messages with templateBindings/bindings, optional reviewBeforeSending) and it is ready in one call; check initiatives_transactional_get for anything still missing, then initiatives_launch. Change it later with initiatives_transactional_configure. Ids: WhatsApp channelId from journeys_message_channels, WhatsApp templateId from journeys_message_templates for that channel, email templateId from journeys_email_templates. Cannot be combined with isRecurring. Any smartSendingMode you pass is overridden to FORCE, and isRecurring is forced to false.
Create a one-time campaign: one email and/or WhatsApp message to an audience, once, at sendAt. The audience is a segment snapshot or people you add. Check initiatives_campaign_get for anything still missing, then initiatives_launch to schedule it. Change it later with initiatives_campaign_configure. Never publish a segment-triggered journey for a one-time send: it keeps enrolling people who join the segment later.
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.
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.
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.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Boom","description":"Boom's public API — REST and MCP over the same capabilities","colors":{"primary":"#3B3B3B","light":"#E5E5E5","dark":"#171717"},"logo":{"light":"https://mintcdn.com/boomai-c1f672dc/2DiZiPkeLvrlfzgs/logo.svg?fit=max\u0026auto=format\u0026n=2DiZiPkeLvrlfzgs\u0026q=85\u0026s=a014030c9acb0f3d8eee9de1fbe632a7","dark":"https://mintcdn.com/boomai-c1f672dc/2DiZiPkeLvrlfzgs/logo-dark.svg?fit=max\u0026auto=format\u0026n=2DiZiPkeLvrlfzgs\u0026q=85\u0026s=8ec1c838c16743220fd0e7f46a0be157","href":"/introduction"},"favicon":"https://mintcdn.com/boomai-c1f672dc/4m9zfCL8IkhJn1sI/favicon.svg?fit=max\u0026auto=format\u0026n=4m9zfCL8IkhJn1sI\u0026q=85\u0026s=949c3ecc5e2011cf0a7d4a0e33204c1d","appearance":{"default":"system"},"navbar":{"links":[{"href":"mailto:support@useboom.ai","label":"Support"},{"href":"https://app.useboom.ai","label":"Dashboard"}]},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","assistant","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"boomai-c1f672dc","hasAudioNarration":false,"actualSubdomain":"boomai-c1f672dc","customDomains":["docs.useboom.ai"],"gitSource":{"type":"github","owner":"boom-tml","repo":"product-research","deployBranch":"main","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"ca542f17-f4ef-4bd7-9dec-4327eb890a84","liveDeploymentHistoryId":"6adada31c9b285ea9e7588cf","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adada31c9b285ea9e7588cf"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adada31c9b285ea9e7588cf","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API","count":80},{"language":"default","tag":"Guides","count":34},{"language":"default","tag":"CDP","count":29},{"language":"default","tag":"Initiatives","count":23},{"language":"default","tag":"Journeys","count":22},{"language":"default","tag":"How Boom works","count":17},{"language":"default","tag":"Lead Capture","count":11},{"language":"default","tag":"Tutorials","count":10},{"language":"default","tag":"Segments","count":10},{"language":"default","tag":"Connect your tools","count":9}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"html{font-size:14px}:root:root{--font-family-headings-custom:ui-sans-serif, system-ui, sans-serif;--font-family-body-custom:ui-sans-serif, system-ui, sans-serif}#page-title{font-weight:400!important;letter-spacing:-.025em!important}#content-area .prose h2{font-weight:400;letter-spacing:-.015em}#content-area .prose h3{font-weight:500;letter-spacing:-.008em}body{background-color:oklch(.97 0 0)}.dark body{background-color:oklch(.18 0 0)}#content-area .text-primary.font-semibold:not(.eyebrow){color:#18181b!important}.dark #content-area .text-primary.font-semibold:not(.eyebrow){color:#f4f4f5!important}#pagination{background-color:transparent!important;border:0!important;border-top:1px solid rgba(17,17,26,.08)!important;border-radius:0!important;padding:1.25rem 0 0!important}.dark #pagination{border-top-color:rgba(255,255,255,.08)!important}#footer a[href*=mintlify],#pagination a .flex-col.items-end,#pagination a .w-px{display:none!important}#pagination a.w-full>div{justify-content:flex-end!important}@media (min-width:1024px){#sidebar-content{width:18rem!important}#body-content{padding-left:18rem!important}}#sidebar-content a[aria-current=page]{background-color:oklch(.955 .004 80);border-radius:.5rem}.dark #sidebar-content a[aria-current=page]{background-color:rgba(255,255,255,.06)}#sidebar-content [class*=group i]:not(a):not(:has(a)),#sidebar-content h5,#sidebar-content li>div:first-child>p:first-child:not(:has(a)){font-size:.9rem!important;font-weight:600!important;letter-spacing:normal!important;text-transform:none!important}.boom-home{--bh-ink:oklch(0.145 0 0);--bh-muted:oklch(0.556 0 0);--bh-hero:oklch(0.984 0.003 85);--bh-card:oklch(0.984 0.003 85);--bh-line:rgba(0, 0, 0, 0.07);--bh-grain:url(\"data:image/svg+xml;utf8,\u003csvg xmlns='http://www.w3.org/2000/svg' width='220' height='220'>\u003cfilter id='n'>\u003cfeTurbulence type='fractalNoise' baseFrequency='0.72' numOctaves='3' stitchTiles='stitch'/>\u003cfeColorMatrix values='0 0 0 0 0.5 0 0 0 0 0.5 0 0 0 0 0.5 0 0 0 1.4 -0.2'/>\u003c/filter>\u003crect width='100%' height='100%' filter='url(%23n)'/>\u003c/svg>\");padding:.5rem 0 1rem;container-type:inline-size}.dark .boom-home{--bh-ink:oklch(0.978 0.001 286);--bh-muted:oklch(0.78 0.016 286);--bh-hero:rgba(255, 255, 255, 0.03);--bh-card:rgba(255, 255, 255, 0.03);--bh-line:rgba(255, 255, 255, 0.08)}.boom-home a,.boom-home a:focus,.boom-home a:hover{text-decoration:none;border:0}.boom-home span{display:block}.boom-home .bh-hero{position:relative;overflow:hidden;isolation:isolate;border-radius:24px;border:1px solid var(--bh-line);background:var(--bh-hero);padding:clamp(2.5rem,7vw,4.5rem) clamp(1.5rem,5vw,3.5rem);margin-bottom:1rem}.boom-home .bh-eyebrow{display:inline-block;font-size:.93rem;color:var(--bh-muted);border:1px solid var(--bh-line);border-radius:999px;padding:.3rem .8rem;background:rgba(255,255,255,.8)}.dark .boom-home .bh-eyebrow{background:rgba(255,255,255,.04)}.boom-home .bh-title{margin:1.4rem 0 0;max-width:14ch;font-weight:400;font-size:clamp(2.6rem,6.5vw,4.2rem);line-height:1.04;letter-spacing:-.025em;color:var(--bh-ink);opacity:.85;text-wrap:balance}.boom-home .bh-sub{margin:1.25rem 0 0;max-width:34rem;color:var(--bh-muted);font-size:1.15rem;line-height:1.6;text-wrap:pretty}.boom-home .bh-arcs{position:absolute;z-index:-1;right:-17rem;top:50%;width:34rem;height:34rem;transform:translateY(-50%);color:var(--bh-ink);opacity:.16;pointer-events:none}.boom-home .bh-arcs svg{width:100%;height:100%}@media (max-width:640px){.boom-home .bh-arcs{display:none}}.boom-home .bh-grid{display:grid;grid-template-columns:repeat(3,minmax(0,1fr));gap:.75rem}@container (max-width: 820px){.boom-home .bh-grid{grid-template-columns:repeat(2,minmax(0,1fr))}}@container (max-width: 520px){.boom-home .bh-grid{grid-template-columns:1fr}}.boom-home .bh-tile{position:relative;overflow:hidden;isolation:isolate;height:17rem;border-radius:24px;border:1px solid var(--bh-line);background:var(--bh-card)}.boom-home .bh-tile:focus-visible{outline:2px solid var(--bh-ink);outline-offset:3px}.boom-home .bh-paint{position:absolute;inset:0;z-index:-1;opacity:0;background:var(--bh-paint);transition:opacity .5s ease-out}.boom-home .bh-paint::after{content:\"\";position:absolute;inset:0;mix-blend-mode:overlay;opacity:.7;background-image:var(--bh-grain)}.boom-home .bh-tile:focus-visible .bh-paint,.boom-home .bh-tile:hover .bh-paint{opacity:1}.boom-home .bh-tile:nth-child(1){--bh-paint:radial-gradient(85% 60% at 90% 0%, oklch(0.84 0.07 315) 0%, transparent 60%), linear-gradient(180deg, oklch(0.62 0.13 305), oklch(0.42 0.12 295))}.boom-home .bh-tile:nth-child(2){--bh-paint:radial-gradient(85% 60% at 90% 0%, oklch(0.9 0.09 85) 0%, transparent 60%), linear-gradient(180deg, oklch(0.72 0.13 55), oklch(0.5 0.14 22))}.boom-home .bh-tile:nth-child(3){--bh-paint:radial-gradient(85% 60% at 10% 0%, oklch(0.88 0.06 30) 0%, transparent 60%), linear-gradient(180deg, oklch(0.66 0.13 18), oklch(0.46 0.13 0))}.boom-home .bh-tile:nth-child(4){--bh-paint:radial-gradient(85% 60% at 90% 0%, oklch(0.88 0.06 220) 0%, transparent 60%), linear-gradient(180deg, oklch(0.66 0.11 240), oklch(0.4 0.1 258))}.boom-home .bh-tile:nth-child(5){--bh-paint:radial-gradient(85% 60% at 10% 0%, oklch(0.88 0.08 150) 0%, transparent 60%), linear-gradient(180deg, oklch(0.6 0.09 180), oklch(0.4 0.07 215))}.boom-home .bh-tile:nth-child(6){--bh-paint:radial-gradient(85% 60% at 90% 0%, oklch(0.8 0.09 295) 0%, transparent 60%), linear-gradient(180deg, oklch(0.55 0.15 280), oklch(0.33 0.11 268))}.boom-home .bh-art{position:absolute;inset:0 0 5.25rem;display:grid;place-items:center;padding:1.25rem 2rem 0;color:var(--bh-ink);opacity:.85;transition:color .5s ease,opacity .5s ease}.boom-home .bh-art svg{width:100%;max-width:230px;height:140px;overflow:visible}.boom-home .bh-text{position:absolute;inset:auto 0 0;height:5.25rem;padding:0 1.5rem;text-align:center}.boom-home .bh-h{font-size:1.15rem;font-weight:500;letter-spacing:-.008em;color:var(--bh-ink);transition:color .5s ease}.boom-home .bh-p{margin:.3rem auto 0;font-size:.95rem;font-weight:400;line-height:1.5;color:var(--bh-muted);text-wrap:pretty;transition:color .5s ease}.boom-home .bh-tile:focus-visible .bh-art,.boom-home .bh-tile:hover .bh-art{color:#fff;opacity:1}.boom-home .bh-tile:focus-visible .bh-h,.boom-home .bh-tile:hover .bh-h{color:#fff}.boom-home .bh-tile:focus-visible .bh-p,.boom-home .bh-tile:hover .bh-p{color:rgba(255,255,255,.85)}.boom-home svg .d,.boom-home svg .h{fill:none;stroke:currentColor;stroke-width:.75;vector-effect:non-scaling-stroke}.boom-home svg .d{stroke-dasharray:.5 3;stroke-linecap:round}.boom-home svg .f{fill:currentColor;stroke:none}body:has(.boom-home) #header,body:has(.boom-home) #page-context-menu,body:has(.boom-home) #page-context-menu-button,body:has(.boom-home) #pagination{display:none!important}body:has(.boom-home) #content-area{max-width:72rem!important}#page-context-menu button[aria-haspopup=menu]{height:calc(2rem + 2px)}"}],"page":{"pagePath":"api-reference/initiatives/create-initiative","slug":"/api-reference/initiatives/create-initiative","pageMetadata":{"title":"Create initiative","description":"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. The third kind is a Transactional: pass `transactional` instead (it cannot be combined with `isRecurring: true`). To send ONE message to an audience ONCE, pass `campaign`: its journey is built for you and nobody enrolls on their own. For a WhatsApp send, link an approved template before launching.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives","href":"/api-reference/initiatives/create-initiative","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Create a draft initiative or campaign — only a name is required. \", _jsx(_components.code, {\n children: \"isRecurring\"\n }), \" decides which: omit it or pass \", _jsx(_components.code, {\n children: \"false\"\n }), \" for a campaign (one-time outreach, lives under Campaigns), \", _jsx(_components.code, {\n children: \"true\"\n }), \" for an initiative (ongoing work, lives under Initiatives). No UI control changes this afterwards, so set it deliberately. The third kind is a Transactional: pass \", _jsx(_components.code, {\n children: \"transactional\"\n }), \" instead (it cannot be combined with \", _jsx(_components.code, {\n children: \"isRecurring: true\"\n }), \"). To send ONE message to an audience ONCE, pass \", _jsx(_components.code, {\n children: \"campaign\"\n }), \": its journey is built for you and nobody enrolls on their own. For a WhatsApp send, link an approved template before launching.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create initiative","description":"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. The third kind is a Transactional: pass `transactional` instead (it cannot be combined with `isRecurring: true`). To send ONE message to an audience ONCE, pass `campaign`: its journey is built for you and nobody enrolls on their own. For a WhatsApp send, link an approved template before launching.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives","href":"/api-reference/initiatives/create-initiative","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"initiatives_create","summary":"Create initiative","description":"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. The third kind is a Transactional: pass `transactional` instead (it cannot be combined with `isRecurring: true`). To send ONE message to an audience ONCE, pass `campaign`: its journey is built for you and nobody enrolls on their own. For a WhatsApp send, link an approved template before launching.","tags":["Initiatives"],"requestBody":"005a1955-89ef-43c9-9d39-a6bb99bc421d","responses":{"201":"3afaede3-8674-4d82-9408-ac2866042c74","400":"72e10273-3973-48e4-a436-82df1bfdae9d","401":"b30c69df-23df-4a44-a744-64738d68f97c","404":"b806dfbd-00ae-4f77-a606-5d379c5ab080","409":"a3868bcf-5f99-4a87-b754-f506bdcb0af5","422":"f419a0f2-06fb-4cbd-b583-1cc4c30ae8fe","429":"ca1e8159-1b75-440c-b3d8-553851cf7604","500":"0337b274-da20-423f-bff9-808d16d059fc","503":"45cb0d92-751f-49ab-a01b-f795293b387f"},"method":"post","type":"path","servers":["c765c082-4d63-4903-8901-a4e25004f471","b80279d2-0255-46dc-bddc-f490bd7a2ec8"],"security":["ec2314a0-cdd3-4628-bc94-f84fbb0b23d0"],"path":"/api/v1/initiatives","baseUrlOptions":["https://www.useboom.ai","https://dev.useboom.ai"],"title":"Create initiative","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Initiative name.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"language":{"type":"string","enum":["en","es","pt"],"uniqueKey":"language","typeLabel":"enum\u003cstring>"},"objective":{"description":"What the initiative aims to learn.","type":"string","maxLength":2000,"uniqueKey":"objective","typeLabel":"string"},"context":{"description":"Background the conversation draws on.","type":"string","maxLength":20000,"uniqueKey":"context","typeLabel":"string"},"maxAttempts":{"description":"Outreach attempts per participant. Default 3.","type":"integer","minimum":1,"maximum":5,"uniqueKey":"maxAttempts","typeLabel":"integer"},"isRecurring":{"description":"Splits 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.","type":"boolean","uniqueKey":"isRecurring","typeLabel":"boolean"},"flagCondition":{"oneOf":[{"type":"string","description":"Natural-language condition; conversations matching it get flagged during analysis. Set null to clear.","maxLength":500,"uniqueKey":"flagCondition.oneOf.0","typeLabel":"string"},{"type":"null","description":"Natural-language condition; conversations matching it get flagged during analysis. Set null to clear.","uniqueKey":"flagCondition.oneOf.1","typeLabel":"null"}],"uniqueKey":"flagCondition","typeLabel":"string | null"},"smartSendingMode":{"description":"Smart 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.","type":"string","enum":["DEFER","DROP","FORCE"],"uniqueKey":"smartSendingMode","typeLabel":"enum\u003cstring>"},"identityDeflection":{"oneOf":[{"type":"string","description":"Custom reply when a contact asks whether they are talking to a bot. Set null to clear.","maxLength":1000,"uniqueKey":"identityDeflection.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom reply when a contact asks whether they are talking to a bot. Set null to clear.","uniqueKey":"identityDeflection.oneOf.1","typeLabel":"null"}],"uniqueKey":"identityDeflection","typeLabel":"string | null"},"guidingQuestions":{"description":"The 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.","maxItems":50,"type":"array","items":{"type":"object","properties":{"questionText":{"type":"string","minLength":1,"maxLength":280,"description":"The question to cover.","isRequired":true,"uniqueKey":"guidingQuestions.items.[INDEX].questionText","typeLabel":"string"},"id":{"description":"Omit to add a new question. On update, pass the id from `initiatives_get` to edit a question in place — a question you drop from a launched initiative is archived if it already has answers (kept for reporting, no longer asked) and deleted otherwise. The id of an archived question is not reusable: sending it creates a new question.","type":"string","uniqueKey":"guidingQuestions.items.[INDEX].id","typeLabel":"string"},"answerType":{"description":"Defaults to OPEN on a new question. On an existing one, omitting it leaves the type as it is — it does not reset to OPEN.","type":"string","enum":["OPEN","MULTIPLE_CHOICE","BOOLEAN","SCALE"],"uniqueKey":"guidingQuestions.items.[INDEX].answerType","typeLabel":"enum\u003cstring>"},"priority":{"description":"Ask order, 1 first. Defaults to the position in this array.","type":"integer","minimum":1,"maximum":9007199254740991,"uniqueKey":"guidingQuestions.items.[INDEX].priority","typeLabel":"integer"},"scaleMin":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991,"uniqueKey":"guidingQuestions.items.[INDEX].scaleMin.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"guidingQuestions.items.[INDEX].scaleMin.oneOf.1","typeLabel":"null"}],"uniqueKey":"guidingQuestions.items.[INDEX].scaleMin","typeLabel":"integer | null"},"scaleMax":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991,"uniqueKey":"guidingQuestions.items.[INDEX].scaleMax.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"guidingQuestions.items.[INDEX].scaleMax.oneOf.1","typeLabel":"null"}],"uniqueKey":"guidingQuestions.items.[INDEX].scaleMax","typeLabel":"integer | null"},"options":{"description":"Answer options (MULTIPLE_CHOICE only). On an existing question, omitting them leaves the current options alone; send `[]` to clear them.","maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":280,"uniqueKey":"guidingQuestions.items.[INDEX].options.items.[INDEX]","typeLabel":"string"},"uniqueKey":"guidingQuestions.items.[INDEX].options","typeLabel":"string[]"}},"required":["questionText"],"uniqueKey":"guidingQuestions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"guidingQuestions","typeLabel":"object[]"},"channel":{"default":"WHATSAPP","description":"Default WHATSAPP.","type":"string","enum":["WHATSAPP","EMAIL"],"uniqueKey":"channel","typeLabel":"enum\u003cstring>"},"transactional":{"description":"Create a Transactional instead: one event sends this WhatsApp and/or email template: one notification per event, or one per value of `parallelRunsBy` when set. Pass the whole setup here (event, optional key, messages with `templateBindings`/`bindings`, optional `reviewBeforeSending`) and it is ready in one call; check `initiatives_transactional_get` for anything still missing, then `initiatives_launch`. Change it later with `initiatives_transactional_configure`. Ids: WhatsApp `channelId` from `journeys_message_channels`, WhatsApp `templateId` from `journeys_message_templates` for that channel, email `templateId` from `journeys_email_templates`. Cannot be combined with isRecurring. Any `smartSendingMode` you pass is overridden to FORCE, and `isRecurring` is forced to false.","type":"object","properties":{"whatsapp":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"transactional.whatsapp.templateId","typeLabel":"string"},"channelId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"transactional.whatsapp.channelId","typeLabel":"string"},"templateBindings":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","uniqueKey":"transactional.whatsapp.templateBindings.additionalProperties","typeLabel":"string"},"description":"Template variable → where its value comes from: `engagement.workflowState.\u003cproperty>` for a property of the triggering event, `person.\u003cfield>` for a customer field, or `literal:\u003ctext>` for fixed text. WhatsApp keys are the placeholder numbers (\"1\", \"2\").","uniqueKey":"transactional.whatsapp.templateBindings","typeLabel":"object"}},"required":["templateId","channelId"],"uniqueKey":"transactional.whatsapp","typeLabel":"object"},"email":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"transactional.email.templateId","typeLabel":"string"},"bindings":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","uniqueKey":"transactional.email.bindings.additionalProperties","typeLabel":"string"},"description":"Template variable → where its value comes from: `engagement.workflowState.\u003cproperty>` for a property of the triggering event, `person.\u003cfield>` for a customer field, or `literal:\u003ctext>` for fixed text. WhatsApp keys are the placeholder numbers (\"1\", \"2\").","uniqueKey":"transactional.email.bindings","typeLabel":"object"}},"required":["templateId"],"uniqueKey":"transactional.email","typeLabel":"object"},"eventName":{"type":"string","minLength":1,"pattern":"^[a-zA-Z0-9_]+$","uniqueKey":"transactional.eventName","typeLabel":"string"},"parallelRunsBy":{"type":"string","minLength":1,"uniqueKey":"transactional.parallelRunsBy","typeLabel":"string"},"reviewBeforeSending":{"description":"Every send waits in Drafts until an org member approves or rejects it (`drafts_list`, `drafts_decide`); a rejected email still lets the WhatsApp message go. Without `parallelRunsBy`, a customer's next event is dropped while their earlier send waits, so set a key when events can repeat. Refused (`drafts_disabled`) while drafts are turned off for the organization.","type":"boolean","uniqueKey":"transactional.reviewBeforeSending","typeLabel":"boolean"}},"uniqueKey":"transactional","typeLabel":"object"},"campaign":{"description":"Create a one-time campaign: one email and/or WhatsApp message to an audience, once, at `sendAt`. The audience is a segment snapshot or people you add. Check `initiatives_campaign_get` for anything still missing, then `initiatives_launch` to schedule it. Change it later with `initiatives_campaign_configure`. Never publish a segment-triggered journey for a one-time send: it keeps enrolling people who join the segment later.","type":"object","properties":{"audience":{"oneOf":[{"type":"object","description":"Who gets it. `manual`: people you add with `initiatives_participants_add`. `segment`: a one-time snapshot of that segment. It never keeps enrolling people who join later.","required":["kind"],"properties":{"kind":{"type":"string","const":"manual","isRequired":true,"uniqueKey":"campaign.audience.oneOf.0.kind","typeLabel":"string"}},"isRequired":true,"uniqueKey":"campaign.audience.oneOf.0","typeLabel":"object"},{"type":"object","description":"Who gets it. `manual`: people you add with `initiatives_participants_add`. `segment`: a one-time snapshot of that segment. It never keeps enrolling people who join later.","required":["kind","segmentId","readAtSend"],"properties":{"kind":{"type":"string","const":"segment","isRequired":true,"uniqueKey":"campaign.audience.oneOf.1.kind","typeLabel":"string"},"segmentId":{"type":"string","minLength":1,"description":"The segment id (not its slug).","isRequired":true,"uniqueKey":"campaign.audience.oneOf.1.segmentId","typeLabel":"string"},"readAtSend":{"type":"boolean","description":"true = read the segment at `sendAt` (someone who leaves it before then drops out); false = read it when the campaign is scheduled.","isRequired":true,"uniqueKey":"campaign.audience.oneOf.1.readAtSend","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"campaign.audience.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"campaign.audience","typeLabel":"object"},"sendAt":{"oneOf":[{"type":"string","description":"ISO instant the message goes out, in the future. Null = as soon as the campaign is scheduled.","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","uniqueKey":"campaign.sendAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"ISO instant the message goes out, in the future. Null = as soon as the campaign is scheduled.","uniqueKey":"campaign.sendAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.sendAt","typeLabel":"string\u003cdate-time> | null"},"email":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"campaign.email.templateId","typeLabel":"string"},"bindings":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","uniqueKey":"campaign.email.bindings.additionalProperties","typeLabel":"string"},"description":"Template variable → where its value comes from: `person.\u003cfield>` for a customer field (e.g. `person.firstName`), or `literal:\u003ctext>` for fixed text. WhatsApp keys are the placeholder numbers (\"1\", \"2\").","uniqueKey":"campaign.email.bindings","typeLabel":"object"},"fromSenderIdOverride":{"oneOf":[{"type":"string","description":"Sender to send From, with usableAsFrom: true in `journeys_email_templates`. Null = the template sender, else the org default.","minLength":1,"uniqueKey":"campaign.email.fromSenderIdOverride.oneOf.0","typeLabel":"string"},{"type":"null","description":"Sender to send From, with usableAsFrom: true in `journeys_email_templates`. Null = the template sender, else the org default.","uniqueKey":"campaign.email.fromSenderIdOverride.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.email.fromSenderIdOverride","typeLabel":"string | null"},"replyToSenderIdOverride":{"oneOf":[{"type":"string","minLength":1,"uniqueKey":"campaign.email.replyToSenderIdOverride.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"campaign.email.replyToSenderIdOverride.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.email.replyToSenderIdOverride","typeLabel":"string | null"}},"required":["templateId"],"description":"The email message: a PUBLISHED template (`journeys_email_templates`). Unbound variables use the template's own value.","uniqueKey":"campaign.email","typeLabel":"object"},"whatsapp":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"campaign.whatsapp.templateId","typeLabel":"string"},"channelId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"campaign.whatsapp.channelId","typeLabel":"string"},"templateBindings":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","uniqueKey":"campaign.whatsapp.templateBindings.additionalProperties","typeLabel":"string"},"description":"Template variable → where its value comes from: `person.\u003cfield>` for a customer field (e.g. `person.firstName`), or `literal:\u003ctext>` for fixed text. WhatsApp keys are the placeholder numbers (\"1\", \"2\").","uniqueKey":"campaign.whatsapp.templateBindings","typeLabel":"object"}},"required":["templateId","channelId"],"description":"The WhatsApp message: an APPROVED template, the sending number (`journeys_message_channels`), and a binding for EVERY placeholder. Replies go to the agent for 24 hours.","uniqueKey":"campaign.whatsapp","typeLabel":"object"},"reviewBeforeSending":{"description":"Every send waits in Drafts until someone approves it.","type":"boolean","uniqueKey":"campaign.reviewBeforeSending","typeLabel":"boolean"}},"required":["audience"],"uniqueKey":"campaign","typeLabel":"object"}},"required":["name"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","objective":"\u003cstring>","context":"\u003cstring>","maxAttempts":3,"isRecurring":true,"flagCondition":"\u003cstring>","identityDeflection":"\u003cstring>","guidingQuestions":[{"questionText":"\u003cstring>","id":"\u003cstring>","priority":4503599627370496,"scaleMin":0,"scaleMax":0,"options":["\u003cstring>"]}],"channel":"WHATSAPP","transactional":{"eventName":"\u003cstring>","parallelRunsBy":"\u003cstring>","reviewBeforeSending":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"3afaede3-8674-4d82-9408-ac2866042c74":{"description":"Success","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string","description":"Initiative id.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"channel":{"type":"string","enum":["WHATSAPP","EMAIL"],"description":"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.","isRequired":true,"uniqueKey":"channel","typeLabel":"enum\u003cstring>"},"sendChannels":{"type":"array","items":{"type":"string","enum":["WHATSAPP","EMAIL","SMS","INSTAGRAM","FACEBOOK_MESSENGER"],"uniqueKey":"sendChannels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"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.","isRequired":true,"uniqueKey":"sendChannels","typeLabel":"enum\u003cstring>[]"},"status":{"type":"string","enum":["DRAFT","ACTIVE","PAUSED","COMPLETED","CANCELED"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"Conversation language, e.g. `es`.","isRequired":true,"uniqueKey":"language","typeLabel":"string"},"objective":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"objective.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"objective.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"objective","typeLabel":"string | null"},"isRecurring":{"type":"boolean","description":"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.","isRequired":true,"uniqueKey":"isRecurring","typeLabel":"boolean"},"isTransactional":{"type":"boolean","description":"True for a Transactional (one event, one message per channel; listed under Transactional).","isRequired":true,"uniqueKey":"isTransactional","typeLabel":"boolean"},"flagCondition":{"oneOf":[{"type":"string","description":"Natural-language condition; matching conversations get flagged during analysis.","isRequired":true,"uniqueKey":"flagCondition.oneOf.0","typeLabel":"string"},{"type":"null","description":"Natural-language condition; matching conversations get flagged during analysis.","isRequired":true,"uniqueKey":"flagCondition.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"flagCondition","typeLabel":"string | null"},"identityDeflection":{"oneOf":[{"type":"string","description":"Custom reply when a contact asks whether they are talking to a bot.","isRequired":true,"uniqueKey":"identityDeflection.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom reply when a contact asks whether they are talking to a bot.","isRequired":true,"uniqueKey":"identityDeflection.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"identityDeflection","typeLabel":"string | null"},"smartSendingMode":{"type":"string","enum":["DEFER","DROP","FORCE"],"description":"Smart Sending mode: DEFER, DROP or FORCE.","isRequired":true,"uniqueKey":"smartSendingMode","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","description":"ISO 8601 timestamp.","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"ISO 8601 timestamp.","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string"},"activatedAt":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"activatedAt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"activatedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"activatedAt","typeLabel":"string | null"},"completedAt":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"completedAt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"completedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"completedAt","typeLabel":"string | null"},"canceledAt":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"canceledAt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"canceledAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"canceledAt","typeLabel":"string | null"},"pausedAt":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"pausedAt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"pausedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"pausedAt","typeLabel":"string | null"},"context":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"context.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"context.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"context","typeLabel":"string | null"},"maxAttempts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"maxAttempts","typeLabel":"integer"},"guidingQuestions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"guidingQuestions.items.[INDEX].id","typeLabel":"string"},"questionText":{"type":"string","isRequired":true,"uniqueKey":"guidingQuestions.items.[INDEX].questionText","typeLabel":"string"},"answerType":{"type":"string","isRequired":true,"uniqueKey":"guidingQuestions.items.[INDEX].answerType","typeLabel":"string"},"priority":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"guidingQuestions.items.[INDEX].priority","typeLabel":"integer"},"scaleMin":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991,"isRequired":true,"uniqueKey":"guidingQuestions.items.[INDEX].scaleMin.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"guidingQuestions.items.[INDEX].scaleMin.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"guidingQuestions.items.[INDEX].scaleMin","typeLabel":"integer | null"},"scaleMax":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991,"isRequired":true,"uniqueKey":"guidingQuestions.items.[INDEX].scaleMax.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"guidingQuestions.items.[INDEX].scaleMax.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"guidingQuestions.items.[INDEX].scaleMax","typeLabel":"integer | null"},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"guidingQuestions.items.[INDEX].options.items.[INDEX].id","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"guidingQuestions.items.[INDEX].options.items.[INDEX].label","typeLabel":"string"},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"guidingQuestions.items.[INDEX].options.items.[INDEX].position","typeLabel":"integer"}},"required":["id","label","position"],"additionalProperties":false,"uniqueKey":"guidingQuestions.items.[INDEX].options.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"guidingQuestions.items.[INDEX].options","typeLabel":"object[]"}},"required":["id","questionText","answerType","priority","scaleMin","scaleMax","options"],"additionalProperties":false,"uniqueKey":"guidingQuestions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"guidingQuestions","typeLabel":"object[]"}},"required":["id","name","channel","sendChannels","status","language","objective","isRecurring","isTransactional","flagCondition","identityDeflection","smartSendingMode","createdAt","updatedAt","activatedAt","completedAt","canceledAt","pausedAt","context","maxAttempts","guidingQuestions"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","channel":"WHATSAPP","sendChannels":["WHATSAPP"],"status":"DRAFT","language":"\u003cstring>","objective":"\u003cstring>","isRecurring":true,"isTransactional":true,"flagCondition":"\u003cstring>","identityDeflection":"\u003cstring>","smartSendingMode":"DEFER","createdAt":"\u003cstring>","updatedAt":"\u003cstring>","activatedAt":"\u003cstring>","completedAt":"\u003cstring>","canceledAt":"\u003cstring>","pausedAt":"\u003cstring>","context":"\u003cstring>","maxAttempts":0,"guidingQuestions":[{"id":"\u003cstring>","questionText":"\u003cstring>","answerType":"\u003cstring>","priority":0,"scaleMin":0,"scaleMax":0,"options":[{"id":"\u003cstring>","label":"\u003cstring>","position":0}]}]}}},"exampleType":"generated"}},"exampleType":"generated"},"72e10273-3973-48e4-a436-82df1bfdae9d":{"description":"Validation failed or the request cannot proceed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable machine-readable error code (snake_case).","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"b30c69df-23df-4a44-a744-64738d68f97c":{"description":"Missing, malformed, or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable machine-readable error code (snake_case).","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"b806dfbd-00ae-4f77-a606-5d379c5ab080":{"description":"The resource does not exist in this organization.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable machine-readable error code (snake_case).","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"a3868bcf-5f99-4a87-b754-f506bdcb0af5":{"description":"Conflicts with the current state (duplicates, wrong lifecycle state).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable machine-readable error code (snake_case).","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"f419a0f2-06fb-4cbd-b583-1cc4c30ae8fe":{"description":"The request is well-formed but semantically invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable machine-readable error code (snake_case).","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"ca1e8159-1b75-440c-b3d8-553851cf7604":{"description":"Rate limit exceeded — retry after `Retry-After`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable machine-readable error code (snake_case).","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"0337b274-da20-423f-bff9-808d16d059fc":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable machine-readable error code (snake_case).","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"45cb0d92-751f-49ab-a01b-f795293b387f":{"description":"Transient error — retry with a narrower request.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable machine-readable error code (snake_case).","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ec2314a0-cdd3-4628-bc94-f84fbb0b23d0":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Organization API key, sent as `Authorization: Bearer boom_org_...`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"c765c082-4d63-4903-8901-a4e25004f471":{"url":"https://www.useboom.ai","description":"Production"},"b80279d2-0255-46dc-bddc-f490bd7a2ec8":{"url":"https://dev.useboom.ai","description":"Development (sandbox — use a development organization API key)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Organization API key, sent as `Authorization: Bearer boom_org_...`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Organization API key, sent as `Authorization: Bearer boom_org_...`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"boomai-c1f672dc","siteName":"Boom","title":"Create initiative - Boom","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T19:58:55.908Z","originalFileLocation":"api-reference/initiatives/create-initiative.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"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. The third kind is a Transactional: pass transactional instead (it cannot be combined with isRecurring: true). To send ONE message to an audience ONCE, pass campaign: its journey is built for you and nobody enrolls on their own. For a WhatsApp send, link an approved template before launching.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Boom\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/boomai-c1f672dc/nVSaLoJMoPadjXEM/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/boomai-c1f672dc/nVSaLoJMoPadjXEM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/boomai-c1f672dc/nVSaLoJMoPadjXEM/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/boomai-c1f672dc/nVSaLoJMoPadjXEM/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/boomai-c1f672dc/nVSaLoJMoPadjXEM/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/boomai-c1f672dc/nVSaLoJMoPadjXEM/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/boomai-c1f672dc/nVSaLoJMoPadjXEM/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/boomai-c1f672dc/nVSaLoJMoPadjXEM/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/boomai-c1f672dc/nVSaLoJMoPadjXEM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create initiative - Boom\">\u003cmeta data-mint-head property=\"og:description\" content=\"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. The third kind is a Transactional: pass transactional instead (it cannot be combined with isRecurring: true). To send ONE message to an audience ONCE, pass campaign: its journey is built for you and nobody enrolls on their own. For a WhatsApp send, link an approved template before launching.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Boom\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.useboom.ai/api-reference/initiatives/create-initiative\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://boomai-c1f672dc.mintlify.app/_mintlify/api/og/v2?division=Initiatives\u0026amp;title=Create+initiative\u0026amp;description=Create+a+draft+initiative+or+campaign+%E2%80%94+only+a+name+is+required.+%60isRecurring%60+decides+which%3A+omit+it+or+pass+%60false%60+for+a+campaign+%28one-time+outreach%2C+lives+u\u0026amp;theme=83c6d51bda2a99f16cf59c6e\u0026amp;signature=26663154fb384bc63ad95e3f0eae00854afb9a5f07129bbb40faadba8477a287\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create initiative - Boom\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"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. The third kind is a Transactional: pass transactional instead (it cannot be combined with isRecurring: true). To send ONE message to an audience ONCE, pass campaign: its journey is built for you and nobody enrolls on their own. For a WhatsApp send, link an approved template before launching.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://boomai-c1f672dc.mintlify.app/_mintlify/api/og/v2?division=Initiatives\u0026amp;title=Create+initiative\u0026amp;description=Create+a+draft+initiative+or+campaign+%E2%80%94+only+a+name+is+required.+%60isRecurring%60+decides+which%3A+omit+it+or+pass+%60false%60+for+a+campaign+%28one-time+outreach%2C+lives+u\u0026amp;theme=83c6d51bda2a99f16cf59c6e\u0026amp;signature=26663154fb384bc63ad95e3f0eae00854afb9a5f07129bbb40faadba8477a287\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/boomai-c1f672dc/nVSaLoJMoPadjXEM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Boom\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3B3B3B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.useboom.ai/api-reference/initiatives/create-initiative\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/initiatives/create-initiative.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.useboom.ai/#organization\",\"name\":\"Boom\",\"url\":\"https://docs.useboom.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/boomai-c1f672dc/2DiZiPkeLvrlfzgs/logo.svg?fit=max\u0026auto=format\u0026n=2DiZiPkeLvrlfzgs\u0026q=85\u0026s=a014030c9acb0f3d8eee9de1fbe632a7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.useboom.ai#website\",\"name\":\"Boom\",\"url\":\"https://docs.useboom.ai\",\"publisher\":{\"@id\":\"https://docs.useboom.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.useboom.ai/api-reference/initiatives/create-initiative#webpage\",\"url\":\"https://docs.useboom.ai/api-reference/initiatives/create-initiative\",\"name\":\"Create initiative\",\"description\":\"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. The third kind is a Transactional: pass transactional instead (it cannot be combined with isRecurring: true). To send ONE message to an audience ONCE, pass campaign: its journey is built for you and nobody enrolls on their own. For a WhatsApp send, link an approved template before launching.\",\"dateModified\":\"2026-10-22T19:58:55.908Z\",\"isPartOf\":{\"@id\":\"https://docs.useboom.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.useboom.ai/api-reference/initiatives/create-initiative#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.useboom.ai/api-reference/initiatives/create-initiative#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Initiatives\",\"item\":\"https://docs.useboom.ai/api-reference/initiatives/list-initiatives\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create initiative\",\"item\":\"https://docs.useboom.ai/api-reference/initiatives/create-initiative\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.useboom.ai/api-reference/initiatives/create-initiative#apireference\",\"headline\":\"Create initiative\",\"name\":\"Create initiative\",\"description\":\"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. The third kind is a Transactional: pass transactional instead (it cannot be combined with isRecurring: true). To send ONE message to an audience ONCE, pass campaign: its journey is built for you and nobody enrolls on their own. For a WhatsApp send, link an approved template before launching.\",\"url\":\"https://docs.useboom.ai/api-reference/initiatives/create-initiative\",\"mainEntityOfPage\":{\"@id\":\"https://docs.useboom.ai/api-reference/initiatives/create-initiative#webpage\"},\"dateModified\":\"2026-10-22T19:58:55.908Z\",\"publisher\":{\"@id\":\"https://docs.useboom.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.useboom.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Boom\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Boom","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"Tutorials","icon":"circle-play","pages":[{"title":"Tutorials","href":"/tutorials/overview"}]},{"tab":"CDP","icon":"layers","pages":[{"title":"CDP","href":"/cdp/overview"}]},{"tab":"API","icon":"code","groups":[{"group":"Overview","pages":[{"title":"API","sidebarTitle":"Introduction","href":"/api-reference/overview"},{"title":"Quickstart","href":"/quickstart"},{"title":"Authentication","href":"/authentication"},{"title":"Rate limits \u0026 errors","href":"/rate-limits-and-errors"}]},{"group":"Initiatives","icon":"rocket","pages":[{"title":"List initiatives","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives","href":"/api-reference/initiatives/list-initiatives"},{"title":"Get initiative","description":"Get one initiative by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}","href":"/api-reference/initiatives/get-initiative"},{"title":"Create initiative","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives","href":"/api-reference/initiatives/create-initiative"},{"title":"Update initiative","description":"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.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/initiatives/{id}","href":"/api-reference/initiatives/update-initiative"},{"title":"Launch initiative","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/launch","href":"/api-reference/initiatives/launch-initiative"},{"title":"Cancel initiative","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/cancel","href":"/api-reference/initiatives/cancel-initiative"},{"title":"Pause initiative","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/pause","href":"/api-reference/initiatives/pause-initiative"},{"title":"Resume initiative","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/resume","href":"/api-reference/initiatives/resume-initiative"},{"title":"Archive initiative","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/archive","href":"/api-reference/initiatives/archive-initiative"},{"title":"Unarchive initiative","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/unarchive","href":"/api-reference/initiatives/unarchive-initiative"},{"title":"Get templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}/templates","href":"/api-reference/initiatives/get-templates"},{"title":"Set template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/templates","href":"/api-reference/initiatives/set-template"},{"title":"Data summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}/data/summary","href":"/api-reference/initiatives/data-summary"},{"title":"List success metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}/success-metrics","href":"/api-reference/initiatives/list-success-metrics"},{"title":"Success-metric catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}/success-metrics/catalog","href":"/api-reference/initiatives/success-metric-catalog"},{"title":"Add or replace a success metric","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/success-metrics","href":"/api-reference/initiatives/add-or-replace-a-success-metric"},{"title":"Delete a success metric","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/initiatives/{id}/success-metrics/{rootId}","href":"/api-reference/initiatives/delete-a-success-metric"},{"title":"Add participants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/participants","href":"/api-reference/initiatives/add-participants"},{"title":"List participants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}/participants","href":"/api-reference/initiatives/list-participants"},{"title":"Get participant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}/participants/{participantId}","href":"/api-reference/initiatives/get-participant"},{"title":"Participant messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}/participants/{participantId}/messages","href":"/api-reference/initiatives/participant-messages"},{"title":"List transcripts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/initiatives/{id}/transcripts","href":"/api-reference/initiatives/list-transcripts"},{"title":"Stop participant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/initiatives/{id}/participants/{participantId}/stop","href":"/api-reference/initiatives/stop-participant"}]},{"group":"Journeys","icon":"route","pages":[{"title":"List journeys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys","href":"/api-reference/journeys/list-journeys"},{"title":"Get journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys/{journeyId}","href":"/api-reference/journeys/get-journey"},{"title":"Get journey definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys/{journeyId}/definition","href":"/api-reference/journeys/get-journey-definition"},{"title":"Node catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys/catalog","href":"/api-reference/journeys/node-catalog"},{"title":"Validate journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/journeys/validate","href":"/api-reference/journeys/validate-journey"},{"title":"Create draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/journeys","href":"/api-reference/journeys/create-draft"},{"title":"Update draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/journeys/{journeyId}","href":"/api-reference/journeys/update-draft"},{"title":"Add node","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/journeys/{journeyId}/nodes","href":"/api-reference/journeys/add-node"},{"title":"Update node","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/journeys/{journeyId}/nodes/{nodeId}","href":"/api-reference/journeys/update-node"},{"title":"Delete node","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/journeys/{journeyId}/nodes/{nodeId}","href":"/api-reference/journeys/delete-node"},{"title":"Connect nodes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/journeys/{journeyId}/edges","href":"/api-reference/journeys/connect-nodes"},{"title":"Disconnect nodes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/journeys/{journeyId}/edges","href":"/api-reference/journeys/disconnect-nodes"},{"title":"Set trigger","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/journeys/{journeyId}/trigger","href":"/api-reference/journeys/set-trigger"},{"title":"Fork journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/journeys/{journeyId}/fork","href":"/api-reference/journeys/fork-journey"},{"title":"Publish journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/journeys/{journeyId}/publish","href":"/api-reference/journeys/publish-journey"},{"title":"Stop journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/journeys/{journeyId}/stop","href":"/api-reference/journeys/stop-journey"},{"title":"List message channels","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys/message-channels","href":"/api-reference/journeys/list-message-channels"},{"title":"List message templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys/message-templates","href":"/api-reference/journeys/list-message-templates"},{"title":"List email templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys/email-templates","href":"/api-reference/journeys/list-email-templates"},{"title":"Event catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys/event-catalog","href":"/api-reference/journeys/event-catalog"},{"title":"Condition catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys/condition-catalog","href":"/api-reference/journeys/condition-catalog"},{"title":"Message variable catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/journeys/{journeyId}/message-variables","href":"/api-reference/journeys/message-variable-catalog"}]},{"group":"Segments","icon":"blend","pages":[{"title":"List segments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/segments","href":"/api-reference/segments/list-segments"},{"title":"Get a segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/segments/{slug}","href":"/api-reference/segments/get-a-segment"},{"title":"List segment members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/segments/{slug}/members","href":"/api-reference/segments/list-segment-members"},{"title":"Get the segment filter catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/segments/catalog","href":"/api-reference/segments/get-the-segment-filter-catalog"},{"title":"Validate a segment filter","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/segments/validate","href":"/api-reference/segments/validate-a-segment-filter"},{"title":"Create a segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/segments","href":"/api-reference/segments/create-a-segment"},{"title":"Update a segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/segments/{slug}","href":"/api-reference/segments/update-a-segment"},{"title":"Delete a segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/segments/{slug}","href":"/api-reference/segments/delete-a-segment"},{"title":"Preview a segment filter","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/segments/preview","href":"/api-reference/segments/preview-a-segment-filter"},{"title":"Evaluate a segment now","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/segments/{slug}/evaluate","href":"/api-reference/segments/evaluate-a-segment-now"}]},{"group":"WhatsApp","icon":"https://mintlify.s3.us-west-1.amazonaws.com/boomai-c1f672dc/whatsapp.svg","pages":[{"title":"List numbers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/whatsapp-numbers","href":"/api-reference/whatsapp-templates/list-numbers"},{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/templates","href":"/api-reference/whatsapp-templates/list-templates"},{"title":"Create template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/templates","href":"/api-reference/whatsapp-templates/create-template"},{"title":"Get template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/templates/{id}","href":"/api-reference/whatsapp-templates/get-template"},{"title":"Update template tracking","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/templates/{id}/tracking","href":"/api-reference/whatsapp-templates/update-template-tracking"}]},{"group":"Email templates","icon":"envelope","pages":[{"title":"List email templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/email-templates","href":"/api-reference/email-templates/list-email-templates"},{"title":"Get email template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/email-templates/{templateId}","href":"/api-reference/email-templates/get-email-template"},{"title":"Create email template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/email-templates","href":"/api-reference/email-templates/create-email-template"},{"title":"Update email template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/email-templates/{templateId}","href":"/api-reference/email-templates/update-email-template"}]},{"group":"Lead Capture","icon":"magnet","pages":[{"title":"List Lead Capture pop-ups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/lead-capture/forms","href":"/api-reference/lead-capture/list-lead-capture-pop-ups"},{"title":"Get a Lead Capture pop-up","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/lead-capture/forms/{formId}","href":"/api-reference/lead-capture/get-a-lead-capture-pop-up"},{"title":"Create a Lead Capture pop-up","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/lead-capture/forms","href":"/api-reference/lead-capture/create-a-lead-capture-pop-up"},{"title":"Update a Lead Capture pop-up","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/lead-capture/forms/{formId}","href":"/api-reference/lead-capture/update-a-lead-capture-pop-up"},{"title":"List the leads a pop-up collected","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/lead-capture/forms/{formId}/leads","href":"/api-reference/lead-capture/list-the-leads-a-pop-up-collected"},{"title":"List embedded forms","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/lead-capture/embedded-forms","href":"/api-reference/lead-capture/list-embedded-forms"},{"title":"Get an embedded form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/lead-capture/embedded-forms/{formId}","href":"/api-reference/lead-capture/get-an-embedded-form"},{"title":"Create an embedded form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/lead-capture/embedded-forms","href":"/api-reference/lead-capture/create-an-embedded-form"},{"title":"Update an embedded form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/lead-capture/embedded-forms/{formId}","href":"/api-reference/lead-capture/update-an-embedded-form"},{"title":"Publish an embedded form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/lead-capture/embedded-forms/{formId}/publish","href":"/api-reference/lead-capture/publish-an-embedded-form"},{"title":"List an embedded form’s responses","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/lead-capture/embedded-forms/{formId}/responses","href":"/api-reference/lead-capture/list-an-embedded-form’s-responses"}]},{"group":"Message logs","icon":"scroll-text","pages":[{"title":"List message delivery logs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/message-logs","href":"/api-reference/message-logs/list-message-delivery-logs"}]}]}]},"title":"Create initiative - Boom","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-n7I5XbKb.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}