Sends one SMS to one number in E.164 form, from the environment’s configured sender. The body may carry . Asks the audience policy first: a number that has replied STOP is recorded as suppressed, not sent. Billing counts segments, not messages — a body outside the GSM alphabet costs more than twice as much per character, and the reply says how many segments were counted. If the environment cannot text anyone yet (no active carrier registration, or no number to send from) the message is still stored and the reply carries blocked saying why — do not wait on a status that cannot change until that clears.
Send the template's variant for this language, falling back to the broader language and then the default. Omit to use the recipient's own locale if one is recorded.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Lath","description":"Documentation for Lath: auth, email and SMS behind one API, one MCP server and one CLI.","colors":{"primary":"#141414","light":"#F7F6F3","dark":"#141414"},"logo":{"light":"https://mintcdn.com/try-lath/hpSxNuaOf1P6pXSd/logo/light.png?fit=max\u0026auto=format\u0026n=hpSxNuaOf1P6pXSd\u0026q=85\u0026s=b6e21cf7c27e4bd1af38901399991f7f","dark":"https://mintcdn.com/try-lath/hpSxNuaOf1P6pXSd/logo/dark.png?fit=max\u0026auto=format\u0026n=hpSxNuaOf1P6pXSd\u0026q=85\u0026s=0f1711f6b03627ec73337bf4fa7db2cc","href":"https://trylath.com"},"favicon":"https://mintcdn.com/try-lath/SBWSGv0A40oE2WjS/logo/icon.png?fit=max\u0026auto=format\u0026n=SBWSGv0A40oE2WjS\u0026q=85\u0026s=804f7e13e18839ae4a65f1fb053c19a3","api":{"openapi":"api-reference/openapi.json","playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python","go"]}},"appearance":{"default":"system"},"background":{"color":{"light":"#F7F6F3","dark":"#000000"}},"navbar":{"links":[{"href":"https://console.trylath.com","label":"Dashboard"}],"primary":{"type":"button","label":"Sign up","href":"https://console.trylath.com/signup"}},"footer":{"socials":{"website":"https://trylath.com"}},"search":{"prompt":"Search the Lath docs"},"seo":{"metatags":{"og:site_name":"Lath Docs"}},"fonts":{"family":"Instrument Sans","weight":400,"source":"fonts/InstrumentSans-Variable.woff2","format":"woff2"},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","latex":false},"errors":{"404":{"redirect":false,"title":"No page here","description":"Start from the [quickstart](/get-started/quickstart), or search above. Operations are listed in the [API reference](/api-reference/introduction)."}},"contextual":{"options":["copy","view","claude","chatgpt","cursor","vscode"],"display":"header"},"metadata":{"timestamp":true},"markdown":{"instructions":["Every Lath operation is POST https://platform.trylath.com/\u003coperation name with dots replaced by slashes>, with a JSON body and `Authorization: Bearer \u003ckey>`. `email.send` is POST /email/send.","Branch on `error.code`, never on `error.message`. Every refusal also carries `error.fix`, which names the next step.","Send an `Idempotency-Key` header on any operation that is not retry-safe, so a retry cannot run it twice.","A `lath_test_` key emails only the account's own members and sends no SMS; a `lath_live_` key reaches real recipients and is billed.","The OpenAPI document, generated from the same registry as the routes, is at https://platform.trylath.com/openapi.json."]},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"try-lath","hasAudioNarration":false,"actualSubdomain":"try-lath","customDomains":["docs.trylath.com"],"gitSource":{"type":"github","owner":"trylath","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ab3516d1e361aae8924723f","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API reference","count":477},{"language":"default","tag":"Auth","count":81},{"language":"default","tag":"Email","count":43},{"language":"default","tag":"Documentation","count":38},{"language":"default","tag":"SMS","count":30},{"language":"default","tag":"Audience","count":28},{"language":"default","tag":"Developers","count":22},{"language":"default","tag":"Platform","count":19},{"language":"default","tag":"Account","count":14},{"language":"default","tag":"Billing","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@font-face{font-family:\"Instrument Sans\";src:url(\"/fonts/InstrumentSans-Variable.woff2\") format(\"woff2\");font-weight:400 700;font-style:normal;font-display:swap}@font-face{font-family:\"JetBrains Mono\";src:url(\"/fonts/JetBrainsMono-Regular.woff2\") format(\"woff2\");font-weight:400;font-style:normal;font-display:swap}@font-face{font-family:\"JetBrains Mono\";src:url(\"/fonts/JetBrainsMono-Medium.woff2\") format(\"woff2\");font-weight:500;font-style:normal;font-display:swap}code,pre,kbd,.font-mono{font-family:\"JetBrains Mono\", ui-monospace, SFMono-Regular, Menlo, Consolas, monospace!important}h1,#page-title{font-weight:550!important;letter-spacing:-0.03em}h2,h3{font-weight:550!important;letter-spacing:-0.015em}.tryit-button,button.tryit-button[class*=\"bg-[\"]{background-color:#141414!important;color:#f7f6f3!important}.dark .tryit-button,.dark button.tryit-button[class*=\"bg-[\"]{background-color:#f7f6f3!important;color:#141414!important}.method-pill,.method-nav-pill>span,span[class*=\"bg-[#3064E3]\"]{background-color:rgb(20 20 20 / 0.06)!important;color:#141414!important}.dark .method-pill,.dark .method-nav-pill>span,.dark span[class*=\"bg-[#3064E3]\"]{background-color:rgb(255 255 255 / 0.1)!important;color:rgb(255 255 255 / 0.92)!important}div[class*=\"bg-red-100/50\"][class*=\"text-red-600\"]{background-color:rgb(20 20 20 / 0.06)!important;color:#141414!important}.dark div[class*=\"bg-red-100/50\"][class*=\"text-red-600\"]{background-color:rgb(255 255 255 / 0.1)!important;color:rgb(255 255 255 / 0.92)!important}.chat-assistant-floating-input{display:none!important}:root{--lath-callout-border: rgb(20 20 20 / 0.12);--lath-callout-bg: rgb(20 20 20 / 0.03);--lath-callout-fg: #3d3d3d;--lath-callout-icon: #141414}.dark{--lath-callout-border: rgb(255 255 255 / 0.12);--lath-callout-bg: rgb(255 255 255 / 0.04);--lath-callout-fg: #c8c8c8;--lath-callout-icon: rgb(255 255 255 / 0.92)}.callout[data-callout-type]:not([data-callout-type=\"danger\"]){border-color:var(--lath-callout-border)!important;background-color:var(--lath-callout-bg)!important}.callout[data-callout-type]:not([data-callout-type=\"danger\"]) [data-component-part=\"callout-content\"]{color:var(--lath-callout-fg)!important}.callout[data-callout-type]:not([data-callout-type=\"danger\"]) [data-component-part=\"callout-icon\"] svg{color:var(--lath-callout-icon)!important}:root{--lath-text-secondary: #5a5a5a}.dark{--lath-text-secondary: #b4b4b4}[data-component-part=\"accordion-description\"]{color:var(--lath-text-secondary)!important;font-size:0.875rem;line-height:1.25rem}table td,table th{font-variant-numeric:tabular-nums}table td:first-child>code{white-space:nowrap}"}],"page":{"pagePath":"api-reference/sms/smssend","slug":"/api-reference/sms/smssend","pageMetadata":{"title":"sms.send","description":"Sends one SMS to one number in E.164 form, from the environment's configured sender. The body may carry {{variables}}. Asks the audience policy first: a number that has replied STOP is recorded as suppressed, not sent. Billing counts segments, not messages — a body outside the GSM alphabet costs more than twice as much per character, and the reply says how many segments were counted. If the environment cannot text anyone yet (no active carrier registration, or no number to send from) the message is still stored and the reply carries `blocked` saying why — do not wait on a status that cannot change until that clears.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/send","href":"/api-reference/sms/smssend","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Sends one SMS to one number in E.164 form, from the environment’s configured sender. The body may carry \", \". Asks the audience policy first: a number that has replied STOP is recorded as suppressed, not sent. Billing counts segments, not messages — a body outside the GSM alphabet costs more than twice as much per character, and the reply says how many segments were counted. If the environment cannot text anyone yet (no active carrier registration, or no number to send from) the message is still stored and the reply carries \", _jsx(_components.code, {\n children: \"blocked\"\n }), \" saying why — do not wait on a status that cannot change until that clears.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"sms.send","description":"Sends one SMS to one number in E.164 form, from the environment's configured sender. The body may carry {{variables}}. Asks the audience policy first: a number that has replied STOP is recorded as suppressed, not sent. Billing counts segments, not messages — a body outside the GSM alphabet costs more than twice as much per character, and the reply says how many segments were counted. If the environment cannot text anyone yet (no active carrier registration, or no number to send from) the message is still stored and the reply carries `blocked` saying why — do not wait on a status that cannot change until that clears.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/send","href":"/api-reference/sms/smssend","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"sms.send","summary":"sms.send","description":"Sends one SMS to one number in E.164 form, from the environment's configured sender. The body may carry {{variables}}. Asks the audience policy first: a number that has replied STOP is recorded as suppressed, not sent. Billing counts segments, not messages — a body outside the GSM alphabet costs more than twice as much per character, and the reply says how many segments were counted. If the environment cannot text anyone yet (no active carrier registration, or no number to send from) the message is still stored and the reply carries `blocked` saying why — do not wait on a status that cannot change until that clears.","tags":["sms"],"x-lath-impact":{"destructive":false,"retrySafe":false,"billable":true,"read":false},"x-lath-permission":"sms:write","x-lath-scope":{"environment":true},"security":["12c1decc-f079-4dbb-abaf-9e41d8edf033"],"parameters":["4a8ade66-28a6-4c27-8d20-29a790b08bd7"],"requestBody":"697b5a5c-9f64-4d3a-ad00-7c6f909147c4","responses":{"200":"072d33dd-d7bb-4667-8bfc-3ae733dc192a","400":"9b091e6b-ba9b-4d80-a27d-d33dd05ca853","401":"138381ca-023e-450e-822e-6ce5bad3e928","403":"a94f6092-c06d-4341-8410-39726aa60d9b","404":"77cd21d0-748a-49a7-8fcd-83ca1ff4574f","409":"f48b1cc5-42ad-48f0-88ac-664564bb430b","413":"937385c2-fcde-47dd-a076-aab62cebec6d","429":"67af9805-42ba-48a5-b54a-86f242eeee84"},"method":"post","type":"path","servers":["ae2e6b8a-500f-48c1-b703-6328988740c3"],"path":"/sms/send","baseUrlOptions":["https://platform.trylath.com"],"title":"sms.send","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","go"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"4a8ade66-28a6-4c27-8d20-29a790b08bd7":{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","isRequired":false,"description":"Replays the stored response for the same key and input; refuses different input.","uniqueKey":"","typeLabel":"string"},"description":"Replays the stored response for the same key and input; refuses different input."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"to":{"type":"string","pattern":"^\\+[1-9]\\d{6,14}$","description":"One recipient, E.164, e.g. +14155550100","isRequired":true,"uniqueKey":"to","typeLabel":"string"},"template":{"description":"An SMS template name; provide variables with it. Use instead of body, not with it.","type":"string","minLength":1,"maxLength":120,"uniqueKey":"template","typeLabel":"string"},"locale":{"description":"Send the template's variant for this language, falling back to the broader language and then the default. Omit to use the recipient's own locale if one is recorded.","type":"string","maxLength":20,"uniqueKey":"locale","typeLabel":"string"},"body":{"description":"Inline send: the message; may reference {{variables}}","type":"string","minLength":1,"maxLength":1600,"uniqueKey":"body","typeLabel":"string"},"variables":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z_][A-Za-z0-9_]*$"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"variables.additionalProperties","typeLabel":"any"},"uniqueKey":"variables","typeLabel":"object"},"sendAfter":{"description":"Hold the message until this moment; omit to send now. Until it is sent it can be stopped with sms.message.cancel.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","uniqueKey":"sendAfter","typeLabel":"string\u003cdate-time>"},"topic":{"description":"A consent topic for marketing; omit for transactional, which only a suppression stops","type":"string","minLength":1,"maxLength":64,"uniqueKey":"topic","typeLabel":"string"},"metadata":{"description":"Up to 20 key/values echoed on every webhook about this message","type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"oneOf":[{"type":"string","maxLength":500,"uniqueKey":"metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"metadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"metadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"metadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"metadata","typeLabel":"object"}},"required":["to"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"to":"\u003cstring>","template":"\u003cstring>","locale":"\u003cstring>","body":"\u003cstring>","variables":{},"sendAfter":"2023-11-07T05:31:56Z","topic":"\u003cstring>","metadata":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"072d33dd-d7bb-4667-8bfc-3ae733dc192a":{"description":"{ activityId, result }. activityId is empty for reads.","content":{"application/json":{"schema":{"type":"object","properties":{"activityId":{"type":"string","description":"The activity this call created, or empty for a read.","isRequired":true,"uniqueKey":"activityId","typeLabel":"string"},"result":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"messageId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"uniqueKey":"result.messageId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["queued","suppressed"],"isRequired":true,"uniqueKey":"result.status","typeLabel":"enum\u003cstring>"},"to":{"type":"string","isRequired":true,"uniqueKey":"result.to","typeLabel":"string"},"segments":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"result.segments","typeLabel":"integer"},"encoding":{"type":"string","isRequired":true,"uniqueKey":"result.encoding","typeLabel":"string"},"template":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"result.template.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"result.template.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.template","typeLabel":"string | null"},"templateVersion":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991,"isRequired":true,"uniqueKey":"result.templateVersion.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"result.templateVersion.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.templateVersion","typeLabel":"integer | null"},"templateLocale":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"result.templateLocale.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"result.templateLocale.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.templateLocale","typeLabel":"string | null"},"sendAfter":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","isRequired":true,"uniqueKey":"result.sendAfter.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"result.sendAfter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.sendAfter","typeLabel":"string\u003cdate-time> | null"},"suppressed":{"type":"object","properties":{"reason":{"type":"string","isRequired":true,"uniqueKey":"result.suppressed.reason","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"result.suppressed.detail","typeLabel":"string"}},"required":["reason","detail"],"additionalProperties":{"oneOf":[{}],"uniqueKey":"result.suppressed.additionalProperties","typeLabel":"any"},"uniqueKey":"result.suppressed","typeLabel":"object"},"blocked":{"type":"object","properties":{"reason":{"type":"string","isRequired":true,"uniqueKey":"result.blocked.reason","typeLabel":"string"},"fix":{"type":"string","isRequired":true,"uniqueKey":"result.blocked.fix","typeLabel":"string"}},"required":["reason","fix"],"additionalProperties":{"oneOf":[{}],"uniqueKey":"result.blocked.additionalProperties","typeLabel":"any"},"uniqueKey":"result.blocked","typeLabel":"object"}},"required":["messageId","status","to","segments","encoding","template","templateVersion","templateLocale","sendAfter"],"additionalProperties":{"oneOf":[{}],"uniqueKey":"result.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"result","typeLabel":"object"}},"required":["activityId","result"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"activityId":"\u003cstring>","result":{"messageId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"queued","to":"\u003cstring>","segments":0,"encoding":"\u003cstring>","template":"\u003cstring>","templateVersion":0,"templateLocale":"\u003cstring>","sendAfter":"2023-11-07T05:31:56Z","suppressed":{"reason":"\u003cstring>","detail":"\u003cstring>"},"blocked":{"reason":"\u003cstring>","fix":"\u003cstring>"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"9b091e6b-ba9b-4d80-a27d-d33dd05ca853":{"description":"invalid_input or invalid_json","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"138381ca-023e-450e-822e-6ce5bad3e928":{"description":"unauthenticated","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"a94f6092-c06d-4341-8410-39726aa60d9b":{"description":"forbidden","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"77cd21d0-748a-49a7-8fcd-83ca1ff4574f":{"description":"not_found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"f48b1cc5-42ad-48f0-88ac-664564bb430b":{"description":"conflict: idempotency_mismatch, email_taken, last_key","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"937385c2-fcde-47dd-a076-aab62cebec6d":{"description":"body_too_large","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"67af9805-42ba-48a5-b54a-86f242eeee84":{"description":"rate_limited","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"12c1decc-f079-4dbb-abaf-9e41d8edf033":{"bearer":{"type":"http","scheme":"bearer","description":"A Lath API key: lath_live_… or lath_test_… on a server, lath_live_pk… or lath_test_pk… in a browser.","scopes":[]}}},"servers":{"ae2e6b8a-500f-48c1-b703-6328988740c3":{"url":"https://platform.trylath.com","description":"This deployment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A Lath API key: lath_live_… or lath_test_… on a server, lath_live_pk… or lath_test_pk… in a browser.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A Lath API key: lath_live_… or lath_test_… on a server, lath_live_pk… or lath_test_pk… in a browser.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"try-lath","siteName":"Lath","title":"sms.send - Lath","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-23T04:11:34.340Z","originalFileLocation":"api-reference/sms/smssend.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=\"Sends one SMS to one number in E.164 form, from the environment\u0026#x27;s configured sender. The body may carry {{variables}}. Asks the audience policy first: a number that has replied STOP is recorded as suppressed, not sent. Billing counts segments, not messages — a body outside the GSM alphabet costs more than twice as much per character, and the reply says how many segments were counted. If the environment cannot text anyone yet (no active carrier registration, or no number to send from) the message is still stored and the reply carries blocked saying why — do not wait on a status that cannot change until that clears.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Lath\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/try-lath/a0nppl-WgGNlEkft/_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/try-lath/a0nppl-WgGNlEkft/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/try-lath/a0nppl-WgGNlEkft/_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/try-lath/a0nppl-WgGNlEkft/_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/try-lath/a0nppl-WgGNlEkft/_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/try-lath/a0nppl-WgGNlEkft/_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/try-lath/a0nppl-WgGNlEkft/_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/try-lath/a0nppl-WgGNlEkft/_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/try-lath/a0nppl-WgGNlEkft/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"sms.send - Lath\">\u003cmeta data-mint-head property=\"og:description\" content=\"Sends one SMS to one number in E.164 form, from the environment\u0026#x27;s configured sender. The body may carry {{variables}}. Asks the audience policy first: a number that has replied STOP is recorded as suppressed, not sent. Billing counts segments, not messages — a body outside the GSM alphabet costs more than twice as much per character, and the reply says how many segments were counted. If the environment cannot text anyone yet (no active carrier registration, or no number to send from) the message is still stored and the reply carries blocked saying why — do not wait on a status that cannot change until that clears.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Lath Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.trylath.com/api-reference/sms/smssend\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://try-lath.mintlify.site/_mintlify/api/og/v2?division=SMS\u0026amp;title=sms.send\u0026amp;description=Sends+one+SMS+to+one+number+in+E.164+form%2C+from+the+environment%27s+configured+sender.+The+body+may+carry+%7B%7Bvariables%7D%7D.+Asks+the+audience+policy+first%3A+a+number+\u0026amp;theme=668e6aa9f38d1b133bc43b7c\u0026amp;signature=e26c40aa6b2a17906b6510e0f8b31c99ed4923716e46d639c069d0dd0c07cd24\">\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=\"sms.send - Lath\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Sends one SMS to one number in E.164 form, from the environment\u0026#x27;s configured sender. The body may carry {{variables}}. Asks the audience policy first: a number that has replied STOP is recorded as suppressed, not sent. Billing counts segments, not messages — a body outside the GSM alphabet costs more than twice as much per character, and the reply says how many segments were counted. If the environment cannot text anyone yet (no active carrier registration, or no number to send from) the message is still stored and the reply carries blocked saying why — do not wait on a status that cannot change until that clears.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://try-lath.mintlify.site/_mintlify/api/og/v2?division=SMS\u0026amp;title=sms.send\u0026amp;description=Sends+one+SMS+to+one+number+in+E.164+form%2C+from+the+environment%27s+configured+sender.+The+body+may+carry+%7B%7Bvariables%7D%7D.+Asks+the+audience+policy+first%3A+a+number+\u0026amp;theme=668e6aa9f38d1b133bc43b7c\u0026amp;signature=e26c40aa6b2a17906b6510e0f8b31c99ed4923716e46d639c069d0dd0c07cd24\">\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/try-lath/a0nppl-WgGNlEkft/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Lath\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#141414\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.trylath.com/api-reference/sms/smssend\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sms/smssend.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.trylath.com/#organization\",\"name\":\"Lath\",\"url\":\"https://docs.trylath.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/try-lath/hpSxNuaOf1P6pXSd/logo/light.png?fit=max\u0026auto=format\u0026n=hpSxNuaOf1P6pXSd\u0026q=85\u0026s=b6e21cf7c27e4bd1af38901399991f7f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.trylath.com#website\",\"name\":\"Lath\",\"url\":\"https://docs.trylath.com\",\"publisher\":{\"@id\":\"https://docs.trylath.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.trylath.com/api-reference/sms/smssend#webpage\",\"url\":\"https://docs.trylath.com/api-reference/sms/smssend\",\"name\":\"sms.send\",\"description\":\"Sends one SMS to one number in E.164 form, from the environment's configured sender. The body may carry {{variables}}. Asks the audience policy first: a number that has replied STOP is recorded as suppressed, not sent. Billing counts segments, not messages — a body outside the GSM alphabet costs more than twice as much per character, and the reply says how many segments were counted. If the environment cannot text anyone yet (no active carrier registration, or no number to send from) the message is still stored and the reply carries blocked saying why — do not wait on a status that cannot change until that clears.\",\"dateModified\":\"2026-09-23T04:11:34.340Z\",\"isPartOf\":{\"@id\":\"https://docs.trylath.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.trylath.com/api-reference/sms/smssend#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.trylath.com/api-reference/sms/smssend#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.trylath.com/api-reference/auth/authdeviceapprove\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"SMS\",\"item\":\"https://docs.trylath.com/api-reference/sms/smsbroadcastcancel\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"sms.send\",\"item\":\"https://docs.trylath.com/api-reference/sms/smssend\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.trylath.com/api-reference/sms/smssend#apireference\",\"headline\":\"sms.send\",\"name\":\"sms.send\",\"description\":\"Sends one SMS to one number in E.164 form, from the environment's configured sender. The body may carry {{variables}}. Asks the audience policy first: a number that has replied STOP is recorded as suppressed, not sent. Billing counts segments, not messages — a body outside the GSM alphabet costs more than twice as much per character, and the reply says how many segments were counted. If the environment cannot text anyone yet (no active carrier registration, or no number to send from) the message is still stored and the reply carries blocked saying why — do not wait on a status that cannot change until that clears.\",\"url\":\"https://docs.trylath.com/api-reference/sms/smssend\",\"mainEntityOfPage\":{\"@id\":\"https://docs.trylath.com/api-reference/sms/smssend#webpage\"},\"dateModified\":\"2026-09-23T04:11:34.340Z\",\"publisher\":{\"@id\":\"https://docs.trylath.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.trylath.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Lath\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Lath\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/sms/smssend.md","siteName":"Lath","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","icon":"square-terminal","groups":[{"group":"Overview","pages":[{"title":"API reference","sidebarTitle":"Introduction","icon":"book-open","href":"/api-reference/introduction"}]},{"group":"API reference","pages":[{"group":"Auth","pages":[{"title":"auth.device.approve","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/device/approve","href":"/api-reference/auth/authdeviceapprove"},{"title":"auth.device.describe","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/device/describe","href":"/api-reference/auth/authdevicedescribe"},{"title":"auth.device.poll","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/device/poll","href":"/api-reference/auth/authdevicepoll"},{"title":"auth.device.start","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/device/start","href":"/api-reference/auth/authdevicestart"},{"title":"auth.factor.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/factor/list","href":"/api-reference/auth/authfactorlist"},{"title":"auth.factor.recovery.regenerate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/factor/recovery/regenerate","href":"/api-reference/auth/authfactorrecoveryregenerate"},{"title":"auth.factor.remove","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/factor/remove","href":"/api-reference/auth/authfactorremove"},{"title":"auth.factor.totp.activate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/factor/totp/activate","href":"/api-reference/auth/authfactortotpactivate"},{"title":"auth.factor.totp.enroll","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/factor/totp/enroll","href":"/api-reference/auth/authfactortotpenroll"},{"title":"auth.identity.add","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/identity/add","href":"/api-reference/auth/authidentityadd"},{"title":"auth.identity.remove","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/identity/remove","href":"/api-reference/auth/authidentityremove"},{"title":"auth.identity.verify","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/identity/verify","href":"/api-reference/auth/authidentityverify"},{"title":"auth.invitation.create","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/invitation/create","href":"/api-reference/auth/authinvitationcreate"},{"title":"auth.invitation.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/invitation/list","href":"/api-reference/auth/authinvitationlist"},{"title":"auth.invitation.revoke","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/invitation/revoke","href":"/api-reference/auth/authinvitationrevoke"},{"title":"auth.link.complete","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/link/complete","href":"/api-reference/auth/authlinkcomplete"},{"title":"auth.mfa.verify","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/mfa/verify","href":"/api-reference/auth/authmfaverify"},{"title":"auth.oauth.app.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/oauth/app/list","href":"/api-reference/auth/authoauthapplist"},{"title":"auth.oauth.app.remove","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/oauth/app/remove","href":"/api-reference/auth/authoauthappremove"},{"title":"auth.oauth.app.set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/oauth/app/set","href":"/api-reference/auth/authoauthappset"},{"title":"auth.oauth.complete","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/oauth/complete","href":"/api-reference/auth/authoauthcomplete"},{"title":"auth.oauth.start","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/oauth/start","href":"/api-reference/auth/authoauthstart"},{"title":"auth.org.create","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/org/create","href":"/api-reference/auth/authorgcreate"},{"title":"auth.org.delete","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/org/delete","href":"/api-reference/auth/authorgdelete"},{"title":"auth.org.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/org/get","href":"/api-reference/auth/authorgget"},{"title":"auth.org.invite.accept","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/org/invite/accept","href":"/api-reference/auth/authorginviteaccept"},{"title":"auth.org.invite.create","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/org/invite/create","href":"/api-reference/auth/authorginvitecreate"},{"title":"auth.org.invite.revoke","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/org/invite/revoke","href":"/api-reference/auth/authorginviterevoke"},{"title":"auth.org.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/org/list","href":"/api-reference/auth/authorglist"},{"title":"auth.org.member.remove","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/org/member/remove","href":"/api-reference/auth/authorgmemberremove"},{"title":"auth.org.member.update","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/org/member/update","href":"/api-reference/auth/authorgmemberupdate"},{"title":"auth.org.switch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/org/switch","href":"/api-reference/auth/authorgswitch"},{"title":"auth.org.update","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/org/update","href":"/api-reference/auth/authorgupdate"},{"title":"auth.organization.create","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/organization/create","href":"/api-reference/auth/authorganizationcreate"},{"title":"auth.organization.delete","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/organization/delete","href":"/api-reference/auth/authorganizationdelete"},{"title":"auth.organization.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/organization/get","href":"/api-reference/auth/authorganizationget"},{"title":"auth.organization.invite.create","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/organization/invite/create","href":"/api-reference/auth/authorganizationinvitecreate"},{"title":"auth.organization.invite.revoke","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/organization/invite/revoke","href":"/api-reference/auth/authorganizationinviterevoke"},{"title":"auth.organization.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/organization/list","href":"/api-reference/auth/authorganizationlist"},{"title":"auth.organization.member.remove","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/organization/member/remove","href":"/api-reference/auth/authorganizationmemberremove"},{"title":"auth.organization.member.update","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/organization/member/update","href":"/api-reference/auth/authorganizationmemberupdate"},{"title":"auth.organization.update","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/organization/update","href":"/api-reference/auth/authorganizationupdate"},{"title":"auth.passkey.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/passkey/list","href":"/api-reference/auth/authpasskeylist"},{"title":"auth.passkey.register.start","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/passkey/register/start","href":"/api-reference/auth/authpasskeyregisterstart"},{"title":"auth.passkey.register.verify","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/passkey/register/verify","href":"/api-reference/auth/authpasskeyregisterverify"},{"title":"auth.passkey.remove","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/passkey/remove","href":"/api-reference/auth/authpasskeyremove"},{"title":"auth.passkey.signin.start","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/passkey/signin/start","href":"/api-reference/auth/authpasskeysigninstart"},{"title":"auth.passkey.signin.verify","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/passkey/signin/verify","href":"/api-reference/auth/authpasskeysigninverify"},{"title":"auth.password.remove","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/password/remove","href":"/api-reference/auth/authpasswordremove"},{"title":"auth.password.set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/password/set","href":"/api-reference/auth/authpasswordset"},{"title":"auth.password.signin","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/password/signin","href":"/api-reference/auth/authpasswordsignin"},{"title":"auth.session.exchange","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/session/exchange","href":"/api-reference/auth/authsessionexchange"},{"title":"auth.session.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/session/list","href":"/api-reference/auth/authsessionlist"},{"title":"auth.session.mine","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/session/mine","href":"/api-reference/auth/authsessionmine"},{"title":"auth.session.refresh","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/session/refresh","href":"/api-reference/auth/authsessionrefresh"},{"title":"auth.session.revoke","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/session/revoke","href":"/api-reference/auth/authsessionrevoke"},{"title":"auth.session.revokeMine","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/session/revokeMine","href":"/api-reference/auth/authsessionrevokemine"},{"title":"auth.session.signout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/session/signout","href":"/api-reference/auth/authsessionsignout"},{"title":"auth.settings.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/settings/get","href":"/api-reference/auth/authsettingsget"},{"title":"auth.settings.reset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/settings/reset","href":"/api-reference/auth/authsettingsreset"},{"title":"auth.settings.set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/settings/set","href":"/api-reference/auth/authsettingsset"},{"title":"auth.signin.start","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/signin/start","href":"/api-reference/auth/authsigninstart"},{"title":"auth.signin.verify","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/signin/verify","href":"/api-reference/auth/authsigninverify"},{"title":"auth.signingKey.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/signingKey/list","href":"/api-reference/auth/authsigningkeylist"},{"title":"auth.signingKey.retire","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/signingKey/retire","href":"/api-reference/auth/authsigningkeyretire"},{"title":"auth.signingKey.rotate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/signingKey/rotate","href":"/api-reference/auth/authsigningkeyrotate"},{"title":"auth.user.ban","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/user/ban","href":"/api-reference/auth/authuserban"},{"title":"auth.user.create","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/user/create","href":"/api-reference/auth/authusercreate"},{"title":"auth.user.credential.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/user/credential/list","href":"/api-reference/auth/authusercredentiallist"},{"title":"auth.user.delete","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/user/delete","href":"/api-reference/auth/authuserdelete"},{"title":"auth.user.export","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/user/export","href":"/api-reference/auth/authuserexport"},{"title":"auth.user.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/user/get","href":"/api-reference/auth/authuserget"},{"title":"auth.user.impersonate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/user/impersonate","href":"/api-reference/auth/authuserimpersonate"},{"title":"auth.user.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/user/list","href":"/api-reference/auth/authuserlist"},{"title":"auth.user.me","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/user/me","href":"/api-reference/auth/authuserme"},{"title":"auth.user.unban","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/user/unban","href":"/api-reference/auth/authuserunban"},{"title":"auth.user.update","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/user/update","href":"/api-reference/auth/authuserupdate"},{"title":"auth.user.updateMe","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/user/updateMe","href":"/api-reference/auth/authuserupdateme"}]},{"group":"Email","pages":[{"title":"email.automation.activate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/automation/activate","href":"/api-reference/email/emailautomationactivate"},{"title":"email.automation.archive","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/automation/archive","href":"/api-reference/email/emailautomationarchive"},{"title":"email.automation.create","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/automation/create","href":"/api-reference/email/emailautomationcreate"},{"title":"email.automation.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/automation/get","href":"/api-reference/email/emailautomationget"},{"title":"email.automation.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/automation/list","href":"/api-reference/email/emailautomationlist"},{"title":"email.automation.pause","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/automation/pause","href":"/api-reference/email/emailautomationpause"},{"title":"email.automation.run.cancel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/automation/run/cancel","href":"/api-reference/email/emailautomationruncancel"},{"title":"email.automation.run.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/automation/run/list","href":"/api-reference/email/emailautomationrunlist"},{"title":"email.automation.update","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/automation/update","href":"/api-reference/email/emailautomationupdate"},{"title":"email.broadcast.cancel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/broadcast/cancel","href":"/api-reference/email/emailbroadcastcancel"},{"title":"email.broadcast.create","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/broadcast/create","href":"/api-reference/email/emailbroadcastcreate"},{"title":"email.broadcast.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/broadcast/get","href":"/api-reference/email/emailbroadcastget"},{"title":"email.broadcast.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/broadcast/list","href":"/api-reference/email/emailbroadcastlist"},{"title":"email.broadcast.pause","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/broadcast/pause","href":"/api-reference/email/emailbroadcastpause"},{"title":"email.broadcast.resume","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/broadcast/resume","href":"/api-reference/email/emailbroadcastresume"},{"title":"email.broadcast.send","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/broadcast/send","href":"/api-reference/email/emailbroadcastsend"},{"title":"email.broadcast.update","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/broadcast/update","href":"/api-reference/email/emailbroadcastupdate"},{"title":"email.domain.add","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/domain/add","href":"/api-reference/email/emaildomainadd"},{"title":"email.domain.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/domain/get","href":"/api-reference/email/emaildomainget"},{"title":"email.domain.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/domain/list","href":"/api-reference/email/emaildomainlist"},{"title":"email.domain.receiving.set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/domain/receiving/set","href":"/api-reference/email/emaildomainreceivingset"},{"title":"email.domain.remove","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/domain/remove","href":"/api-reference/email/emaildomainremove"},{"title":"email.domain.returnPath.set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/domain/returnPath/set","href":"/api-reference/email/emaildomainreturnpathset"},{"title":"email.domain.tracking.set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/domain/tracking/set","href":"/api-reference/email/emaildomaintrackingset"},{"title":"email.domain.verify","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/domain/verify","href":"/api-reference/email/emaildomainverify"},{"title":"email.inbound.delete","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/inbound/delete","href":"/api-reference/email/emailinbounddelete"},{"title":"email.inbound.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/inbound/get","href":"/api-reference/email/emailinboundget"},{"title":"email.inbound.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/inbound/list","href":"/api-reference/email/emailinboundlist"},{"title":"email.message.cancel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/message/cancel","href":"/api-reference/email/emailmessagecancel"},{"title":"email.message.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/message/get","href":"/api-reference/email/emailmessageget"},{"title":"email.message.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/message/list","href":"/api-reference/email/emailmessagelist"},{"title":"email.message.stats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/message/stats","href":"/api-reference/email/emailmessagestats"},{"title":"email.send","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/send","href":"/api-reference/email/emailsend"},{"title":"email.sender.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sender/get","href":"/api-reference/email/emailsenderget"},{"title":"email.sender.set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sender/set","href":"/api-reference/email/emailsenderset"},{"title":"email.template.delete","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/template/delete","href":"/api-reference/email/emailtemplatedelete"},{"title":"email.template.generate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/template/generate","href":"/api-reference/email/emailtemplategenerate"},{"title":"email.template.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/template/get","href":"/api-reference/email/emailtemplateget"},{"title":"email.template.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/template/list","href":"/api-reference/email/emailtemplatelist"},{"title":"email.template.preview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/template/preview","href":"/api-reference/email/emailtemplatepreview"},{"title":"email.template.publish","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/template/publish","href":"/api-reference/email/emailtemplatepublish"},{"title":"email.template.set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/template/set","href":"/api-reference/email/emailtemplateset"},{"title":"email.template.starter.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/template/starter/list","href":"/api-reference/email/emailtemplatestarterlist"}]},{"group":"SMS","pages":[{"title":"sms.broadcast.cancel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/broadcast/cancel","href":"/api-reference/sms/smsbroadcastcancel"},{"title":"sms.broadcast.create","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/broadcast/create","href":"/api-reference/sms/smsbroadcastcreate"},{"title":"sms.broadcast.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/broadcast/get","href":"/api-reference/sms/smsbroadcastget"},{"title":"sms.broadcast.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/broadcast/list","href":"/api-reference/sms/smsbroadcastlist"},{"title":"sms.broadcast.pause","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/broadcast/pause","href":"/api-reference/sms/smsbroadcastpause"},{"title":"sms.broadcast.resume","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/broadcast/resume","href":"/api-reference/sms/smsbroadcastresume"},{"title":"sms.broadcast.send","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/broadcast/send","href":"/api-reference/sms/smsbroadcastsend"},{"title":"sms.broadcast.update","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/broadcast/update","href":"/api-reference/sms/smsbroadcastupdate"},{"title":"sms.conversation.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/conversation/get","href":"/api-reference/sms/smsconversationget"},{"title":"sms.conversation.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/conversation/list","href":"/api-reference/sms/smsconversationlist"},{"title":"sms.message.cancel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/message/cancel","href":"/api-reference/sms/smsmessagecancel"},{"title":"sms.message.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/message/get","href":"/api-reference/sms/smsmessageget"},{"title":"sms.message.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/message/list","href":"/api-reference/sms/smsmessagelist"},{"title":"sms.message.stats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/message/stats","href":"/api-reference/sms/smsmessagestats"},{"title":"sms.number.buy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/number/buy","href":"/api-reference/sms/smsnumberbuy"},{"title":"sms.number.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/number/list","href":"/api-reference/sms/smsnumberlist"},{"title":"sms.number.release","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/number/release","href":"/api-reference/sms/smsnumberrelease"},{"title":"sms.number.search","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/number/search","href":"/api-reference/sms/smsnumbersearch"},{"title":"sms.registration.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/registration/get","href":"/api-reference/sms/smsregistrationget"},{"title":"sms.registration.submit","description":"Records this project's carrier registration details and marks it 'registering', or replaces them when the carrier asked for changes. It does not file anything with the carrier: sending the registration to the carrier is not built yet, and the tax id is checked for presence and then discarded, neither stored nor sent. On a deployment with a carrier configured, a worker checks it roughly every fifteen minutes and moves the status to 'active', 'action_needed' or 'failed' once a brand filed with the carrier can be matched to this registration; until then it stays 'registering'. US carriers refuse application-to-person traffic from an unregistered sender, so SMS cannot send until this reaches 'active'. A sole_proprietor brand takes no tax id; a standard brand requires one. Resubmitting replaces the previous details rather than adding a second registration.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/registration/submit","href":"/api-reference/sms/smsregistrationsubmit"},{"title":"sms.send","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/send","href":"/api-reference/sms/smssend"},{"title":"sms.settings.get","description":"Returns this environment's SMS settings with defaults filled in. Quiet hours are the window in which marketing texts are held rather than sent, judged in the recipient's own timezone (their contact property if set, otherwise the environment's). Transactional messages — anything sent without a consent topic — are never held.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/settings/get","href":"/api-reference/sms/smssettingsget"},{"title":"sms.settings.reset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/settings/reset","href":"/api-reference/sms/smssettingsreset"},{"title":"sms.settings.set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/settings/set","href":"/api-reference/sms/smssettingsset"},{"title":"sms.template.delete","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/template/delete","href":"/api-reference/sms/smstemplatedelete"},{"title":"sms.template.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/template/get","href":"/api-reference/sms/smstemplateget"},{"title":"sms.template.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/template/list","href":"/api-reference/sms/smstemplatelist"},{"title":"sms.template.preview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/template/preview","href":"/api-reference/sms/smstemplatepreview"},{"title":"sms.template.publish","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/template/publish","href":"/api-reference/sms/smstemplatepublish"},{"title":"sms.template.set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/template/set","href":"/api-reference/sms/smstemplateset"}]},{"group":"Audience","pages":[{"title":"audience.consent.grant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/consent/grant","href":"/api-reference/audience/audienceconsentgrant"},{"title":"audience.consent.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/consent/list","href":"/api-reference/audience/audienceconsentlist"},{"title":"audience.consent.revoke","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/consent/revoke","href":"/api-reference/audience/audienceconsentrevoke"},{"title":"audience.contact.create","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/contact/create","href":"/api-reference/audience/audiencecontactcreate"},{"title":"audience.contact.delete","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/contact/delete","href":"/api-reference/audience/audiencecontactdelete"},{"title":"audience.contact.export","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/contact/export","href":"/api-reference/audience/audiencecontactexport"},{"title":"audience.contact.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/contact/get","href":"/api-reference/audience/audiencecontactget"},{"title":"audience.contact.import","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/contact/import","href":"/api-reference/audience/audiencecontactimport"},{"title":"audience.contact.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/contact/list","href":"/api-reference/audience/audiencecontactlist"},{"title":"audience.contact.stats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/contact/stats","href":"/api-reference/audience/audiencecontactstats"},{"title":"audience.contact.update","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/contact/update","href":"/api-reference/audience/audiencecontactupdate"},{"title":"audience.optin.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/optin/get","href":"/api-reference/audience/audienceoptinget"},{"title":"audience.preferences.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/preferences/get","href":"/api-reference/audience/audiencepreferencesget"},{"title":"audience.preferences.set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/preferences/set","href":"/api-reference/audience/audiencepreferencesset"},{"title":"audience.segment.create","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/segment/create","href":"/api-reference/audience/audiencesegmentcreate"},{"title":"audience.segment.delete","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/segment/delete","href":"/api-reference/audience/audiencesegmentdelete"},{"title":"audience.segment.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/segment/get","href":"/api-reference/audience/audiencesegmentget"},{"title":"audience.segment.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/segment/list","href":"/api-reference/audience/audiencesegmentlist"},{"title":"audience.segment.preview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/segment/preview","href":"/api-reference/audience/audiencesegmentpreview"},{"title":"audience.segment.update","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/segment/update","href":"/api-reference/audience/audiencesegmentupdate"},{"title":"audience.suppression.add","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/suppression/add","href":"/api-reference/audience/audiencesuppressionadd"},{"title":"audience.suppression.lift","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/suppression/lift","href":"/api-reference/audience/audiencesuppressionlift"},{"title":"audience.suppression.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/suppression/list","href":"/api-reference/audience/audiencesuppressionlist"},{"title":"audience.topic.archive","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/topic/archive","href":"/api-reference/audience/audiencetopicarchive"},{"title":"audience.topic.create","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/topic/create","href":"/api-reference/audience/audiencetopiccreate"},{"title":"audience.topic.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/topic/list","href":"/api-reference/audience/audiencetopiclist"},{"title":"audience.topic.restore","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/topic/restore","href":"/api-reference/audience/audiencetopicrestore"},{"title":"audience.topic.update","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audience/topic/update","href":"/api-reference/audience/audiencetopicupdate"}]},{"group":"Developers","pages":[{"title":"developers.activity.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/activity/get","href":"/api-reference/developers/developersactivityget"},{"title":"developers.activity.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/activity/list","href":"/api-reference/developers/developersactivitylist"},{"title":"developers.agent.config","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/agent/config","href":"/api-reference/developers/developersagentconfig"},{"title":"developers.agent.prompt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/agent/prompt","href":"/api-reference/developers/developersagentprompt"},{"title":"developers.events.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/events/list","href":"/api-reference/developers/developerseventslist"},{"title":"developers.events.types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/events/types","href":"/api-reference/developers/developerseventstypes"},{"title":"developers.key.create","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/key/create","href":"/api-reference/developers/developerskeycreate"},{"title":"developers.key.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/key/list","href":"/api-reference/developers/developerskeylist"},{"title":"developers.key.revoke","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/key/revoke","href":"/api-reference/developers/developerskeyrevoke"},{"title":"developers.key.rotate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/key/rotate","href":"/api-reference/developers/developerskeyrotate"},{"title":"developers.key.update","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/key/update","href":"/api-reference/developers/developerskeyupdate"},{"title":"developers.webhook.create","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/webhook/create","href":"/api-reference/developers/developerswebhookcreate"},{"title":"developers.webhook.deliveries.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/webhook/deliveries/list","href":"/api-reference/developers/developerswebhookdeliverieslist"},{"title":"developers.webhook.delivery.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/webhook/delivery/get","href":"/api-reference/developers/developerswebhookdeliveryget"},{"title":"developers.webhook.disable","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/webhook/disable","href":"/api-reference/developers/developerswebhookdisable"},{"title":"developers.webhook.enable","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/webhook/enable","href":"/api-reference/developers/developerswebhookenable"},{"title":"developers.webhook.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/webhook/list","href":"/api-reference/developers/developerswebhooklist"},{"title":"developers.webhook.replay","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/webhook/replay","href":"/api-reference/developers/developerswebhookreplay"},{"title":"developers.webhook.replayDead","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/webhook/replayDead","href":"/api-reference/developers/developerswebhookreplaydead"},{"title":"developers.webhook.secret.rotate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/webhook/secret/rotate","href":"/api-reference/developers/developerswebhooksecretrotate"},{"title":"developers.webhook.test","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/webhook/test","href":"/api-reference/developers/developerswebhooktest"},{"title":"developers.webhook.update","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /developers/webhook/update","href":"/api-reference/developers/developerswebhookupdate"}]},{"group":"Billing","pages":[{"title":"billing.credit.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /billing/credit/list","href":"/api-reference/billing/billingcreditlist"},{"title":"billing.credit.record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /billing/credit/record","href":"/api-reference/billing/billingcreditrecord"},{"title":"billing.credit.reverse","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /billing/credit/reverse","href":"/api-reference/billing/billingcreditreverse"},{"title":"billing.invoice.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /billing/invoice/get","href":"/api-reference/billing/billinginvoiceget"},{"title":"billing.invoice.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /billing/invoice/list","href":"/api-reference/billing/billinginvoicelist"},{"title":"billing.passthrough.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /billing/passthrough/list","href":"/api-reference/billing/billingpassthroughlist"},{"title":"billing.passthrough.record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /billing/passthrough/record","href":"/api-reference/billing/billingpassthroughrecord"},{"title":"billing.payment.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /billing/payment/get","href":"/api-reference/billing/billingpaymentget"},{"title":"billing.payment.refresh","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /billing/payment/refresh","href":"/api-reference/billing/billingpaymentrefresh"},{"title":"billing.payment.setup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /billing/payment/setup","href":"/api-reference/billing/billingpaymentsetup"},{"title":"billing.profile.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /billing/profile/get","href":"/api-reference/billing/billingprofileget"},{"title":"billing.profile.set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /billing/profile/set","href":"/api-reference/billing/billingprofileset"},{"title":"billing.usage.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /billing/usage/get","href":"/api-reference/billing/billingusageget"}]},{"group":"Account","pages":[{"title":"account.close","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /account/close","href":"/api-reference/account/accountclose"},{"title":"account.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /account/get","href":"/api-reference/account/accountget"},{"title":"account.member.accept","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /account/member/accept","href":"/api-reference/account/accountmemberaccept"},{"title":"account.member.invite","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /account/member/invite","href":"/api-reference/account/accountmemberinvite"},{"title":"account.member.list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /account/member/list","href":"/api-reference/account/accountmemberlist"},{"title":"account.member.remove","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /account/member/remove","href":"/api-reference/account/accountmemberremove"},{"title":"account.member.update","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /account/member/update","href":"/api-reference/account/accountmemberupdate"},{"title":"account.reopen","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /account/reopen","href":"/api-reference/account/accountreopen"},{"title":"account.signup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /account/signup","href":"/api-reference/account/accountsignup"},{"title":"account.theme.get","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /account/theme/get","href":"/api-reference/account/accountthemeget"},{"title":"account.theme.publish","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /account/theme/publish","href":"/api-reference/account/accountthemepublish"},{"title":"account.theme.reset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /account/theme/reset","href":"/api-reference/account/accountthemereset"},{"title":"account.theme.set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /account/theme/set","href":"/api-reference/account/accountthemeset"},{"title":"account.update","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /account/update","href":"/api-reference/account/accountupdate"}]},{"group":"Platform","pages":[{"title":"Liveness and database reachability","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /health","href":"/api-reference/platform/liveness-and-database-reachability"},{"title":"This document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /openapi.json","href":"/api-reference/platform/this-document"},{"title":"Model Context Protocol endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /mcp","href":"/api-reference/platform/model-context-protocol-endpoint"},{"title":"The rate book","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /pricing","href":"/api-reference/platform/the-rate-book"},{"title":"Public keys for verifying access tokens","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /auth/jwks/{environmentId}","href":"/api-reference/platform/public-keys-for-verifying-access-tokens"},{"title":"The environment's published theme","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /auth/theme/{environmentId}","href":"/api-reference/platform/the-environments-published-theme"},{"title":"The public subset of sign-in settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /auth/settings/{environmentId}","href":"/api-reference/platform/the-public-subset-of-sign-in-settings"},{"title":"Console bootstrap","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /console/config","href":"/api-reference/platform/console-bootstrap"},{"title":"Accounts this person can open","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /console/accounts","href":"/api-reference/platform/accounts-this-person-can-open"}]}]},{"group":"Catalogues","pages":[{"title":"Webhook events","icon":"radio","href":"/reference/webhook-events"},{"title":"Error codes","icon":"circle-alert","href":"/reference/error-codes"}]}]}]},"basePath":"","title":"sms.send - Lath","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}