202 acknowledges acceptance, not delivery — the returned broadcast’s
counts all start at zero and move as the worker fans the batch out. Poll
GET /v1/broadcasts/{id} for progress and
/v1/broadcasts/{id}/recipients for per-recipient outcomes.
Address each recipient by contact_id or phone. A phone that matches
no contact creates one, in the org’s initial funnel stage — sending to a
hundred unknown numbers grows the CRM by up to a hundred contacts. The same
person named twice (once by id, once by phone) is queued and charged once.
GET /v1/templates/{id}/send-requirements lists exactly what this template
needs filled. Everything it names is validated here before the wallet is
touched or Meta is called, so a refusal costs nothing: 400 an unusable or
ambiguous channel_id, 402 a batch the WhatsApp balance can’t cover, 404 an
unknown template or recipient, 409 a template that is not APPROVED or a
batch past what is left of Meta’s rolling 24h messaging window (the whole
request is refused rather than silently truncated), 422 anything missing,
unknown, or unfetchable in the parameters.
Pass Idempotency-Key to make a retry safe: the same key returns the
original broadcast instead of queuing a second one, for 24h.
Send an APPROVED template to one recipient or a list of them.
recipients accepts a single object or an array with identical semantics —
sending to one person should not require wrapping it — and the response is
a PublicBroadcast either way.
One person to send to, plus what this template needs filled for them.
Exactly one of contact_id / phone. A phone that matches no contact
creates one (see the endpoint docstring) — the honest consequence of
addressing a CRM-backed product by phone number.
variables is keyed by the authored token — "1" for a positional
template, "discount_code" or "contact.first_name" for a named one.
Positional-vs-named is a property of the template and mixing the two is
fatal at Meta, so this is deliberately not an ordered array.
GET /v1/templates/{id}/send-requirements lists the exact keys.
Derived campaign status shown in the UI. stopped_low_balance and
cancelled mirror the stored state; the other two are computed from the
counts (no stored value — chunked async means no single worker knows it sent
the last recipient).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ciarem","description":"Ciarem help center: set up and run your AI agent across WhatsApp, Instagram, Messenger, and your website.","colors":{"primary":"#7669FC","light":"#9B8CFF","dark":"#5B4BD6"},"logo":{"light":"https://mintcdn.com/ciaremaai/FrCl9vIQUOJmXw0K/logo/ciarem-logo.svg?fit=max\u0026auto=format\u0026n=FrCl9vIQUOJmXw0K\u0026q=85\u0026s=4826d113777f270789a291ef1256cbbe","dark":"https://mintcdn.com/ciaremaai/FrCl9vIQUOJmXw0K/logo/ciarem-logo.svg?fit=max\u0026auto=format\u0026n=FrCl9vIQUOJmXw0K\u0026q=85\u0026s=4826d113777f270789a291ef1256cbbe"},"favicon":"https://mintcdn.com/ciaremaai/rrKvoMfzjsUS61Og/favicon.png?fit=max\u0026auto=format\u0026n=rrKvoMfzjsUS61Og\u0026q=85\u0026s=39e5fa47dd157989e89d46ead28399a2","appearance":{"default":"light"},"navbar":{"primary":{"type":"button","label":"ciarem.ai","href":"https://www.ciarem.ai"}},"footer":{"socials":{"website":"https://www.ciarem.ai"}},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","href":"getting-started/what-is-ciarem"},{"language":"es","href":"es/getting-started/what-is-ciarem"},{"language":"pt","href":"pt/getting-started/what-is-ciarem"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ciaremaai","hasAudioNarration":false,"actualSubdomain":"ciaremaai","customDomains":["help.ciarem.ai"],"gitSource":{"type":"github","owner":"ciaremai","repo":"help-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"f3acf3c1-814b-42f1-a5ae-c55de9928eab","liveDeploymentHistoryId":"6adf83db6c71dd37a988cc4f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adf83db6c71dd37a988cc4f"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adfa9f24c626e3171be5150","clientVersion":"0.0.3969","searchFilterCounts":[{"language":"default","tag":"API for developers","count":40},{"language":"default","tag":"API reference","count":40},{"language":"en","tag":"Channels","count":17},{"language":"es","tag":"Canales","count":17},{"language":"pt","tag":"Canais","count":17},{"language":"en","tag":"Your AI agent","count":13},{"language":"es","tag":"Tu agente de IA","count":13},{"language":"pt","tag":"Seu agente de IA","count":13},{"language":"en","tag":"WhatsApp","count":12},{"language":"es","tag":"WhatsApp","count":12},{"language":"pt","tag":"WhatsApp","count":12},{"language":"default","tag":"CRM","count":11},{"language":"en","tag":"Using Ciarem","count":10},{"language":"es","tag":"Usando Ciarem","count":10},{"language":"pt","tag":"Usando a Ciarem","count":10},{"language":"default","tag":"Webhooks","count":9},{"language":"en","tag":"API for developers","count":8},{"language":"es","tag":"API para desarrolladores","count":8},{"language":"pt","tag":"API para desenvolvedores","count":8},{"language":"en","tag":"Agent team","count":5},{"language":"en","tag":"Integrations","count":5},{"language":"es","tag":"Equipo de agentes","count":5},{"language":"es","tag":"Integraciones","count":5},{"language":"pt","tag":"Equipe de agentes","count":5},{"language":"pt","tag":"Integrações","count":5},{"language":"default","tag":"Broadcasts","count":5},{"language":"default","tag":"Contacts","count":5},{"language":"default","tag":"WhatsApp templates","count":5},{"language":"en","tag":"Mobile app","count":4},{"language":"en","tag":"Webhooks","count":4},{"language":"es","tag":"App móvil","count":4},{"language":"es","tag":"Webhooks","count":4},{"language":"pt","tag":"App móvel","count":4},{"language":"pt","tag":"Webhooks","count":4},{"language":"en","tag":"What your agent can do","count":3},{"language":"es","tag":"Qué puede hacer tu agente","count":3},{"language":"pt","tag":"O que seu agente pode fazer","count":3},{"language":"default","tag":"Conversations","count":3},{"language":"default","tag":"Account","count":1},{"language":"default","tag":"WhatsApp numbers","count":1}]},"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":"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":[],"page":{"pagePath":"api-reference/broadcasts/send-a-template","slug":"/api-reference/broadcasts/send-a-template","pageMetadata":{"title":"Send a template","description":"Queue an APPROVED template to 1-100 recipients.\n\n**202 acknowledges acceptance, not delivery** — the returned broadcast's\ncounts all start at zero and move as the worker fans the batch out. Poll\n`GET /v1/broadcasts/{id}` for progress and\n`/v1/broadcasts/{id}/recipients` for per-recipient outcomes.\n\nAddress each recipient by `contact_id` or `phone`. **A `phone` that matches\nno contact creates one**, in the org's initial funnel stage — sending to a\nhundred unknown numbers grows the CRM by up to a hundred contacts. The same\nperson named twice (once by id, once by phone) is queued and charged once.\n\n`GET /v1/templates/{id}/send-requirements` lists exactly what this template\nneeds filled. Everything it names is validated here **before** the wallet is\ntouched or Meta is called, so a refusal costs nothing: 400 an unusable or\nambiguous `channel_id`, 402 a batch the WhatsApp balance can't cover, 404 an\nunknown template or recipient, 409 a template that is not APPROVED or a\nbatch past what is left of Meta's rolling 24h messaging window (the whole\nrequest is refused rather than silently truncated), 422 anything missing,\nunknown, or unfetchable in the parameters.\n\nPass `Idempotency-Key` to make a retry safe: the same key returns the\noriginal broadcast instead of queuing a second one, for 24h.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates/{template_id}/send","href":"/api-reference/broadcasts/send-a-template","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Queue an APPROVED template to 1-100 recipients.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"202 acknowledges acceptance, not delivery\"\n }), \" — the returned broadcast’s\\ncounts all start at zero and move as the worker fans the batch out. Poll\\n\", _jsx(_components.code, {\n children: \"GET /v1/broadcasts/{id}\"\n }), \" for progress and\\n\", _jsx(_components.code, {\n children: \"/v1/broadcasts/{id}/recipients\"\n }), \" for per-recipient outcomes.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Address each recipient by \", _jsx(_components.code, {\n children: \"contact_id\"\n }), \" or \", _jsx(_components.code, {\n children: \"phone\"\n }), \". \", _jsxs(_components.strong, {\n children: [\"A \", _jsx(_components.code, {\n children: \"phone\"\n }), \" that matches\\nno contact creates one\"]\n }), \", in the org’s initial funnel stage — sending to a\\nhundred unknown numbers grows the CRM by up to a hundred contacts. The same\\nperson named twice (once by id, once by phone) is queued and charged once.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"GET /v1/templates/{id}/send-requirements\"\n }), \" lists exactly what this template\\nneeds filled. Everything it names is validated here \", _jsx(_components.strong, {\n children: \"before\"\n }), \" the wallet is\\ntouched or Meta is called, so a refusal costs nothing: 400 an unusable or\\nambiguous \", _jsx(_components.code, {\n children: \"channel_id\"\n }), \", 402 a batch the WhatsApp balance can’t cover, 404 an\\nunknown template or recipient, 409 a template that is not APPROVED or a\\nbatch past what is left of Meta’s rolling 24h messaging window (the whole\\nrequest is refused rather than silently truncated), 422 anything missing,\\nunknown, or unfetchable in the parameters.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Pass \", _jsx(_components.code, {\n children: \"Idempotency-Key\"\n }), \" to make a retry safe: the same key returns the\\noriginal broadcast instead of queuing a second one, for 24h.\"]\n })]\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":"Send a template","description":"Queue an APPROVED template to 1-100 recipients.\n\n**202 acknowledges acceptance, not delivery** — the returned broadcast's\ncounts all start at zero and move as the worker fans the batch out. Poll\n`GET /v1/broadcasts/{id}` for progress and\n`/v1/broadcasts/{id}/recipients` for per-recipient outcomes.\n\nAddress each recipient by `contact_id` or `phone`. **A `phone` that matches\nno contact creates one**, in the org's initial funnel stage — sending to a\nhundred unknown numbers grows the CRM by up to a hundred contacts. The same\nperson named twice (once by id, once by phone) is queued and charged once.\n\n`GET /v1/templates/{id}/send-requirements` lists exactly what this template\nneeds filled. Everything it names is validated here **before** the wallet is\ntouched or Meta is called, so a refusal costs nothing: 400 an unusable or\nambiguous `channel_id`, 402 a batch the WhatsApp balance can't cover, 404 an\nunknown template or recipient, 409 a template that is not APPROVED or a\nbatch past what is left of Meta's rolling 24h messaging window (the whole\nrequest is refused rather than silently truncated), 422 anything missing,\nunknown, or unfetchable in the parameters.\n\nPass `Idempotency-Key` to make a retry safe: the same key returns the\noriginal broadcast instead of queuing a second one, for 24h.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates/{template_id}/send","href":"/api-reference/broadcasts/send-a-template","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Broadcasts"],"summary":"Send a template","description":"Queue an APPROVED template to 1-100 recipients.\n\n**202 acknowledges acceptance, not delivery** — the returned broadcast's\ncounts all start at zero and move as the worker fans the batch out. Poll\n`GET /v1/broadcasts/{id}` for progress and\n`/v1/broadcasts/{id}/recipients` for per-recipient outcomes.\n\nAddress each recipient by `contact_id` or `phone`. **A `phone` that matches\nno contact creates one**, in the org's initial funnel stage — sending to a\nhundred unknown numbers grows the CRM by up to a hundred contacts. The same\nperson named twice (once by id, once by phone) is queued and charged once.\n\n`GET /v1/templates/{id}/send-requirements` lists exactly what this template\nneeds filled. Everything it names is validated here **before** the wallet is\ntouched or Meta is called, so a refusal costs nothing: 400 an unusable or\nambiguous `channel_id`, 402 a batch the WhatsApp balance can't cover, 404 an\nunknown template or recipient, 409 a template that is not APPROVED or a\nbatch past what is left of Meta's rolling 24h messaging window (the whole\nrequest is refused rather than silently truncated), 422 anything missing,\nunknown, or unfetchable in the parameters.\n\nPass `Idempotency-Key` to make a retry safe: the same key returns the\noriginal broadcast instead of queuing a second one, for 24h.","operationId":"send_endpoint_v1_templates__template_id__send_post","parameters":["3edcae9a-5b57-46a9-98ed-80b72fb5810a","a13c40e9-b2ec-42ca-a09b-9ca85323dc89"],"requestBody":"fb7ad12a-76b0-4284-8b9a-3addd8a50cbd","responses":{"202":"ffe60bb4-1a90-49de-9f19-18436d73cc6c","401":"2b3e751c-7a0d-487a-afe9-3c2d8b6cce36","403":"9ea0bf9c-6a6a-4e8d-9931-e166b2c3e4aa","422":"4a2e85ce-1fbf-492d-abc0-6dcf0431df18","429":"2ff2fac7-73c8-4121-8b21-de5591eae04d","503":"804b9c4c-090b-40e5-9af6-66e541e5742b"},"method":"post","type":"path","servers":["5b78e9ff-1963-4818-8c29-aa7c2f9cadbc"],"security":["c28375ca-7ae9-4d52-aa3f-f21832e5f2a6"],"path":"/v1/templates/{template_id}/send","baseUrlOptions":["https://api.ciarem.ai"],"title":"Send a template","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3edcae9a-5b57-46a9-98ed-80b72fb5810a":{"name":"template_id","in":"path","required":true,"schema":{"type":"string","title":"Template Id","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"a13c40e9-b2ec-42ca-a09b-9ca85323dc89":{"name":"Idempotency-Key","in":"header","required":false,"schema":{"oneOf":[{"type":"string","title":"Idempotency-Key","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Idempotency-Key","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"recipients":{"oneOf":[{"type":"object","title":"PublicSendRecipient","description":"One person to send to, plus what this template needs filled *for them*.\n\nExactly one of `contact_id` / `phone`. A `phone` that matches no contact\ncreates one (see the endpoint docstring) — the honest consequence of\naddressing a CRM-backed product by phone number.\n\n`variables` is keyed by the **authored token** — `\"1\"` for a positional\ntemplate, `\"discount_code\"` or `\"contact.first_name\"` for a named one.\nPositional-vs-named is a property of the template and mixing the two is\nfatal at Meta, so this is deliberately not an ordered array.\n`GET /v1/templates/{id}/send-requirements` lists the exact keys.","properties":{"contact_id":{"oneOf":[{"type":"string","title":"Contact Id","uniqueKey":"recipients.oneOf.0.contact_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Contact Id","uniqueKey":"recipients.oneOf.0.contact_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.oneOf.0.contact_id","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","title":"Phone","pattern":"^\\+[1-9]\\d{1,14}$","uniqueKey":"recipients.oneOf.0.phone.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phone","uniqueKey":"recipients.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.oneOf.0.phone","typeLabel":"string | null"},"variables":{"additionalProperties":{"type":"string","uniqueKey":"recipients.oneOf.0.variables.additionalProperties","typeLabel":"string"},"type":"object","title":"Variables","uniqueKey":"recipients.oneOf.0.variables","typeLabel":"Variables · object"},"coupon_code":{"oneOf":[{"type":"string","title":"Coupon Code","uniqueKey":"recipients.oneOf.0.coupon_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Coupon Code","uniqueKey":"recipients.oneOf.0.coupon_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.oneOf.0.coupon_code","typeLabel":"string | null"},"url_suffixes":{"patternProperties":{"^\\d+$":{"type":"string"}},"type":"object","title":"Url Suffixes","uniqueKey":"recipients.oneOf.0.url_suffixes","typeLabel":"Url Suffixes · object"},"lto_expiration":{"oneOf":[{"type":"string","title":"Lto Expiration","format":"date-time","uniqueKey":"recipients.oneOf.0.lto_expiration.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Lto Expiration","uniqueKey":"recipients.oneOf.0.lto_expiration.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.oneOf.0.lto_expiration","typeLabel":"string\u003cdate-time> | null"},"catalog_records":{"patternProperties":{"^[a-z][a-z0-9_]*\\.\\d+$":{"type":"string"}},"type":"object","title":"Catalog Records","uniqueKey":"recipients.oneOf.0.catalog_records","typeLabel":"Catalog Records · object"},"header_media_url":{"oneOf":[{"type":"string","title":"Header Media Url","uniqueKey":"recipients.oneOf.0.header_media_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Header Media Url","uniqueKey":"recipients.oneOf.0.header_media_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.oneOf.0.header_media_url","typeLabel":"string | null"},"card_media_urls":{"patternProperties":{"^\\d+$":{"type":"string"}},"type":"object","title":"Card Media Urls","uniqueKey":"recipients.oneOf.0.card_media_urls","typeLabel":"Card Media Urls · object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"recipients.oneOf.0","typeLabel":"PublicSendRecipient · object"},{"type":"array","items":{"properties":{"contact_id":{"oneOf":[{"type":"string","title":"Contact Id","uniqueKey":"recipients.oneOf.1.items.[INDEX].contact_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Contact Id","uniqueKey":"recipients.oneOf.1.items.[INDEX].contact_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.oneOf.1.items.[INDEX].contact_id","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","title":"Phone","pattern":"^\\+[1-9]\\d{1,14}$","uniqueKey":"recipients.oneOf.1.items.[INDEX].phone.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phone","uniqueKey":"recipients.oneOf.1.items.[INDEX].phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.oneOf.1.items.[INDEX].phone","typeLabel":"string | null"},"variables":{"additionalProperties":{"type":"string","uniqueKey":"recipients.oneOf.1.items.[INDEX].variables.additionalProperties","typeLabel":"string"},"type":"object","title":"Variables","uniqueKey":"recipients.oneOf.1.items.[INDEX].variables","typeLabel":"Variables · object"},"coupon_code":{"oneOf":[{"type":"string","title":"Coupon Code","uniqueKey":"recipients.oneOf.1.items.[INDEX].coupon_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Coupon Code","uniqueKey":"recipients.oneOf.1.items.[INDEX].coupon_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.oneOf.1.items.[INDEX].coupon_code","typeLabel":"string | null"},"url_suffixes":{"patternProperties":{"^\\d+$":{"type":"string"}},"type":"object","title":"Url Suffixes","uniqueKey":"recipients.oneOf.1.items.[INDEX].url_suffixes","typeLabel":"Url Suffixes · object"},"lto_expiration":{"oneOf":[{"type":"string","title":"Lto Expiration","format":"date-time","uniqueKey":"recipients.oneOf.1.items.[INDEX].lto_expiration.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Lto Expiration","uniqueKey":"recipients.oneOf.1.items.[INDEX].lto_expiration.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.oneOf.1.items.[INDEX].lto_expiration","typeLabel":"string\u003cdate-time> | null"},"catalog_records":{"patternProperties":{"^[a-z][a-z0-9_]*\\.\\d+$":{"type":"string"}},"type":"object","title":"Catalog Records","uniqueKey":"recipients.oneOf.1.items.[INDEX].catalog_records","typeLabel":"Catalog Records · object"},"header_media_url":{"oneOf":[{"type":"string","title":"Header Media Url","uniqueKey":"recipients.oneOf.1.items.[INDEX].header_media_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Header Media Url","uniqueKey":"recipients.oneOf.1.items.[INDEX].header_media_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.oneOf.1.items.[INDEX].header_media_url","typeLabel":"string | null"},"card_media_urls":{"patternProperties":{"^\\d+$":{"type":"string"}},"type":"object","title":"Card Media Urls","uniqueKey":"recipients.oneOf.1.items.[INDEX].card_media_urls","typeLabel":"Card Media Urls · object"}},"additionalProperties":false,"type":"object","title":"PublicSendRecipient","description":"One person to send to, plus what this template needs filled *for them*.\n\nExactly one of `contact_id` / `phone`. A `phone` that matches no contact\ncreates one (see the endpoint docstring) — the honest consequence of\naddressing a CRM-backed product by phone number.\n\n`variables` is keyed by the **authored token** — `\"1\"` for a positional\ntemplate, `\"discount_code\"` or `\"contact.first_name\"` for a named one.\nPositional-vs-named is a property of the template and mixing the two is\nfatal at Meta, so this is deliberately not an ordered array.\n`GET /v1/templates/{id}/send-requirements` lists the exact keys.","uniqueKey":"recipients.oneOf.1.items.[INDEX]","typeLabel":"PublicSendRecipient · object"},"title":"Recipients","isRequired":true,"uniqueKey":"recipients.oneOf.1","typeLabel":"PublicSendRecipient · object[]"}],"isRequired":true,"uniqueKey":"recipients","typeLabel":"PublicSendRecipient · object | PublicSendRecipient · object[]"},"channel_id":{"oneOf":[{"type":"string","title":"Channel Id","uniqueKey":"channel_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Channel Id","uniqueKey":"channel_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"channel_id","typeLabel":"string | null"}},"additionalProperties":false,"type":"object","required":["recipients"],"title":"PublicSendRequest","description":"Send an APPROVED template to one recipient or a list of them.\n\n`recipients` accepts a single object or an array with identical semantics —\nsending to one person should not require wrapping it — and the response is\na `PublicBroadcast` either way.","uniqueKey":"","typeLabel":"PublicSendRequest · object"},"examples":{"Example":{"title":"Example","value":{"recipients":{"contact_id":"\u003cstring>","phone":"\u003cstring>","variables":{},"coupon_code":"\u003cstring>","url_suffixes":{},"lto_expiration":"2023-11-07T05:31:56Z","catalog_records":{},"header_media_url":"\u003cstring>","card_media_urls":{}},"channel_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ffe60bb4-1a90-49de-9f19-18436d73cc6c":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"template_id":{"type":"string","title":"Template Id","isRequired":true,"uniqueKey":"template_id","typeLabel":"string"},"template_name":{"type":"string","title":"Template Name","isRequired":true,"uniqueKey":"template_name","typeLabel":"string"},"template_language":{"type":"string","title":"Template Language","isRequired":true,"uniqueKey":"template_language","typeLabel":"string"},"channel_id":{"type":"string","title":"Channel Id","isRequired":true,"uniqueKey":"channel_id","typeLabel":"string"},"status":{"type":"string","enum":["in_progress","completed","stopped_low_balance","cancelled"],"title":"BroadcastDisplayStatus","description":"Derived campaign status shown in the UI. `stopped_low_balance` and\n`cancelled` mirror the stored state; the other two are computed from the\ncounts (no stored value — chunked async means no single worker knows it sent\nthe last recipient).","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"requested":{"type":"integer","title":"Requested","isRequired":true,"uniqueKey":"requested","typeLabel":"integer"},"sent":{"type":"integer","title":"Sent","isRequired":true,"uniqueKey":"sent","typeLabel":"integer"},"failed":{"type":"integer","title":"Failed","isRequired":true,"uniqueKey":"failed","typeLabel":"integer"},"pending":{"type":"integer","title":"Pending","isRequired":true,"uniqueKey":"pending","typeLabel":"integer"},"origin":{"type":"string","title":"Origin","isRequired":true,"uniqueKey":"origin","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","title":"Created At","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"}},"type":"object","required":["id","template_id","template_name","template_language","channel_id","status","requested","sent","failed","pending","origin","created_at"],"title":"PublicBroadcast","description":"A queued template send. Counts are derived from the messages it produced,\nso they move as the worker fans the batch out; they always sum to\n`requested`.","uniqueKey":"","typeLabel":"PublicBroadcast · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","template_id":"\u003cstring>","template_name":"\u003cstring>","template_language":"\u003cstring>","channel_id":"\u003cstring>","status":"in_progress","requested":123,"sent":123,"failed":123,"pending":123,"origin":"\u003cstring>","created_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"headers":{"X-RateLimit-Limit":{"description":"Requests allowed per window, shared across the org's keys.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"When the window resets, as a Unix timestamp in seconds.","schema":{"type":"integer"}}},"exampleType":"generated"},"2b3e751c-7a0d-487a-afe9-3c2d8b6cce36":{"description":"No usable credential: `missing_bearer_token` (no `Authorization: Bearer`) or `invalid_api_key` (unknown or revoked key).","content":{"application/json":{"schema":{"description":"An error whose `detail` is a stable, machine-readable code.","properties":{"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"required":["detail"],"title":"PublicError","type":"object","uniqueKey":"","typeLabel":"PublicError · object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"9ea0bf9c-6a6a-4e8d-9931-e166b2c3e4aa":{"description":"The credential is real but not allowed here: `api_key_required` (a session token rather than an `oak_` key), `plan_upgrade_required` (the plan doesn't include API access — upgrade to Growth or Scale), `trial_expired` (the free trial ended without a card — subscribe to keep the key working), or `subscription_required` (the subscription is canceled or suspended).","content":{"application/json":{"schema":{"description":"An error whose `detail` is a stable, machine-readable code.","properties":{"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"required":["detail"],"title":"PublicError","type":"object","uniqueKey":"","typeLabel":"PublicError · object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"4a2e85ce-1fbf-492d-abc0-6dcf0431df18":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"2ff2fac7-73c8-4121-8b21-de5591eae04d":{"description":"Over the organization's request budget (`rate_limited`); the budget depends on the plan. `Retry-After` says how many seconds to wait.","content":{"application/json":{"schema":{"description":"An error whose `detail` is a stable, machine-readable code.","properties":{"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"required":["detail"],"title":"PublicError","type":"object","uniqueKey":"","typeLabel":"PublicError · object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"headers":{"Retry-After":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"Requests allowed per window, shared across the org's keys.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"When the window resets, as a Unix timestamp in seconds.","schema":{"type":"integer"}}},"exampleType":"generated"},"804b9c4c-090b-40e5-9af6-66e541e5742b":{"description":"The API is at capacity (`server_busy`). The request was not run and does not count against the budget; retry after `Retry-After` seconds.","content":{"application/json":{"schema":{"description":"An error whose `detail` is a stable, machine-readable code.","properties":{"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"required":["detail"],"title":"PublicError","type":"object","uniqueKey":"","typeLabel":"PublicError · object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"exampleType":"generated"}},"security":{"c28375ca-7ae9-4d52-aa3f-f21832e5f2a6":{"apiKey":{"type":"http","scheme":"bearer","description":"An org API key: `Authorization: Bearer oak_…`.","scopes":[],"schemeName":"apiKey"}}},"servers":{"5b78e9ff-1963-4818-8c29-aa7c2f9cadbc":{"url":"https://api.ciarem.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An org API key: `Authorization: Bearer oak_…`.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An org API key: `Authorization: Bearer oak_…`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"ciaremaai","siteName":"Ciarem","title":"Send a template - Ciarem","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/broadcasts/send-a-template","matchLevel":0},"es":{"href":"/api-reference/broadcasts/send-a-template","matchLevel":0},"pt":{"href":"/api-reference/broadcasts/send-a-template","matchLevel":0}}},"lastModified":"2026-10-23T21:51:26.599Z","originalFileLocation":"api-reference/broadcasts/send-a-template.mdx","locale":"en"},"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=\"light\"}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=\"Queue an APPROVED template to 1-100 recipients. 202 acknowledges acceptance, not delivery — the returned broadcast\u0026#x27;s counts all start at zero and move as the worker fans the batch out. Poll GET /v1/broadcasts/{id} for progress and /v1/broadcasts/{id}/recipients for per-recipient outcomes. Address each recipient by contact_id or phone. A phone that matches no contact creates one, in the org\u0026#x27;s initial funnel stage — sending to a hundred unknown numbers grows the CRM by up to a hundred contacts. The same person named twice (once by id, once by phone) is queued and charged once. GET /v1/templates/{id}/send-requirements lists exactly what this template needs filled. Everything it names is validated here before the wallet is touched or Meta is called, so a refusal costs nothing: 400 an unusable or ambiguous channel_id, 402 a batch the WhatsApp balance can\u0026#x27;t cover, 404 an unknown template or recipient, 409 a template that is not APPROVED or a batch past what is left of Meta\u0026#x27;s rolling 24h messaging window (the whole request is refused rather than silently truncated), 422 anything missing, unknown, or unfetchable in the parameters. Pass Idempotency-Key to make a retry safe: the same key returns the original broadcast instead of queuing a second one, for 24h.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ciarem\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ciaremaai/ZgQ3esrcbcJVW0W3/_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/ciaremaai/ZgQ3esrcbcJVW0W3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ciaremaai/ZgQ3esrcbcJVW0W3/_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/ciaremaai/ZgQ3esrcbcJVW0W3/_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/ciaremaai/ZgQ3esrcbcJVW0W3/_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/ciaremaai/ZgQ3esrcbcJVW0W3/_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/ciaremaai/ZgQ3esrcbcJVW0W3/_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/ciaremaai/ZgQ3esrcbcJVW0W3/_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/ciaremaai/ZgQ3esrcbcJVW0W3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Send a template - Ciarem\">\u003cmeta data-mint-head property=\"og:description\" content=\"Queue an APPROVED template to 1-100 recipients. 202 acknowledges acceptance, not delivery — the returned broadcast\u0026#x27;s counts all start at zero and move as the worker fans the batch out. Poll GET /v1/broadcasts/{id} for progress and /v1/broadcasts/{id}/recipients for per-recipient outcomes. Address each recipient by contact_id or phone. A phone that matches no contact creates one, in the org\u0026#x27;s initial funnel stage — sending to a hundred unknown numbers grows the CRM by up to a hundred contacts. The same person named twice (once by id, once by phone) is queued and charged once. GET /v1/templates/{id}/send-requirements lists exactly what this template needs filled. Everything it names is validated here before the wallet is touched or Meta is called, so a refusal costs nothing: 400 an unusable or ambiguous channel_id, 402 a batch the WhatsApp balance can\u0026#x27;t cover, 404 an unknown template or recipient, 409 a template that is not APPROVED or a batch past what is left of Meta\u0026#x27;s rolling 24h messaging window (the whole request is refused rather than silently truncated), 422 anything missing, unknown, or unfetchable in the parameters. Pass Idempotency-Key to make a retry safe: the same key returns the original broadcast instead of queuing a second one, for 24h.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ciarem\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://help.ciarem.ai/api-reference/broadcasts/send-a-template\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ciaremaai.mintlify.app/_mintlify/api/og/v2?division=Broadcasts\u0026amp;title=Send+a+template\u0026amp;description=Queue+an+APPROVED+template+to+1-100+recipients.%0A%0A**202+acknowledges+acceptance%2C+not+delivery**+%E2%80%94+the+returned+broadcast%27s%0Acounts+all+start+at+zero+and+move+as+t\u0026amp;theme=3f057bbf8fb0731c095aa029\u0026amp;signature=249d4810a5d217fd88f342da1e17548ac2879c936091d9c5ebf69c4bff23c1dd\">\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=\"Send a template - Ciarem\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Queue an APPROVED template to 1-100 recipients. 202 acknowledges acceptance, not delivery — the returned broadcast\u0026#x27;s counts all start at zero and move as the worker fans the batch out. Poll GET /v1/broadcasts/{id} for progress and /v1/broadcasts/{id}/recipients for per-recipient outcomes. Address each recipient by contact_id or phone. A phone that matches no contact creates one, in the org\u0026#x27;s initial funnel stage — sending to a hundred unknown numbers grows the CRM by up to a hundred contacts. The same person named twice (once by id, once by phone) is queued and charged once. GET /v1/templates/{id}/send-requirements lists exactly what this template needs filled. Everything it names is validated here before the wallet is touched or Meta is called, so a refusal costs nothing: 400 an unusable or ambiguous channel_id, 402 a batch the WhatsApp balance can\u0026#x27;t cover, 404 an unknown template or recipient, 409 a template that is not APPROVED or a batch past what is left of Meta\u0026#x27;s rolling 24h messaging window (the whole request is refused rather than silently truncated), 422 anything missing, unknown, or unfetchable in the parameters. Pass Idempotency-Key to make a retry safe: the same key returns the original broadcast instead of queuing a second one, for 24h.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ciaremaai.mintlify.app/_mintlify/api/og/v2?division=Broadcasts\u0026amp;title=Send+a+template\u0026amp;description=Queue+an+APPROVED+template+to+1-100+recipients.%0A%0A**202+acknowledges+acceptance%2C+not+delivery**+%E2%80%94+the+returned+broadcast%27s%0Acounts+all+start+at+zero+and+move+as+t\u0026amp;theme=3f057bbf8fb0731c095aa029\u0026amp;signature=249d4810a5d217fd88f342da1e17548ac2879c936091d9c5ebf69c4bff23c1dd\">\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/ciaremaai/ZgQ3esrcbcJVW0W3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ciarem\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7669FC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://help.ciarem.ai/api-reference/broadcasts/send-a-template\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/broadcasts/send-a-template.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://help.ciarem.ai/#organization\",\"name\":\"Ciarem\",\"url\":\"https://help.ciarem.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ciaremaai/FrCl9vIQUOJmXw0K/logo/ciarem-logo.svg?fit=max\u0026auto=format\u0026n=FrCl9vIQUOJmXw0K\u0026q=85\u0026s=4826d113777f270789a291ef1256cbbe\"}},{\"@type\":\"WebSite\",\"@id\":\"https://help.ciarem.ai#website\",\"name\":\"Ciarem\",\"url\":\"https://help.ciarem.ai\",\"publisher\":{\"@id\":\"https://help.ciarem.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://help.ciarem.ai/api-reference/broadcasts/send-a-template#webpage\",\"url\":\"https://help.ciarem.ai/api-reference/broadcasts/send-a-template\",\"name\":\"Send a template\",\"description\":\"Queue an APPROVED template to 1-100 recipients. 202 acknowledges acceptance, not delivery — the returned broadcast's counts all start at zero and move as the worker fans the batch out. Poll GET /v1/broadcasts/{id} for progress and /v1/broadcasts/{id}/recipients for per-recipient outcomes. Address each recipient by contact_id or phone. A phone that matches no contact creates one, in the org's initial funnel stage — sending to a hundred unknown numbers grows the CRM by up to a hundred contacts. The same person named twice (once by id, once by phone) is queued and charged once. GET /v1/templates/{id}/send-requirements lists exactly what this template needs filled. Everything it names is validated here before the wallet is touched or Meta is called, so a refusal costs nothing: 400 an unusable or ambiguous channel_id, 402 a batch the WhatsApp balance can't cover, 404 an unknown template or recipient, 409 a template that is not APPROVED or a batch past what is left of Meta's rolling 24h messaging window (the whole request is refused rather than silently truncated), 422 anything missing, unknown, or unfetchable in the parameters. Pass Idempotency-Key to make a retry safe: the same key returns the original broadcast instead of queuing a second one, for 24h.\",\"dateModified\":\"2026-10-23T21:51:26.599Z\",\"isPartOf\":{\"@id\":\"https://help.ciarem.ai#website\"},\"breadcrumb\":{\"@id\":\"https://help.ciarem.ai/api-reference/broadcasts/send-a-template#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://help.ciarem.ai/api-reference/broadcasts/send-a-template#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API for developers\",\"item\":\"https://help.ciarem.ai/api-reference/quickstart\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API reference\",\"item\":\"https://help.ciarem.ai/api-reference/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Send a template\",\"item\":\"https://help.ciarem.ai/api-reference/broadcasts/send-a-template\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://help.ciarem.ai/api-reference/broadcasts/send-a-template#apireference\",\"headline\":\"Send a template\",\"name\":\"Send a template\",\"description\":\"Queue an APPROVED template to 1-100 recipients. 202 acknowledges acceptance, not delivery — the returned broadcast's counts all start at zero and move as the worker fans the batch out. Poll GET /v1/broadcasts/{id} for progress and /v1/broadcasts/{id}/recipients for per-recipient outcomes. Address each recipient by contact_id or phone. A phone that matches no contact creates one, in the org's initial funnel stage — sending to a hundred unknown numbers grows the CRM by up to a hundred contacts. The same person named twice (once by id, once by phone) is queued and charged once. GET /v1/templates/{id}/send-requirements lists exactly what this template needs filled. Everything it names is validated here before the wallet is touched or Meta is called, so a refusal costs nothing: 400 an unusable or ambiguous channel_id, 402 a batch the WhatsApp balance can't cover, 404 an unknown template or recipient, 409 a template that is not APPROVED or a batch past what is left of Meta's rolling 24h messaging window (the whole request is refused rather than silently truncated), 422 anything missing, unknown, or unfetchable in the parameters. Pass Idempotency-Key to make a retry safe: the same key returns the original broadcast instead of queuing a second one, for 24h.\",\"url\":\"https://help.ciarem.ai/api-reference/broadcasts/send-a-template\",\"mainEntityOfPage\":{\"@id\":\"https://help.ciarem.ai/api-reference/broadcasts/send-a-template#webpage\"},\"dateModified\":\"2026-10-23T21:51:26.599Z\",\"publisher\":{\"@id\":\"https://help.ciarem.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://help.ciarem.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ciarem\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Ciarem","nav":{"global":null,"languages":[{"language":"en","groups":[{"group":"Getting started","pages":[{"title":"What is Ciarem?","href":"/getting-started/what-is-ciarem"},{"title":"From signup to live: the launch checklist","href":"/getting-started/launch-checklist"},{"title":"Report a problem","href":"/getting-started/report-a-problem"}]},{"group":"Channels","pages":[{"group":"WhatsApp","pages":[{"title":"Connecting WhatsApp","href":"/channels/connect-whatsapp"},{"title":"WhatsApp Coexistence explained","href":"/channels/whatsapp-coexistence"},{"title":"Creating and managing message templates","href":"/channels/message-templates"},{"title":"WhatsApp broadcasts","href":"/channels/broadcasts"},{"title":"WhatsApp forms","href":"/channels/whatsapp-forms"},{"title":"Building WhatsApp forms","href":"/channels/whatsapp-forms-builder"},{"title":"Photo and document questions","href":"/channels/whatsapp-forms-uploads"},{"title":"WhatsApp forms troubleshooting","href":"/channels/whatsapp-forms-troubleshooting"},{"title":"WhatsApp marketing opt-out","href":"/channels/whatsapp-marketing-opt-out"},{"title":"WhatsApp voice calls","href":"/channels/whatsapp-calling"},{"title":"Calls in the Inbox","href":"/channels/whatsapp-calling-inbox"},{"title":"WhatsApp connection troubleshooting","href":"/channels/whatsapp-troubleshooting"}]},{"group":"Instagram","pages":[{"title":"Instagram","sidebarTitle":"Connecting Instagram","href":"/channels/connect-instagram"},{"title":"Instagram comment-to-DM automations","href":"/channels/instagram-comment-automations"}]},{"group":"Messenger","pages":[{"title":"Facebook Messenger","sidebarTitle":"Connecting Messenger","href":"/channels/connect-messenger"},{"title":"Facebook comment-to-DM automations","href":"/channels/facebook-comment-automations"}]},{"title":"Website chat","href":"/channels/website-chat"}]},{"group":"Your AI agent","pages":[{"title":"Is my agent working correctly?","sidebarTitle":"Control center: is my agent working?","href":"/ai-agent/agent-health"},{"group":"Agent team","pages":[{"title":"Basic configuration: how your agent communicates","sidebarTitle":"Basic configuration","href":"/ai-agent/basic-configuration"},{"title":"The first message and personalization","href":"/ai-agent/first-message"},{"title":"Your AI agent team: types and per-agent settings","sidebarTitle":"Agent types and settings","href":"/ai-agent/agent-team"},{"title":"Proactive follow-ups","href":"/ai-agent/follow-ups"},{"title":"Human handoff and transfer rules","href":"/ai-agent/human-handoff-and-escalation"}]},{"group":"Knowledge bases","pages":[{"title":"Knowledge bases: what your agent knows","sidebarTitle":"Knowledge bases","href":"/ai-agent/knowledge-bases"},{"title":"Website sources: index your whole site","href":"/ai-agent/website-sources"}]},{"group":"Training and evaluation","pages":[{"title":"The playground: test and train your agent","sidebarTitle":"The playground","href":"/ai-agent/playground"},{"title":"The Evaluation center: reviewing real replies","href":"/ai-agent/evaluation-center"}]},{"group":"What your agent can do","pages":[{"title":"Booking meetings: calendars and AI scheduling","href":"/ai-agent/booking-and-calendars"},{"title":"WhatsApp forms in your AI agents","sidebarTitle":"WhatsApp forms","href":"/ai-agent/whatsapp-forms-for-agents"},{"title":"Taking orders in chat: the checkout module","href":"/ai-agent/taking-orders"}]}]},{"group":"Using Ciarem","pages":[{"title":"Working the Inbox","href":"/using-ciarem/inbox"},{"title":"After the handoff: getting to a waiting customer","href":"/using-ciarem/after-the-handoff"},{"title":"Contacts and funnel stages","href":"/using-ciarem/contacts-and-stages"},{"title":"Tasks: follow-ups your team owes a contact","sidebarTitle":"Tasks","href":"/using-ciarem/tasks"},{"title":"Catalogs: your products, services, and prices","href":"/using-ciarem/catalogs"},{"title":"Teams and tags","href":"/using-ciarem/teams-and-tags"},{"title":"Team roles and what each can see","href":"/using-ciarem/roles-and-permissions"},{"title":"Reports and CSV exports","href":"/using-ciarem/reports-and-exports"},{"title":"Satisfaction surveys (CSAT and NPS)","href":"/using-ciarem/satisfaction-surveys"},{"title":"Recommended actions","href":"/using-ciarem/recommended-actions"}]},{"group":"Integrations","pages":[{"group":"HubSpot","pages":[{"title":"HubSpot","sidebarTitle":"Connect and sync","href":"/integrations/hubspot"},{"title":"Send WhatsApp from a HubSpot record","sidebarTitle":"Send from a record","href":"/integrations/hubspot/record-card"}]},{"title":"Meta Lead Ads","href":"/integrations/meta-lead-ads"},{"title":"Meta Conversions","href":"/integrations/meta-conversions"},{"title":"AI assistants (MCP)","href":"/integrations/ai-assistants"}]},{"group":"Mobile app","pages":[{"title":"Get the Ciarem app","href":"/mobile/get-the-app"},{"title":"Inbox on mobile","href":"/mobile/inbox-on-mobile"},{"title":"Contacts on mobile","href":"/mobile/contacts-on-mobile"},{"title":"Notifications and settings","href":"/mobile/notifications-and-settings"}]},{"group":"Billing","pages":[{"title":"Plans, messages, and how your bill is built","href":"/billing/plans-and-billing"},{"title":"WhatsApp costs and the 24-hour window","href":"/billing/whatsapp-costs-and-templates"}]},{"group":"API for developers","pages":[{"title":"API quickstart","href":"/api-reference/quickstart"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors, limits, and pagination","href":"/api-reference/errors-limits-pagination"},{"title":"Changelog","href":"/api-reference/changelog"},{"group":"Webhooks","pages":[{"title":"Webhooks","href":"/webhooks/overview"},{"title":"Event catalog","href":"/webhooks/events"},{"title":"Verify signatures","href":"/webhooks/signatures"},{"title":"Deliveries and retries","href":"/webhooks/deliveries"}]},{"group":"API reference","root":{"title":"API reference","href":"/api-reference/overview"},"pages":[{"group":"Account","pages":[{"title":"Get the current organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/me","href":"/api-reference/account/get-the-current-organization"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts/{contact_id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/contacts/{contact_id}","href":"/api-reference/contacts/delete-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/contacts/{contact_id}","href":"/api-reference/contacts/update-a-contact"}]},{"group":"CRM","pages":[{"title":"List custom properties","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/properties","href":"/api-reference/crm/list-custom-properties"},{"title":"Create a custom property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/properties","href":"/api-reference/crm/create-a-custom-property"},{"title":"Delete a custom property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/properties/{property_id}","href":"/api-reference/crm/delete-a-custom-property"},{"title":"Update a custom property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/properties/{property_id}","href":"/api-reference/crm/update-a-custom-property"},{"title":"Reorder custom properties","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/properties/reorder","href":"/api-reference/crm/reorder-custom-properties"},{"title":"List funnel stages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/funnel-stages","href":"/api-reference/crm/list-funnel-stages"},{"title":"Create a funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/funnel-stages","href":"/api-reference/crm/create-a-funnel-stage"},{"title":"Delete a funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/funnel-stages/{stage_id}","href":"/api-reference/crm/delete-a-funnel-stage"},{"title":"Update a funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/funnel-stages/{stage_id}","href":"/api-reference/crm/update-a-funnel-stage"},{"title":"Reorder funnel stages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/funnel-stages/reorder","href":"/api-reference/crm/reorder-funnel-stages"},{"title":"Set the initial funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/funnel-stages/{stage_id}/set-initial","href":"/api-reference/crm/set-the-initial-funnel-stage"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}","href":"/api-reference/conversations/get-a-conversation"},{"title":"List a conversation's messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}/messages","href":"/api-reference/conversations/list-a-conversations-messages"}]},{"group":"WhatsApp templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates","href":"/api-reference/whatsapp-templates/list-templates"},{"title":"Create and submit a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates","href":"/api-reference/whatsapp-templates/create-and-submit-a-template"},{"title":"Get a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{template_id}","href":"/api-reference/whatsapp-templates/get-a-template"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/templates/{template_id}","href":"/api-reference/whatsapp-templates/delete-a-template"},{"title":"Get a template's send requirements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{template_id}/send-requirements","href":"/api-reference/whatsapp-templates/get-a-templates-send-requirements"}]},{"group":"WhatsApp numbers","pages":[{"title":"List WhatsApp numbers","description":"Connected WhatsApp numbers, oldest first. Unpaginated: an org has a\nhandful of lines, not a page of them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/channels/whatsapp/phones","href":"/api-reference/whatsapp-numbers/list-whatsapp-numbers"}]},{"group":"Broadcasts","pages":[{"title":"Send a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates/{template_id}/send","href":"/api-reference/broadcasts/send-a-template"},{"title":"List broadcasts","description":"The org's broadcasts, newest first — dashboard sends included, not only\nthe ones this key queued.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/broadcasts","href":"/api-reference/broadcasts/list-broadcasts"},{"title":"Get a broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/broadcasts/{broadcast_id}","href":"/api-reference/broadcasts/get-a-broadcast"},{"title":"List a broadcast's recipients","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/broadcasts/{broadcast_id}/recipients","href":"/api-reference/broadcasts/list-a-broadcasts-recipients"},{"title":"Cancel a broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/broadcasts/{broadcast_id}/cancel","href":"/api-reference/broadcasts/cancel-a-broadcast"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-endpoints","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-endpoints","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-endpoints/{endpoint_id}/test","href":"/api-reference/webhooks/send-a-test-event"},{"title":"List sample events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-event-samples","href":"/api-reference/webhooks/list-sample-events"},{"title":"List an endpoint's deliveries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-endpoints/{endpoint_id}/deliveries","href":"/api-reference/webhooks/list-an-endpoints-deliveries"},{"title":"Redeliver an event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-deliveries/{delivery_id}/redeliver","href":"/api-reference/webhooks/redeliver-an-event"}]}]}]}]},{"language":"es","groups":[{"group":"Primeros pasos","pages":[{"title":"¿Qué es Ciarem?","href":"/es/getting-started/what-is-ciarem"},{"title":"Del registro a estar en vivo: la lista de lanzamiento","href":"/es/getting-started/launch-checklist"},{"title":"Reportar un problema","href":"/es/getting-started/report-a-problem"}]},{"group":"Canales","pages":[{"group":"WhatsApp","pages":[{"title":"Conectar WhatsApp","href":"/es/channels/connect-whatsapp"},{"title":"WhatsApp Coexistence explicado","href":"/es/channels/whatsapp-coexistence"},{"title":"Crear y gestionar plantillas de mensajes","href":"/es/channels/message-templates"},{"title":"Envíos masivos de WhatsApp","href":"/es/channels/broadcasts"},{"title":"Formularios de WhatsApp","href":"/es/channels/whatsapp-forms"},{"title":"Crear formularios de WhatsApp","href":"/es/channels/whatsapp-forms-builder"},{"title":"Preguntas de fotos y documentos","href":"/es/channels/whatsapp-forms-uploads"},{"title":"Solución de problemas de formularios de WhatsApp","href":"/es/channels/whatsapp-forms-troubleshooting"},{"title":"Baja de marketing por WhatsApp","href":"/es/channels/whatsapp-marketing-opt-out"},{"title":"Llamadas de voz por WhatsApp","href":"/es/channels/whatsapp-calling"},{"title":"Llamadas en la Bandeja de entrada","href":"/es/channels/whatsapp-calling-inbox"},{"title":"Solución de problemas de conexión de WhatsApp","href":"/es/channels/whatsapp-troubleshooting"}]},{"group":"Instagram","pages":[{"title":"Instagram","sidebarTitle":"Conectar Instagram","href":"/es/channels/connect-instagram"},{"title":"Automatizaciones de comentarios en Instagram (comment-to-DM)","href":"/es/channels/instagram-comment-automations"}]},{"group":"Messenger","pages":[{"title":"Facebook Messenger","sidebarTitle":"Conectar Messenger","href":"/es/channels/connect-messenger"},{"title":"Automatizaciones de comentarios en Facebook (comment-to-DM)","href":"/es/channels/facebook-comment-automations"}]},{"title":"Chat del sitio web","href":"/es/channels/website-chat"}]},{"group":"Tu agente de IA","pages":[{"title":"¿Mi agente está funcionando correctamente?","sidebarTitle":"Centro de control: ¿mi agente funciona?","href":"/es/ai-agent/agent-health"},{"group":"Equipo de agentes","pages":[{"title":"Configuración básica: cómo se comunica tu agente","sidebarTitle":"Configuración básica","href":"/es/ai-agent/basic-configuration"},{"title":"El primer mensaje y la personalización","href":"/es/ai-agent/first-message"},{"title":"Tu equipo de agentes IA: tipos y configuración de cada agente","sidebarTitle":"Tipos de agente y configuración","href":"/es/ai-agent/agent-team"},{"title":"Seguimientos proactivos","href":"/es/ai-agent/follow-ups"},{"title":"Transferencia a una persona y reglas de transferencia","href":"/es/ai-agent/human-handoff-and-escalation"}]},{"group":"Bases de conocimiento","pages":[{"title":"Bases de conocimiento: lo que sabe tu agente","sidebarTitle":"Bases de conocimiento","href":"/es/ai-agent/knowledge-bases"},{"title":"Fuentes de sitio web: indexa todo tu sitio","href":"/es/ai-agent/website-sources"}]},{"group":"Entrenamiento y evaluación","pages":[{"title":"El playground: prueba y entrena a tu agente","sidebarTitle":"El playground","href":"/es/ai-agent/playground"},{"title":"El Centro de evaluación: revisar respuestas reales","href":"/es/ai-agent/evaluation-center"}]},{"group":"Qué puede hacer tu agente","pages":[{"title":"Agendar reuniones: calendarios y programación con IA","href":"/es/ai-agent/booking-and-calendars"},{"title":"Formularios de WhatsApp en tus agentes de IA","sidebarTitle":"Formularios de WhatsApp","href":"/es/ai-agent/whatsapp-forms-for-agents"},{"title":"Tomar pedidos en el chat: el módulo de checkout","href":"/es/ai-agent/taking-orders"}]}]},{"group":"Usando Ciarem","pages":[{"title":"Trabajar la Bandeja de entrada","href":"/es/using-ciarem/inbox"},{"title":"Después de la transferencia: llegar a un cliente que espera","href":"/es/using-ciarem/after-the-handoff"},{"title":"Contactos y etapas del embudo","href":"/es/using-ciarem/contacts-and-stages"},{"title":"Tareas: los pendientes de tu equipo con un contacto","sidebarTitle":"Tareas","href":"/es/using-ciarem/tasks"},{"title":"Catálogos: tus productos, servicios y precios","href":"/es/using-ciarem/catalogs"},{"title":"Equipos y etiquetas","href":"/es/using-ciarem/teams-and-tags"},{"title":"Roles del equipo y qué puede ver cada uno","href":"/es/using-ciarem/roles-and-permissions"},{"title":"Reportes y exportaciones CSV","href":"/es/using-ciarem/reports-and-exports"},{"title":"Encuestas de satisfacción (CSAT y NPS)","href":"/es/using-ciarem/satisfaction-surveys"},{"title":"Acciones recomendadas","href":"/es/using-ciarem/recommended-actions"}]},{"group":"Integraciones","pages":[{"group":"HubSpot","pages":[{"title":"HubSpot","sidebarTitle":"Conectar y sincronizar","href":"/es/integrations/hubspot"},{"title":"Enviar WhatsApp desde un registro de HubSpot","sidebarTitle":"Enviar desde un registro","href":"/es/integrations/hubspot/record-card"}]},{"title":"Meta Lead Ads","href":"/es/integrations/meta-lead-ads"},{"title":"Conversiones de Meta","href":"/es/integrations/meta-conversions"},{"title":"Asistentes de IA (MCP)","href":"/es/integrations/ai-assistants"}]},{"group":"App móvil","pages":[{"title":"Descarga la app de Ciarem","href":"/es/mobile/get-the-app"},{"title":"Bandeja de entrada en el móvil","href":"/es/mobile/inbox-on-mobile"},{"title":"Contactos en el móvil","href":"/es/mobile/contacts-on-mobile"},{"title":"Notificaciones y ajustes","href":"/es/mobile/notifications-and-settings"}]},{"group":"Facturación","pages":[{"title":"Planes, mensajes y cómo se arma tu factura","href":"/es/billing/plans-and-billing"},{"title":"Costos de WhatsApp y la ventana de 24 horas","href":"/es/billing/whatsapp-costs-and-templates"}]},{"group":"API para desarrolladores","pages":[{"title":"Inicio rápido de la API","href":"/es/api-reference/quickstart"},{"title":"Autenticación","href":"/es/api-reference/authentication"},{"title":"Errores, límites y paginación","href":"/es/api-reference/errors-limits-pagination"},{"title":"Changelog","href":"/es/api-reference/changelog"},{"group":"Webhooks","pages":[{"title":"Webhooks","href":"/es/webhooks/overview"},{"title":"Catálogo de eventos","href":"/es/webhooks/events"},{"title":"Verificar firmas","href":"/es/webhooks/signatures"},{"title":"Entregas y reintentos","href":"/es/webhooks/deliveries"}]},{"group":"Referencia de la API","root":{"title":"Referencia de la API","href":"/es/api-reference/overview"},"pages":[{"group":"Account","pages":[{"title":"Get the current organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/me","href":"/api-reference/account/get-the-current-organization"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts/{contact_id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/contacts/{contact_id}","href":"/api-reference/contacts/delete-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/contacts/{contact_id}","href":"/api-reference/contacts/update-a-contact"}]},{"group":"CRM","pages":[{"title":"List custom properties","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/properties","href":"/api-reference/crm/list-custom-properties"},{"title":"Create a custom property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/properties","href":"/api-reference/crm/create-a-custom-property"},{"title":"Delete a custom property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/properties/{property_id}","href":"/api-reference/crm/delete-a-custom-property"},{"title":"Update a custom property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/properties/{property_id}","href":"/api-reference/crm/update-a-custom-property"},{"title":"Reorder custom properties","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/properties/reorder","href":"/api-reference/crm/reorder-custom-properties"},{"title":"List funnel stages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/funnel-stages","href":"/api-reference/crm/list-funnel-stages"},{"title":"Create a funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/funnel-stages","href":"/api-reference/crm/create-a-funnel-stage"},{"title":"Delete a funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/funnel-stages/{stage_id}","href":"/api-reference/crm/delete-a-funnel-stage"},{"title":"Update a funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/funnel-stages/{stage_id}","href":"/api-reference/crm/update-a-funnel-stage"},{"title":"Reorder funnel stages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/funnel-stages/reorder","href":"/api-reference/crm/reorder-funnel-stages"},{"title":"Set the initial funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/funnel-stages/{stage_id}/set-initial","href":"/api-reference/crm/set-the-initial-funnel-stage"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}","href":"/api-reference/conversations/get-a-conversation"},{"title":"List a conversation's messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}/messages","href":"/api-reference/conversations/list-a-conversations-messages"}]},{"group":"WhatsApp templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates","href":"/api-reference/whatsapp-templates/list-templates"},{"title":"Create and submit a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates","href":"/api-reference/whatsapp-templates/create-and-submit-a-template"},{"title":"Get a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{template_id}","href":"/api-reference/whatsapp-templates/get-a-template"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/templates/{template_id}","href":"/api-reference/whatsapp-templates/delete-a-template"},{"title":"Get a template's send requirements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{template_id}/send-requirements","href":"/api-reference/whatsapp-templates/get-a-templates-send-requirements"}]},{"group":"WhatsApp numbers","pages":[{"title":"List WhatsApp numbers","description":"Connected WhatsApp numbers, oldest first. Unpaginated: an org has a\nhandful of lines, not a page of them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/channels/whatsapp/phones","href":"/api-reference/whatsapp-numbers/list-whatsapp-numbers"}]},{"group":"Broadcasts","pages":[{"title":"Send a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates/{template_id}/send","href":"/api-reference/broadcasts/send-a-template"},{"title":"List broadcasts","description":"The org's broadcasts, newest first — dashboard sends included, not only\nthe ones this key queued.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/broadcasts","href":"/api-reference/broadcasts/list-broadcasts"},{"title":"Get a broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/broadcasts/{broadcast_id}","href":"/api-reference/broadcasts/get-a-broadcast"},{"title":"List a broadcast's recipients","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/broadcasts/{broadcast_id}/recipients","href":"/api-reference/broadcasts/list-a-broadcasts-recipients"},{"title":"Cancel a broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/broadcasts/{broadcast_id}/cancel","href":"/api-reference/broadcasts/cancel-a-broadcast"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-endpoints","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-endpoints","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-endpoints/{endpoint_id}/test","href":"/api-reference/webhooks/send-a-test-event"},{"title":"List sample events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-event-samples","href":"/api-reference/webhooks/list-sample-events"},{"title":"List an endpoint's deliveries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-endpoints/{endpoint_id}/deliveries","href":"/api-reference/webhooks/list-an-endpoints-deliveries"},{"title":"Redeliver an event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-deliveries/{delivery_id}/redeliver","href":"/api-reference/webhooks/redeliver-an-event"}]}]}]}]},{"language":"pt","groups":[{"group":"Primeiros passos","pages":[{"title":"O que é a Ciarem?","href":"/pt/getting-started/what-is-ciarem"},{"title":"Do cadastro ao ar: a lista de lançamento","href":"/pt/getting-started/launch-checklist"},{"title":"Relatar um problema","href":"/pt/getting-started/report-a-problem"}]},{"group":"Canais","pages":[{"group":"WhatsApp","pages":[{"title":"Conectar o WhatsApp","href":"/pt/channels/connect-whatsapp"},{"title":"WhatsApp Coexistência explicada","href":"/pt/channels/whatsapp-coexistence"},{"title":"Criar e gerenciar modelos de mensagem","href":"/pt/channels/message-templates"},{"title":"Transmissões de WhatsApp","href":"/pt/channels/broadcasts"},{"title":"Formulários do WhatsApp","href":"/pt/channels/whatsapp-forms"},{"title":"Criar formulários do WhatsApp","href":"/pt/channels/whatsapp-forms-builder"},{"title":"Perguntas de fotos e documentos","href":"/pt/channels/whatsapp-forms-uploads"},{"title":"Solução de problemas dos formulários do WhatsApp","href":"/pt/channels/whatsapp-forms-troubleshooting"},{"title":"Descadastro de marketing por WhatsApp","href":"/pt/channels/whatsapp-marketing-opt-out"},{"title":"Chamadas de voz pelo WhatsApp","href":"/pt/channels/whatsapp-calling"},{"title":"Chamadas na Caixa de entrada","href":"/pt/channels/whatsapp-calling-inbox"},{"title":"Solução de problemas de conexão do WhatsApp","href":"/pt/channels/whatsapp-troubleshooting"}]},{"group":"Instagram","pages":[{"title":"Instagram","sidebarTitle":"Conectar o Instagram","href":"/pt/channels/connect-instagram"},{"title":"Automações de comentários no Instagram (comment-to-DM)","href":"/pt/channels/instagram-comment-automations"}]},{"group":"Messenger","pages":[{"title":"Facebook Messenger","sidebarTitle":"Conectar o Messenger","href":"/pt/channels/connect-messenger"},{"title":"Automações de comentários no Facebook (comment-to-DM)","href":"/pt/channels/facebook-comment-automations"}]},{"title":"Chat do site","href":"/pt/channels/website-chat"}]},{"group":"Seu agente de IA","pages":[{"title":"Meu agente está funcionando corretamente?","sidebarTitle":"Central de controle: meu agente funciona?","href":"/pt/ai-agent/agent-health"},{"group":"Equipe de agentes","pages":[{"title":"Configuração básica: como seu agente se comunica","sidebarTitle":"Configuração básica","href":"/pt/ai-agent/basic-configuration"},{"title":"A primeira mensagem e a personalização","href":"/pt/ai-agent/first-message"},{"title":"Sua equipe de agentes de IA: tipos e configuração de cada agente","sidebarTitle":"Tipos de agente e configuração","href":"/pt/ai-agent/agent-team"},{"title":"Acompanhamentos proativos","href":"/pt/ai-agent/follow-ups"},{"title":"Transferência para uma pessoa e regras de transferência","href":"/pt/ai-agent/human-handoff-and-escalation"}]},{"group":"Bases de conhecimento","pages":[{"title":"Bases de conhecimento: o que seu agente sabe","sidebarTitle":"Bases de conhecimento","href":"/pt/ai-agent/knowledge-bases"},{"title":"Fontes de site: indexe o seu site inteiro","href":"/pt/ai-agent/website-sources"}]},{"group":"Treinamento e avaliação","pages":[{"title":"O playground: teste e treine seu agente","sidebarTitle":"O playground","href":"/pt/ai-agent/playground"},{"title":"O Centro de avaliação: revisar respostas reais","href":"/pt/ai-agent/evaluation-center"}]},{"group":"O que seu agente pode fazer","pages":[{"title":"Agendar reuniões: calendários e agendamento com IA","href":"/pt/ai-agent/booking-and-calendars"},{"title":"Formulários do WhatsApp nos seus agentes de IA","sidebarTitle":"Formulários do WhatsApp","href":"/pt/ai-agent/whatsapp-forms-for-agents"},{"title":"Receber pedidos no chat: o módulo de checkout","href":"/pt/ai-agent/taking-orders"}]}]},{"group":"Usando a Ciarem","pages":[{"title":"Trabalhar na Caixa de entrada","href":"/pt/using-ciarem/inbox"},{"title":"Depois da transferência: chegar a um cliente que espera","href":"/pt/using-ciarem/after-the-handoff"},{"title":"Contatos e etapas do funil","href":"/pt/using-ciarem/contacts-and-stages"},{"title":"Tarefas: as pendências da sua equipe com um contato","sidebarTitle":"Tarefas","href":"/pt/using-ciarem/tasks"},{"title":"Catálogos: seus produtos, serviços e preços","href":"/pt/using-ciarem/catalogs"},{"title":"Equipes e etiquetas","href":"/pt/using-ciarem/teams-and-tags"},{"title":"Funções da equipe e o que cada uma pode ver","href":"/pt/using-ciarem/roles-and-permissions"},{"title":"Relatórios e exportações CSV","href":"/pt/using-ciarem/reports-and-exports"},{"title":"Pesquisas de satisfação (CSAT e NPS)","href":"/pt/using-ciarem/satisfaction-surveys"},{"title":"Ações recomendadas","href":"/pt/using-ciarem/recommended-actions"}]},{"group":"Integrações","pages":[{"group":"HubSpot","pages":[{"title":"HubSpot","sidebarTitle":"Conectar e sincronizar","href":"/pt/integrations/hubspot"},{"title":"Enviar WhatsApp a partir de um registro do HubSpot","sidebarTitle":"Enviar a partir de um registro","href":"/pt/integrations/hubspot/record-card"}]},{"title":"Meta Lead Ads","href":"/pt/integrations/meta-lead-ads"},{"title":"Conversões da Meta","href":"/pt/integrations/meta-conversions"},{"title":"Assistentes de IA (MCP)","href":"/pt/integrations/ai-assistants"}]},{"group":"App móvel","pages":[{"title":"Baixe o app da Ciarem","href":"/pt/mobile/get-the-app"},{"title":"Caixa de entrada no celular","href":"/pt/mobile/inbox-on-mobile"},{"title":"Contatos no celular","href":"/pt/mobile/contacts-on-mobile"},{"title":"Notificações e configurações","href":"/pt/mobile/notifications-and-settings"}]},{"group":"Faturamento","pages":[{"title":"Planos, mensagens e como sua fatura é montada","href":"/pt/billing/plans-and-billing"},{"title":"Custos do WhatsApp e a janela de 24 horas","href":"/pt/billing/whatsapp-costs-and-templates"}]},{"group":"API para desenvolvedores","pages":[{"title":"Início rápido da API","href":"/pt/api-reference/quickstart"},{"title":"Autenticação","href":"/pt/api-reference/authentication"},{"title":"Erros, limites e paginação","href":"/pt/api-reference/errors-limits-pagination"},{"title":"Changelog","href":"/pt/api-reference/changelog"},{"group":"Webhooks","pages":[{"title":"Webhooks","href":"/pt/webhooks/overview"},{"title":"Catálogo de eventos","href":"/pt/webhooks/events"},{"title":"Verificar assinaturas","href":"/pt/webhooks/signatures"},{"title":"Entregas e novas tentativas","href":"/pt/webhooks/deliveries"}]},{"group":"Referência da API","root":{"title":"Referência da API","href":"/pt/api-reference/overview"},"pages":[{"group":"Account","pages":[{"title":"Get the current organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/me","href":"/api-reference/account/get-the-current-organization"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts/{contact_id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/contacts/{contact_id}","href":"/api-reference/contacts/delete-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/contacts/{contact_id}","href":"/api-reference/contacts/update-a-contact"}]},{"group":"CRM","pages":[{"title":"List custom properties","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/properties","href":"/api-reference/crm/list-custom-properties"},{"title":"Create a custom property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/properties","href":"/api-reference/crm/create-a-custom-property"},{"title":"Delete a custom property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/properties/{property_id}","href":"/api-reference/crm/delete-a-custom-property"},{"title":"Update a custom property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/properties/{property_id}","href":"/api-reference/crm/update-a-custom-property"},{"title":"Reorder custom properties","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/properties/reorder","href":"/api-reference/crm/reorder-custom-properties"},{"title":"List funnel stages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/funnel-stages","href":"/api-reference/crm/list-funnel-stages"},{"title":"Create a funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/funnel-stages","href":"/api-reference/crm/create-a-funnel-stage"},{"title":"Delete a funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/funnel-stages/{stage_id}","href":"/api-reference/crm/delete-a-funnel-stage"},{"title":"Update a funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/funnel-stages/{stage_id}","href":"/api-reference/crm/update-a-funnel-stage"},{"title":"Reorder funnel stages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/funnel-stages/reorder","href":"/api-reference/crm/reorder-funnel-stages"},{"title":"Set the initial funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/funnel-stages/{stage_id}/set-initial","href":"/api-reference/crm/set-the-initial-funnel-stage"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}","href":"/api-reference/conversations/get-a-conversation"},{"title":"List a conversation's messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}/messages","href":"/api-reference/conversations/list-a-conversations-messages"}]},{"group":"WhatsApp templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates","href":"/api-reference/whatsapp-templates/list-templates"},{"title":"Create and submit a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates","href":"/api-reference/whatsapp-templates/create-and-submit-a-template"},{"title":"Get a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{template_id}","href":"/api-reference/whatsapp-templates/get-a-template"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/templates/{template_id}","href":"/api-reference/whatsapp-templates/delete-a-template"},{"title":"Get a template's send requirements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{template_id}/send-requirements","href":"/api-reference/whatsapp-templates/get-a-templates-send-requirements"}]},{"group":"WhatsApp numbers","pages":[{"title":"List WhatsApp numbers","description":"Connected WhatsApp numbers, oldest first. Unpaginated: an org has a\nhandful of lines, not a page of them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/channels/whatsapp/phones","href":"/api-reference/whatsapp-numbers/list-whatsapp-numbers"}]},{"group":"Broadcasts","pages":[{"title":"Send a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates/{template_id}/send","href":"/api-reference/broadcasts/send-a-template"},{"title":"List broadcasts","description":"The org's broadcasts, newest first — dashboard sends included, not only\nthe ones this key queued.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/broadcasts","href":"/api-reference/broadcasts/list-broadcasts"},{"title":"Get a broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/broadcasts/{broadcast_id}","href":"/api-reference/broadcasts/get-a-broadcast"},{"title":"List a broadcast's recipients","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/broadcasts/{broadcast_id}/recipients","href":"/api-reference/broadcasts/list-a-broadcasts-recipients"},{"title":"Cancel a broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/broadcasts/{broadcast_id}/cancel","href":"/api-reference/broadcasts/cancel-a-broadcast"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-endpoints","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-endpoints","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-endpoints/{endpoint_id}/test","href":"/api-reference/webhooks/send-a-test-event"},{"title":"List sample events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-event-samples","href":"/api-reference/webhooks/list-sample-events"},{"title":"List an endpoint's deliveries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-endpoints/{endpoint_id}/deliveries","href":"/api-reference/webhooks/list-an-endpoints-deliveries"},{"title":"Redeliver an event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-deliveries/{delivery_id}/redeliver","href":"/api-reference/webhooks/redeliver-an-event"}]}]}]}]}]},"title":"Send a template - Ciarem","buildId":"dpl_G8u2B2Ji9qJYF9umedjv293TxycS","deploymentId":"dpl_G8u2B2Ji9qJYF9umedjv293TxycS","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-S3ptrr-V.js","utils-CUxEJy9u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DavhVrxy.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B1sOUY6E.js","snippetPresets-C-RLYOrF.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Duz18EdI.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DPsbCc6D.js","shallow-B1dlhlOw.js","getApiPlaygroundDisplay-DvOu-BhE.js","CodeSnippet-By8wd64X.js","CodeSnippets-BxVv6TjI.js","Page-BGh0lBck.js","getPastedJson-DOAt9xJn.js","icon-BYg-qtQ2.js","MethodPill-Dtah8ZSz.js","DuplicateIcon-guWfDmh1.js","createIcon-pTGhj_hk.js","DynamicMarkdown-DpsHMHVL.js","SectionHeading-BbutQCjq.js","axios-vUo_bRtp.js","Markdown-DZ-stgDu.js","clsx-Dfme4k4V.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CPNs0ebX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-3JVAA-i3.js"]}