Send a WhatsApp template message. The template must be approved by Meta and linked to this app. Variables can be passed using named keys that will be automatically mapped to positional indices.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Chirp","colors":{"primary":"#6C63FF","light":"#6C63FF","dark":"#6C63FF"},"logo":{"light":"https://mintcdn.com/chirp-542e2f98/NWWcTXi85omYcm46/chirp-logo-light.svg?fit=max\u0026auto=format\u0026n=NWWcTXi85omYcm46\u0026q=85\u0026s=ea6bd143fa5ef227d88963f9b5d16e2c","dark":"https://mintcdn.com/chirp-542e2f98/uoM83IPsGshjftV4/chirp-logo-dark.svg?fit=max\u0026auto=format\u0026n=uoM83IPsGshjftV4\u0026q=85\u0026s=36c848dfd21f64b62134e6c5e1003c84"},"favicon":"https://mintcdn.com/chirp-542e2f98/NWWcTXi85omYcm46/chirp-bird-only.svg?fit=max\u0026auto=format\u0026n=NWWcTXi85omYcm46\u0026q=85\u0026s=ea3466c37555ad29ee74b0047bdb4a2a","navbar":{"links":[{"href":"mailto:support@chirp.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.chirp.com"}},"footer":{"socials":{"x":"https://x.com/chirp","github":"https://github.com/chirp","linkedin":"https://linkedin.com/company/chirp"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"interaction":{"drilldown":true},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"chirp-542e2f98","hasAudioNarration":false,"actualSubdomain":"chirp-542e2f98","customDomains":["docs.buildwithchirp.com"],"gitSource":{"type":"github","owner":"buildwithchirp","repo":"chirp","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae940f503b05c950b978dcc:success","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API Reference","count":156},{"language":"default","tag":"Administration APIs","count":79},{"language":"default","tag":"Application APIs","count":63},{"language":"default","tag":"Documentation","count":42},{"language":"default","tag":"WhatsApp","count":18},{"language":"default","tag":"Playground","count":18},{"language":"default","tag":"WhatsApp Groups","count":15},{"language":"default","tag":"WhatsApp Templates","count":14},{"language":"default","tag":"WhatsApp Business Profiles","count":11},{"language":"default","tag":"Calls","count":11}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".nav-logo{height:2rem}"}],"page":{"pagePath":"api-reference/app/post-v1whatsapptemplatessend","slug":"/api-reference/app/post-v1whatsapptemplatessend","pageMetadata":{"title":"Send app template message","description":"Send a WhatsApp template message. The template must be approved by Meta and linked to this app. Variables can be passed using named keys that will be automatically mapped to positional indices.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/templates/send","href":"/api-reference/app/post-v1whatsapptemplatessend","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Send a WhatsApp template message. The template must be approved by Meta and linked to this app. Variables can be passed using named keys that will be automatically mapped to positional indices.\"\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 app template message","description":"Send a WhatsApp template message. The template must be approved by Meta and linked to this app. Variables can be passed using named keys that will be automatically mapped to positional indices.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/templates/send","href":"/api-reference/app/post-v1whatsapptemplatessend","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["App","WhatsApp Templates"],"security":["40d954c4-cc79-4719-beb3-1e6bcf129df8"],"x-mint":{"metadata":{"title":"Send app template message","description":"Send a WhatsApp template message. The template must be approved by Meta and linked to this app. Variables can be passed using named keys that will be automatically mapped to positional indices."}},"requestBody":"eb175e91-1a4a-4e90-849c-278c1a27703b","responses":{"200":"8509dff9-88b3-4be1-829e-05badbdde252","400":"4cb14521-ffa9-459c-be6e-af6bf24398d8","401":"36050184-683b-45a5-8b54-fd0ffc700d94","402":"b5356ebc-be7c-47a2-87a8-fcd693b04fd2","404":"8578cdfc-8f0f-4398-b6dc-8af677828639","424":"d38999ca-8c6c-4234-8101-8d5df213b593","500":"220b79c2-ebe0-4973-96ae-c4e3a72abb74"},"method":"post","type":"path","servers":["8a7e5dd7-9eff-454a-bab0-649f7b39a2b0"],"path":"/v1/whatsapp/templates/send","baseUrlOptions":["https://api.buildwithchirp.com"],"title":"","description":"Send a WhatsApp template message. The template must be approved by Meta and linked to this app. Variables can be passed using named keys that will be automatically mapped to positional indices.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string","pattern":"^\\+[1-9]\\d{1,14}$","description":"Your WhatsApp phone number to send from (E.164 format)","example":"+15551234567","isRequired":true,"uniqueKey":"from","typeLabel":"string"},"to":{"type":"string","pattern":"^\\+[1-9]\\d{1,14}$","description":"Recipient phone number in E.164 format","example":"+15559876543","isRequired":true,"uniqueKey":"to","typeLabel":"string"},"templateName":{"type":"string","description":"Name of the approved template to send","example":"order_confirmation","isRequired":true,"uniqueKey":"templateName","typeLabel":"string"},"languageCode":{"type":"string","description":"Language code of the template","example":"en_US","isRequired":true,"uniqueKey":"languageCode","typeLabel":"string"},"variables":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"variables.additionalProperties","typeLabel":"string"},"description":"Body variables as key-value pairs","example":{"customer_name":"John","order_id":"12345"},"uniqueKey":"variables","typeLabel":"object"},"headerVariables":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"headerVariables.additionalProperties","typeLabel":"string"},"description":"Header variables as key-value pairs","example":{"header_text":"Order Update"},"uniqueKey":"headerVariables","typeLabel":"object"},"buttonVariables":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"buttonVariables.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"buttonVariables.additionalProperties","typeLabel":"string[]"},"description":"Button URL variables by button index (e.g., button_0: ['value'])","example":{"button_0":["https://example.com/track/12345"]},"uniqueKey":"buttonVariables","typeLabel":"object"}},"required":["from","to","templateName","languageCode"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"from":"+15551234567","to":"+15559876543","templateName":"order_confirmation","languageCode":"en_US","variables":{"customer_name":"John","order_id":"12345"},"headerVariables":{"header_text":"Order Update"},"buttonVariables":{"button_0":["https://example.com/track/12345"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8509dff9-88b3-4be1-829e-05badbdde252":{"description":"Message sent successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Chirp message ID - use this to correlate with webhook events","example":"msg_wa_abc123","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"messaging_product":{"type":"string","enum":["whatsapp"],"isRequired":true,"uniqueKey":"messaging_product","typeLabel":"enum\u003cstring>"},"contacts":{"type":"array","items":{"type":"object","properties":{"input":{"type":"string","isRequired":true,"uniqueKey":"contacts.items.[INDEX].input","typeLabel":"string"},"wa_id":{"type":"string","isRequired":true,"uniqueKey":"contacts.items.[INDEX].wa_id","typeLabel":"string"}},"required":["input","wa_id"],"uniqueKey":"contacts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"contacts","typeLabel":"object[]"},"messages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Meta WhatsApp message ID","example":"wamid.HBgLMTUwMzMwNzk5NzQVAgARGBI...","isRequired":true,"uniqueKey":"messages.items.[INDEX].id","typeLabel":"string"},"message_status":{"type":"string","uniqueKey":"messages.items.[INDEX].message_status","typeLabel":"string"}},"required":["id"],"uniqueKey":"messages.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"messages","typeLabel":"object[]"}},"required":["id","messaging_product","contacts","messages"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"msg_wa_abc123","messaging_product":"whatsapp","contacts":[{"input":"\u003cstring>","wa_id":"\u003cstring>"}],"messages":[{"id":"wamid.HBgLMTUwMzMwNzk5NzQVAgARGBI...","message_status":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"4cb14521-ffa9-459c-be6e-af6bf24398d8":{"description":"Invalid request or template not approved Possible codes: `template_parameter_mismatch`","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","provider_error","api_error"],"description":"The type of error returned","example":"invalid_request_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"The phone number \"+1abc\" is not in E.164 format.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","enum":["message_undeliverable","conversation_window_expired","recipient_not_on_whatsapp","phone_number_not_assigned","unsupported_message_type","media_too_large","invalid_phone_number","template_not_found","template_parameter_mismatch","groups_not_eligible","account_restricted","display_name_not_approved","whatsapp_not_configured","meta_api_error","meta_api_unavailable","telnyx_api_error","telnyx_api_unavailable","rate_limit_exceeded","whatsapp_rate_limited","resource_already_exists","test_app_required","call_not_found","call_already_ended","call_failed","call_rejected","call_timeout","call_busy","calling_not_configured","calling_disabled","max_concurrent_calls_reached","recording_not_found","recording_already_in_progress","recording_failed","voicemail_not_found","voicemail_disabled","invalid_call_command","command_not_applicable","whatsapp_calling_not_enabled","whatsapp_call_permission_required","whatsapp_call_permission_limit","whatsapp_pstn_bridge_forbidden","livekit_api_error","livekit_room_error","sip_trunk_error"],"description":"A machine-readable error code for programmatic handling","example":"invalid_phone_number","uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","description":"URL to documentation for this error code","example":"https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"param":{"type":"string","description":"The parameter that caused the error","example":"from","uniqueKey":"error.param","typeLabel":"string"},"provider":{"type":"object","properties":{"source":{"type":"string","enum":["meta","telnyx","livekit"],"description":"Provider name","example":"meta","isRequired":true,"uniqueKey":"error.provider.source","typeLabel":"enum\u003cstring>"},"code":{"oneOf":[{"type":"number","description":"Provider's native error code","isRequired":true,"uniqueKey":"error.provider.code.oneOf.0","typeLabel":"number"},{"type":"string","description":"Provider's native error code","isRequired":true,"uniqueKey":"error.provider.code.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"error.provider.code","typeLabel":"number | string"},"message":{"type":"string","description":"Provider's error message","isRequired":true,"uniqueKey":"error.provider.message","typeLabel":"string"},"fbtrace_id":{"type":"string","description":"Meta's trace ID for support tickets","uniqueKey":"error.provider.fbtrace_id","typeLabel":"string"},"health_status":{"type":"object","properties":{"can_send_message":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","isRequired":true,"uniqueKey":"error.provider.health_status.can_send_message","typeLabel":"enum\u003cstring>"},"entities":{"type":"array","items":{"oneOf":[{"type":"object","required":["entity_type","id","can_send_message"],"properties":{"entity_type":{"type":"string","enum":["PHONE_NUMBER","MESSAGE_TEMPLATE","WABA","BUSINESS","APP"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.entity_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.id","typeLabel":"string"},"can_send_message":{"type":"string","enum":["AVAILABLE"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.can_send_message","typeLabel":"enum\u003cstring>"},"can_receive_call_sip":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.can_receive_call_sip","typeLabel":"enum\u003cstring>"},"errors":{"type":"array","items":{"type":"object","properties":{"error_code":{"type":"number","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX].error_code","typeLabel":"number"},"error_description":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX].error_description","typeLabel":"string"},"possible_solution":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX].possible_solution","typeLabel":"string"}},"required":["error_code","error_description","possible_solution"],"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors","typeLabel":"object[]"}},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["entity_type","id","can_send_message","additional_info"],"properties":{"entity_type":{"type":"string","enum":["PHONE_NUMBER","MESSAGE_TEMPLATE","WABA","BUSINESS","APP"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.entity_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.id","typeLabel":"string"},"can_send_message":{"type":"string","enum":["LIMITED"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.can_send_message","typeLabel":"enum\u003cstring>"},"additional_info":{"type":"array","items":{"type":"string","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.additional_info.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.additional_info","typeLabel":"string[]"},"can_receive_call_sip":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.can_receive_call_sip","typeLabel":"enum\u003cstring>"},"errors":{"type":"array","items":{"type":"object","properties":{"error_code":{"type":"number","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX].error_code","typeLabel":"number"},"error_description":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX].error_description","typeLabel":"string"},"possible_solution":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX].possible_solution","typeLabel":"string"}},"required":["error_code","error_description","possible_solution"],"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors","typeLabel":"object[]"}},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["entity_type","id","can_send_message","errors"],"properties":{"entity_type":{"type":"string","enum":["PHONE_NUMBER","MESSAGE_TEMPLATE","WABA","BUSINESS","APP"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.entity_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.id","typeLabel":"string"},"can_send_message":{"type":"string","enum":["BLOCKED"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.can_send_message","typeLabel":"enum\u003cstring>"},"errors":{"type":"array","items":{"type":"object","properties":{"error_code":{"type":"number","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX].error_code","typeLabel":"number"},"error_description":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX].error_description","typeLabel":"string"},"possible_solution":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX].possible_solution","typeLabel":"string"}},"required":["error_code","error_description","possible_solution"],"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors","typeLabel":"object[]"},"can_receive_call_sip":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.can_receive_call_sip","typeLabel":"enum\u003cstring>"}},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"error.provider.health_status.entities.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.provider.health_status.entities","typeLabel":"object[]"}},"required":["can_send_message","entities"],"description":"Meta Health Status payload, present when the error was enriched via the Health Status API.","uniqueKey":"error.provider.health_status","typeLabel":"object"}},"required":["source","code","message"],"uniqueKey":"error.provider","typeLabel":"object"},"additional_info":{"type":"array","items":{"type":"string","uniqueKey":"error.additional_info.items.[INDEX]","typeLabel":"string"},"description":"Human-readable remediation hints (e.g. from Meta Health Status).","uniqueKey":"error.additional_info","typeLabel":"string[]"}},"required":["type","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","message":"The phone number \"+1abc\" is not in E.164 format.","code":"invalid_phone_number","doc_url":"https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number","param":"from","provider":{"source":"meta","code":123,"message":"\u003cstring>","fbtrace_id":"\u003cstring>","health_status":{"can_send_message":"AVAILABLE","entities":[{"entity_type":"PHONE_NUMBER","id":"\u003cstring>","can_send_message":"AVAILABLE","can_receive_call_sip":"AVAILABLE","errors":[{"error_code":123,"error_description":"\u003cstring>","possible_solution":"\u003cstring>"}]}]}},"additional_info":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"36050184-683b-45a5-8b54-fd0ffc700d94":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","provider_error","api_error"],"description":"The type of error returned","example":"invalid_request_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"The phone number \"+1abc\" is not in E.164 format.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","enum":["message_undeliverable","conversation_window_expired","recipient_not_on_whatsapp","phone_number_not_assigned","unsupported_message_type","media_too_large","invalid_phone_number","template_not_found","template_parameter_mismatch","groups_not_eligible","account_restricted","display_name_not_approved","whatsapp_not_configured","meta_api_error","meta_api_unavailable","telnyx_api_error","telnyx_api_unavailable","rate_limit_exceeded","whatsapp_rate_limited","resource_already_exists","test_app_required","call_not_found","call_already_ended","call_failed","call_rejected","call_timeout","call_busy","calling_not_configured","calling_disabled","max_concurrent_calls_reached","recording_not_found","recording_already_in_progress","recording_failed","voicemail_not_found","voicemail_disabled","invalid_call_command","command_not_applicable","whatsapp_calling_not_enabled","whatsapp_call_permission_required","whatsapp_call_permission_limit","whatsapp_pstn_bridge_forbidden","livekit_api_error","livekit_room_error","sip_trunk_error"],"description":"A machine-readable error code for programmatic handling","example":"invalid_phone_number","uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","description":"URL to documentation for this error code","example":"https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"param":{"type":"string","description":"The parameter that caused the error","example":"from","uniqueKey":"error.param","typeLabel":"string"},"provider":{"type":"object","properties":{"source":{"type":"string","enum":["meta","telnyx","livekit"],"description":"Provider name","example":"meta","isRequired":true,"uniqueKey":"error.provider.source","typeLabel":"enum\u003cstring>"},"code":{"oneOf":[{"type":"number","description":"Provider's native error code","isRequired":true,"uniqueKey":"error.provider.code.oneOf.0","typeLabel":"number"},{"type":"string","description":"Provider's native error code","isRequired":true,"uniqueKey":"error.provider.code.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"error.provider.code","typeLabel":"number | string"},"message":{"type":"string","description":"Provider's error message","isRequired":true,"uniqueKey":"error.provider.message","typeLabel":"string"},"fbtrace_id":{"type":"string","description":"Meta's trace ID for support tickets","uniqueKey":"error.provider.fbtrace_id","typeLabel":"string"},"health_status":{"type":"object","properties":{"can_send_message":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","isRequired":true,"uniqueKey":"error.provider.health_status.can_send_message","typeLabel":"enum\u003cstring>"},"entities":{"type":"array","items":{"oneOf":[{"type":"object","required":["entity_type","id","can_send_message"],"properties":{"entity_type":{"type":"string","enum":["PHONE_NUMBER","MESSAGE_TEMPLATE","WABA","BUSINESS","APP"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.entity_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.id","typeLabel":"string"},"can_send_message":{"type":"string","enum":["AVAILABLE"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.can_send_message","typeLabel":"enum\u003cstring>"},"can_receive_call_sip":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.can_receive_call_sip","typeLabel":"enum\u003cstring>"},"errors":{"type":"array","items":{"type":"object","properties":{"error_code":{"type":"number","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX].error_code","typeLabel":"number"},"error_description":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX].error_description","typeLabel":"string"},"possible_solution":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX].possible_solution","typeLabel":"string"}},"required":["error_code","error_description","possible_solution"],"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors","typeLabel":"object[]"}},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["entity_type","id","can_send_message","additional_info"],"properties":{"entity_type":{"type":"string","enum":["PHONE_NUMBER","MESSAGE_TEMPLATE","WABA","BUSINESS","APP"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.entity_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.id","typeLabel":"string"},"can_send_message":{"type":"string","enum":["LIMITED"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.can_send_message","typeLabel":"enum\u003cstring>"},"additional_info":{"type":"array","items":{"type":"string","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.additional_info.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.additional_info","typeLabel":"string[]"},"can_receive_call_sip":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.can_receive_call_sip","typeLabel":"enum\u003cstring>"},"errors":{"type":"array","items":{"type":"object","properties":{"error_code":{"type":"number","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX].error_code","typeLabel":"number"},"error_description":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX].error_description","typeLabel":"string"},"possible_solution":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX].possible_solution","typeLabel":"string"}},"required":["error_code","error_description","possible_solution"],"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors","typeLabel":"object[]"}},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["entity_type","id","can_send_message","errors"],"properties":{"entity_type":{"type":"string","enum":["PHONE_NUMBER","MESSAGE_TEMPLATE","WABA","BUSINESS","APP"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.entity_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.id","typeLabel":"string"},"can_send_message":{"type":"string","enum":["BLOCKED"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.can_send_message","typeLabel":"enum\u003cstring>"},"errors":{"type":"array","items":{"type":"object","properties":{"error_code":{"type":"number","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX].error_code","typeLabel":"number"},"error_description":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX].error_description","typeLabel":"string"},"possible_solution":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX].possible_solution","typeLabel":"string"}},"required":["error_code","error_description","possible_solution"],"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors","typeLabel":"object[]"},"can_receive_call_sip":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.can_receive_call_sip","typeLabel":"enum\u003cstring>"}},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"error.provider.health_status.entities.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.provider.health_status.entities","typeLabel":"object[]"}},"required":["can_send_message","entities"],"description":"Meta Health Status payload, present when the error was enriched via the Health Status API.","uniqueKey":"error.provider.health_status","typeLabel":"object"}},"required":["source","code","message"],"uniqueKey":"error.provider","typeLabel":"object"},"additional_info":{"type":"array","items":{"type":"string","uniqueKey":"error.additional_info.items.[INDEX]","typeLabel":"string"},"description":"Human-readable remediation hints (e.g. from Meta Health Status).","uniqueKey":"error.additional_info","typeLabel":"string[]"}},"required":["type","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","message":"The phone number \"+1abc\" is not in E.164 format.","code":"invalid_phone_number","doc_url":"https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number","param":"from","provider":{"source":"meta","code":123,"message":"\u003cstring>","fbtrace_id":"\u003cstring>","health_status":{"can_send_message":"AVAILABLE","entities":[{"entity_type":"PHONE_NUMBER","id":"\u003cstring>","can_send_message":"AVAILABLE","can_receive_call_sip":"AVAILABLE","errors":[{"error_code":123,"error_description":"\u003cstring>","possible_solution":"\u003cstring>"}]}]}},"additional_info":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"b5356ebc-be7c-47a2-87a8-fcd693b04fd2":{"description":"Message delivery failed Possible codes: `message_undeliverable`, `recipient_not_on_whatsapp`","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","provider_error","api_error"],"description":"The type of error returned","example":"invalid_request_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"The phone number \"+1abc\" is not in E.164 format.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","enum":["message_undeliverable","conversation_window_expired","recipient_not_on_whatsapp","phone_number_not_assigned","unsupported_message_type","media_too_large","invalid_phone_number","template_not_found","template_parameter_mismatch","groups_not_eligible","account_restricted","display_name_not_approved","whatsapp_not_configured","meta_api_error","meta_api_unavailable","telnyx_api_error","telnyx_api_unavailable","rate_limit_exceeded","whatsapp_rate_limited","resource_already_exists","test_app_required","call_not_found","call_already_ended","call_failed","call_rejected","call_timeout","call_busy","calling_not_configured","calling_disabled","max_concurrent_calls_reached","recording_not_found","recording_already_in_progress","recording_failed","voicemail_not_found","voicemail_disabled","invalid_call_command","command_not_applicable","whatsapp_calling_not_enabled","whatsapp_call_permission_required","whatsapp_call_permission_limit","whatsapp_pstn_bridge_forbidden","livekit_api_error","livekit_room_error","sip_trunk_error"],"description":"A machine-readable error code for programmatic handling","example":"invalid_phone_number","uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","description":"URL to documentation for this error code","example":"https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"param":{"type":"string","description":"The parameter that caused the error","example":"from","uniqueKey":"error.param","typeLabel":"string"},"provider":{"type":"object","properties":{"source":{"type":"string","enum":["meta","telnyx","livekit"],"description":"Provider name","example":"meta","isRequired":true,"uniqueKey":"error.provider.source","typeLabel":"enum\u003cstring>"},"code":{"oneOf":[{"type":"number","description":"Provider's native error code","isRequired":true,"uniqueKey":"error.provider.code.oneOf.0","typeLabel":"number"},{"type":"string","description":"Provider's native error code","isRequired":true,"uniqueKey":"error.provider.code.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"error.provider.code","typeLabel":"number | string"},"message":{"type":"string","description":"Provider's error message","isRequired":true,"uniqueKey":"error.provider.message","typeLabel":"string"},"fbtrace_id":{"type":"string","description":"Meta's trace ID for support tickets","uniqueKey":"error.provider.fbtrace_id","typeLabel":"string"},"health_status":{"type":"object","properties":{"can_send_message":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","isRequired":true,"uniqueKey":"error.provider.health_status.can_send_message","typeLabel":"enum\u003cstring>"},"entities":{"type":"array","items":{"oneOf":[{"type":"object","required":["entity_type","id","can_send_message"],"properties":{"entity_type":{"type":"string","enum":["PHONE_NUMBER","MESSAGE_TEMPLATE","WABA","BUSINESS","APP"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.entity_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.id","typeLabel":"string"},"can_send_message":{"type":"string","enum":["AVAILABLE"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.can_send_message","typeLabel":"enum\u003cstring>"},"can_receive_call_sip":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.can_receive_call_sip","typeLabel":"enum\u003cstring>"},"errors":{"type":"array","items":{"type":"object","properties":{"error_code":{"type":"number","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX].error_code","typeLabel":"number"},"error_description":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX].error_description","typeLabel":"string"},"possible_solution":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX].possible_solution","typeLabel":"string"}},"required":["error_code","error_description","possible_solution"],"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors","typeLabel":"object[]"}},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["entity_type","id","can_send_message","additional_info"],"properties":{"entity_type":{"type":"string","enum":["PHONE_NUMBER","MESSAGE_TEMPLATE","WABA","BUSINESS","APP"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.entity_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.id","typeLabel":"string"},"can_send_message":{"type":"string","enum":["LIMITED"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.can_send_message","typeLabel":"enum\u003cstring>"},"additional_info":{"type":"array","items":{"type":"string","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.additional_info.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.additional_info","typeLabel":"string[]"},"can_receive_call_sip":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.can_receive_call_sip","typeLabel":"enum\u003cstring>"},"errors":{"type":"array","items":{"type":"object","properties":{"error_code":{"type":"number","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX].error_code","typeLabel":"number"},"error_description":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX].error_description","typeLabel":"string"},"possible_solution":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX].possible_solution","typeLabel":"string"}},"required":["error_code","error_description","possible_solution"],"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors","typeLabel":"object[]"}},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["entity_type","id","can_send_message","errors"],"properties":{"entity_type":{"type":"string","enum":["PHONE_NUMBER","MESSAGE_TEMPLATE","WABA","BUSINESS","APP"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.entity_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.id","typeLabel":"string"},"can_send_message":{"type":"string","enum":["BLOCKED"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.can_send_message","typeLabel":"enum\u003cstring>"},"errors":{"type":"array","items":{"type":"object","properties":{"error_code":{"type":"number","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX].error_code","typeLabel":"number"},"error_description":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX].error_description","typeLabel":"string"},"possible_solution":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX].possible_solution","typeLabel":"string"}},"required":["error_code","error_description","possible_solution"],"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors","typeLabel":"object[]"},"can_receive_call_sip":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.can_receive_call_sip","typeLabel":"enum\u003cstring>"}},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"error.provider.health_status.entities.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.provider.health_status.entities","typeLabel":"object[]"}},"required":["can_send_message","entities"],"description":"Meta Health Status payload, present when the error was enriched via the Health Status API.","uniqueKey":"error.provider.health_status","typeLabel":"object"}},"required":["source","code","message"],"uniqueKey":"error.provider","typeLabel":"object"},"additional_info":{"type":"array","items":{"type":"string","uniqueKey":"error.additional_info.items.[INDEX]","typeLabel":"string"},"description":"Human-readable remediation hints (e.g. from Meta Health Status).","uniqueKey":"error.additional_info","typeLabel":"string[]"}},"required":["type","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","message":"The phone number \"+1abc\" is not in E.164 format.","code":"invalid_phone_number","doc_url":"https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number","param":"from","provider":{"source":"meta","code":123,"message":"\u003cstring>","fbtrace_id":"\u003cstring>","health_status":{"can_send_message":"AVAILABLE","entities":[{"entity_type":"PHONE_NUMBER","id":"\u003cstring>","can_send_message":"AVAILABLE","can_receive_call_sip":"AVAILABLE","errors":[{"error_code":123,"error_description":"\u003cstring>","possible_solution":"\u003cstring>"}]}]}},"additional_info":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"8578cdfc-8f0f-4398-b6dc-8af677828639":{"description":"Template or phone number not found Possible codes: `template_not_found`, `phone_number_not_assigned`","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","provider_error","api_error"],"description":"The type of error returned","example":"invalid_request_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"The phone number \"+1abc\" is not in E.164 format.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","enum":["message_undeliverable","conversation_window_expired","recipient_not_on_whatsapp","phone_number_not_assigned","unsupported_message_type","media_too_large","invalid_phone_number","template_not_found","template_parameter_mismatch","groups_not_eligible","account_restricted","display_name_not_approved","whatsapp_not_configured","meta_api_error","meta_api_unavailable","telnyx_api_error","telnyx_api_unavailable","rate_limit_exceeded","whatsapp_rate_limited","resource_already_exists","test_app_required","call_not_found","call_already_ended","call_failed","call_rejected","call_timeout","call_busy","calling_not_configured","calling_disabled","max_concurrent_calls_reached","recording_not_found","recording_already_in_progress","recording_failed","voicemail_not_found","voicemail_disabled","invalid_call_command","command_not_applicable","whatsapp_calling_not_enabled","whatsapp_call_permission_required","whatsapp_call_permission_limit","whatsapp_pstn_bridge_forbidden","livekit_api_error","livekit_room_error","sip_trunk_error"],"description":"A machine-readable error code for programmatic handling","example":"invalid_phone_number","uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","description":"URL to documentation for this error code","example":"https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"param":{"type":"string","description":"The parameter that caused the error","example":"from","uniqueKey":"error.param","typeLabel":"string"},"provider":{"type":"object","properties":{"source":{"type":"string","enum":["meta","telnyx","livekit"],"description":"Provider name","example":"meta","isRequired":true,"uniqueKey":"error.provider.source","typeLabel":"enum\u003cstring>"},"code":{"oneOf":[{"type":"number","description":"Provider's native error code","isRequired":true,"uniqueKey":"error.provider.code.oneOf.0","typeLabel":"number"},{"type":"string","description":"Provider's native error code","isRequired":true,"uniqueKey":"error.provider.code.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"error.provider.code","typeLabel":"number | string"},"message":{"type":"string","description":"Provider's error message","isRequired":true,"uniqueKey":"error.provider.message","typeLabel":"string"},"fbtrace_id":{"type":"string","description":"Meta's trace ID for support tickets","uniqueKey":"error.provider.fbtrace_id","typeLabel":"string"},"health_status":{"type":"object","properties":{"can_send_message":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","isRequired":true,"uniqueKey":"error.provider.health_status.can_send_message","typeLabel":"enum\u003cstring>"},"entities":{"type":"array","items":{"oneOf":[{"type":"object","required":["entity_type","id","can_send_message"],"properties":{"entity_type":{"type":"string","enum":["PHONE_NUMBER","MESSAGE_TEMPLATE","WABA","BUSINESS","APP"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.entity_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.id","typeLabel":"string"},"can_send_message":{"type":"string","enum":["AVAILABLE"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.can_send_message","typeLabel":"enum\u003cstring>"},"can_receive_call_sip":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.can_receive_call_sip","typeLabel":"enum\u003cstring>"},"errors":{"type":"array","items":{"type":"object","properties":{"error_code":{"type":"number","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX].error_code","typeLabel":"number"},"error_description":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX].error_description","typeLabel":"string"},"possible_solution":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX].possible_solution","typeLabel":"string"}},"required":["error_code","error_description","possible_solution"],"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors","typeLabel":"object[]"}},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["entity_type","id","can_send_message","additional_info"],"properties":{"entity_type":{"type":"string","enum":["PHONE_NUMBER","MESSAGE_TEMPLATE","WABA","BUSINESS","APP"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.entity_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.id","typeLabel":"string"},"can_send_message":{"type":"string","enum":["LIMITED"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.can_send_message","typeLabel":"enum\u003cstring>"},"additional_info":{"type":"array","items":{"type":"string","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.additional_info.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.additional_info","typeLabel":"string[]"},"can_receive_call_sip":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.can_receive_call_sip","typeLabel":"enum\u003cstring>"},"errors":{"type":"array","items":{"type":"object","properties":{"error_code":{"type":"number","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX].error_code","typeLabel":"number"},"error_description":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX].error_description","typeLabel":"string"},"possible_solution":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX].possible_solution","typeLabel":"string"}},"required":["error_code","error_description","possible_solution"],"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors","typeLabel":"object[]"}},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["entity_type","id","can_send_message","errors"],"properties":{"entity_type":{"type":"string","enum":["PHONE_NUMBER","MESSAGE_TEMPLATE","WABA","BUSINESS","APP"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.entity_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.id","typeLabel":"string"},"can_send_message":{"type":"string","enum":["BLOCKED"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.can_send_message","typeLabel":"enum\u003cstring>"},"errors":{"type":"array","items":{"type":"object","properties":{"error_code":{"type":"number","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX].error_code","typeLabel":"number"},"error_description":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX].error_description","typeLabel":"string"},"possible_solution":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX].possible_solution","typeLabel":"string"}},"required":["error_code","error_description","possible_solution"],"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors","typeLabel":"object[]"},"can_receive_call_sip":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.can_receive_call_sip","typeLabel":"enum\u003cstring>"}},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"error.provider.health_status.entities.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.provider.health_status.entities","typeLabel":"object[]"}},"required":["can_send_message","entities"],"description":"Meta Health Status payload, present when the error was enriched via the Health Status API.","uniqueKey":"error.provider.health_status","typeLabel":"object"}},"required":["source","code","message"],"uniqueKey":"error.provider","typeLabel":"object"},"additional_info":{"type":"array","items":{"type":"string","uniqueKey":"error.additional_info.items.[INDEX]","typeLabel":"string"},"description":"Human-readable remediation hints (e.g. from Meta Health Status).","uniqueKey":"error.additional_info","typeLabel":"string[]"}},"required":["type","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","message":"The phone number \"+1abc\" is not in E.164 format.","code":"invalid_phone_number","doc_url":"https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number","param":"from","provider":{"source":"meta","code":123,"message":"\u003cstring>","fbtrace_id":"\u003cstring>","health_status":{"can_send_message":"AVAILABLE","entities":[{"entity_type":"PHONE_NUMBER","id":"\u003cstring>","can_send_message":"AVAILABLE","can_receive_call_sip":"AVAILABLE","errors":[{"error_code":123,"error_description":"\u003cstring>","possible_solution":"\u003cstring>"}]}]}},"additional_info":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"d38999ca-8c6c-4234-8101-8d5df213b593":{"description":"Provider error from Meta Possible codes: `meta_api_error`, `meta_api_unavailable`","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","provider_error","api_error"],"description":"The type of error returned","example":"invalid_request_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"The phone number \"+1abc\" is not in E.164 format.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","enum":["message_undeliverable","conversation_window_expired","recipient_not_on_whatsapp","phone_number_not_assigned","unsupported_message_type","media_too_large","invalid_phone_number","template_not_found","template_parameter_mismatch","groups_not_eligible","account_restricted","display_name_not_approved","whatsapp_not_configured","meta_api_error","meta_api_unavailable","telnyx_api_error","telnyx_api_unavailable","rate_limit_exceeded","whatsapp_rate_limited","resource_already_exists","test_app_required","call_not_found","call_already_ended","call_failed","call_rejected","call_timeout","call_busy","calling_not_configured","calling_disabled","max_concurrent_calls_reached","recording_not_found","recording_already_in_progress","recording_failed","voicemail_not_found","voicemail_disabled","invalid_call_command","command_not_applicable","whatsapp_calling_not_enabled","whatsapp_call_permission_required","whatsapp_call_permission_limit","whatsapp_pstn_bridge_forbidden","livekit_api_error","livekit_room_error","sip_trunk_error"],"description":"A machine-readable error code for programmatic handling","example":"invalid_phone_number","uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","description":"URL to documentation for this error code","example":"https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"param":{"type":"string","description":"The parameter that caused the error","example":"from","uniqueKey":"error.param","typeLabel":"string"},"provider":{"type":"object","properties":{"source":{"type":"string","enum":["meta","telnyx","livekit"],"description":"Provider name","example":"meta","isRequired":true,"uniqueKey":"error.provider.source","typeLabel":"enum\u003cstring>"},"code":{"oneOf":[{"type":"number","description":"Provider's native error code","isRequired":true,"uniqueKey":"error.provider.code.oneOf.0","typeLabel":"number"},{"type":"string","description":"Provider's native error code","isRequired":true,"uniqueKey":"error.provider.code.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"error.provider.code","typeLabel":"number | string"},"message":{"type":"string","description":"Provider's error message","isRequired":true,"uniqueKey":"error.provider.message","typeLabel":"string"},"fbtrace_id":{"type":"string","description":"Meta's trace ID for support tickets","uniqueKey":"error.provider.fbtrace_id","typeLabel":"string"},"health_status":{"type":"object","properties":{"can_send_message":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","isRequired":true,"uniqueKey":"error.provider.health_status.can_send_message","typeLabel":"enum\u003cstring>"},"entities":{"type":"array","items":{"oneOf":[{"type":"object","required":["entity_type","id","can_send_message"],"properties":{"entity_type":{"type":"string","enum":["PHONE_NUMBER","MESSAGE_TEMPLATE","WABA","BUSINESS","APP"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.entity_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.id","typeLabel":"string"},"can_send_message":{"type":"string","enum":["AVAILABLE"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.can_send_message","typeLabel":"enum\u003cstring>"},"can_receive_call_sip":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.can_receive_call_sip","typeLabel":"enum\u003cstring>"},"errors":{"type":"array","items":{"type":"object","properties":{"error_code":{"type":"number","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX].error_code","typeLabel":"number"},"error_description":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX].error_description","typeLabel":"string"},"possible_solution":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX].possible_solution","typeLabel":"string"}},"required":["error_code","error_description","possible_solution"],"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors","typeLabel":"object[]"}},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["entity_type","id","can_send_message","additional_info"],"properties":{"entity_type":{"type":"string","enum":["PHONE_NUMBER","MESSAGE_TEMPLATE","WABA","BUSINESS","APP"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.entity_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.id","typeLabel":"string"},"can_send_message":{"type":"string","enum":["LIMITED"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.can_send_message","typeLabel":"enum\u003cstring>"},"additional_info":{"type":"array","items":{"type":"string","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.additional_info.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.additional_info","typeLabel":"string[]"},"can_receive_call_sip":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.can_receive_call_sip","typeLabel":"enum\u003cstring>"},"errors":{"type":"array","items":{"type":"object","properties":{"error_code":{"type":"number","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX].error_code","typeLabel":"number"},"error_description":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX].error_description","typeLabel":"string"},"possible_solution":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX].possible_solution","typeLabel":"string"}},"required":["error_code","error_description","possible_solution"],"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors","typeLabel":"object[]"}},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["entity_type","id","can_send_message","errors"],"properties":{"entity_type":{"type":"string","enum":["PHONE_NUMBER","MESSAGE_TEMPLATE","WABA","BUSINESS","APP"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.entity_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.id","typeLabel":"string"},"can_send_message":{"type":"string","enum":["BLOCKED"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.can_send_message","typeLabel":"enum\u003cstring>"},"errors":{"type":"array","items":{"type":"object","properties":{"error_code":{"type":"number","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX].error_code","typeLabel":"number"},"error_description":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX].error_description","typeLabel":"string"},"possible_solution":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX].possible_solution","typeLabel":"string"}},"required":["error_code","error_description","possible_solution"],"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors","typeLabel":"object[]"},"can_receive_call_sip":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.can_receive_call_sip","typeLabel":"enum\u003cstring>"}},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"error.provider.health_status.entities.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.provider.health_status.entities","typeLabel":"object[]"}},"required":["can_send_message","entities"],"description":"Meta Health Status payload, present when the error was enriched via the Health Status API.","uniqueKey":"error.provider.health_status","typeLabel":"object"}},"required":["source","code","message"],"uniqueKey":"error.provider","typeLabel":"object"},"additional_info":{"type":"array","items":{"type":"string","uniqueKey":"error.additional_info.items.[INDEX]","typeLabel":"string"},"description":"Human-readable remediation hints (e.g. from Meta Health Status).","uniqueKey":"error.additional_info","typeLabel":"string[]"}},"required":["type","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","message":"The phone number \"+1abc\" is not in E.164 format.","code":"invalid_phone_number","doc_url":"https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number","param":"from","provider":{"source":"meta","code":123,"message":"\u003cstring>","fbtrace_id":"\u003cstring>","health_status":{"can_send_message":"AVAILABLE","entities":[{"entity_type":"PHONE_NUMBER","id":"\u003cstring>","can_send_message":"AVAILABLE","can_receive_call_sip":"AVAILABLE","errors":[{"error_code":123,"error_description":"\u003cstring>","possible_solution":"\u003cstring>"}]}]}},"additional_info":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"220b79c2-ebe0-4973-96ae-c4e3a72abb74":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","provider_error","api_error"],"description":"The type of error returned","example":"invalid_request_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"The phone number \"+1abc\" is not in E.164 format.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","enum":["message_undeliverable","conversation_window_expired","recipient_not_on_whatsapp","phone_number_not_assigned","unsupported_message_type","media_too_large","invalid_phone_number","template_not_found","template_parameter_mismatch","groups_not_eligible","account_restricted","display_name_not_approved","whatsapp_not_configured","meta_api_error","meta_api_unavailable","telnyx_api_error","telnyx_api_unavailable","rate_limit_exceeded","whatsapp_rate_limited","resource_already_exists","test_app_required","call_not_found","call_already_ended","call_failed","call_rejected","call_timeout","call_busy","calling_not_configured","calling_disabled","max_concurrent_calls_reached","recording_not_found","recording_already_in_progress","recording_failed","voicemail_not_found","voicemail_disabled","invalid_call_command","command_not_applicable","whatsapp_calling_not_enabled","whatsapp_call_permission_required","whatsapp_call_permission_limit","whatsapp_pstn_bridge_forbidden","livekit_api_error","livekit_room_error","sip_trunk_error"],"description":"A machine-readable error code for programmatic handling","example":"invalid_phone_number","uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","description":"URL to documentation for this error code","example":"https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"param":{"type":"string","description":"The parameter that caused the error","example":"from","uniqueKey":"error.param","typeLabel":"string"},"provider":{"type":"object","properties":{"source":{"type":"string","enum":["meta","telnyx","livekit"],"description":"Provider name","example":"meta","isRequired":true,"uniqueKey":"error.provider.source","typeLabel":"enum\u003cstring>"},"code":{"oneOf":[{"type":"number","description":"Provider's native error code","isRequired":true,"uniqueKey":"error.provider.code.oneOf.0","typeLabel":"number"},{"type":"string","description":"Provider's native error code","isRequired":true,"uniqueKey":"error.provider.code.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"error.provider.code","typeLabel":"number | string"},"message":{"type":"string","description":"Provider's error message","isRequired":true,"uniqueKey":"error.provider.message","typeLabel":"string"},"fbtrace_id":{"type":"string","description":"Meta's trace ID for support tickets","uniqueKey":"error.provider.fbtrace_id","typeLabel":"string"},"health_status":{"type":"object","properties":{"can_send_message":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","isRequired":true,"uniqueKey":"error.provider.health_status.can_send_message","typeLabel":"enum\u003cstring>"},"entities":{"type":"array","items":{"oneOf":[{"type":"object","required":["entity_type","id","can_send_message"],"properties":{"entity_type":{"type":"string","enum":["PHONE_NUMBER","MESSAGE_TEMPLATE","WABA","BUSINESS","APP"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.entity_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.id","typeLabel":"string"},"can_send_message":{"type":"string","enum":["AVAILABLE"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.can_send_message","typeLabel":"enum\u003cstring>"},"can_receive_call_sip":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.can_receive_call_sip","typeLabel":"enum\u003cstring>"},"errors":{"type":"array","items":{"type":"object","properties":{"error_code":{"type":"number","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX].error_code","typeLabel":"number"},"error_description":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX].error_description","typeLabel":"string"},"possible_solution":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX].possible_solution","typeLabel":"string"}},"required":["error_code","error_description","possible_solution"],"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0.errors","typeLabel":"object[]"}},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["entity_type","id","can_send_message","additional_info"],"properties":{"entity_type":{"type":"string","enum":["PHONE_NUMBER","MESSAGE_TEMPLATE","WABA","BUSINESS","APP"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.entity_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.id","typeLabel":"string"},"can_send_message":{"type":"string","enum":["LIMITED"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.can_send_message","typeLabel":"enum\u003cstring>"},"additional_info":{"type":"array","items":{"type":"string","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.additional_info.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.additional_info","typeLabel":"string[]"},"can_receive_call_sip":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.can_receive_call_sip","typeLabel":"enum\u003cstring>"},"errors":{"type":"array","items":{"type":"object","properties":{"error_code":{"type":"number","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX].error_code","typeLabel":"number"},"error_description":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX].error_description","typeLabel":"string"},"possible_solution":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX].possible_solution","typeLabel":"string"}},"required":["error_code","error_description","possible_solution"],"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1.errors","typeLabel":"object[]"}},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["entity_type","id","can_send_message","errors"],"properties":{"entity_type":{"type":"string","enum":["PHONE_NUMBER","MESSAGE_TEMPLATE","WABA","BUSINESS","APP"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.entity_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.id","typeLabel":"string"},"can_send_message":{"type":"string","enum":["BLOCKED"],"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.can_send_message","typeLabel":"enum\u003cstring>"},"errors":{"type":"array","items":{"type":"object","properties":{"error_code":{"type":"number","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX].error_code","typeLabel":"number"},"error_description":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX].error_description","typeLabel":"string"},"possible_solution":{"type":"string","isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX].possible_solution","typeLabel":"string"}},"required":["error_code","error_description","possible_solution"],"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.errors","typeLabel":"object[]"},"can_receive_call_sip":{"type":"string","enum":["AVAILABLE","LIMITED","BLOCKED"],"description":"Meta Health Status value","uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2.can_receive_call_sip","typeLabel":"enum\u003cstring>"}},"uniqueKey":"error.provider.health_status.entities.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"error.provider.health_status.entities.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.provider.health_status.entities","typeLabel":"object[]"}},"required":["can_send_message","entities"],"description":"Meta Health Status payload, present when the error was enriched via the Health Status API.","uniqueKey":"error.provider.health_status","typeLabel":"object"}},"required":["source","code","message"],"uniqueKey":"error.provider","typeLabel":"object"},"additional_info":{"type":"array","items":{"type":"string","uniqueKey":"error.additional_info.items.[INDEX]","typeLabel":"string"},"description":"Human-readable remediation hints (e.g. from Meta Health Status).","uniqueKey":"error.additional_info","typeLabel":"string[]"}},"required":["type","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","message":"The phone number \"+1abc\" is not in E.164 format.","code":"invalid_phone_number","doc_url":"https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number","param":"from","provider":{"source":"meta","code":123,"message":"\u003cstring>","fbtrace_id":"\u003cstring>","health_status":{"can_send_message":"AVAILABLE","entities":[{"entity_type":"PHONE_NUMBER","id":"\u003cstring>","can_send_message":"AVAILABLE","can_receive_call_sip":"AVAILABLE","errors":[{"error_code":123,"error_description":"\u003cstring>","possible_solution":"\u003cstring>"}]}]}},"additional_info":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"40d954c4-cc79-4719-beb3-1e6bcf129df8":{"appAuth":{"type":"http","scheme":"bearer","description":"App API key (format: sk_live_app_* or sk_test_app_*) for app-level operations","scopes":[]}}},"servers":{"8a7e5dd7-9eff-454a-bab0-649f7b39a2b0":{"url":"https://api.buildwithchirp.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"App API key (format: sk_live_app_* or sk_test_app_*) for app-level operations","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"App API key (format: sk_live_app_* or sk_test_app_*) for app-level operations","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"appAuth","name":"Authorization"}],"title":"appAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"chirp-542e2f98","siteName":"Chirp","title":"Send app template message - Chirp","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-04T04:10:58.669Z","originalFileLocation":"api-reference/app/post-v1whatsapptemplatessend.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Send a WhatsApp template message. The template must be approved by Meta and linked to this app. Variables can be passed using named keys that will be automatically mapped to positional indices.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Chirp\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/chirp-542e2f98/pUClOYUkHiRRF0yE/_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/chirp-542e2f98/pUClOYUkHiRRF0yE/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/chirp-542e2f98/pUClOYUkHiRRF0yE/_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/chirp-542e2f98/pUClOYUkHiRRF0yE/_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/chirp-542e2f98/pUClOYUkHiRRF0yE/_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/chirp-542e2f98/pUClOYUkHiRRF0yE/_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/chirp-542e2f98/pUClOYUkHiRRF0yE/_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/chirp-542e2f98/pUClOYUkHiRRF0yE/_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/chirp-542e2f98/pUClOYUkHiRRF0yE/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Send app template message - Chirp\">\u003cmeta data-mint-head property=\"og:description\" content=\"Send a WhatsApp template message. The template must be approved by Meta and linked to this app. Variables can be passed using named keys that will be automatically mapped to positional indices.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Chirp\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.buildwithchirp.com/api-reference/app/post-v1whatsapptemplatessend\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://chirp-542e2f98.mintlify.site/_mintlify/api/og/v2?division=WhatsApp+Templates\u0026amp;title=Send+app+template+message\u0026amp;description=Send+a+WhatsApp+template+message.+The+template+must+be+approved+by+Meta+and+linked+to+this+app.+Variables+can+be+passed+using+named+keys+that+will+be+automatica\u0026amp;theme=aaac106ca8610ae0b79e9ae0\u0026amp;signature=c47b088cb45c0a6e3f166888a47dc0e4a118ff0397972ed4b12ed6f39d67d7d5\">\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 app template message - Chirp\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Send a WhatsApp template message. The template must be approved by Meta and linked to this app. Variables can be passed using named keys that will be automatically mapped to positional indices.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://chirp-542e2f98.mintlify.site/_mintlify/api/og/v2?division=WhatsApp+Templates\u0026amp;title=Send+app+template+message\u0026amp;description=Send+a+WhatsApp+template+message.+The+template+must+be+approved+by+Meta+and+linked+to+this+app.+Variables+can+be+passed+using+named+keys+that+will+be+automatica\u0026amp;theme=aaac106ca8610ae0b79e9ae0\u0026amp;signature=c47b088cb45c0a6e3f166888a47dc0e4a118ff0397972ed4b12ed6f39d67d7d5\">\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/chirp-542e2f98/pUClOYUkHiRRF0yE/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Chirp\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6C63FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.buildwithchirp.com/api-reference/app/post-v1whatsapptemplatessend\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/app/post-v1whatsapptemplatessend.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.buildwithchirp.com/#organization\",\"name\":\"Chirp\",\"url\":\"https://docs.buildwithchirp.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/chirp-542e2f98/NWWcTXi85omYcm46/chirp-logo-light.svg?fit=max\u0026auto=format\u0026n=NWWcTXi85omYcm46\u0026q=85\u0026s=ea6bd143fa5ef227d88963f9b5d16e2c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.buildwithchirp.com#website\",\"name\":\"Chirp\",\"url\":\"https://docs.buildwithchirp.com\",\"publisher\":{\"@id\":\"https://docs.buildwithchirp.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.buildwithchirp.com/api-reference/app/post-v1whatsapptemplatessend#webpage\",\"url\":\"https://docs.buildwithchirp.com/api-reference/app/post-v1whatsapptemplatessend\",\"name\":\"Send app template message\",\"description\":\"Send a WhatsApp template message. The template must be approved by Meta and linked to this app. Variables can be passed using named keys that will be automatically mapped to positional indices.\",\"dateModified\":\"2026-05-04T04:10:58.669Z\",\"isPartOf\":{\"@id\":\"https://docs.buildwithchirp.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.buildwithchirp.com/api-reference/app/post-v1whatsapptemplatessend#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.buildwithchirp.com/api-reference/app/post-v1whatsapptemplatessend#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Application APIs\",\"item\":\"https://docs.buildwithchirp.com/api_reference/app-keys\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"WhatsApp Templates\",\"item\":\"https://docs.buildwithchirp.com/api-reference/app/get-v1whatsapptemplates\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Send app template message\",\"item\":\"https://docs.buildwithchirp.com/api-reference/app/post-v1whatsapptemplatessend\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.buildwithchirp.com/api-reference/app/post-v1whatsapptemplatessend#apireference\",\"headline\":\"Send app template message\",\"name\":\"Send app template message\",\"description\":\"Send a WhatsApp template message. The template must be approved by Meta and linked to this app. Variables can be passed using named keys that will be automatically mapped to positional indices.\",\"url\":\"https://docs.buildwithchirp.com/api-reference/app/post-v1whatsapptemplatessend\",\"mainEntityOfPage\":{\"@id\":\"https://docs.buildwithchirp.com/api-reference/app/post-v1whatsapptemplatessend#webpage\"},\"dateModified\":\"2026-05-04T04:10:58.669Z\",\"publisher\":{\"@id\":\"https://docs.buildwithchirp.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.buildwithchirp.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Chirp\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Chirp\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/app/post-v1whatsapptemplatessend.md","siteName":"Chirp","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","pages":[{"group":"API Reference","icon":"square-terminal","expanded":false,"pages":[{"title":"API Introduction","href":"/api_reference/introduction"},{"title":"Authentication","href":"/api_reference/authentication"},{"title":"Errors","href":"/api_reference/errors"},{"title":"Error Codes","href":"/api_reference/error-codes"},{"title":"Handling Errors","href":"/api_reference/handling-errors"},{"title":"Rate Limits","href":"/api_reference/rate-limits"},{"title":"Webhook Event Reference","href":"/api_reference/webhooks/events"}]},{"group":"Application APIs","icon":"code","expanded":false,"pages":[{"title":"App Keys","href":"/api_reference/app-keys"},{"group":"Functions","expanded":false,"pages":[{"title":"List functions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/functions","href":"/api-reference/app/get-v1functions"},{"title":"Create function","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/functions","href":"/api-reference/app/post-v1functions"},{"title":"Update function","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/functions/{slug}","href":"/api-reference/app/put-v1functions"},{"title":"Create function deployment","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/functions/{slug}/deployments","href":"/api-reference/app/post-v1functions-deployments"}]},{"group":"Webhooks","expanded":false,"pages":[{"title":"Get app webhook","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhooks/{webhookId}","href":"/api-reference/app/get-v1webhooks"},{"title":"Create app webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhooks","href":"/api-reference/app/post-v1webhooks"},{"title":"Get app webhook","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhooks/{webhookId}","href":"/api-reference/app/get-v1webhooks"},{"title":"Update app webhook","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/webhooks/{webhookId}","href":"/api-reference/app/put-v1webhooks"},{"title":"Delete app webhook","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/webhooks/{webhookId}","href":"/api-reference/app/delete-v1webhooks"}]},{"group":"Phone Numbers","expanded":false,"pages":[{"title":"Assign phone number","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/phone-numbers","href":"/api-reference/app/post-v1phone-numbers"},{"title":"Unassign phone number","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/phone-numbers/{phoneNumberId}","href":"/api-reference/app/delete-v1phone-numbers"}]},{"group":"SMS","expanded":false,"pages":[{"title":"Send SMS","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sms","href":"/api-reference/app/post-v1sms"}]},{"group":"WhatsApp","expanded":false,"pages":[{"title":"Send WhatsApp Message","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/messages","href":"/api-reference/app/post-v1whatsappmessages"},{"title":"Mark Message as Read","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/messages/read","href":"/api-reference/app/post-v1whatsappmessagesread"},{"title":"Send Typing Indicator","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/messages/typing","href":"/api-reference/app/post-v1whatsappmessagestyping"}]},{"group":"WhatsApp Groups","expanded":false,"pages":[{"title":"Get group","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/groups/{groupId}","href":"/api-reference/app/get-v1whatsappgroups"},{"title":"Create group","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/groups","href":"/api-reference/app/post-v1whatsappgroups"},{"title":"Get group","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/groups/{groupId}","href":"/api-reference/app/get-v1whatsappgroups"},{"title":"Update group","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/whatsapp/groups/{groupId}","href":"/api-reference/app/put-v1whatsappgroups"},{"title":"Delete group","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/whatsapp/groups/{groupId}","href":"/api-reference/app/delete-v1whatsappgroups"},{"title":"Get invite link","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/groups/{groupId}/invite-link","href":"/api-reference/app/get-v1whatsappgroups-invite-link"},{"title":"Reset invite link","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/groups/{groupId}/invite-link/reset","href":"/api-reference/app/post-v1whatsappgroups-invite-linkreset"},{"title":"List participants","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/groups/{groupId}/participants","href":"/api-reference/app/get-v1whatsappgroups-participants"},{"title":"Remove participants","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/whatsapp/groups/{groupId}/participants","href":"/api-reference/app/delete-v1whatsappgroups-participants"},{"title":"List join requests","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/groups/{groupId}/join-requests","href":"/api-reference/app/get-v1whatsappgroups-join-requests"},{"title":"Approve join requests","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/groups/{groupId}/join-requests/approve","href":"/api-reference/app/post-v1whatsappgroups-join-requestsapprove"},{"title":"Reject join requests","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/groups/{groupId}/join-requests/reject","href":"/api-reference/app/post-v1whatsappgroups-join-requestsreject"},{"title":"Send group message","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/groups/{groupId}/messages","href":"/api-reference/app/post-v1whatsappgroups-messages"},{"title":"Pin message","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/groups/{groupId}/messages/pin","href":"/api-reference/app/post-v1whatsappgroups-messagespin"},{"title":"Unpin message","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/groups/{groupId}/messages/unpin","href":"/api-reference/app/post-v1whatsappgroups-messagesunpin"},{"title":"Update profile picture","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/whatsapp/groups/{groupId}/profile-picture","href":"/api-reference/app/put-v1whatsappgroups-profile-picture"}]},{"group":"WhatsApp Phone Settings","expanded":false,"pages":[{"title":"Get business profile","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/phone-numbers/{phoneNumberId}/business-profile","href":"/api-reference/app/get-v1whatsappphone-numbers-business-profile"},{"title":"Update business profile","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/whatsapp/phone-numbers/{phoneNumberId}/business-profile","href":"/api-reference/app/patch-v1whatsappphone-numbers-business-profile"},{"title":"Get phone settings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/phone-numbers/{phoneNumberId}/settings","href":"/api-reference/app/get-v1whatsappphone-numbers-settings"},{"title":"Update phone settings","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/whatsapp/phone-numbers/{phoneNumberId}/settings","href":"/api-reference/app/patch-v1whatsappphone-numbers-settings"}]},{"group":"WhatsApp Templates","expanded":false,"pages":[{"title":"Get app template","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/templates/{templateId}","href":"/api-reference/app/get-v1whatsapptemplates"},{"title":"Create app template","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/templates","href":"/api-reference/app/post-v1whatsapptemplates"},{"title":"Get app template","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/templates/{templateId}","href":"/api-reference/app/get-v1whatsapptemplates"},{"title":"Update app template","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/whatsapp/templates/{templateId}","href":"/api-reference/app/put-v1whatsapptemplates"},{"title":"Delete app template","description":"Delete a WhatsApp message template. This permanently deletes the template from Meta, which will affect ALL apps that have this template linked. The template cannot be recovered after deletion.","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/whatsapp/templates/{templateId}","href":"/api-reference/app/delete-v1whatsapptemplates"},{"title":"Send app template message","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/templates/send","href":"/api-reference/app/post-v1whatsapptemplatessend"}]},{"group":"Calls","expanded":false,"pages":[{"title":"Create call","description":"Initiate an outbound call","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/calls","href":"/api-reference/app/post-v1calls"},{"title":"Get call","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/calls/{callId}","href":"/api-reference/app/get-v1calls"},{"title":"Get call","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/calls/{callId}","href":"/api-reference/app/get-v1calls"},{"title":"Execute call command","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/calls/{callId}/commands","href":"/api-reference/app/post-v1calls-commands"},{"title":"End call","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/calls/{callId}","href":"/api-reference/app/delete-v1calls"},{"title":"Generate call token","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/calls/token","href":"/api-reference/app/post-v1callstoken"},{"title":"List call recordings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/calls/{callId}/recordings","href":"/api-reference/app/get-v1calls-recordings"},{"title":"Get recording","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/calls/recordings/{recordingId}","href":"/api-reference/app/get-v1callsrecordings"},{"title":"Delete recording","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/calls/recordings/{recordingId}","href":"/api-reference/app/delete-v1callsrecordings"},{"title":"Get voicemail","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/calls/voicemails/{voicemailId}","href":"/api-reference/app/get-v1callsvoicemails"},{"title":"Get voicemail","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/calls/voicemails/{voicemailId}","href":"/api-reference/app/get-v1callsvoicemails"},{"title":"Update voicemail","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/calls/voicemails/{voicemailId}","href":"/api-reference/app/patch-v1callsvoicemails"},{"title":"Delete voicemail","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/calls/voicemails/{voicemailId}","href":"/api-reference/app/delete-v1callsvoicemails"}]},{"group":"Media","expanded":false,"pages":[{"title":"Get media","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/media/{id}","href":"/api-reference/app/get-v1media"},{"title":"Upload media","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/media","href":"/api-reference/app/post-v1media"},{"title":"Get media","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/media/{id}","href":"/api-reference/app/get-v1media"},{"title":"Delete media","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/media/{id}","href":"/api-reference/app/delete-v1media"}]},{"group":"Playground","expanded":false,"pages":[{"title":"List playground SMS system numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/playground/phone-numbers/system","href":"/api-reference/app/get-v1playgroundphone-numberssystem"},{"title":"Purchase a playground SMS system number","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/playground/phone-numbers/system","href":"/api-reference/app/post-v1playgroundphone-numberssystem"},{"title":"List playground SMS user numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/playground/phone-numbers/user","href":"/api-reference/app/get-v1playgroundphone-numbersuser"},{"title":"Generate a playground SMS user number","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/playground/phone-numbers/user","href":"/api-reference/app/post-v1playgroundphone-numbersuser"},{"title":"List playground WhatsApp system numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/playground/whatsapp/phone-numbers/system","href":"/api-reference/app/get-v1playgroundwhatsappphone-numberssystem"},{"title":"Purchase a playground WhatsApp system number","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/playground/whatsapp/phone-numbers/system","href":"/api-reference/app/post-v1playgroundwhatsappphone-numberssystem"},{"title":"List playground WhatsApp user numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/playground/whatsapp/phone-numbers/user","href":"/api-reference/app/get-v1playgroundwhatsappphone-numbersuser"},{"title":"Generate a playground WhatsApp user number","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/playground/whatsapp/phone-numbers/user","href":"/api-reference/app/post-v1playgroundwhatsappphone-numbersuser"},{"title":"Simulate inbound SMS","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/playground/sms/inbound","href":"/api-reference/app/post-v1playgroundsmsinbound"},{"title":"Simulate inbound WhatsApp message","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/playground/whatsapp/inbound","href":"/api-reference/app/post-v1playgroundwhatsappinbound"}]}]},{"group":"Administration APIs","icon":"shield-halved","pages":[{"title":"Admin Keys","href":"/administration_apis/admin-keys"},{"group":"Billing","expanded":false,"pages":[{"title":"Get billing summary","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/billing/summary","href":"/api-reference/admin/get-v1organizationbillingsummary"},{"title":"Get billing record","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/billing/records/{id}","href":"/api-reference/admin/get-v1organizationbillingrecords"},{"title":"Get billing record","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/billing/records/{id}","href":"/api-reference/admin/get-v1organizationbillingrecords"},{"title":"Get daily costs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/billing/daily-costs","href":"/api-reference/admin/get-v1organizationbillingdaily-costs"},{"title":"List sync runs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/billing/sync-runs","href":"/api-reference/admin/get-v1organizationbillingsync-runs"},{"title":"Get reconciliation report","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/billing/reconciliation","href":"/api-reference/admin/get-v1organizationbillingreconciliation"},{"title":"Trigger billing sync","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/billing/sync","href":"/api-reference/admin/post-v1organizationbillingsync"}]},{"group":"Settings","expanded":false,"pages":[{"title":"Get organization settings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/settings","href":"/api-reference/admin/get-v1organizationsettings"},{"title":"Update organization settings","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/organization/settings","href":"/api-reference/admin/patch-v1organizationsettings"}]},{"group":"Stats","expanded":false,"pages":[{"title":"Get App Stats","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/stats/{appId}","href":"/api-reference/admin/get-v1organizationstats"}]},{"group":"Apps","expanded":false,"pages":[{"title":"List apps","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/apps","href":"/api-reference/admin/get-v1organizationapps"},{"title":"Create app","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/apps","href":"/api-reference/admin/post-v1organizationapps"},{"title":"Check slug availability","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/apps/check-slug","href":"/api-reference/admin/get-v1organizationappscheck-slug"},{"title":"Update app","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/organization/apps/{appId}","href":"/api-reference/admin/put-v1organizationapps"},{"title":"Delete app","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/organization/apps/{appId}","href":"/api-reference/admin/delete-v1organizationapps"}]},{"group":"Admin Keys","expanded":false,"pages":[{"title":"List admin keys","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/admin-keys","href":"/api-reference/admin/get-v1organizationadmin-keys"},{"title":"Create admin key","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/admin-keys","href":"/api-reference/admin/post-v1organizationadmin-keys"},{"title":"Delete admin key","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/organization/admin-keys/{id}","href":"/api-reference/admin/delete-v1organizationadmin-keys"}]},{"group":"App Keys","expanded":false,"pages":[{"title":"List app keys","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/app-keys","href":"/api-reference/admin/get-v1organizationapp-keys"},{"title":"Create app key","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/app-keys","href":"/api-reference/admin/post-v1organizationapp-keys"},{"title":"Delete app key","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/organization/app-keys/{id}","href":"/api-reference/admin/delete-v1organizationapp-keys"}]},{"group":"App Webhooks","expanded":false,"pages":[{"title":"Get webhook for app","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/apps/{appId}/webhooks/{webhookId}","href":"/api-reference/admin/get-v1organizationapps-webhooks"},{"title":"Create webhook for app","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/apps/{appId}/webhooks","href":"/api-reference/admin/post-v1organizationapps-webhooks"},{"title":"Get webhook for app","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/apps/{appId}/webhooks/{webhookId}","href":"/api-reference/admin/get-v1organizationapps-webhooks"},{"title":"Update webhook for app","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/organization/apps/{appId}/webhooks/{webhookId}","href":"/api-reference/admin/put-v1organizationapps-webhooks"},{"title":"Delete webhook for app","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/organization/apps/{appId}/webhooks/{webhookId}","href":"/api-reference/admin/delete-v1organizationapps-webhooks"}]},{"group":"App Phone Numbers","expanded":false,"pages":[{"title":"List app phone numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/apps/{appId}/phone-numbers","href":"/api-reference/admin/get-v1organizationapps-phone-numbers"},{"title":"Add phone number to app","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/apps/{appId}/phone-numbers","href":"/api-reference/admin/post-v1organizationapps-phone-numbers"},{"title":"Update app phone number","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/organization/apps/{appId}/phone-numbers/{phoneNumberId}","href":"/api-reference/admin/put-v1organizationapps-phone-numbers"},{"title":"Remove phone number from app","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/organization/apps/{appId}/phone-numbers/{phoneNumberId}","href":"/api-reference/admin/delete-v1organizationapps-phone-numbers"}]},{"group":"Calling Configuration","expanded":false,"pages":[{"title":"Get calling configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/apps/{appId}/calling","href":"/api-reference/admin/get-v1organizationapps-calling"},{"title":"Update calling configuration","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/organization/apps/{appId}/calling","href":"/api-reference/admin/put-v1organizationapps-calling"}]},{"group":"Phone Numbers","expanded":false,"pages":[{"title":"List organization phone numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/phone-numbers","href":"/api-reference/admin/get-v1organizationphone-numbers"},{"title":"List available phone numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/phone-numbers/available","href":"/api-reference/admin/get-v1organizationphone-numbersavailable"},{"title":"Purchase phone number","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/phone-numbers/{appId}/purchase","href":"/api-reference/admin/post-v1organizationphone-numbers-purchase"},{"title":"Update phone number app assignments","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/organization/phone-numbers/{phoneNumberId}/apps","href":"/api-reference/admin/put-v1organizationphone-numbers-apps"},{"title":"Delete phone number","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/organization/phone-numbers/{phoneNumberId}","href":"/api-reference/admin/delete-v1organizationphone-numbers"}]},{"group":"SMS","expanded":false,"pages":[{"title":"List SMS messages","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/sms/messages","href":"/api-reference/admin/get-v1organizationsmsmessages"}]},{"group":"WhatsApp Messages","expanded":false,"pages":[{"title":"Get WhatsApp message","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/whatsapp/messages/{messageId}","href":"/api-reference/admin/get-v1organizationwhatsappmessages"},{"title":"Get WhatsApp message","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/whatsapp/messages/{messageId}","href":"/api-reference/admin/get-v1organizationwhatsappmessages"}]},{"group":"WhatsApp Business Profiles","expanded":false,"pages":[{"title":"Get business profile","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/whatsapp/business-profiles/{profileId}","href":"/api-reference/admin/get-v1organizationwhatsappbusiness-profiles"},{"title":"Get business profile","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/whatsapp/business-profiles/{profileId}","href":"/api-reference/admin/get-v1organizationwhatsappbusiness-profiles"},{"title":"Complete Embedded Signup","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/whatsapp/business-profiles/callback","href":"/api-reference/admin/post-v1organizationwhatsappbusiness-profilescallback"},{"title":"Start Signup Attempt","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/whatsapp/business-profiles/start-attempt","href":"/api-reference/admin/post-v1organizationwhatsappbusiness-profilesstart-attempt"},{"title":"Cancel Signup Attempt","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/whatsapp/business-profiles/cancel-attempt","href":"/api-reference/admin/post-v1organizationwhatsappbusiness-profilescancel-attempt"},{"title":"Fail Signup Attempt","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/whatsapp/business-profiles/fail-attempt","href":"/api-reference/admin/post-v1organizationwhatsappbusiness-profilesfail-attempt"},{"title":"Mark Signup Interrupted","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/whatsapp/business-profiles/mark-interrupted","href":"/api-reference/admin/post-v1organizationwhatsappbusiness-profilesmark-interrupted"},{"title":"List Recovered Signup Attempts","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/whatsapp/business-profiles/recovered-attempts","href":"/api-reference/admin/get-v1organizationwhatsappbusiness-profilesrecovered-attempts"},{"title":"Claim Recovered Signup Attempt","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/whatsapp/business-profiles/claim","href":"/api-reference/admin/post-v1organizationwhatsappbusiness-profilesclaim"},{"title":"Sync phone numbers","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/whatsapp/business-profiles/{profileId}/sync","href":"/api-reference/admin/post-v1organizationwhatsappbusiness-profiles-sync"},{"title":"Update business profile apps","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/organization/whatsapp/business-profiles/{profileId}/apps","href":"/api-reference/admin/put-v1organizationwhatsappbusiness-profiles-apps"},{"title":"Disconnect business profile","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/organization/whatsapp/business-profiles/{profileId}","href":"/api-reference/admin/delete-v1organizationwhatsappbusiness-profiles"}]},{"group":"WhatsApp Phone Numbers","expanded":false,"pages":[{"title":"List WhatsApp phone numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/whatsapp/phone-numbers","href":"/api-reference/admin/get-v1organizationwhatsappphone-numbers"},{"title":"Register WhatsApp phone number","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/whatsapp/phone-numbers","href":"/api-reference/admin/post-v1organizationwhatsappphone-numbers"},{"title":"Update WhatsApp phone number app assignments","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/organization/whatsapp/phone-numbers/{phoneNumberId}/apps","href":"/api-reference/admin/put-v1organizationwhatsappphone-numbers-apps"},{"title":"Register phone number with Meta Cloud API","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/whatsapp/phone-numbers/{phoneNumberId}/cloud-api-register","href":"/api-reference/admin/post-v1organizationwhatsappphone-numbers-cloud-api-register"},{"title":"Get business profile","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/whatsapp/phone-numbers/{phoneNumberId}/business-profile","href":"/api-reference/admin/get-v1organizationwhatsappphone-numbers-business-profile"},{"title":"Update business profile","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/organization/whatsapp/phone-numbers/{phoneNumberId}/business-profile","href":"/api-reference/admin/patch-v1organizationwhatsappphone-numbers-business-profile"},{"title":"Get phone settings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/whatsapp/phone-numbers/{phoneNumberId}/settings","href":"/api-reference/admin/get-v1organizationwhatsappphone-numbers-settings"},{"title":"Update phone settings","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/organization/whatsapp/phone-numbers/{phoneNumberId}/settings","href":"/api-reference/admin/patch-v1organizationwhatsappphone-numbers-settings"}]},{"group":"WhatsApp Templates","expanded":false,"pages":[{"title":"Get template","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/whatsapp/templates/{templateId}","href":"/api-reference/admin/get-v1organizationwhatsapptemplates"},{"title":"Create template","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/whatsapp/templates","href":"/api-reference/admin/post-v1organizationwhatsapptemplates"},{"title":"Get template","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/whatsapp/templates/{templateId}","href":"/api-reference/admin/get-v1organizationwhatsapptemplates"},{"title":"Update template","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/organization/whatsapp/templates/{templateId}","href":"/api-reference/admin/put-v1organizationwhatsapptemplates"},{"title":"Delete template","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/organization/whatsapp/templates/{templateId}","href":"/api-reference/admin/delete-v1organizationwhatsapptemplates"},{"title":"Sync templates","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/whatsapp/templates/sync","href":"/api-reference/admin/post-v1organizationwhatsapptemplatessync"},{"title":"Send template message","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/whatsapp/templates/send","href":"/api-reference/admin/post-v1organizationwhatsapptemplatessend"},{"title":"List linked apps","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/whatsapp/templates/{templateId}/apps","href":"/api-reference/admin/get-v1organizationwhatsapptemplates-apps"},{"title":"Link template to app","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/whatsapp/templates/{templateId}/apps","href":"/api-reference/admin/post-v1organizationwhatsapptemplates-apps"},{"title":"Unlink template from app","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/organization/whatsapp/templates/{templateId}/apps/{appId}","href":"/api-reference/admin/delete-v1organizationwhatsapptemplates-apps"}]},{"group":"Embedded Signup Sessions","expanded":false,"pages":[{"title":"Get embedded signup session","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/embedded-signup/sessions/{sessionId}","href":"/api-reference/admin/get-v1organizationembedded-signupsessions"},{"title":"Create embedded signup session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/embedded-signup/sessions","href":"/api-reference/admin/post-v1organizationembedded-signupsessions"},{"title":"Get embedded signup session","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/embedded-signup/sessions/{sessionId}","href":"/api-reference/admin/get-v1organizationembedded-signupsessions"},{"title":"Cancel embedded signup session","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/organization/embedded-signup/sessions/{sessionId}","href":"/api-reference/admin/delete-v1organizationembedded-signupsessions"},{"title":"Complete embedded signup session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/embedded-signup/sessions/{sessionId}/complete","href":"/api-reference/admin/post-v1organizationembedded-signupsessions-complete"}]},{"group":"Playground","expanded":false,"pages":[{"title":"List playground SMS system numbers (org)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/playground/phone-numbers/system","href":"/api-reference/admin/get-v1organizationplaygroundphone-numberssystem"},{"title":"Purchase a playground SMS system number (org)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/playground/phone-numbers/system","href":"/api-reference/admin/post-v1organizationplaygroundphone-numberssystem"},{"title":"List playground SMS user numbers (org)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/playground/phone-numbers/user","href":"/api-reference/admin/get-v1organizationplaygroundphone-numbersuser"},{"title":"Generate a playground SMS user number (org)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/playground/phone-numbers/user","href":"/api-reference/admin/post-v1organizationplaygroundphone-numbersuser"},{"title":"List playground WhatsApp system numbers (org)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/playground/whatsapp/phone-numbers/system","href":"/api-reference/admin/get-v1organizationplaygroundwhatsappphone-numberssystem"},{"title":"Purchase a playground WhatsApp system number (org)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/playground/whatsapp/phone-numbers/system","href":"/api-reference/admin/post-v1organizationplaygroundwhatsappphone-numberssystem"},{"title":"List playground WhatsApp user numbers (org)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/playground/whatsapp/phone-numbers/user","href":"/api-reference/admin/get-v1organizationplaygroundwhatsappphone-numbersuser"},{"title":"Generate a playground WhatsApp user number (org)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organization/playground/whatsapp/phone-numbers/user","href":"/api-reference/admin/post-v1organizationplaygroundwhatsappphone-numbersuser"}]},{"group":"Playground Async","expanded":false,"pages":[{"title":"Playground Async API","asyncapi":"asyncapi.json Root","href":"/api_reference/playground-async-api"}]}]},{"group":"Playground","icon":"code","asyncapi":"asyncapi.json","pages":[]}]}]},"basePath":"","title":"Send app template message - Chirp","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}