{
"success": false,
"error": {
"messageKey": "too_many_requests",
"message": "Too many requests. Limit is applied per minute per tenant. Please retry after the time indicated by the X-RateLimit-Reset header."
}
}
{
"success": false,
"error": {
"messageKey": "too_many_requests",
"message": "Too many requests. Limit is applied per minute per tenant. Please retry after the time indicated by the X-RateLimit-Reset header."
}
}
When you send a marketing message through this endpoint, you are responsible for confirming the contact is subscribed before you call it. The message will be sent even if the contact is unsubscribed. You can use the trigger automation API instead to trigger an automation where you check using a condition that the contact is subscribed.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Heyy Help Center","colors":{"primary":"#FE3265","light":"#FE3265","dark":"#FE3265"},"logo":{"light":"https://mintcdn.com/heyy-c8bd5c9e/cOuWPkt81GyZiNr6/assets/logo.svg?fit=max\u0026auto=format\u0026n=cOuWPkt81GyZiNr6\u0026q=85\u0026s=15d8f051f3dbe3cb5e5d0241b7a50372","dark":"https://mintcdn.com/heyy-c8bd5c9e/cOuWPkt81GyZiNr6/assets/logo.svg?fit=max\u0026auto=format\u0026n=cOuWPkt81GyZiNr6\u0026q=85\u0026s=15d8f051f3dbe3cb5e5d0241b7a50372","href":"https://app.heyy.io"},"favicon":"https://mintcdn.com/heyy-c8bd5c9e/yDd_iArPMYbdrfO5/favicon.svg?fit=max\u0026auto=format\u0026n=yDd_iArPMYbdrfO5\u0026q=85\u0026s=c04875889f1d50bf2447289aa0b31f4f","api":{"playground":{"display":"interactive"}},"navbar":{"links":[{"href":"https://wa.me/16504570123","label":"Contact support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.heyy.io"}},"footer":{"socials":{"instagram":"https://www.instagram.com/heyy_hq","linkedin":"https://www.linkedin.com/company/heyyio","x":"https://x.com/Heyy_hq","website":"https://app.heyy.io"}},"seo":{"indexing":"all"},"fonts":{"heading":{"family":"Satoshi","weight":700,"source":"fonts/Satoshi-Variable.woff2","format":"woff2"}},"icons":{"library":"lucide"},"integrations":{"telemetry":{"enabled":true}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"heyy-c8bd5c9e","hasAudioNarration":false,"actualSubdomain":"heyy-c8bd5c9e","customDomains":["docs.heyy.io"],"gitSource":{"type":"github","owner":"heyy-io","repo":"heyy-docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ac63f1943f8b0b9e9831153","collectionId":"42fb144c-e7fc-4b9a-8074-ef745a9f2295","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac63f1943f8b0b9e9831153"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ac63f1943f8b0b9e9831153","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Help Center","count":124},{"language":"default","tag":"API Reference","count":115},{"language":"default","tag":"HEYY API","count":101},{"language":"default","tag":"AI EMPLOYEES","count":33},{"language":"default","tag":"AUTOMATIONS","count":32},{"language":"default","tag":"Chat","count":20},{"language":"default","tag":"MANAGING YOUR INBOX","count":18},{"language":"default","tag":"Contact","count":18},{"language":"default","tag":"MESSAGING CHANNELS","count":17},{"language":"default","tag":"Triggers","count":15}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".changelog-month-header{position:relative;padding-block:40px}.changelog-month-bg{position:absolute;top:0;left:50%;width:100vw;height:100%;transform:translateX(-50%);margin-inline:0;z-index:1;background-color:rgb(var(--gray-50)/.5);mask-image:linear-gradient(0deg,#fff,rgba(255,255,255,.6));background-image:url(\"data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 32 32' width='32' height='32' fill='none' stroke='rgb(229 229 229 / 0.2)'%3e%3cpath d='M0 .5H31.5V32'/%3e%3c/svg%3e\");border-top:1px solid rgb(0 0 0/.05);border-bottom:1px solid rgb(0 0 0/.05)}.dark .changelog-month-bg{background-color:rgb(var(--gray-800)/.25);mask-image:linear-gradient(0deg,rgba(255,255,255,.3),rgba(255,255,255,.8));background-image:url(\"data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 32 32' width='32' height='32' fill='none' stroke='rgb(255 255 255 / 0.05)'%3e%3cpath d='M0 .5H31.5V32'/%3e%3c/svg%3e\");border-top:1px solid rgb(255 255 255/.05);border-bottom:1px solid rgb(255 255 255/.05)}.changelog-month-content{position:relative;z-index:2}.changelog-month-kicker{font-size:11px;letter-spacing:.14em;text-transform:uppercase;opacity:.6;margin-bottom:8px;font-weight:500}"}],"page":{"pagePath":"api-reference/send-message","slug":"/api-reference/send-message","pageMetadata":{"title":"Send message","description":"Send a message to a contact on a connected channel.","openapi":"api-reference/openapi-v3.json POST /messages/send","href":"/api-reference/send-message"},"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 message to a contact on a connected channel.\"\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Info}=_components;if(!Info)_missingMdxReference(`Info`,true);return _jsx(Info,{children:_jsxs(_components.p,{children:[`When you send a `,_jsx(_components.strong,{children:`marketing`}),` message through this endpoint, you are responsible for confirming the contact is subscribed `,_jsx(_components.strong,{children:`before`}),` you call it. The message will be sent even if the contact is unsubscribed. You can use the `,_jsx(_components.a,{href:`/api-reference/trigger-automation`,children:`trigger automation`}),` API instead to trigger an automation where you check using a condition that the contact is subscribed.`]})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Send message","description":"Send a message to a contact on a connected channel.","openapi":"api-reference/openapi-v3.json POST /messages/send","href":"/api-reference/send-message"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Send message","requestBody":"289c7046-f388-4d1e-bcb6-1f39d49e67e8","responses":{"200":"f59759fb-8768-4916-b186-8857a81d96de","400":"77c7c65e-d3d5-4227-a5a6-01706d4c2716","401":"bd66d123-f69c-4d91-a40e-9676a2b599be","402":"fd938e92-4ca7-4159-89d2-f60c6b892187","403":"92bfe400-ff53-4d97-a85b-493cd990bd5a","404":"122e281d-23d2-4d33-a824-6edd12f26864","429":"6e45f721-bfaa-48b7-b22d-cc46aa62faf0","500":"82d658ce-4b80-4a30-9492-5ea3c0d3f905"},"description":"Send a message to a contact on a connected channel.","method":"post","type":"path","servers":["d337f328-cc33-443a-9da2-88c1ad7823c9"],"security":["b75e6a32-453a-4290-9bd4-2a3bb76b1db7"],"path":"/messages/send","baseUrlOptions":["https://api.heyy.io/v3"],"title":"Send message","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"chat":{"oneOf":[{"type":"object","description":"Identifies the conversation to send to (by chat id or channel + contact/handle).","required":["chatId"],"properties":{"chatId":{"type":"string","format":"uuid","description":"Existing chat id to send the message to.","isRequired":true,"uniqueKey":"chat.oneOf.0.chatId","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"chat.oneOf.0","typeLabel":"object"},{"type":"object","description":"Identifies the conversation to send to (by chat id or channel + contact/handle).","required":["channelId","contactId"],"properties":{"channelId":{"type":"string","format":"uuid","description":"Channel to open or use for the conversation.","isRequired":true,"uniqueKey":"chat.oneOf.1.channelId","typeLabel":"string\u003cuuid>"},"contactId":{"type":"string","format":"uuid","description":"Contact to message on the given channel.","isRequired":true,"uniqueKey":"chat.oneOf.1.contactId","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"chat.oneOf.1","typeLabel":"object"},{"type":"object","description":"Identifies the conversation to send to (by chat id or channel + contact/handle).","required":["channelId","phoneNumber"],"properties":{"channelId":{"type":"string","format":"uuid","description":"Channel to open or use for the conversation.","isRequired":true,"uniqueKey":"chat.oneOf.2.channelId","typeLabel":"string\u003cuuid>"},"phoneNumber":{"type":"string","description":"Phone number to message on the given channel.","isRequired":true,"uniqueKey":"chat.oneOf.2.phoneNumber","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"chat.oneOf.2","typeLabel":"object"},{"type":"object","description":"Identifies the conversation to send to (by chat id or channel + contact/handle).","required":["channelId","email"],"properties":{"channelId":{"type":"string","format":"uuid","description":"Channel to open or use for the conversation.","isRequired":true,"uniqueKey":"chat.oneOf.3.channelId","typeLabel":"string\u003cuuid>"},"email":{"type":"string","description":"Email address to message on the given channel.","isRequired":true,"uniqueKey":"chat.oneOf.3.email","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"chat.oneOf.3","typeLabel":"object"},{"type":"object","description":"Identifies the conversation to send to (by chat id or channel + contact/handle).","required":["channelId","handleId"],"properties":{"channelId":{"type":"string","format":"uuid","description":"Channel to open or use for the conversation.","isRequired":true,"uniqueKey":"chat.oneOf.4.channelId","typeLabel":"string\u003cuuid>"},"handleId":{"type":"string","description":"Contact handle to message on the given channel.","isRequired":true,"uniqueKey":"chat.oneOf.4.handleId","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"chat.oneOf.4","typeLabel":"object"}],"isRequired":true,"uniqueKey":"chat","typeLabel":"object"},"body":{"type":"string","description":"Plain text body of the message.","uniqueKey":"body","typeLabel":"string"},"attachments":{"type":"array","items":{"oneOf":[{"type":"object","description":"Media or interactive attachments to send with the message.","required":["type","fileId"],"properties":{"type":{"type":"string","enum":["image"],"description":"Attachment or content type discriminator.","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"fileId":{"type":"string","format":"uuid","description":"File id from [Upload file](/api-reference/openapi-v3.json%20POST%20/files).","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.0.fileId","typeLabel":"string\u003cuuid>"},"id":{"type":"string","format":"uuid","description":"Message id.","uniqueKey":"attachments.items.[INDEX].oneOf.0.id","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"uniqueKey":"attachments.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"Media or interactive attachments to send with the message.","required":["type","fileId"],"properties":{"type":{"type":"string","enum":["video"],"description":"Attachment or content type discriminator.","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"fileId":{"type":"string","format":"uuid","description":"File id from [Upload file](/api-reference/openapi-v3.json%20POST%20/files).","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.1.fileId","typeLabel":"string\u003cuuid>"},"id":{"type":"string","format":"uuid","description":"Message id.","uniqueKey":"attachments.items.[INDEX].oneOf.1.id","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"uniqueKey":"attachments.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"Media or interactive attachments to send with the message.","required":["type","fileId"],"properties":{"type":{"type":"string","enum":["document"],"description":"Attachment or content type discriminator.","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"fileId":{"type":"string","format":"uuid","description":"File id from [Upload file](/api-reference/openapi-v3.json%20POST%20/files).","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.2.fileId","typeLabel":"string\u003cuuid>"},"id":{"type":"string","format":"uuid","description":"Message id.","uniqueKey":"attachments.items.[INDEX].oneOf.2.id","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"uniqueKey":"attachments.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"Media or interactive attachments to send with the message.","required":["type","fileId"],"properties":{"type":{"type":"string","enum":["audio"],"description":"Attachment or content type discriminator.","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"fileId":{"type":"string","format":"uuid","description":"File id from [Upload file](/api-reference/openapi-v3.json%20POST%20/files).","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.3.fileId","typeLabel":"string\u003cuuid>"},"id":{"type":"string","format":"uuid","description":"Message id.","uniqueKey":"attachments.items.[INDEX].oneOf.3.id","typeLabel":"string\u003cuuid>"},"isVoice":{"type":"boolean","description":"Whether the audio attachment is a voice note.","uniqueKey":"attachments.items.[INDEX].oneOf.3.isVoice","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"attachments.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","description":"Media or interactive attachments to send with the message.","required":["type","buttonType","text"],"properties":{"type":{"type":"string","enum":["button"],"description":"Attachment or content type discriminator.","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"buttonType":{"type":"string","enum":["quick_reply","url","phone_number","list_title"],"description":"Interactive button type.","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.4.buttonType","typeLabel":"enum\u003cstring>"},"text":{"oneOf":[{"type":"string","description":"Text content.","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.4.text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Text content.","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.4.text.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.4.text","typeLabel":"string | null"},"id":{"type":"string","format":"uuid","description":"Message id.","uniqueKey":"attachments.items.[INDEX].oneOf.4.id","typeLabel":"string\u003cuuid>"},"data":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["phone_number","static_url","dynamic_url"],"description":"Attachment or content type discriminator.","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.4.data.oneOf.0.type","typeLabel":"enum\u003cstring>"},"phoneNumber":{"type":"string","description":"Phone number to message on the given channel.","uniqueKey":"attachments.items.[INDEX].oneOf.4.data.oneOf.0.phoneNumber","typeLabel":"string"},"url":{"type":"string","description":"URL.","uniqueKey":"attachments.items.[INDEX].oneOf.4.data.oneOf.0.url","typeLabel":"string"},"urlExtension":{"type":"string","description":"Dynamic URL suffix for button templates.","uniqueKey":"attachments.items.[INDEX].oneOf.4.data.oneOf.0.urlExtension","typeLabel":"string"}},"required":["type"],"description":"Message data object.","uniqueKey":"attachments.items.[INDEX].oneOf.4.data.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"type":{"type":"string","enum":["phone_number","static_url","dynamic_url"],"description":"Attachment or content type discriminator."},"phoneNumber":{"type":"string","description":"Phone number to message on the given channel."},"url":{"type":"string","description":"URL."},"urlExtension":{"type":"string","description":"Dynamic URL suffix for button templates."}},"required":["type"],"description":"Message data object.","uniqueKey":"attachments.items.[INDEX].oneOf.4.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"attachments.items.[INDEX].oneOf.4.data","typeLabel":"object | null"},"payload":{"oneOf":[{"type":"string","description":"Opaque payload (for example button response data).","uniqueKey":"attachments.items.[INDEX].oneOf.4.payload.oneOf.0","typeLabel":"string"},{"type":"null","description":"Opaque payload (for example button response data).","uniqueKey":"attachments.items.[INDEX].oneOf.4.payload.oneOf.1","typeLabel":"null"}],"uniqueKey":"attachments.items.[INDEX].oneOf.4.payload","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"attachments.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","description":"Media or interactive attachments to send with the message.","required":["type","title","rows"],"properties":{"type":{"type":"string","enum":["list_section"],"description":"Attachment or content type discriminator.","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"title":{"oneOf":[{"type":"string","description":"Title text.","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.5.title.oneOf.0","typeLabel":"string"},{"type":"null","description":"Title text.","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.5.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.5.title","typeLabel":"string | null"},"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Message id.","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.5.rows.items.[INDEX].id","typeLabel":"string"},"title":{"type":"string","description":"Title text.","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.5.rows.items.[INDEX].title","typeLabel":"string"}},"required":["id","title","description"],"description":"List section rows for interactive messages.","uniqueKey":"attachments.items.[INDEX].oneOf.5.rows.items.[INDEX]","typeLabel":"object"},"description":"List section rows for interactive messages.","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.5.rows","typeLabel":"object[]"},"id":{"type":"string","format":"uuid","description":"Message id.","uniqueKey":"attachments.items.[INDEX].oneOf.5.id","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"uniqueKey":"attachments.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","description":"Media or interactive attachments to send with the message.","required":["type","text","payload"],"properties":{"type":{"type":"string","enum":["quick_reply"],"description":"Attachment or content type discriminator.","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"Text content.","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.6.text","typeLabel":"string"},"payload":{"type":"string","description":"Opaque payload (for example button response data).","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.6.payload","typeLabel":"string"},"id":{"type":"string","format":"uuid","description":"Message id.","uniqueKey":"attachments.items.[INDEX].oneOf.6.id","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"uniqueKey":"attachments.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","description":"Media or interactive attachments to send with the message.","required":["type"],"properties":{"type":{"type":"string","enum":["contact"],"description":"Attachment or content type discriminator.","isRequired":true,"uniqueKey":"attachments.items.[INDEX].oneOf.7.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","description":"Message id.","uniqueKey":"attachments.items.[INDEX].oneOf.7.id","typeLabel":"string\u003cuuid>"},"addresses":{"type":"array","items":{"type":"object","properties":{"street":{"type":"string","description":"Street line.","uniqueKey":"attachments.items.[INDEX].oneOf.7.addresses.items.[INDEX].street","typeLabel":"string"},"city":{"type":"string","description":"City.","uniqueKey":"attachments.items.[INDEX].oneOf.7.addresses.items.[INDEX].city","typeLabel":"string"},"state":{"type":"string","description":"State or region.","uniqueKey":"attachments.items.[INDEX].oneOf.7.addresses.items.[INDEX].state","typeLabel":"string"},"zip":{"type":"string","description":"Postal or ZIP code.","uniqueKey":"attachments.items.[INDEX].oneOf.7.addresses.items.[INDEX].zip","typeLabel":"string"},"country":{"type":"string","description":"Country name.","uniqueKey":"attachments.items.[INDEX].oneOf.7.addresses.items.[INDEX].country","typeLabel":"string"},"countryCode":{"type":"string","description":"ISO country calling code.","uniqueKey":"attachments.items.[INDEX].oneOf.7.addresses.items.[INDEX].countryCode","typeLabel":"string"},"type":{"type":"string","description":"Attachment or content type discriminator.","uniqueKey":"attachments.items.[INDEX].oneOf.7.addresses.items.[INDEX].type","typeLabel":"string"}},"description":"Addresses on a shared contact card.","uniqueKey":"attachments.items.[INDEX].oneOf.7.addresses.items.[INDEX]","typeLabel":"object"},"description":"Addresses on a shared contact card.","uniqueKey":"attachments.items.[INDEX].oneOf.7.addresses","typeLabel":"object[]"},"birthday":{"type":"string","description":"Birthday (`YYYY-MM-DD`).","uniqueKey":"attachments.items.[INDEX].oneOf.7.birthday","typeLabel":"string"},"emails":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","description":"Email address to message on the given channel.","uniqueKey":"attachments.items.[INDEX].oneOf.7.emails.items.[INDEX].email","typeLabel":"string"},"type":{"type":"string","description":"Attachment or content type discriminator.","uniqueKey":"attachments.items.[INDEX].oneOf.7.emails.items.[INDEX].type","typeLabel":"string"}},"description":"Email addresses on a shared contact card.","uniqueKey":"attachments.items.[INDEX].oneOf.7.emails.items.[INDEX]","typeLabel":"object"},"description":"Email addresses on a shared contact card.","uniqueKey":"attachments.items.[INDEX].oneOf.7.emails","typeLabel":"object[]"},"name":{"type":"object","properties":{"formattedName":{"type":"string","description":"Formatted name on a shared contact card.","uniqueKey":"attachments.items.[INDEX].oneOf.7.name.formattedName","typeLabel":"string"},"firstName":{"type":"string","description":"Message first name.","uniqueKey":"attachments.items.[INDEX].oneOf.7.name.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Message last name.","uniqueKey":"attachments.items.[INDEX].oneOf.7.name.lastName","typeLabel":"string"},"middleName":{"type":"string","description":"Middle name.","uniqueKey":"attachments.items.[INDEX].oneOf.7.name.middleName","typeLabel":"string"},"suffix":{"type":"string","description":"Name suffix.","uniqueKey":"attachments.items.[INDEX].oneOf.7.name.suffix","typeLabel":"string"},"prefix":{"type":"string","description":"Name prefix.","uniqueKey":"attachments.items.[INDEX].oneOf.7.name.prefix","typeLabel":"string"}},"description":"Message name object.","uniqueKey":"attachments.items.[INDEX].oneOf.7.name","typeLabel":"object"},"org":{"type":"object","properties":{"company":{"type":"string","description":"Company name.","uniqueKey":"attachments.items.[INDEX].oneOf.7.org.company","typeLabel":"string"},"department":{"type":"string","description":"Department name.","uniqueKey":"attachments.items.[INDEX].oneOf.7.org.department","typeLabel":"string"},"title":{"type":"string","description":"Title text.","uniqueKey":"attachments.items.[INDEX].oneOf.7.org.title","typeLabel":"string"}},"description":"Organization block on a shared contact card.","uniqueKey":"attachments.items.[INDEX].oneOf.7.org","typeLabel":"object"},"phones":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","description":"Message phone.","uniqueKey":"attachments.items.[INDEX].oneOf.7.phones.items.[INDEX].phone","typeLabel":"string"},"type":{"type":"string","description":"Attachment or content type discriminator.","uniqueKey":"attachments.items.[INDEX].oneOf.7.phones.items.[INDEX].type","typeLabel":"string"}},"description":"Phone numbers on a shared contact card.","uniqueKey":"attachments.items.[INDEX].oneOf.7.phones.items.[INDEX]","typeLabel":"object"},"description":"Phone numbers on a shared contact card.","uniqueKey":"attachments.items.[INDEX].oneOf.7.phones","typeLabel":"object[]"},"urls":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"URL.","uniqueKey":"attachments.items.[INDEX].oneOf.7.urls.items.[INDEX].url","typeLabel":"string"},"type":{"type":"string","description":"Attachment or content type discriminator.","uniqueKey":"attachments.items.[INDEX].oneOf.7.urls.items.[INDEX].type","typeLabel":"string"}},"description":"URLs on a shared contact card.","uniqueKey":"attachments.items.[INDEX].oneOf.7.urls.items.[INDEX]","typeLabel":"object"},"description":"URLs on a shared contact card.","uniqueKey":"attachments.items.[INDEX].oneOf.7.urls","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"attachments.items.[INDEX].oneOf.7","typeLabel":"object"}],"uniqueKey":"attachments.items.[INDEX]","typeLabel":"object"},"description":"Media or interactive attachments to send with the message.","uniqueKey":"attachments","typeLabel":"object[]"},"header":{"type":"string","description":"Header text.","uniqueKey":"header","typeLabel":"string"},"footer":{"type":"string","description":"Footer text.","uniqueKey":"footer","typeLabel":"string"},"replyToMessageId":{"type":"string","format":"uuid","description":"Message id to reply to.","uniqueKey":"replyToMessageId","typeLabel":"string\u003cuuid>"},"scheduledAt":{"type":"string","format":"date-time","description":"Schedule the message for a future time (ISO 8601).","uniqueKey":"scheduledAt","typeLabel":"string\u003cdate-time>"}},"required":["chat"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"chat":{"chatId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"body":"\u003cstring>","attachments":[{"type":"image","fileId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}],"header":"\u003cstring>","footer":"\u003cstring>","replyToMessageId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","scheduledAt":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"f59759fb-8768-4916-b186-8857a81d96de":{"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"data":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.updatedAt","typeLabel":"string\u003cdate-time>"},"chatId":{"type":"string","isRequired":true,"uniqueKey":"data.chatId","typeLabel":"string"},"channelId":{"type":"string","isRequired":true,"uniqueKey":"data.channelId","typeLabel":"string"},"type":{"type":"string","enum":["message","note","chat_open","chat_close","chat_snoozed","chat_assigned","vendor_comment","ai_tool_call","ai_exit_route","summary"],"isRequired":true,"uniqueKey":"data.type","typeLabel":"enum\u003cstring>"},"sender":{"type":"string","enum":["outbound","inbound","unknown","system"],"isRequired":true,"uniqueKey":"data.sender","typeLabel":"enum\u003cstring>"},"sources":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","campaignExecutionId"],"properties":{"type":{"type":"string","enum":["campaign"],"isRequired":true,"uniqueKey":"data.sources.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"campaignExecutionId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.sources.items.[INDEX].oneOf.0.campaignExecutionId","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"uniqueKey":"data.sources.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["type","journeyId","journeyExecutionId"],"properties":{"type":{"type":"string","enum":["journey"],"isRequired":true,"uniqueKey":"data.sources.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"journeyId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.sources.items.[INDEX].oneOf.1.journeyId","typeLabel":"string\u003cuuid>"},"journeyExecutionId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.sources.items.[INDEX].oneOf.1.journeyExecutionId","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"uniqueKey":"data.sources.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["type","automationActionExecutionId"],"properties":{"type":{"type":"string","enum":["automation"],"isRequired":true,"uniqueKey":"data.sources.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"automationActionExecutionId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.sources.items.[INDEX].oneOf.2.automationActionExecutionId","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"uniqueKey":"data.sources.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["type","userId"],"properties":{"type":{"type":"string","enum":["inbox"],"isRequired":true,"uniqueKey":"data.sources.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"userId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.sources.items.[INDEX].oneOf.3.userId","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"uniqueKey":"data.sources.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["vendor"],"isRequired":true,"uniqueKey":"data.sources.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"data.sources.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["type","apiKeyId"],"properties":{"type":{"type":"string","enum":["api"],"isRequired":true,"uniqueKey":"data.sources.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"apiKeyId":{"type":"string","isRequired":true,"uniqueKey":"data.sources.items.[INDEX].oneOf.5.apiKeyId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"data.sources.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","required":["type","aiAgentId"],"properties":{"type":{"type":"string","enum":["ai_agent"],"isRequired":true,"uniqueKey":"data.sources.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"aiAgentId":{"type":"string","isRequired":true,"uniqueKey":"data.sources.items.[INDEX].oneOf.6.aiAgentId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"data.sources.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["system"],"isRequired":true,"uniqueKey":"data.sources.items.[INDEX].oneOf.7.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"data.sources.items.[INDEX].oneOf.7","typeLabel":"object"}],"uniqueKey":"data.sources.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.sources","typeLabel":"object[]"},"status":{"type":"string","enum":["none","pending","sent","delivered","read","scheduled","deleted","failed"],"isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"scheduledAt":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.scheduledAt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.scheduledAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.scheduledAt","typeLabel":"string | null"},"content":{"type":"object","properties":{"body":{"oneOf":[{"type":"string","uniqueKey":"data.content.body.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.content.body.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.content.body","typeLabel":"string | null"},"attachments":{"type":"array","items":{"oneOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.0.id","typeLabel":"string"},"type":{"type":"string","enum":["image"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"file":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.0.file.oneOf.0.id","typeLabel":"string"},"createdAt":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.0.file.oneOf.0.createdAt","typeLabel":"string"},"type":{"type":"string","enum":["image","video","audio","document"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.0.file.oneOf.0.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.0.file.oneOf.0.name","typeLabel":"string"},"contentType":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.0.file.oneOf.0.contentType","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.0.file.oneOf.0.url","typeLabel":"string"},"size":{"type":"number","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.0.file.oneOf.0.size","typeLabel":"number"}},"required":["id","createdAt","type","name","contentType","url","size"],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.0.file.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"type":{"type":"string","enum":["image","video","audio","document"]},"name":{"type":"string"},"contentType":{"type":"string"},"url":{"type":"string"},"size":{"type":"number"}},"required":["id","createdAt","type","name","contentType","url","size"],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.0.file.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.0.file","typeLabel":"object | null"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.1.id","typeLabel":"string"},"type":{"type":"string","enum":["video"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"file":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.1.file.oneOf.0.id","typeLabel":"string"},"createdAt":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.1.file.oneOf.0.createdAt","typeLabel":"string"},"type":{"type":"string","enum":["image","video","audio","document"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.1.file.oneOf.0.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.1.file.oneOf.0.name","typeLabel":"string"},"contentType":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.1.file.oneOf.0.contentType","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.1.file.oneOf.0.url","typeLabel":"string"},"size":{"type":"number","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.1.file.oneOf.0.size","typeLabel":"number"}},"required":["id","createdAt","type","name","contentType","url","size"],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.1.file.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"type":{"type":"string","enum":["image","video","audio","document"]},"name":{"type":"string"},"contentType":{"type":"string"},"url":{"type":"string"},"size":{"type":"number"}},"required":["id","createdAt","type","name","contentType","url","size"],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.1.file.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.1.file","typeLabel":"object | null"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.2.id","typeLabel":"string"},"type":{"type":"string","enum":["document"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"file":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.2.file.oneOf.0.id","typeLabel":"string"},"createdAt":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.2.file.oneOf.0.createdAt","typeLabel":"string"},"type":{"type":"string","enum":["image","video","audio","document"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.2.file.oneOf.0.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.2.file.oneOf.0.name","typeLabel":"string"},"contentType":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.2.file.oneOf.0.contentType","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.2.file.oneOf.0.url","typeLabel":"string"},"size":{"type":"number","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.2.file.oneOf.0.size","typeLabel":"number"}},"required":["id","createdAt","type","name","contentType","url","size"],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.2.file.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"type":{"type":"string","enum":["image","video","audio","document"]},"name":{"type":"string"},"contentType":{"type":"string"},"url":{"type":"string"},"size":{"type":"number"}},"required":["id","createdAt","type","name","contentType","url","size"],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.2.file.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.2.file","typeLabel":"object | null"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.3.id","typeLabel":"string"},"type":{"type":"string","enum":["audio"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"file":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.3.file.oneOf.0.id","typeLabel":"string"},"createdAt":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.3.file.oneOf.0.createdAt","typeLabel":"string"},"type":{"type":"string","enum":["image","video","audio","document"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.3.file.oneOf.0.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.3.file.oneOf.0.name","typeLabel":"string"},"contentType":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.3.file.oneOf.0.contentType","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.3.file.oneOf.0.url","typeLabel":"string"},"size":{"type":"number","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.3.file.oneOf.0.size","typeLabel":"number"}},"required":["id","createdAt","type","name","contentType","url","size"],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.3.file.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"type":{"type":"string","enum":["image","video","audio","document"]},"name":{"type":"string"},"contentType":{"type":"string"},"url":{"type":"string"},"size":{"type":"number"}},"required":["id","createdAt","type","name","contentType","url","size"],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.3.file.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.3.file","typeLabel":"object | null"},"isVoice":{"type":"boolean","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.3.isVoice","typeLabel":"boolean"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.4.id","typeLabel":"string"},"type":{"type":"string","enum":["location"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"latitude":{"oneOf":[{"type":"number","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.4.latitude.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.4.latitude.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.4.latitude","typeLabel":"number | null"},"longitude":{"oneOf":[{"type":"number","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.4.longitude.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.4.longitude.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.4.longitude","typeLabel":"number | null"},"name":{"oneOf":[{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.4.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.4.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.4.name","typeLabel":"string | null"},"address":{"oneOf":[{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.4.address.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.4.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.4.address","typeLabel":"string | null"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.id","typeLabel":"string"},"type":{"type":"string","enum":["contact"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"addresses":{"type":"array","items":{"type":"object","properties":{"street":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.addresses.items.[INDEX].street","typeLabel":"string"},"city":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.addresses.items.[INDEX].city","typeLabel":"string"},"state":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.addresses.items.[INDEX].state","typeLabel":"string"},"zip":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.addresses.items.[INDEX].zip","typeLabel":"string"},"country":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.addresses.items.[INDEX].country","typeLabel":"string"},"countryCode":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.addresses.items.[INDEX].countryCode","typeLabel":"string"},"type":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.addresses.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.addresses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.addresses","typeLabel":"object[]"},"birthday":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.birthday","typeLabel":"string"},"emails":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.emails.items.[INDEX].email","typeLabel":"string"},"type":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.emails.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.emails.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.emails","typeLabel":"object[]"},"name":{"type":"object","properties":{"formattedName":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.name.formattedName","typeLabel":"string"},"firstName":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.name.firstName","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.name.lastName","typeLabel":"string"},"middleName":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.name.middleName","typeLabel":"string"},"suffix":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.name.suffix","typeLabel":"string"},"prefix":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.name.prefix","typeLabel":"string"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.name","typeLabel":"object"},"org":{"type":"object","properties":{"company":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.org.company","typeLabel":"string"},"department":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.org.department","typeLabel":"string"},"title":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.org.title","typeLabel":"string"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.org","typeLabel":"object"},"phones":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.phones.items.[INDEX].phone","typeLabel":"string"},"type":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.phones.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.phones.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.phones","typeLabel":"object[]"},"urls":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.urls.items.[INDEX].url","typeLabel":"string"},"type":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.urls.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.urls.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5.urls","typeLabel":"object[]"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","required":["id","type","buttonType","text"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.6.id","typeLabel":"string"},"type":{"type":"string","enum":["button"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"buttonType":{"type":"string","enum":["quick_reply","url","phone_number","list_title"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.6.buttonType","typeLabel":"enum\u003cstring>"},"text":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.6.text.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.6.text.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.6.text","typeLabel":"string | null"},"data":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["phone_number","static_url","dynamic_url"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.6.data.oneOf.0.type","typeLabel":"enum\u003cstring>"},"phoneNumber":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.6.data.oneOf.0.phoneNumber","typeLabel":"string"},"url":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.6.data.oneOf.0.url","typeLabel":"string"},"urlExtension":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.6.data.oneOf.0.urlExtension","typeLabel":"string"}},"required":["type"],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.6.data.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"type":{"type":"string","enum":["phone_number","static_url","dynamic_url"]},"phoneNumber":{"type":"string"},"url":{"type":"string"},"urlExtension":{"type":"string"}},"required":["type"],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.6.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.6.data","typeLabel":"object | null"},"payload":{"oneOf":[{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.6.payload.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.6.payload.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.6.payload","typeLabel":"string | null"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","required":["id","type","title","rows"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.7.id","typeLabel":"string"},"type":{"type":"string","enum":["list_section"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.7.type","typeLabel":"enum\u003cstring>"},"title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.7.title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.7.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.7.title","typeLabel":"string | null"},"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.7.rows.items.[INDEX].id","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.7.rows.items.[INDEX].title","typeLabel":"string"}},"required":["id","title","description"],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.7.rows.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.7.rows","typeLabel":"object[]"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.7","typeLabel":"object"},{"type":"object","required":["id","type","text","payload"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.8.id","typeLabel":"string"},"type":{"type":"string","enum":["quick_reply"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.8.type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.8.text","typeLabel":"string"},"payload":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.8.payload","typeLabel":"string"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.8","typeLabel":"object"},{"type":"object","required":["id","type","text"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9.id","typeLabel":"string"},"type":{"type":"string","enum":["comment"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9.type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9.text","typeLabel":"string"},"commentId":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9.commentId","typeLabel":"string"},"mediaId":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9.mediaId","typeLabel":"string"},"file":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9.file.oneOf.0.id","typeLabel":"string"},"createdAt":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9.file.oneOf.0.createdAt","typeLabel":"string"},"type":{"type":"string","enum":["image","video","audio","document"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9.file.oneOf.0.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9.file.oneOf.0.name","typeLabel":"string"},"contentType":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9.file.oneOf.0.contentType","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9.file.oneOf.0.url","typeLabel":"string"},"size":{"type":"number","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9.file.oneOf.0.size","typeLabel":"number"}},"required":["id","createdAt","type","name","contentType","url","size"],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9.file.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"type":{"type":"string","enum":["image","video","audio","document"]},"name":{"type":"string"},"contentType":{"type":"string"},"url":{"type":"string"},"size":{"type":"number"}},"required":["id","createdAt","type","name","contentType","url","size"],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9.file.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9.file","typeLabel":"object | null"},"mediaUrl":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9.mediaUrl","typeLabel":"string"},"mediaType":{"type":"string","enum":["IMAGE","VIDEO","CAROUSEL_ALBUM"],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9.mediaType","typeLabel":"enum\u003cstring>"},"mediaProductType":{"type":"string","enum":["FEED","REELS","STORY"],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9.mediaProductType","typeLabel":"enum\u003cstring>"},"platform":{"type":"string","enum":["instagram","facebook"],"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9.platform","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.9","typeLabel":"object"},{"type":"object","required":["id","type","toolCallId","toolName","input","output"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.10.id","typeLabel":"string"},"type":{"type":"string","enum":["ai_tool_call"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.10.type","typeLabel":"enum\u003cstring>"},"toolCallId":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.10.toolCallId","typeLabel":"string"},"toolName":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.10.toolName","typeLabel":"string"},"input":{"oneOf":[{"isRequired":true}],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.10.input","typeLabel":"any"},"output":{"oneOf":[{"isRequired":true}],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.10.output","typeLabel":"any"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.10","typeLabel":"object"},{"type":"object","required":["id","type","source"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.11.id","typeLabel":"string"},"type":{"type":"string","enum":["referral"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.11.type","typeLabel":"enum\u003cstring>"},"source":{"type":"string","enum":["whatsapp"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.11.source","typeLabel":"enum\u003cstring>"},"sourceUrl":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.11.sourceUrl","typeLabel":"string"},"sourceType":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.11.sourceType","typeLabel":"string"},"sourceId":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.11.sourceId","typeLabel":"string"},"headline":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.11.headline","typeLabel":"string"},"body":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.11.body","typeLabel":"string"},"mediaType":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.11.mediaType","typeLabel":"string"},"imageUrl":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.11.imageUrl","typeLabel":"string"},"videoUrl":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.11.videoUrl","typeLabel":"string"},"thumbnailUrl":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.11.thumbnailUrl","typeLabel":"string"},"ctwaClid":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.11.ctwaClid","typeLabel":"string"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.11","typeLabel":"object"},{"type":"object","required":["id","type","contentType","url"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.12.id","typeLabel":"string"},"type":{"type":"string","enum":["content_reference"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.12.type","typeLabel":"enum\u003cstring>"},"contentType":{"type":"string","enum":["story"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.12.contentType","typeLabel":"enum\u003cstring>"},"url":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.12.url","typeLabel":"string"},"externalId":{"type":"string","uniqueKey":"data.content.attachments.items.[INDEX].oneOf.12.externalId","typeLabel":"string"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.12","typeLabel":"object"},{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.13.id","typeLabel":"string"},"type":{"type":"string","enum":["auth"],"isRequired":true,"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.13.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.content.attachments.items.[INDEX].oneOf.13","typeLabel":"object"}],"uniqueKey":"data.content.attachments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.content.attachments","typeLabel":"object[]"},"header":{"oneOf":[{"type":"string","uniqueKey":"data.content.header.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.content.header.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.content.header","typeLabel":"string | null"},"footer":{"oneOf":[{"type":"string","uniqueKey":"data.content.footer.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.content.footer.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.content.footer","typeLabel":"string | null"},"payload":{"type":"string","uniqueKey":"data.content.payload","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.content","typeLabel":"object"},"forwarded":{"type":"boolean","isRequired":true,"uniqueKey":"data.forwarded","typeLabel":"boolean"},"reactions":{"type":"array","items":{"type":"object","properties":{"sender":{"type":"string","enum":["outbound","inbound","unknown","system"],"isRequired":true,"uniqueKey":"data.reactions.items.[INDEX].sender","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"data.reactions.items.[INDEX].text","typeLabel":"string"},"timestamp":{"type":"string","isRequired":true,"uniqueKey":"data.reactions.items.[INDEX].timestamp","typeLabel":"string"},"userId":{"type":"string","uniqueKey":"data.reactions.items.[INDEX].userId","typeLabel":"string"}},"required":["sender","text","timestamp"],"uniqueKey":"data.reactions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.reactions","typeLabel":"object[]"},"errors":{"type":"array","items":{"type":"object","properties":{"messageKey":{"type":"string","isRequired":true,"uniqueKey":"data.errors.items.[INDEX].messageKey","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"data.errors.items.[INDEX].message","typeLabel":"string"},"vendorError":{"type":"object","properties":{"code":{"oneOf":[{"type":"number","uniqueKey":"data.errors.items.[INDEX].vendorError.code.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"data.errors.items.[INDEX].vendorError.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.errors.items.[INDEX].vendorError.code","typeLabel":"number | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"data.errors.items.[INDEX].vendorError.title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.errors.items.[INDEX].vendorError.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.errors.items.[INDEX].vendorError.title","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","uniqueKey":"data.errors.items.[INDEX].vendorError.type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.errors.items.[INDEX].vendorError.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.errors.items.[INDEX].vendorError.type","typeLabel":"string | null"},"message":{"oneOf":[{"type":"string","uniqueKey":"data.errors.items.[INDEX].vendorError.message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.errors.items.[INDEX].vendorError.message.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.errors.items.[INDEX].vendorError.message","typeLabel":"string | null"},"errorData":{"type":"object","properties":{"messagingProduct":{"type":"string","uniqueKey":"data.errors.items.[INDEX].vendorError.errorData.messagingProduct","typeLabel":"string"},"details":{"type":"string","uniqueKey":"data.errors.items.[INDEX].vendorError.errorData.details","typeLabel":"string"}},"uniqueKey":"data.errors.items.[INDEX].vendorError.errorData","typeLabel":"object"},"fbtraceId":{"oneOf":[{"type":"string","uniqueKey":"data.errors.items.[INDEX].vendorError.fbtraceId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.errors.items.[INDEX].vendorError.fbtraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.errors.items.[INDEX].vendorError.fbtraceId","typeLabel":"string | null"}},"uniqueKey":"data.errors.items.[INDEX].vendorError","typeLabel":"object"}},"required":["messageKey","message"],"uniqueKey":"data.errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.errors","typeLabel":"object[]"},"history":{"type":"array","items":{"type":"object","properties":{"event":{"type":"string","enum":["status_update"],"isRequired":true,"uniqueKey":"data.history.items.[INDEX].event","typeLabel":"enum\u003cstring>"},"newStatus":{"type":"string","enum":["none","pending","sent","delivered","read","scheduled","deleted","failed"],"isRequired":true,"uniqueKey":"data.history.items.[INDEX].newStatus","typeLabel":"enum\u003cstring>"},"timestamp":{"type":"string","isRequired":true,"uniqueKey":"data.history.items.[INDEX].timestamp","typeLabel":"string"}},"required":["event","newStatus","timestamp"],"uniqueKey":"data.history.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.history","typeLabel":"object[]"},"vendorId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.vendorId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.vendorId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.vendorId","typeLabel":"string | null"},"timestamp":{"type":"string","isRequired":true,"uniqueKey":"data.timestamp","typeLabel":"string"},"vendorDetails":{"oneOf":[{"type":"object","properties":{"whatsapp":{"type":"object","properties":{"context":{"type":"object","properties":{"frequentlyForwarded":{"type":"boolean","isRequired":true,"uniqueKey":"data.vendorDetails.oneOf.0.whatsapp.context.frequentlyForwarded","typeLabel":"boolean"},"referredProduct":{"type":"object","properties":{"catalogId":{"type":"string","isRequired":true,"uniqueKey":"data.vendorDetails.oneOf.0.whatsapp.context.referredProduct.catalogId","typeLabel":"string"},"productRetailerId":{"type":"string","isRequired":true,"uniqueKey":"data.vendorDetails.oneOf.0.whatsapp.context.referredProduct.productRetailerId","typeLabel":"string"}},"required":["catalogId","productRetailerId"],"uniqueKey":"data.vendorDetails.oneOf.0.whatsapp.context.referredProduct","typeLabel":"object"}},"required":["frequentlyForwarded"],"uniqueKey":"data.vendorDetails.oneOf.0.whatsapp.context","typeLabel":"object"},"order":{"type":"object","properties":{"catalogId":{"oneOf":[{"type":"string","uniqueKey":"data.vendorDetails.oneOf.0.whatsapp.order.catalogId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.vendorDetails.oneOf.0.whatsapp.order.catalogId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.vendorDetails.oneOf.0.whatsapp.order.catalogId","typeLabel":"string | null"},"productItems":{"type":"array","items":{"type":"object","properties":{"productRetailerId":{"type":"string","isRequired":true,"uniqueKey":"data.vendorDetails.oneOf.0.whatsapp.order.productItems.items.[INDEX].productRetailerId","typeLabel":"string"},"quantity":{"type":"string","isRequired":true,"uniqueKey":"data.vendorDetails.oneOf.0.whatsapp.order.productItems.items.[INDEX].quantity","typeLabel":"string"},"itemPrice":{"type":"string","isRequired":true,"uniqueKey":"data.vendorDetails.oneOf.0.whatsapp.order.productItems.items.[INDEX].itemPrice","typeLabel":"string"},"currency":{"type":"string","isRequired":true,"uniqueKey":"data.vendorDetails.oneOf.0.whatsapp.order.productItems.items.[INDEX].currency","typeLabel":"string"}},"required":["productRetailerId","quantity","itemPrice","currency"],"uniqueKey":"data.vendorDetails.oneOf.0.whatsapp.order.productItems.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.vendorDetails.oneOf.0.whatsapp.order.productItems","typeLabel":"object[]"}},"uniqueKey":"data.vendorDetails.oneOf.0.whatsapp.order","typeLabel":"object"}},"uniqueKey":"data.vendorDetails.oneOf.0.whatsapp","typeLabel":"object"},"instagram":{"type":"object","properties":{"commentId":{"type":"string","uniqueKey":"data.vendorDetails.oneOf.0.instagram.commentId","typeLabel":"string"}},"uniqueKey":"data.vendorDetails.oneOf.0.instagram","typeLabel":"object"},"messenger":{"type":"object","properties":{"commentId":{"type":"string","uniqueKey":"data.vendorDetails.oneOf.0.messenger.commentId","typeLabel":"string"}},"uniqueKey":"data.vendorDetails.oneOf.0.messenger","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.vendorDetails.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"whatsapp":{"type":"object","properties":{"context":{"type":"object","properties":{"frequentlyForwarded":{"type":"boolean"},"referredProduct":{"type":"object","properties":{"catalogId":{"type":"string"},"productRetailerId":{"type":"string"}},"required":["catalogId","productRetailerId"]}},"required":["frequentlyForwarded"]},"order":{"type":"object","properties":{"catalogId":{"oneOf":[{"type":"string"},{"type":"null"}]},"productItems":{"type":"array","items":{"type":"object","properties":{"productRetailerId":{"type":"string"},"quantity":{"type":"string"},"itemPrice":{"type":"string"},"currency":{"type":"string"}},"required":["productRetailerId","quantity","itemPrice","currency"]}}}}}},"instagram":{"type":"object","properties":{"commentId":{"type":"string"}}},"messenger":{"type":"object","properties":{"commentId":{"type":"string"}}}},"isRequired":true,"uniqueKey":"data.vendorDetails.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.vendorDetails","typeLabel":"object | null"},"metadata":{"oneOf":[{"type":"object","properties":{"campaignContactId":{"type":"string","uniqueKey":"data.metadata.oneOf.0.campaignContactId","typeLabel":"string"},"campaignExecutionId":{"type":"string","uniqueKey":"data.metadata.oneOf.0.campaignExecutionId","typeLabel":"string"},"assignment":{"type":"object","properties":{"userId":{"oneOf":[{"type":"string","uniqueKey":"data.metadata.oneOf.0.assignment.userId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.metadata.oneOf.0.assignment.userId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.assignment.userId","typeLabel":"string | null"},"teamId":{"oneOf":[{"type":"string","uniqueKey":"data.metadata.oneOf.0.assignment.teamId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.metadata.oneOf.0.assignment.teamId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.assignment.teamId","typeLabel":"string | null"}},"uniqueKey":"data.metadata.oneOf.0.assignment","typeLabel":"object"},"exitRoute":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.metadata.oneOf.0.exitRoute.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.metadata.oneOf.0.exitRoute.name","typeLabel":"string"}},"required":["id","name"],"uniqueKey":"data.metadata.oneOf.0.exitRoute","typeLabel":"object"},"summary":{"type":"object","properties":{"text":{"type":"string","isRequired":true,"uniqueKey":"data.metadata.oneOf.0.summary.text","typeLabel":"string"},"messageCount":{"type":"number","isRequired":true,"uniqueKey":"data.metadata.oneOf.0.summary.messageCount","typeLabel":"number"},"anchorMessageId":{"oneOf":[{"type":"string","uniqueKey":"data.metadata.oneOf.0.summary.anchorMessageId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.metadata.oneOf.0.summary.anchorMessageId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.summary.anchorMessageId","typeLabel":"string | null"},"anchorTimestamp":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.metadata.oneOf.0.summary.anchorTimestamp.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.metadata.oneOf.0.summary.anchorTimestamp.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.summary.anchorTimestamp","typeLabel":"string\u003cdate-time> | null"},"anchorType":{"type":"string","enum":["summary","chat_open","chat_start"],"uniqueKey":"data.metadata.oneOf.0.summary.anchorType","typeLabel":"enum\u003cstring>"}},"required":["text","messageCount"],"uniqueKey":"data.metadata.oneOf.0.summary","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.metadata.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"campaignContactId":{"type":"string"},"campaignExecutionId":{"type":"string"},"assignment":{"type":"object","properties":{"userId":{"oneOf":[{"type":"string"},{"type":"null"}]},"teamId":{"oneOf":[{"type":"string"},{"type":"null"}]}}},"exitRoute":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"summary":{"type":"object","properties":{"text":{"type":"string"},"messageCount":{"type":"number"},"anchorMessageId":{"oneOf":[{"type":"string"},{"type":"null"}]},"anchorTimestamp":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"anchorType":{"type":"string","enum":["summary","chat_open","chat_start"]}},"required":["text","messageCount"]}},"isRequired":true,"uniqueKey":"data.metadata.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.metadata","typeLabel":"object | null"},"isSensitive":{"type":"boolean","isRequired":true,"uniqueKey":"data.isSensitive","typeLabel":"boolean"},"aiGenerationId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.aiGenerationId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.aiGenerationId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.aiGenerationId","typeLabel":"string | null"},"replyTo":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.replyTo.id","typeLabel":"string"},"vendorId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.replyTo.vendorId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.replyTo.vendorId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.replyTo.vendorId","typeLabel":"string | null"},"sender":{"type":"string","enum":["outbound","inbound","unknown","system"],"isRequired":true,"uniqueKey":"data.replyTo.sender","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["text","media","audio","location","contact","auth"],"isRequired":true,"uniqueKey":"data.replyTo.type","typeLabel":"enum\u003cstring>"},"timestamp":{"type":"string","isRequired":true,"uniqueKey":"data.replyTo.timestamp","typeLabel":"string"},"text":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.replyTo.text.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.replyTo.text.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.replyTo.text","typeLabel":"string | null"}},"required":["id","vendorId","sender","type","timestamp","text"],"uniqueKey":"data.replyTo","typeLabel":"object"},"chat":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.chat.id","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.chat.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.chat.updatedAt","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","enum":["open","closed","snoozed"],"isRequired":true,"uniqueKey":"data.chat.status","typeLabel":"enum\u003cstring>"},"isUnread":{"type":"boolean","isRequired":true,"uniqueKey":"data.chat.isUnread","typeLabel":"boolean"},"openUntil":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.chat.openUntil.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.chat.openUntil.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.chat.openUntil","typeLabel":"string | null"},"unreadCount":{"type":"number","isRequired":true,"uniqueKey":"data.chat.unreadCount","typeLabel":"number"},"channelId":{"type":"string","isRequired":true,"uniqueKey":"data.chat.channelId","typeLabel":"string"},"contactId":{"type":"string","isRequired":true,"uniqueKey":"data.chat.contactId","typeLabel":"string"},"handleId":{"type":"string","isRequired":true,"uniqueKey":"data.chat.handleId","typeLabel":"string"},"latestMessage":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.chat.latestMessage.oneOf.0.id","typeLabel":"string"},"vendorId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.chat.latestMessage.oneOf.0.vendorId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.chat.latestMessage.oneOf.0.vendorId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.chat.latestMessage.oneOf.0.vendorId","typeLabel":"string | null"},"sender":{"type":"string","enum":["outbound","inbound","unknown","system"],"isRequired":true,"uniqueKey":"data.chat.latestMessage.oneOf.0.sender","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["text","media","audio","location","contact","auth"],"isRequired":true,"uniqueKey":"data.chat.latestMessage.oneOf.0.type","typeLabel":"enum\u003cstring>"},"timestamp":{"type":"string","isRequired":true,"uniqueKey":"data.chat.latestMessage.oneOf.0.timestamp","typeLabel":"string"},"text":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.chat.latestMessage.oneOf.0.text.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.chat.latestMessage.oneOf.0.text.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.chat.latestMessage.oneOf.0.text","typeLabel":"string | null"}},"required":["id","vendorId","sender","type","timestamp","text"],"isRequired":true,"uniqueKey":"data.chat.latestMessage.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string"},"vendorId":{"oneOf":[{"type":"string"},{"type":"null"}]},"sender":{"type":"string","enum":["outbound","inbound","unknown","system"]},"type":{"type":"string","enum":["text","media","audio","location","contact","auth"]},"timestamp":{"type":"string"},"text":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["id","vendorId","sender","type","timestamp","text"],"isRequired":true,"uniqueKey":"data.chat.latestMessage.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.chat.latestMessage","typeLabel":"object | null"},"assignedUserId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.chat.assignedUserId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.chat.assignedUserId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.chat.assignedUserId","typeLabel":"string | null"},"assignedTeamId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.chat.assignedTeamId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.chat.assignedTeamId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.chat.assignedTeamId","typeLabel":"string | null"},"isSensitive":{"type":"boolean","isRequired":true,"uniqueKey":"data.chat.isSensitive","typeLabel":"boolean"}},"required":["id","createdAt","updatedAt","status","isUnread","openUntil","unreadCount","channelId","contactId","handleId","latestMessage","assignedUserId","assignedTeamId","isSensitive"],"additionalProperties":false,"uniqueKey":"data.chat","typeLabel":"object"}},"required":["id","createdAt","updatedAt","chatId","channelId","type","sender","sources","status","scheduledAt","content","forwarded","reactions","errors","history","vendorId","timestamp","vendorDetails","metadata","isSensitive","aiGenerationId"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["success","data"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"id":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","chatId":"\u003cstring>","channelId":"\u003cstring>","type":"message","sender":"outbound","sources":[{"type":"campaign","campaignExecutionId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}],"status":"none","scheduledAt":"\u003cstring>","content":{"body":"\u003cstring>","attachments":[{"id":"\u003cstring>","type":"image","file":{"id":"\u003cstring>","createdAt":"\u003cstring>","type":"image","name":"\u003cstring>","contentType":"\u003cstring>","url":"\u003cstring>","size":123}}],"header":"\u003cstring>","footer":"\u003cstring>","payload":"\u003cstring>"},"forwarded":true,"reactions":[{"sender":"outbound","text":"\u003cstring>","timestamp":"\u003cstring>","userId":"\u003cstring>"}],"errors":[{"messageKey":"\u003cstring>","message":"\u003cstring>","vendorError":{"code":123,"title":"\u003cstring>","type":"\u003cstring>","message":"\u003cstring>","errorData":{"messagingProduct":"\u003cstring>","details":"\u003cstring>"},"fbtraceId":"\u003cstring>"}}],"history":[{"event":"status_update","newStatus":"none","timestamp":"\u003cstring>"}],"vendorId":"\u003cstring>","timestamp":"\u003cstring>","vendorDetails":{"whatsapp":{"context":{"frequentlyForwarded":true,"referredProduct":{"catalogId":"\u003cstring>","productRetailerId":"\u003cstring>"}},"order":{"catalogId":"\u003cstring>","productItems":[{"productRetailerId":"\u003cstring>","quantity":"\u003cstring>","itemPrice":"\u003cstring>","currency":"\u003cstring>"}]}},"instagram":{"commentId":"\u003cstring>"},"messenger":{"commentId":"\u003cstring>"}},"metadata":{"campaignContactId":"\u003cstring>","campaignExecutionId":"\u003cstring>","assignment":{"userId":"\u003cstring>","teamId":"\u003cstring>"},"exitRoute":{"id":"\u003cstring>","name":"\u003cstring>"},"summary":{"text":"\u003cstring>","messageCount":123,"anchorMessageId":"\u003cstring>","anchorTimestamp":"2023-11-07T05:31:56Z","anchorType":"summary"}},"isSensitive":true,"aiGenerationId":"\u003cstring>","replyTo":{"id":"\u003cstring>","vendorId":"\u003cstring>","sender":"outbound","type":"text","timestamp":"\u003cstring>","text":"\u003cstring>"},"chat":{"id":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","status":"open","isUnread":true,"openUntil":"\u003cstring>","unreadCount":123,"channelId":"\u003cstring>","contactId":"\u003cstring>","handleId":"\u003cstring>","latestMessage":{"id":"\u003cstring>","vendorId":"\u003cstring>","sender":"outbound","type":"text","timestamp":"\u003cstring>","text":"\u003cstring>"},"assignedUserId":"\u003cstring>","assignedTeamId":"\u003cstring>","isSensitive":true}}}}},"exampleType":"generated"}},"description":"OK","exampleType":"generated"},"77c7c65e-d3d5-4227-a5a6-01706d4c2716":{"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Request success.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"messageKey":{"type":"string","description":"Request message key.","uniqueKey":"error.messageKey","typeLabel":"string"},"message":{"type":"string","description":"Request message.","uniqueKey":"error.message","typeLabel":"string"},"invalidParams":{"type":"object","additionalProperties":{"type":"object","properties":{"key":{"type":"string","description":"Request key.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.key","typeLabel":"string"},"message":{"type":"string","description":"Request message.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.message","typeLabel":"string"}},"required":["key","message"],"uniqueKey":"error.invalidParams.additionalProperties","typeLabel":"object"},"description":"Request invalid params object.","uniqueKey":"error.invalidParams","typeLabel":"object"}},"description":"Request error object.","uniqueKey":"error","typeLabel":"object"}},"required":["success"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"messageKey":"invalid_body_params","message":"Invalid body params","invalidParams":{"email":{"key":"invalid_string","message":"Invalid email"}}}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"messageKey":"invalid_body_params","message":"Invalid body params","invalidParams":{"email":{"key":"invalid_string","message":"Invalid email"}}}}}},"exampleType":"examples"}},"description":"Bad request.","exampleType":"examples"},"bd66d123-f69c-4d91-a40e-9676a2b599be":{"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Request success.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"messageKey":{"type":"string","description":"Request message key.","uniqueKey":"error.messageKey","typeLabel":"string"},"message":{"type":"string","description":"Request message.","uniqueKey":"error.message","typeLabel":"string"},"invalidParams":{"type":"object","additionalProperties":{"type":"object","properties":{"key":{"type":"string","description":"Request key.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.key","typeLabel":"string"},"message":{"type":"string","description":"Request message.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.message","typeLabel":"string"}},"required":["key","message"],"uniqueKey":"error.invalidParams.additionalProperties","typeLabel":"object"},"description":"Request invalid params object.","uniqueKey":"error.invalidParams","typeLabel":"object"}},"description":"Request error object.","uniqueKey":"error","typeLabel":"object"}},"required":["success"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"messageKey":"unauthorized","message":"Unauthorized"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"messageKey":"unauthorized","message":"Unauthorized"}}}},"exampleType":"examples"}},"description":"Unauthorized.","exampleType":"examples"},"fd938e92-4ca7-4159-89d2-f60c6b892187":{"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Request success.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"messageKey":{"type":"string","description":"Request message key.","uniqueKey":"error.messageKey","typeLabel":"string"},"message":{"type":"string","description":"Request message.","uniqueKey":"error.message","typeLabel":"string"},"invalidParams":{"type":"object","additionalProperties":{"type":"object","properties":{"key":{"type":"string","description":"Request key.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.key","typeLabel":"string"},"message":{"type":"string","description":"Request message.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.message","typeLabel":"string"}},"required":["key","message"],"uniqueKey":"error.invalidParams.additionalProperties","typeLabel":"object"},"description":"Request invalid params object.","uniqueKey":"error.invalidParams","typeLabel":"object"}},"description":"Request error object.","uniqueKey":"error","typeLabel":"object"}},"required":["success"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"messageKey":"insufficient_billing_plan","message":"Insufficient billing plan"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"messageKey":"insufficient_billing_plan","message":"Insufficient billing plan"}}}},"exampleType":"examples"}},"description":"Payment required.","exampleType":"examples"},"92bfe400-ff53-4d97-a85b-493cd990bd5a":{"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Request success.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"messageKey":{"type":"string","description":"Request message key.","uniqueKey":"error.messageKey","typeLabel":"string"},"message":{"type":"string","description":"Request message.","uniqueKey":"error.message","typeLabel":"string"},"invalidParams":{"type":"object","additionalProperties":{"type":"object","properties":{"key":{"type":"string","description":"Request key.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.key","typeLabel":"string"},"message":{"type":"string","description":"Request message.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.message","typeLabel":"string"}},"required":["key","message"],"uniqueKey":"error.invalidParams.additionalProperties","typeLabel":"object"},"description":"Request invalid params object.","uniqueKey":"error.invalidParams","typeLabel":"object"}},"description":"Request error object.","uniqueKey":"error","typeLabel":"object"}},"required":["success"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"messageKey":"forbidden","message":"Forbidden"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"messageKey":"forbidden","message":"Forbidden"}}}},"exampleType":"examples"}},"description":"Forbidden.","exampleType":"examples"},"122e281d-23d2-4d33-a824-6edd12f26864":{"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Request success.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"messageKey":{"type":"string","description":"Request message key.","uniqueKey":"error.messageKey","typeLabel":"string"},"message":{"type":"string","description":"Request message.","uniqueKey":"error.message","typeLabel":"string"},"invalidParams":{"type":"object","additionalProperties":{"type":"object","properties":{"key":{"type":"string","description":"Request key.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.key","typeLabel":"string"},"message":{"type":"string","description":"Request message.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.message","typeLabel":"string"}},"required":["key","message"],"uniqueKey":"error.invalidParams.additionalProperties","typeLabel":"object"},"description":"Request invalid params object.","uniqueKey":"error.invalidParams","typeLabel":"object"}},"description":"Request error object.","uniqueKey":"error","typeLabel":"object"}},"required":["success"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"messageKey":"contact_not_found","message":"Contact not found"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"messageKey":"contact_not_found","message":"Contact not found"}}}},"exampleType":"examples"}},"description":"Not found.","exampleType":"examples"},"6e45f721-bfaa-48b7-b22d-cc46aa62faf0":{"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Request success.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"messageKey":{"type":"string","description":"Request message key.","uniqueKey":"error.messageKey","typeLabel":"string"},"message":{"type":"string","description":"Request message.","uniqueKey":"error.message","typeLabel":"string"},"invalidParams":{"type":"object","additionalProperties":{"type":"object","properties":{"key":{"type":"string","description":"Request key.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.key","typeLabel":"string"},"message":{"type":"string","description":"Request message.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.message","typeLabel":"string"}},"required":["key","message"],"uniqueKey":"error.invalidParams.additionalProperties","typeLabel":"object"},"description":"Request invalid params object.","uniqueKey":"error.invalidParams","typeLabel":"object"}},"description":"Request error object.","uniqueKey":"error","typeLabel":"object"}},"required":["success"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"messageKey":"too_many_requests","message":"Too many requests. Limit is applied per minute per tenant. Please retry after the time indicated by the X-RateLimit-Reset header."}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"messageKey":"too_many_requests","message":"Too many requests. Limit is applied per minute per tenant. Please retry after the time indicated by the X-RateLimit-Reset header."}}}},"exampleType":"examples"}},"description":"Too many requests.","exampleType":"examples"},"82d658ce-4b80-4a30-9492-5ea3c0d3f905":{"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Request success.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"messageKey":{"type":"string","description":"Request message key.","uniqueKey":"error.messageKey","typeLabel":"string"},"message":{"type":"string","description":"Request message.","uniqueKey":"error.message","typeLabel":"string"},"invalidParams":{"type":"object","additionalProperties":{"type":"object","properties":{"key":{"type":"string","description":"Request key.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.key","typeLabel":"string"},"message":{"type":"string","description":"Request message.","isRequired":true,"uniqueKey":"error.invalidParams.additionalProperties.message","typeLabel":"string"}},"required":["key","message"],"uniqueKey":"error.invalidParams.additionalProperties","typeLabel":"object"},"description":"Request invalid params object.","uniqueKey":"error.invalidParams","typeLabel":"object"}},"description":"Request error object.","uniqueKey":"error","typeLabel":"object"}},"required":["success"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"messageKey":"internal_error","message":"Oops! Something went wrong"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"messageKey":"internal_error","message":"Oops! Something went wrong"}}}},"exampleType":"examples"}},"description":"Internal server error.","exampleType":"examples"}},"security":{"b75e6a32-453a-4290-9bd4-2a3bb76b1db7":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"d337f328-cc33-443a-9da2-88c1ad7823c9":{"url":"https://api.heyy.io/v3"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi-v3.json"},"subdomain":"heyy-c8bd5c9e","siteName":"Heyy Help Center","title":"Send message - Heyy Help Center","navMaps":{"firstHrefInVersion":{"Version 3":{"href":"/api-reference/send-message","matchLevel":0},"Version 2":{"href":"/api-reference/v2/get-attributes","matchLevel":2}},"firstHrefInLanguage":{}},"lastModified":"2026-09-07T19:11:06.063Z","originalFileLocation":"api-reference/send-message.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 message to a contact on a connected channel.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Heyy Help Center\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_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/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_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/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_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/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_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/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_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/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_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/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_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/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Send message - Heyy Help Center\">\u003cmeta data-mint-head property=\"og:description\" content=\"Send a message to a contact on a connected channel.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Heyy Help Center\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.heyy.io/api-reference/send-message\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://heyy-c8bd5c9e.mintlify.app/_mintlify/api/og/v2?division=Message\u0026amp;title=Send+message\u0026amp;description=Send+a+message+to+a+contact+on+a+connected+channel.\u0026amp;theme=ef3232fe885046deda1ba629\u0026amp;signature=951a52f5f6efd804e9618009a065175d04f3cf2190e98434feeb9c77690fcd69\">\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 message - Heyy Help Center\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Send a message to a contact on a connected channel.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://heyy-c8bd5c9e.mintlify.app/_mintlify/api/og/v2?division=Message\u0026amp;title=Send+message\u0026amp;description=Send+a+message+to+a+contact+on+a+connected+channel.\u0026amp;theme=ef3232fe885046deda1ba629\u0026amp;signature=951a52f5f6efd804e9618009a065175d04f3cf2190e98434feeb9c77690fcd69\">\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/heyy-c8bd5c9e/2DDPHeItlA7vAAJv/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Heyy Help Center\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FE3265\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.heyy.io/api-reference/send-message\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/send-message.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.heyy.io/#organization\",\"name\":\"Heyy Help Center\",\"url\":\"https://docs.heyy.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/heyy-c8bd5c9e/cOuWPkt81GyZiNr6/assets/logo.svg?fit=max\u0026auto=format\u0026n=cOuWPkt81GyZiNr6\u0026q=85\u0026s=15d8f051f3dbe3cb5e5d0241b7a50372\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.heyy.io#website\",\"name\":\"Heyy Help Center\",\"url\":\"https://docs.heyy.io\",\"publisher\":{\"@id\":\"https://docs.heyy.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.heyy.io/api-reference/send-message#webpage\",\"url\":\"https://docs.heyy.io/api-reference/send-message\",\"name\":\"Send message\",\"description\":\"Send a message to a contact on a connected channel.\",\"dateModified\":\"2026-09-07T19:11:06.063Z\",\"isPartOf\":{\"@id\":\"https://docs.heyy.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.heyy.io/api-reference/send-message#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.heyy.io/api-reference/send-message#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"HEYY API\",\"item\":\"https://docs.heyy.io/api-reference/search-attributes\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Send message\",\"item\":\"https://docs.heyy.io/api-reference/send-message\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.heyy.io/api-reference/send-message#apireference\",\"headline\":\"Send message\",\"name\":\"Send message\",\"description\":\"Send a message to a contact on a connected channel.\",\"url\":\"https://docs.heyy.io/api-reference/send-message\",\"mainEntityOfPage\":{\"@id\":\"https://docs.heyy.io/api-reference/send-message#webpage\"},\"dateModified\":\"2026-09-07T19:11:06.063Z\",\"publisher\":{\"@id\":\"https://docs.heyy.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.heyy.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Heyy Help Center\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Heyy Help Center","nav":{"global":null,"tabs":[{"tab":"Help Center","icon":"life-buoy","pages":[{"title":"Help Center","href":"/help"}]},{"tab":"API Reference","icon":"code","versions":[{"version":"Version 3","tag":"Latest","groups":[{"group":"GETTING STARTED","pages":[{"title":"Heyy API Documentation - REST API Reference \u0026 Guides","sidebarTitle":"Overview","href":"/api-reference/v3/overview"},{"title":"Authentication","href":"/api-reference/v3/authentication"},{"title":"Versioning","href":"/api-reference/v3/versioning"},{"title":"Query","href":"/api-reference/v3/query"},{"title":"Sort By","href":"/api-reference/v3/sort-by"},{"title":"Search","href":"/api-reference/v3/search"},{"title":"Pagination","href":"/api-reference/v3/pagination"},{"title":"Rate Limiting","href":"/api-reference/v3/rate-limiting"},{"title":"Error Handling","href":"/api-reference/v3/error-handling"}]},{"group":"HEYY API","pages":[{"group":"Attribute","expanded":false,"pages":[{"title":"Search attributes","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /attributes/search","href":"/api-reference/search-attributes"},{"title":"Create attribute","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /attributes","href":"/api-reference/create-attribute"},{"title":"Update attribute","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json put /attributes/{attributeId}","href":"/api-reference/update-attribute"},{"title":"Get attribute","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /attributes/{attributeId}","href":"/api-reference/get-attribute"},{"title":"Delete attribute","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json delete /attributes/{attributeId}","href":"/api-reference/delete-attribute"}]},{"group":"Automation","expanded":false,"pages":[{"title":"Search automations","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /automations/search","href":"/api-reference/search-automations"},{"title":"Get automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /automations/{automationId}","href":"/api-reference/get-automation"},{"title":"Pause automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /automations/{automationId}/pause","href":"/api-reference/pause-automation"},{"title":"Unpause automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /automations/{automationId}/unpause","href":"/api-reference/unpause-automation"},{"title":"Trigger automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /automations/{automationId}/trigger","href":"/api-reference/trigger-automation"}]},{"group":"Campaign","expanded":false,"pages":[{"title":"Search campaigns","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /campaigns/search","href":"/api-reference/search-campaigns"},{"title":"Create campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /campaigns","href":"/api-reference/create-campaign"},{"title":"Update campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json put /campaigns/{campaignId}","href":"/api-reference/update-campaign"},{"title":"Get campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /campaigns/{campaignId}","href":"/api-reference/get-campaign"},{"title":"Delete campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json delete /campaigns/{campaignId}","href":"/api-reference/delete-campaign"},{"title":"Add recipients","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /campaigns/{campaignId}/recipients","href":"/api-reference/add-recipients"},{"title":"Remove recipients","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json delete /campaigns/{campaignId}/recipients","href":"/api-reference/remove-recipients"},{"title":"Start campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /campaigns/{campaignId}/start","href":"/api-reference/start-campaign"}]},{"group":"Channel","expanded":false,"pages":[{"title":"Search channels","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /channels/search","href":"/api-reference/search-channels"},{"title":"Get channel","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /channels/{channelId}","href":"/api-reference/get-channel"}]},{"group":"Chat","expanded":false,"pages":[{"title":"Search chats","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /chats/search","href":"/api-reference/search-chats"},{"title":"Get chat","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /chats/{chatId}","href":"/api-reference/get-chat"},{"title":"Delete chat","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json delete /chats/{chatId}","href":"/api-reference/delete-chat"},{"title":"Change chat status","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /chats/{chatId}/status","href":"/api-reference/change-chat-status"},{"title":"Assign chat to team","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /chats/{chatId}/assign_team","href":"/api-reference/assign-chat-to-team"},{"title":"Assign chat to user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /chats/{chatId}/assign_user","href":"/api-reference/assign-chat-to-user"},{"title":"Mark chat as sensitive","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /chats/{chatId}/mark_as_sensitive","href":"/api-reference/mark-chat-as-sensitive"},{"title":"Mark chat as not sensitive","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /chats/{chatId}/mark_as_not_sensitive","href":"/api-reference/mark-chat-as-not-sensitive"},{"title":"Mark chat as read","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /chats/{chatId}/mark_as_read","href":"/api-reference/mark-chat-as-read"},{"title":"Mark chat as unread","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /chats/{chatId}/mark_as_unread","href":"/api-reference/mark-chat-as-unread"}]},{"group":"Contact","expanded":false,"pages":[{"title":"Search contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /contacts/search","href":"/api-reference/search-contacts"},{"title":"Create contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /contacts","href":"/api-reference/create-contact"},{"title":"Upsert contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /contacts/upsert","href":"/api-reference/upsert-contact"},{"title":"Update contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json put /contacts/{contactId}","href":"/api-reference/update-contact"},{"title":"Get contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /contacts/{contactId}","href":"/api-reference/get-contact"},{"title":"Delete contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json delete /contacts/{contactId}","href":"/api-reference/delete-contact"},{"title":"Add labels to contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /contacts/{contactId}/labels","href":"/api-reference/add-labels-to-contact"},{"title":"Remove labels from contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json delete /contacts/{contactId}/labels","href":"/api-reference/remove-labels-from-contact"},{"title":"Subscribe contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /contacts/{contactId}/subscribe","href":"/api-reference/subscribe-contact"},{"title":"Unsubscribe contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /contacts/{contactId}/unsubscribe","href":"/api-reference/unsubscribe-contact"},{"title":"Bulk upsert contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /contacts/bulk","href":"/api-reference/bulk-upsert-contacts"}]},{"group":"File","expanded":false,"pages":[{"title":"Upload file","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /files","href":"/api-reference/upload-file"},{"title":"Get file","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /files/{fileId}","href":"/api-reference/get-file"},{"title":"Get public file URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /files/{fileId}/public_url","href":"/api-reference/get-public-file-url"}]},{"group":"Journey","expanded":false,"pages":[{"title":"Search journeys","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /journeys/search","href":"/api-reference/search-journeys"},{"title":"Get journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /journeys/{journeyId}","href":"/api-reference/get-journey"},{"title":"Subscribe contacts to journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /journeys/{journeyId}/subscribe","href":"/api-reference/subscribe-contacts-to-journey"},{"title":"Unsubscribe contacts from journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /journeys/{journeyId}/unsubscribe","href":"/api-reference/unsubscribe-contacts-from-journey"}]},{"group":"Label","expanded":false,"pages":[{"title":"Search labels","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /labels/search","href":"/api-reference/search-labels"},{"title":"Create label","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /labels","href":"/api-reference/create-label"},{"title":"Update label","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json put /labels/{labelId}","href":"/api-reference/update-label"},{"title":"Get label","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /labels/{labelId}","href":"/api-reference/get-label"},{"title":"Delete label","description":"Delete label.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json delete /labels/{labelId}","href":"/api-reference/delete-label"}]},{"group":"Message","expanded":false,"pages":[{"title":"Send message","openapi":"api-reference/openapi-v3.json POST /messages/send","href":"/api-reference/send-message"},{"title":"Send template message","description":"Send a template message to a contact on a connected channel.","openapi":"api-reference/openapi-v3.json POST /messages/send_template","href":"/api-reference/send-template-message"}]},{"group":"Message Template","expanded":false,"pages":[{"title":"Search message templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /message_templates/search","href":"/api-reference/search-message-templates"},{"title":"Create message template","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /message_templates","href":"/api-reference/create-message-template"},{"title":"Update message template","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json put /message_templates/{messageTemplateId}","href":"/api-reference/update-message-template"},{"title":"Get message template","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /message_templates/{messageTemplateId}","href":"/api-reference/get-message-template"},{"title":"Delete message template","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json delete /message_templates/{messageTemplateId}","href":"/api-reference/delete-message-template"}]},{"group":"Team","expanded":false,"pages":[{"title":"Search teams","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /teams/search","href":"/api-reference/search-teams"},{"title":"Create team","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json post /teams","href":"/api-reference/create-team"},{"title":"Update team","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json put /teams/{teamId}","href":"/api-reference/update-team"},{"title":"Get team","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /teams/{teamId}","href":"/api-reference/get-team"},{"title":"Delete team","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json delete /teams/{teamId}","href":"/api-reference/delete-team"}]},{"group":"User","expanded":false,"pages":[{"title":"Get users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /users","href":"/api-reference/get-users"},{"title":"Get user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /users/{userId}","href":"/api-reference/get-user"}]},{"group":"Workspace","expanded":false,"pages":[{"title":"Get workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.json get /workspace","href":"/api-reference/get-workspace"}]}]}]},{"version":"Version 2","tag":"Sunset Oct 1, 2026","pages":[{"title":"Version 2","href":"/api-reference/v2/get-attributes"}]}]},{"tab":"Webhooks","icon":"webhook","pages":[{"title":"Webhooks","href":"/webhooks/overview"}]},{"tab":"Changelog","icon":"megaphone","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Send message - Heyy Help Center","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}