Get one pop-up in full: its whole config (design, copy, fields, trigger, game, prizes and codes), the install tag, and anything still stopping it from going live. Edit any part of the config and send it back with lead_capture_forms_update.
Organization API key, sent as Authorization: Bearer boom_org_....
Path Parameters
formId
string
required
Pop-up id.
Required string length: 1 - 64
Response
Success
id
string
required
name
string
required
status
enum<string>
required
ACTIVE shows it to visitors on the allowed sites; it is refused, with the reasons, until the pop-up is ready (at least one site, a prize per game, consent text for a phone).
Available options:
PAUSED,
ACTIVE
game
string
required
The game, or none for a plain form.
allowedOrigins
string[]
required
installKey
string
required
Public; identifies the pop-up in the install tag.
updatedAt
string
required
ISO timestamp.
installTag
string
required
The script tag to paste at the end of the page body.
buttonTag
string
required
A button that opens the pop-up when clicked, whatever its trigger; with the trigger set to click it is the only way it opens. The install tag must be on the page too.
config
object
required
The full design, copy, fields, trigger, game and prizes. Send any part of it back as config to lead_capture_forms_update. Text fields are { "en": "…", "es": "…", "pt": "…" }; en is required. flow.order is form-first (details, then the game) or play-first (the game, then details to claim the prize; needs a game). If the stored settings could no longer be read, this shows the defaults and liveIssues says so; a patch then starts from the defaults.
Show child attributes
liveIssues
string[]
required
Why it could not go live as it stands, one field: reason per line. Empty when it is ready.
{"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":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afe2b6bc299370a019ce16e","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API","count":82},{"language":"default","tag":"Guides","count":46},{"language":"default","tag":"CDP","count":29},{"language":"default","tag":"Initiatives","count":23},{"language":"default","tag":"How Boom works","count":22},{"language":"default","tag":"Journeys","count":22},{"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},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":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:-0.025em!important}#content-area .prose h2{font-weight:400;letter-spacing:-0.015em}#content-area .prose h3{font-weight:500;letter-spacing:-0.008em}body{background-color:oklch(0.97 0 0)}.dark body{background-color:oklch(0.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, 0.08)!important;border-radius:0!important;padding:1.25rem 0 0!important}.dark #pagination{border-top-color:rgba(255, 255, 255, 0.08)!important}#pagination a .flex-col.items-end,#pagination a .w-px{display:none!important}#pagination a.w-full>div{justify-content:flex-end!important}#footer a[href*=\"mintlify\"]{display:none!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(0.955 0.004 80);border-radius:0.5rem}.dark #sidebar-content a[aria-current=\"page\"]{background-color:rgba(255, 255, 255, 0.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:0.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:0.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:hover,.boom-home a:focus{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:0.93rem;color:var(--bh-muted);border:1px solid var(--bh-line);border-radius:999px;padding:0.3rem 0.8rem;background:rgba(255, 255, 255, 0.8)}.dark .boom-home .bh-eyebrow{background:rgba(255, 255, 255, 0.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:-0.025em;color:var(--bh-ink);opacity:0.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:0.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:0.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 0.5s ease-out}.boom-home .bh-paint::after{content:\"\";position:absolute;inset:0;mix-blend-mode:overlay;opacity:0.7;background-image:var(--bh-grain)}.boom-home .bh-tile:hover .bh-paint,.boom-home .bh-tile:focus-visible .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:0.85;transition:color 0.5s ease, opacity 0.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:-0.008em;color:var(--bh-ink);transition:color 0.5s ease}.boom-home .bh-p{margin:0.3rem auto 0;font-size:0.95rem;font-weight:400;line-height:1.5;color:var(--bh-muted);text-wrap:pretty;transition:color 0.5s ease}.boom-home .bh-tile:hover .bh-art,.boom-home .bh-tile:focus-visible .bh-art{color:#fff;opacity:1}.boom-home .bh-tile:hover .bh-h,.boom-home .bh-tile:focus-visible .bh-h{color:#fff}.boom-home .bh-tile:hover .bh-p,.boom-home .bh-tile:focus-visible .bh-p{color:rgba(255, 255, 255, 0.85)}.boom-home svg .h{fill:none;stroke:currentColor;stroke-width:0.75;vector-effect:non-scaling-stroke}.boom-home svg .d{fill:none;stroke:currentColor;stroke-width:0.75;vector-effect:non-scaling-stroke;stroke-dasharray:0.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/lead-capture/get-a-lead-capture-pop-up","slug":"/api-reference/lead-capture/get-a-lead-capture-pop-up","pageMetadata":{"title":"Get a Lead Capture pop-up","description":"Get one pop-up in full: its whole config (design, copy, fields, trigger, game, prizes and codes), the install tag, and anything still stopping it from going live. Edit any part of the config and send it back with lead_capture_forms_update.","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","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Get one pop-up in full: its whole config (design, copy, fields, trigger, game, prizes and codes), the install tag, and anything still stopping it from going live. Edit any part of the config and send it back with lead_capture_forms_update.\"\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":"Get a Lead Capture pop-up","description":"Get one pop-up in full: its whole config (design, copy, fields, trigger, game, prizes and codes), the install tag, and anything still stopping it from going live. Edit any part of the config and send it back with lead_capture_forms_update.","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"lead_capture_forms_get","summary":"Get a Lead Capture pop-up","description":"Get one pop-up in full: its whole config (design, copy, fields, trigger, game, prizes and codes), the install tag, and anything still stopping it from going live. Edit any part of the config and send it back with lead_capture_forms_update.","tags":["Lead Capture"],"parameters":["6ebcdf5e-be4e-4570-9846-dbbd49fbc298"],"responses":{"200":"d065e10d-85ac-4849-a385-5654679f8cc6","400":"0b28d853-70dc-4963-8576-42c32bdd1a10","401":"518ca467-6624-4a46-906d-c93834470f51","404":"958a1a05-a0ef-4bef-95c7-3a7917f24023","409":"04602ec9-7dbc-4644-80f9-3b461ae4219a","422":"f8608aad-a763-46af-8bfb-f78dddb249aa","429":"9d9aece4-0b1e-47a8-b757-3a060718b195","500":"cfe3635e-439f-4157-8fce-a786bb368f46","503":"50f1606c-82c1-42f9-942c-1083adc0c42b"},"method":"get","type":"path","servers":["c172baf1-ccc8-45ef-add0-8e7b3a4d7927","ecfbd585-f00f-444d-9448-4d52eb0286f9"],"security":["f9820212-6ce2-44dd-87ff-e770311fff6b"],"path":"/api/v1/lead-capture/forms/{formId}","baseUrlOptions":["https://www.useboom.ai","https://dev.useboom.ai"],"title":"Get a Lead Capture pop-up","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6ebcdf5e-be4e-4570-9846-dbbd49fbc298":{"name":"formId","in":"path","required":true,"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"string","minLength":1,"maxLength":64,"description":"Pop-up id.","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"d065e10d-85ac-4849-a385-5654679f8cc6":{"description":"Success","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"status":{"type":"string","enum":["PAUSED","ACTIVE"],"description":"ACTIVE shows it to visitors on the allowed sites; it is refused, with the reasons, until the pop-up is ready (at least one site, a prize per game, consent text for a phone).","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"game":{"type":"string","description":"The game, or `none` for a plain form.","isRequired":true,"uniqueKey":"game","typeLabel":"string"},"allowedOrigins":{"type":"array","items":{"type":"string","uniqueKey":"allowedOrigins.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"allowedOrigins","typeLabel":"string[]"},"installKey":{"type":"string","description":"Public; identifies the pop-up in the install tag.","isRequired":true,"uniqueKey":"installKey","typeLabel":"string"},"updatedAt":{"type":"string","description":"ISO timestamp.","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string"},"installTag":{"type":"string","description":"The script tag to paste at the end of the page body.","isRequired":true,"uniqueKey":"installTag","typeLabel":"string"},"buttonTag":{"type":"string","description":"A button that opens the pop-up when clicked, whatever its trigger; with the trigger set to `click` it is the only way it opens. The install tag must be on the page too.","isRequired":true,"uniqueKey":"buttonTag","typeLabel":"string"},"config":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"config.additionalProperties","typeLabel":"any"},"description":"The full design, copy, fields, trigger, game and prizes. Send any part of it back as `config` to `lead_capture_forms_update`. Text fields are `{ \"en\": \"…\", \"es\": \"…\", \"pt\": \"…\" }`; `en` is required. `flow.order` is `form-first` (details, then the game) or `play-first` (the game, then details to claim the prize; needs a game). If the stored settings could no longer be read, this shows the defaults and `liveIssues` says so; a patch then starts from the defaults.","isRequired":true,"uniqueKey":"config","typeLabel":"object"},"liveIssues":{"type":"array","items":{"type":"string","uniqueKey":"liveIssues.items.[INDEX]","typeLabel":"string"},"description":"Why it could not go live as it stands, one `field: reason` per line. Empty when it is ready.","isRequired":true,"uniqueKey":"liveIssues","typeLabel":"string[]"}},"required":["id","name","status","game","allowedOrigins","installKey","updatedAt","installTag","buttonTag","config","liveIssues"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","status":"PAUSED","game":"\u003cstring>","allowedOrigins":["\u003cstring>"],"installKey":"\u003cstring>","updatedAt":"\u003cstring>","installTag":"\u003cstring>","buttonTag":"\u003cstring>","config":{},"liveIssues":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"0b28d853-70dc-4963-8576-42c32bdd1a10":{"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"},"518ca467-6624-4a46-906d-c93834470f51":{"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"},"958a1a05-a0ef-4bef-95c7-3a7917f24023":{"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"},"04602ec9-7dbc-4644-80f9-3b461ae4219a":{"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"},"f8608aad-a763-46af-8bfb-f78dddb249aa":{"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"},"9d9aece4-0b1e-47a8-b757-3a060718b195":{"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"},"cfe3635e-439f-4157-8fce-a786bb368f46":{"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"},"50f1606c-82c1-42f9-942c-1083adc0c42b":{"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":{"f9820212-6ce2-44dd-87ff-e770311fff6b":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Organization API key, sent as `Authorization: Bearer boom_org_...`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"c172baf1-ccc8-45ef-add0-8e7b3a4d7927":{"url":"https://www.useboom.ai","description":"Production"},"ecfbd585-f00f-444d-9448-4d52eb0286f9":{"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":"Get a Lead Capture pop-up - Boom","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T01:20:29.297Z","originalFileLocation":"api-reference/lead-capture/get-a-lead-capture-pop-up.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=\"Get one pop-up in full: its whole config (design, copy, fields, trigger, game, prizes and codes), the install tag, and anything still stopping it from going live. Edit any part of the config and send it back with lead_capture_forms_update.\">\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=\"Get a Lead Capture pop-up - Boom\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get one pop-up in full: its whole config (design, copy, fields, trigger, game, prizes and codes), the install tag, and anything still stopping it from going live. Edit any part of the config and send it back with lead_capture_forms_update.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Boom\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.useboom.ai/api-reference/lead-capture/get-a-lead-capture-pop-up\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://boomai-c1f672dc.mintlify.site/_mintlify/api/og/v2?division=Lead+Capture\u0026amp;title=Get+a+Lead+Capture+pop-up\u0026amp;description=Get+one+pop-up+in+full%3A+its+whole+config+%28design%2C+copy%2C+fields%2C+trigger%2C+game%2C+prizes+and+codes%29%2C+the+install+tag%2C+and+anything+still+stopping+it+from+going+liv\u0026amp;theme=343c6886d5051f5920f834d4\u0026amp;signature=48035f05f59761af2de1e33847a326c41e1a2392139a9a2dc7978d4f2c16588f\">\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=\"Get a Lead Capture pop-up - Boom\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get one pop-up in full: its whole config (design, copy, fields, trigger, game, prizes and codes), the install tag, and anything still stopping it from going live. Edit any part of the config and send it back with lead_capture_forms_update.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://boomai-c1f672dc.mintlify.site/_mintlify/api/og/v2?division=Lead+Capture\u0026amp;title=Get+a+Lead+Capture+pop-up\u0026amp;description=Get+one+pop-up+in+full%3A+its+whole+config+%28design%2C+copy%2C+fields%2C+trigger%2C+game%2C+prizes+and+codes%29%2C+the+install+tag%2C+and+anything+still+stopping+it+from+going+liv\u0026amp;theme=343c6886d5051f5920f834d4\u0026amp;signature=48035f05f59761af2de1e33847a326c41e1a2392139a9a2dc7978d4f2c16588f\">\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/lead-capture/get-a-lead-capture-pop-up\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/lead-capture/get-a-lead-capture-pop-up.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/lead-capture/get-a-lead-capture-pop-up#webpage\",\"url\":\"https://docs.useboom.ai/api-reference/lead-capture/get-a-lead-capture-pop-up\",\"name\":\"Get a Lead Capture pop-up\",\"description\":\"Get one pop-up in full: its whole config (design, copy, fields, trigger, game, prizes and codes), the install tag, and anything still stopping it from going live. Edit any part of the config and send it back with lead_capture_forms_update.\",\"dateModified\":\"2026-11-18T01:20:29.297Z\",\"isPartOf\":{\"@id\":\"https://docs.useboom.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.useboom.ai/api-reference/lead-capture/get-a-lead-capture-pop-up#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.useboom.ai/api-reference/lead-capture/get-a-lead-capture-pop-up#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Lead Capture\",\"item\":\"https://docs.useboom.ai/api-reference/lead-capture/list-lead-capture-pop-ups\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get a Lead Capture pop-up\",\"item\":\"https://docs.useboom.ai/api-reference/lead-capture/get-a-lead-capture-pop-up\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.useboom.ai/api-reference/lead-capture/get-a-lead-capture-pop-up#apireference\",\"headline\":\"Get a Lead Capture pop-up\",\"name\":\"Get a Lead Capture pop-up\",\"description\":\"Get one pop-up in full: its whole config (design, copy, fields, trigger, game, prizes and codes), the install tag, and anything still stopping it from going live. Edit any part of the config and send it back with lead_capture_forms_update.\",\"url\":\"https://docs.useboom.ai/api-reference/lead-capture/get-a-lead-capture-pop-up\",\"mainEntityOfPage\":{\"@id\":\"https://docs.useboom.ai/api-reference/lead-capture/get-a-lead-capture-pop-up#webpage\"},\"dateModified\":\"2026-11-18T01:20:29.297Z\",\"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\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Boom\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/lead-capture/get-a-lead-capture-pop-up.md","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","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","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","description":"List the organization's Lead Capture pop-ups with their status, game, allowed sites and install key. Archived pop-ups are not included.","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","description":"Create a pop-up, PAUSED, optionally from a template. Then add prizes and codes with lead_capture_forms_update, and set it ACTIVE there once lead_capture_forms_get shows no liveIssues. Visitors see nothing until it is ACTIVE and the install tag is on an allowed site.","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"}]},{"group":"One-time codes","icon":"key-round","pages":[{"title":"Send a one-time code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/otp/send","href":"/api-reference/one-time-codes/send-a-one-time-code"},{"title":"Verify a one-time code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/otp/verify","href":"/api-reference/one-time-codes/verify-a-one-time-code"}]}]}]},"basePath":"","title":"Get a Lead Capture pop-up - Boom","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-CnLhKuUV.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}