{ "error": "Invalid recipient phone number format", "code": "invalid_phone"}
Keys requiring send approval receive 403 confirmation_required for direct sends. Use pending sends for approved single or bulk SMS. Pending sends do not support MMS.Send a single message through your sending list. Omit media for SMS, or include hosted attachments for MMS. The message is queued and assigned an opaque, variable-length identifier for tracking. A 201 response confirms queue acceptance; read the message status to check delivery.
Body Parameters
For real trial SMS, send trial_campaign_id instead of list_number and require an Idempotency-Key header. This path accepts only the group selector, to, final body, optional metadata (JSON object, at most 16,384 encoded bytes), and optional wrap_links: false. Body text must be nonempty and at most 4,096 characters. Templates, link wrapping, MMS, pending approval, provider overrides, raw/bulk and schedules are unavailable. A live key with sends.send is required; sandbox, list-restricted and approval-required keys are refused.Trial success returns 201 with success, message_id, status: "queued", trial: true and trial_campaign_id. Reuse the same idempotency key and payload for identical retries, even after an uncertain response. Unknown submission does not establish non-delivery. See trial errors and lifecycle.
string
Account-owned testing group ID for a trial send. Mutually exclusive with list_number.
string
required
Recipient phone number in E.164 format (e.g. +14155551234).
string
Required for ordinary sends: the sending list phone number in E.164 format, belonging to your account. Omit it when using trial_campaign_id.
string
Required for SMS; optional or empty for MMS. An MMS caption may contain up to 4,096 characters. Use the {{messageId}} placeholder to insert the unique message ID into the body at send time.
array
Non-empty array of hosted MMS attachments. Each object requires url and accepts optional content_type and content_id. Omit this field for SMS. See MMS for URL requirements, formats, and examples.
string
Optional MMS subject, up to 66 characters. Requires media.
boolean
default:"false"
Enables link processing for this message. Send the JSON value true or false. A non-empty linkOverrides object requires literal true; other types return invalid_wrap_links. Raw URLs typed into body are still not auto-shortened — only {{linkN}} placeholders resolved through linkOverrides are. For a click-tracked link without placeholders, create it via the Shorten Link endpoint and put the returned short URL in your body.
object
Per-placeholder link targets, keyed link1 … link99 (max 10 entries). Each entry sets exactly one of offerId (an active account-owned SMS offer), partnershipOfferId (an active, account-owned offer with offer management enabled; requires the Partnerships product), or customUrl (an absolute HTTPS URL of at most 2,048 characters on a public hostname, not an IP literal). A customUrl authority must not contain macros. Each referenced {{linkN}} is replaced with a freshly minted short URL; body placeholders without a matching override remain unchanged, and unreferenced entries create no affiliate or offer-access state. Requires wrap_links: true. productId is not supported.
string
Interstitial page for every tracked link in this message, shown before the short link redirects. One of none (redirect straight away, even if the referenced SMS offer has its own interstitial), list_default (the sending list’s default interstitial page; a list without one redirects straight away), or custom (the page described by interstitial). Omit it to keep each referenced SMS offer’s own setting. Requires wrap_links: true and at least one {{linkN}} placeholder backed by linkOverrides; applies to all of them, including every customUrl link, so put an opt-out or unsubscribe page behind a tracked link only if you want it shown there too.
object
Custom interstitial page for this message’s tracked links; supplying it implies interstitialMode: "custom", and it must not be empty. Keys, all optional: title, description, cta (button text), meta_title, meta_description (page metadata), meta_image (absolute HTTP(S) URL used for the Open Graph image and the blurred background), meta_favicon (absolute HTTP(S) URL or inline SVG markup), auto_redirect (boolean; continues automatically after a short pause) and redirect_text (the button text while auto-redirecting). Text values are limited to 2,000 characters, meta_image to 2,048 characters, meta_favicon to 4,096 UTF-8 bytes on this endpoint. Unknown keys are rejected. /v2/send-raw mints no tracked links and refuses both fields with 400 interstitial_requires_links.
object
Optional per-contact data for macro substitution. Supports first_name (string), last_name (string), custom_fields (object), and timezone (string). These values are used to populate template variables like {{first_name}} in the message body. Trackly fills {{contactId}} and {{listContactId}} itself from the recipient’s subscription to the sending list; they resolve to an empty string when the recipient is not on the list and cannot be set through contact_data.
object
Optional key-value metadata dictionary. Ordinary sends currently accept but do not retain this field. Trial sends retain encrypted metadata and include it in events where outgoing-message correlation is proven.
Response Fields
boolean
Whether the message was successfully queued.
string
An opaque, variable-length message identifier for tracking delivery and clicks.
string
Current message status. Will be "queued" on successful submission.
string
"mms" for an MMS request. Omitted for SMS.
Examples
curl -X POST https://api.tracklysms.com/api/v2/send \ -H "X-Api-Key: trk_your_api_key_here" \ -H "Content-Type: application/json" \ -d '{ "to": "+14155551234", "list_number": "+18005551000", "body": "Hello! Your order is confirmed. Ref: {{messageId}}", "wrap_links": true }'
import requestsresponse = requests.post( "https://api.tracklysms.com/api/v2/send", headers={ "X-Api-Key": "trk_your_api_key_here", "Content-Type": "application/json", }, json={ "to": "+14155551234", "list_number": "+18005551000", "body": "Hello! Your order is confirmed. Ref: {{messageId}}", "wrap_links": True, },)data = response.json()print(data["message_id"])
const response = await fetch("https://api.tracklysms.com/api/v2/send", { method: "POST", headers: { "X-Api-Key": "trk_your_api_key_here", "Content-Type": "application/json", }, body: JSON.stringify({ to: "+14155551234", list_number: "+18005551000", body: "Hello! Your order is confirmed. Ref: {{messageId}}", wrap_links: true, }),});const data = await response.json();console.log(data.message_id);
The API key needs explicit sends.send and mms.send grants for MMS.
400
invalid_phone
The to field is not a valid E.164 phone number.
400
invalid_list_number
The list_number field is not a valid E.164 phone number.
400
invalid_contact_data
contact_data or a supported macro field has the wrong JSON type, or an RCS contact value contains invalid Unicode.
400
invalid_rcs_text
An RCS list was selected and the submitted or rendered body contains invalid Unicode.
400
invalid_wrap_links
Non-empty linkOverrides used a wrap_links value that was not a JSON boolean.
400
list_not_found
The sending list was not found or does not belong to your account.
400
webhook_not_configured
Webhook verification required before sending (BYOC lists).
400
pending_confirmation
The recipient has not confirmed their double opt-in yet, so they cannot be messaged.
400
doi_expired
The recipient never confirmed their double opt-in and the confirmation window has expired.
400
warmup_limit
The recipient is not yet eligible to be messaged under the list’s warm-up schedule.
400
contact_suppressed
The recipient is opted out or blocked and cannot receive the message.
400
link_overrides_require_wrap_links
A non-empty linkOverrides object was supplied without the literal wrap_links: true.
400
link_override_invalid
linkOverrides has the wrong type, a key or entry is malformed, more than 10 entries were supplied, an entry does not set exactly one supported arm, or a URL exceeds 2,048 characters before or after macro expansion.
400
link_override_unsafe_url
A customUrl is malformed, is not HTTPS, names an IP address or restricted hostname, contains userinfo, or contains a macro in its authority.
400
interstitial_invalid
interstitialMode is not none, list_default or custom; custom was requested without an interstitial object; interstitial is an empty object with no mode; a non-empty interstitial was combined with none or list_default; or interstitial is not an object, has an unknown key, a wrong value type, an over-long value, or a meta_image / meta_favicon that is not an HTTP(S) URL (or inline SVG for the favicon).
400
interstitial_requires_links
interstitialMode or interstitial was supplied without wrap_links: true and a {{linkN}} placeholder backed by linkOverrides.
403
partnerships_not_enabled
partnershipOfferId requires the Partnerships product on the account.
404
offer_not_found
A referenced offerId is missing, inactive, or belongs to another account.
404
partnership_offer_not_found
A referenced partnershipOfferId is missing, inactive, does not have offer management enabled, or belongs to another account.
409
offer_access_not_active
Your access to the referenced partnershipOfferId is paused or has not been approved.
409
no_domain_configured
A referenced override needs a short URL, but neither the sending list nor the account has a link-shortener domain configured.
403
list_not_allowed_for_key
The API key’s send_policy.list_numbers does not include this list_number. Applies to sandbox keys too.
429
daily_cap_exceeded
The API key’s daily_send_cap is reached for today (UTC). Sandbox sends do not count.
503
send_cap_unavailable
The daily quota check or reservation could not be confirmed; the send was refused. An uncertain reservation may still count toward today’s cap. Retry with backoff.
503
mms_unavailable
MMS sending is currently unavailable.
503
idempotency_unavailable
An MMS request supplied an Idempotency-Key, but its reservation could not be confirmed. This attempt did not run.
502
kafka_producer_failure
Publication was not confirmed; delivery may still occur and daily quota remains charged. The body includes errorCode: "KAFKA_PRODUCER_FAILURE". Reconcile the message ID when available before considering another send.
Authenticated requests can also fail with 401 invalid_credentials, 403 account_suspended, or 429 rate_limited — see Error Codes.
Next Steps
Campaign Execution
How messages flow from queue to delivery
Create Contact
Add contacts before sending
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Trackly SMS","colors":{"primary":"#84DE4D","light":"#A8E87A","dark":"#5CB030"},"favicon":"https://mintcdn.com/trackly/m198FBazwIseN-2r/images/favicon.svg?fit=max\u0026auto=format\u0026n=m198FBazwIseN-2r\u0026q=85\u0026s=61a63692248026382c71445dd67beb20","logo":{"light":"https://mintcdn.com/trackly/m198FBazwIseN-2r/images/logo-light.svg?fit=max\u0026auto=format\u0026n=m198FBazwIseN-2r\u0026q=85\u0026s=675b2c397e9309f5fea1d36c1f87c412","dark":"https://mintcdn.com/trackly/m198FBazwIseN-2r/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=m198FBazwIseN-2r\u0026q=85\u0026s=2d8dda3d4bf41d024a88f041f57b57a1"},"api":{"openapi":"openapi.json","playground":{"display":"interactive"},"mdx":{"server":"https://api.tracklysms.com/api","auth":{"method":"key","name":"X-Api-Key"}}},"background":{"decoration":null,"color":{"light":"#F3F7EF","dark":"#0C0F0C"}},"navbar":{"links":[{"label":"Discord","href":"https://discord.gg/trackly"},{"label":"Support","href":"mailto:support@tracklysms.com"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.tracklysms.com"}},"footer":{"socials":{"twitter":"https://twitter.com/tracklysms","linkedin":"https://linkedin.com/company/tracklysms"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"trackly","hasAudioNarration":false,"actualSubdomain":"trackly","customDomains":["docs.tracklysms.com"],"gitSource":{"type":"github","owner":"it-s-today-media","repo":"trackly_sms_python","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6b011652e6c40135846ae806","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Documentation","count":350},{"language":"default","tag":"API Reference","count":182},{"language":"default","tag":"Guides","count":55},{"language":"default","tag":"Voice Calls (v1)","count":33},{"language":"default","tag":"Number Requests (v2)","count":14},{"language":"default","tag":"Business Verification (v2)","count":13},{"language":"default","tag":"Platform Integrations","count":12},{"language":"default","tag":"Partner Accounts (v2)","count":11},{"language":"default","tag":"V2 API Reference","count":11},{"language":"default","tag":"Webhooks (v2)","count":11}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7SUc.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7SUc.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7SUc.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7SUc.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7SUc.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7SUc.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7SUc.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7SUc.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7SUc.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7SUc.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7SUc.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7SUc.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7SUc.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7SUc.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7SUc.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7SUc.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7SUc.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7SUc.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7SUc.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7SUc.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7SUc.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7SUc.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7SUc.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7SUc.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbY2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8L6tTN1OVgaY.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbY2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8L6tTPlOVgaY.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbY2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8L6tTOVOVgaY.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbY2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8L6tTNVOVgaY.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbY2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8L6tTNFOVgaY.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbY2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8L6tTOlOV.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\nh1,h2,h3{font-family:'JetBrains Mono', monospace;font-weight:700}body,p,li,td{font-family:'Inter', system-ui, -apple-system, sans-serif}"}]}
{"page":{"pagePath":"api-reference/v2/messages/send-single","slug":"/api-reference/v2/messages/send-single","pageMetadata":{"title":"Send Single Message","api":"POST /v2/send","description":"Queue a single SMS or MMS message to a recipient phone number.","href":"/api-reference/v2/messages/send-single"},"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: \"Queue a single SMS or MMS message to a recipient phone number.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Card,CardGroup,Heading,ParamField,ResponseField,Table}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Keys requiring send approval receive `,_jsx(_components.code,{children:`403 confirmation_required`}),` for direct sends. Use `,_jsx(_components.a,{href:`/api-reference/v2/pending-sends/create`,children:`pending sends`}),` for approved single or bulk SMS. Pending sends do not support MMS.`]}),`\n`,_jsxs(_components.p,{children:[`Send a single message through your sending list. Omit `,_jsx(_components.code,{children:`media`}),` for SMS, or include hosted attachments for MMS. The message is queued and assigned an opaque, variable-length identifier for tracking. A `,_jsx(_components.code,{children:`201`}),` response confirms queue acceptance; read the `,_jsx(_components.a,{href:`/api-reference/v2/messages/get-message`,children:`message status`}),` to check delivery.`]}),`\n`,_jsx(Heading,{level:`2`,id:`body-parameters`,children:`Body Parameters`}),`\n`,_jsxs(_components.p,{children:[`For `,_jsx(_components.a,{href:`/guides/trial-sms`,children:`real trial SMS`}),`, send `,_jsx(_components.code,{children:`trial_campaign_id`}),` instead of `,_jsx(_components.code,{children:`list_number`}),` and require an `,_jsx(_components.code,{children:`Idempotency-Key`}),` header. This path accepts only the group selector, `,_jsx(_components.code,{children:`to`}),`, final `,_jsx(_components.code,{children:`body`}),`, optional `,_jsx(_components.code,{children:`metadata`}),` (JSON object, at most 16,384 encoded bytes), and optional `,_jsx(_components.code,{children:`wrap_links: false`}),`. Body text must be nonempty and at most 4,096 characters. Templates, link wrapping, MMS, pending approval, provider overrides, raw/bulk and schedules are unavailable. A live key with `,_jsx(_components.code,{children:`sends.send`}),` is required; sandbox, list-restricted and approval-required keys are refused.`]}),`\n`,_jsxs(_components.p,{children:[`Trial success returns `,_jsx(_components.code,{children:`201`}),` with `,_jsx(_components.code,{children:`success`}),`, `,_jsx(_components.code,{children:`message_id`}),`, `,_jsx(_components.code,{children:`status: \"queued\"`}),`, `,_jsx(_components.code,{children:`trial: true`}),` and `,_jsx(_components.code,{children:`trial_campaign_id`}),`. Reuse the same idempotency key and payload for identical retries, even after an uncertain response. Unknown submission does not establish non-delivery. See `,_jsx(_components.a,{href:`/guides/trial-sms`,children:`trial errors and lifecycle`}),`.`]}),`\n`,_jsx(ParamField,{body:`trial_campaign_id`,type:`string`,id:`param-trial-campaign-id`,children:_jsxs(_components.p,{children:[`Account-owned testing group ID for a trial send. Mutually exclusive with `,_jsx(_components.code,{children:`list_number`}),`.`]})}),`\n`,_jsx(ParamField,{body:`to`,type:`string`,required:true,id:`param-to`,children:_jsxs(_components.p,{children:[`Recipient phone number in E.164 format (e.g. `,_jsx(_components.code,{children:`+14155551234`}),`).`]})}),`\n`,_jsx(ParamField,{body:`list_number`,type:`string`,id:`param-list-number`,children:_jsxs(_components.p,{children:[`Required for ordinary sends: the sending list phone number in E.164 format, belonging to your account. Omit it when using `,_jsx(_components.code,{children:`trial_campaign_id`}),`.`]})}),`\n`,_jsx(ParamField,{body:`body`,type:`string`,id:`param-body`,children:_jsxs(_components.p,{children:[`Required for SMS; optional or empty for MMS. An MMS caption may contain up to 4,096 characters. Use the `,_jsx(_components.code,{children:`{{messageId}}`}),` placeholder to insert the unique message ID into the body at send time.`]})}),`\n`,_jsx(ParamField,{body:`media`,type:`array`,id:`param-media`,children:_jsxs(_components.p,{children:[`Non-empty array of hosted MMS attachments. Each object requires `,_jsx(_components.code,{children:`url`}),` and accepts optional `,_jsx(_components.code,{children:`content_type`}),` and `,_jsx(_components.code,{children:`content_id`}),`. Omit this field for SMS. See `,_jsx(_components.a,{href:`/guides/mms`,children:`MMS`}),` for URL requirements, formats, and examples.`]})}),`\n`,_jsx(ParamField,{body:`subject`,type:`string`,id:`param-subject`,children:_jsxs(_components.p,{children:[`Optional MMS subject, up to 66 characters. Requires `,_jsx(_components.code,{children:`media`}),`.`]})}),`\n`,_jsx(ParamField,{body:`wrap_links`,type:`boolean`,default:`false`,id:`param-wrap-links`,children:_jsxs(_components.p,{children:[`Enables link processing for this message. Send the JSON value `,_jsx(_components.code,{children:`true`}),` or `,_jsx(_components.code,{children:`false`}),`. A non-empty `,_jsx(_components.code,{children:`linkOverrides`}),` object requires literal `,_jsx(_components.code,{children:`true`}),`; other types return `,_jsx(_components.code,{children:`invalid_wrap_links`}),`. Raw URLs typed into `,_jsx(_components.code,{children:`body`}),` are still `,_jsx(_components.strong,{children:`not`}),` auto-shortened — only `,_jsx(_components.code,{children:`{{linkN}}`}),` placeholders resolved through `,_jsx(_components.code,{children:`linkOverrides`}),` are. For a click-tracked link without placeholders, create it via the `,_jsx(_components.a,{href:`/api-reference/v2/links/shorten-link`,children:`Shorten Link`}),` endpoint and put the returned short URL in your body.`]})}),`\n`,_jsx(ParamField,{body:`linkOverrides`,type:`object`,id:`param-link-overrides`,children:_jsxs(_components.p,{children:[`Per-placeholder link targets, keyed `,_jsx(_components.code,{children:`link1`}),` … `,_jsx(_components.code,{children:`link99`}),` (max 10 entries). Each entry sets `,_jsx(_components.strong,{children:`exactly one`}),` of `,_jsx(_components.code,{children:`offerId`}),` (an active account-owned SMS offer), `,_jsx(_components.code,{children:`partnershipOfferId`}),` (an active, account-owned offer with offer management enabled; requires the Partnerships product), or `,_jsx(_components.code,{children:`customUrl`}),` (an absolute HTTPS URL of at most 2,048 characters on a public hostname, not an IP literal). A `,_jsx(_components.code,{children:`customUrl`}),` authority must not contain macros. Each referenced `,_jsx(_components.code,{children:`{{linkN}}`}),` is replaced with a freshly minted short URL; body placeholders without a matching override remain unchanged, and unreferenced entries create no affiliate or offer-access state. Requires `,_jsx(_components.code,{children:`wrap_links: true`}),`. `,_jsx(_components.code,{children:`productId`}),` is not supported.`]})}),`\n`,_jsx(ParamField,{body:`interstitialMode`,type:`string`,id:`param-interstitial-mode`,children:_jsxs(_components.p,{children:[`Interstitial page for every tracked link in this message, shown before the short link redirects. One of `,_jsx(_components.code,{children:`none`}),` (redirect straight away, even if the referenced SMS offer has its own interstitial), `,_jsx(_components.code,{children:`list_default`}),` (the sending list’s default interstitial page; a list without one redirects straight away), or `,_jsx(_components.code,{children:`custom`}),` (the page described by `,_jsx(_components.code,{children:`interstitial`}),`). Omit it to keep each referenced SMS offer’s own setting. Requires `,_jsx(_components.code,{children:`wrap_links: true`}),` and at least one `,_jsx(_components.code,{children:`{{linkN}}`}),` placeholder backed by `,_jsx(_components.code,{children:`linkOverrides`}),`; applies to all of them, including every `,_jsx(_components.code,{children:`customUrl`}),` link, so put an opt-out or unsubscribe page behind a tracked link only if you want it shown there too.`]})}),`\n`,_jsx(ParamField,{body:`interstitial`,type:`object`,id:`param-interstitial`,children:_jsxs(_components.p,{children:[`Custom interstitial page for this message’s tracked links; supplying it implies `,_jsx(_components.code,{children:`interstitialMode: \"custom\"`}),`, and it must not be empty. Keys, all optional: `,_jsx(_components.code,{children:`title`}),`, `,_jsx(_components.code,{children:`description`}),`, `,_jsx(_components.code,{children:`cta`}),` (button text), `,_jsx(_components.code,{children:`meta_title`}),`, `,_jsx(_components.code,{children:`meta_description`}),` (page metadata), `,_jsx(_components.code,{children:`meta_image`}),` (absolute HTTP(S) URL used for the Open Graph image and the blurred background), `,_jsx(_components.code,{children:`meta_favicon`}),` (absolute HTTP(S) URL or inline SVG markup), `,_jsx(_components.code,{children:`auto_redirect`}),` (boolean; continues automatically after a short pause) and `,_jsx(_components.code,{children:`redirect_text`}),` (the button text while auto-redirecting). Text values are limited to 2,000 characters, `,_jsx(_components.code,{children:`meta_image`}),` to 2,048 characters, `,_jsx(_components.code,{children:`meta_favicon`}),` to 4,096 UTF-8 bytes on this endpoint. Unknown keys are rejected. `,_jsx(_components.code,{children:`/v2/send-raw`}),` mints no tracked links and refuses both fields with `,_jsx(_components.code,{children:`400 interstitial_requires_links`}),`.`]})}),`\n`,_jsx(ParamField,{body:`contact_data`,type:`object`,id:`param-contact-data`,children:_jsxs(_components.p,{children:[`Optional per-contact data for macro substitution. Supports `,_jsx(_components.code,{children:`first_name`}),` (string), `,_jsx(_components.code,{children:`last_name`}),` (string), `,_jsx(_components.code,{children:`custom_fields`}),` (object), and `,_jsx(_components.code,{children:`timezone`}),` (string). These values are used to populate template variables like `,_jsx(_components.code,{children:`{{first_name}}`}),` in the message body. Trackly fills `,_jsx(_components.code,{children:`{{contactId}}`}),` and `,_jsx(_components.code,{children:`{{listContactId}}`}),` itself from the recipient’s subscription to the sending list; they resolve to an empty string when the recipient is not on the list and cannot be set through `,_jsx(_components.code,{children:`contact_data`}),`.`]})}),`\n`,_jsx(ParamField,{body:`metadata`,type:`object`,id:`param-metadata`,children:_jsx(_components.p,{children:`Optional key-value metadata dictionary. Ordinary sends currently accept but do not retain this field. Trial sends retain encrypted metadata and include it in events where outgoing-message correlation is proven.`})}),`\n`,_jsx(Heading,{level:`2`,id:`response-fields`,children:`Response Fields`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success`,children:_jsx(_components.p,{children:`Whether the message was successfully queued.`})}),`\n`,_jsx(ResponseField,{name:`message_id`,type:`string`,id:`param-message-id`,children:_jsx(_components.p,{children:`An opaque, variable-length message identifier for tracking delivery and clicks.`})}),`\n`,_jsx(ResponseField,{name:`status`,type:`string`,id:`param-status`,children:_jsxs(_components.p,{children:[`Current message status. Will be `,_jsx(_components.code,{children:`\"queued\"`}),` on successful submission.`]})}),`\n`,_jsx(ResponseField,{name:`message_type`,type:`string`,id:`param-message-type`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`\"mms\"`}),` for an MMS request. Omitted for SMS.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`examples`,children:`Examples`}),`\n`,`\n`,`\n`,_jsx(Heading,{level:`2`,id:`error-codes`,children:`Error Codes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`HTTP Status`}),_jsx(_components.th,{children:`Error Code`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`missing_to`})}),_jsxs(_components.td,{children:[`The `,_jsx(_components.code,{children:`to`}),` field is required but was not provided.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`missing_list_number`})}),_jsxs(_components.td,{children:[`The `,_jsx(_components.code,{children:`list_number`}),` field is required but was not provided.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`missing_body`})}),_jsxs(_components.td,{children:[`The SMS `,_jsx(_components.code,{children:`body`}),` field is required but was not provided.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_mms_media`})}),_jsxs(_components.td,{children:[`MMS media, subject, or caption fail the `,_jsx(_components.a,{href:`/guides/mms#request-requirements`,children:`request requirements`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`mms_not_supported`})}),_jsx(_components.td,{children:`The sending number does not support MMS.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`mms_account_disabled`})}),_jsx(_components.td,{children:`MMS is not enabled for this account.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`insufficient_scope`})}),_jsxs(_components.td,{children:[`The API key needs explicit `,_jsx(_components.code,{children:`sends.send`}),` and `,_jsx(_components.code,{children:`mms.send`}),` grants for MMS.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_phone`})}),_jsxs(_components.td,{children:[`The `,_jsx(_components.code,{children:`to`}),` field is not a valid E.164 phone number.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_list_number`})}),_jsxs(_components.td,{children:[`The `,_jsx(_components.code,{children:`list_number`}),` field is not a valid E.164 phone number.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_contact_data`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`contact_data`}),` or a supported macro field has the wrong JSON type, or an RCS contact value contains invalid Unicode.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_rcs_text`})}),_jsx(_components.td,{children:`An RCS list was selected and the submitted or rendered body contains invalid Unicode.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_wrap_links`})}),_jsxs(_components.td,{children:[`Non-empty `,_jsx(_components.code,{children:`linkOverrides`}),` used a `,_jsx(_components.code,{children:`wrap_links`}),` value that was not a JSON boolean.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`list_not_found`})}),_jsx(_components.td,{children:`The sending list was not found or does not belong to your account.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`webhook_not_configured`})}),_jsx(_components.td,{children:`Webhook verification required before sending (BYOC lists).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`pending_confirmation`})}),_jsx(_components.td,{children:`The recipient has not confirmed their double opt-in yet, so they cannot be messaged.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`doi_expired`})}),_jsx(_components.td,{children:`The recipient never confirmed their double opt-in and the confirmation window has expired.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`warmup_limit`})}),_jsx(_components.td,{children:`The recipient is not yet eligible to be messaged under the list’s warm-up schedule.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`contact_suppressed`})}),_jsx(_components.td,{children:`The recipient is opted out or blocked and cannot receive the message.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`link_overrides_require_wrap_links`})}),_jsxs(_components.td,{children:[`A non-empty `,_jsx(_components.code,{children:`linkOverrides`}),` object was supplied without the literal `,_jsx(_components.code,{children:`wrap_links: true`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`link_override_invalid`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`linkOverrides`}),` has the wrong type, a key or entry is malformed, more than 10 entries were supplied, an entry does not set exactly one supported arm, or a URL exceeds 2,048 characters before or after macro expansion.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`link_override_unsafe_url`})}),_jsxs(_components.td,{children:[`A `,_jsx(_components.code,{children:`customUrl`}),` is malformed, is not HTTPS, names an IP address or restricted hostname, contains userinfo, or contains a macro in its authority.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`interstitial_invalid`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`interstitialMode`}),` is not `,_jsx(_components.code,{children:`none`}),`, `,_jsx(_components.code,{children:`list_default`}),` or `,_jsx(_components.code,{children:`custom`}),`; `,_jsx(_components.code,{children:`custom`}),` was requested without an `,_jsx(_components.code,{children:`interstitial`}),` object; `,_jsx(_components.code,{children:`interstitial`}),` is an empty object with no mode; a non-empty `,_jsx(_components.code,{children:`interstitial`}),` was combined with `,_jsx(_components.code,{children:`none`}),` or `,_jsx(_components.code,{children:`list_default`}),`; or `,_jsx(_components.code,{children:`interstitial`}),` is not an object, has an unknown key, a wrong value type, an over-long value, or a `,_jsx(_components.code,{children:`meta_image`}),` / `,_jsx(_components.code,{children:`meta_favicon`}),` that is not an HTTP(S) URL (or inline SVG for the favicon).`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`interstitial_requires_links`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`interstitialMode`}),` or `,_jsx(_components.code,{children:`interstitial`}),` was supplied without `,_jsx(_components.code,{children:`wrap_links: true`}),` and a `,_jsx(_components.code,{children:`{{linkN}}`}),` placeholder backed by `,_jsx(_components.code,{children:`linkOverrides`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`partnerships_not_enabled`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`partnershipOfferId`}),` requires the Partnerships product on the account.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`offer_not_found`})}),_jsxs(_components.td,{children:[`A referenced `,_jsx(_components.code,{children:`offerId`}),` is missing, inactive, or belongs to another account.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`partnership_offer_not_found`})}),_jsxs(_components.td,{children:[`A referenced `,_jsx(_components.code,{children:`partnershipOfferId`}),` is missing, inactive, does not have offer management enabled, or belongs to another account.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`409`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`offer_access_not_active`})}),_jsxs(_components.td,{children:[`Your access to the referenced `,_jsx(_components.code,{children:`partnershipOfferId`}),` is paused or has not been approved.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`409`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`no_domain_configured`})}),_jsx(_components.td,{children:`A referenced override needs a short URL, but neither the sending list nor the account has a link-shortener domain configured.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`list_not_allowed_for_key`})}),_jsxs(_components.td,{children:[`The API key’s `,_jsx(_components.code,{children:`send_policy.list_numbers`}),` does not include this `,_jsx(_components.code,{children:`list_number`}),`. Applies to sandbox keys too.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`429`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`daily_cap_exceeded`})}),_jsxs(_components.td,{children:[`The API key’s `,_jsx(_components.code,{children:`daily_send_cap`}),` is reached for today (UTC). Sandbox sends do not count.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`503`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`send_cap_unavailable`})}),_jsx(_components.td,{children:`The daily quota check or reservation could not be confirmed; the send was refused. An uncertain reservation may still count toward today’s cap. Retry with backoff.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`503`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`mms_unavailable`})}),_jsx(_components.td,{children:`MMS sending is currently unavailable.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`503`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`idempotency_unavailable`})}),_jsxs(_components.td,{children:[`An MMS request supplied an `,_jsx(_components.code,{children:`Idempotency-Key`}),`, but its reservation could not be confirmed. This attempt did not run.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`502`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`kafka_producer_failure`})}),_jsxs(_components.td,{children:[`Publication was not confirmed; delivery may still occur and daily quota remains charged. The body includes `,_jsx(_components.code,{children:`errorCode: \"KAFKA_PRODUCER_FAILURE\"`}),`. Reconcile the message ID when available before considering another send.`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Authenticated requests can also fail with `,_jsx(_components.code,{children:`401 invalid_credentials`}),`, `,_jsx(_components.code,{children:`403 account_suspended`}),`, or `,_jsx(_components.code,{children:`429 rate_limited`}),` — see `,_jsx(_components.a,{href:`/api-reference/v2/error-codes`,children:`Error Codes`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`next-steps`,children:`Next Steps`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Campaign Execution`,icon:`rocket`,href:`/guides/campaigns/execution`,children:_jsx(_components.p,{children:`How messages flow from queue to delivery`})}),_jsx(Card,{title:`Create Contact`,icon:`user-plus`,href:`/api-reference/v2/contacts/create-contact`,children:_jsx(_components.p,{children:`Add contacts before sending`})})]})]})}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 Single Message","api":"POST /v2/send","description":"Queue a single SMS or MMS message to a recipient phone number.","href":"/api-reference/v2/messages/send-single"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Card,CardGroup,CodeBlock,Heading,ParamField,RequestExample,ResponseExample,ResponseField,Table}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Keys requiring send approval receive `,_jsx(_components.code,{children:`403 confirmation_required`}),` for direct sends. Use `,_jsx(_components.a,{href:`/api-reference/v2/pending-sends/create`,children:`pending sends`}),` for approved single or bulk SMS. Pending sends do not support MMS.`]}),`\n`,_jsxs(_components.p,{children:[`Send a single message through your sending list. Omit `,_jsx(_components.code,{children:`media`}),` for SMS, or include hosted attachments for MMS. The message is queued and assigned an opaque, variable-length identifier for tracking. A `,_jsx(_components.code,{children:`201`}),` response confirms queue acceptance; read the `,_jsx(_components.a,{href:`/api-reference/v2/messages/get-message`,children:`message status`}),` to check delivery.`]}),`\n`,_jsx(Heading,{level:`2`,id:`body-parameters`,children:`Body Parameters`}),`\n`,_jsxs(_components.p,{children:[`For `,_jsx(_components.a,{href:`/guides/trial-sms`,children:`real trial SMS`}),`, send `,_jsx(_components.code,{children:`trial_campaign_id`}),` instead of `,_jsx(_components.code,{children:`list_number`}),` and require an `,_jsx(_components.code,{children:`Idempotency-Key`}),` header. This path accepts only the group selector, `,_jsx(_components.code,{children:`to`}),`, final `,_jsx(_components.code,{children:`body`}),`, optional `,_jsx(_components.code,{children:`metadata`}),` (JSON object, at most 16,384 encoded bytes), and optional `,_jsx(_components.code,{children:`wrap_links: false`}),`. Body text must be nonempty and at most 4,096 characters. Templates, link wrapping, MMS, pending approval, provider overrides, raw/bulk and schedules are unavailable. A live key with `,_jsx(_components.code,{children:`sends.send`}),` is required; sandbox, list-restricted and approval-required keys are refused.`]}),`\n`,_jsxs(_components.p,{children:[`Trial success returns `,_jsx(_components.code,{children:`201`}),` with `,_jsx(_components.code,{children:`success`}),`, `,_jsx(_components.code,{children:`message_id`}),`, `,_jsx(_components.code,{children:`status: \"queued\"`}),`, `,_jsx(_components.code,{children:`trial: true`}),` and `,_jsx(_components.code,{children:`trial_campaign_id`}),`. Reuse the same idempotency key and payload for identical retries, even after an uncertain response. Unknown submission does not establish non-delivery. See `,_jsx(_components.a,{href:`/guides/trial-sms`,children:`trial errors and lifecycle`}),`.`]}),`\n`,_jsx(ParamField,{body:`trial_campaign_id`,type:`string`,id:`param-trial-campaign-id`,children:_jsxs(_components.p,{children:[`Account-owned testing group ID for a trial send. Mutually exclusive with `,_jsx(_components.code,{children:`list_number`}),`.`]})}),`\n`,_jsx(ParamField,{body:`to`,type:`string`,required:true,id:`param-to`,children:_jsxs(_components.p,{children:[`Recipient phone number in E.164 format (e.g. `,_jsx(_components.code,{children:`+14155551234`}),`).`]})}),`\n`,_jsx(ParamField,{body:`list_number`,type:`string`,id:`param-list-number`,children:_jsxs(_components.p,{children:[`Required for ordinary sends: the sending list phone number in E.164 format, belonging to your account. Omit it when using `,_jsx(_components.code,{children:`trial_campaign_id`}),`.`]})}),`\n`,_jsx(ParamField,{body:`body`,type:`string`,id:`param-body`,children:_jsxs(_components.p,{children:[`Required for SMS; optional or empty for MMS. An MMS caption may contain up to 4,096 characters. Use the `,_jsx(_components.code,{children:`{{messageId}}`}),` placeholder to insert the unique message ID into the body at send time.`]})}),`\n`,_jsx(ParamField,{body:`media`,type:`array`,id:`param-media`,children:_jsxs(_components.p,{children:[`Non-empty array of hosted MMS attachments. Each object requires `,_jsx(_components.code,{children:`url`}),` and accepts optional `,_jsx(_components.code,{children:`content_type`}),` and `,_jsx(_components.code,{children:`content_id`}),`. Omit this field for SMS. See `,_jsx(_components.a,{href:`/guides/mms`,children:`MMS`}),` for URL requirements, formats, and examples.`]})}),`\n`,_jsx(ParamField,{body:`subject`,type:`string`,id:`param-subject`,children:_jsxs(_components.p,{children:[`Optional MMS subject, up to 66 characters. Requires `,_jsx(_components.code,{children:`media`}),`.`]})}),`\n`,_jsx(ParamField,{body:`wrap_links`,type:`boolean`,default:`false`,id:`param-wrap-links`,children:_jsxs(_components.p,{children:[`Enables link processing for this message. Send the JSON value `,_jsx(_components.code,{children:`true`}),` or `,_jsx(_components.code,{children:`false`}),`. A non-empty `,_jsx(_components.code,{children:`linkOverrides`}),` object requires literal `,_jsx(_components.code,{children:`true`}),`; other types return `,_jsx(_components.code,{children:`invalid_wrap_links`}),`. Raw URLs typed into `,_jsx(_components.code,{children:`body`}),` are still `,_jsx(_components.strong,{children:`not`}),` auto-shortened — only `,_jsx(_components.code,{children:`{{linkN}}`}),` placeholders resolved through `,_jsx(_components.code,{children:`linkOverrides`}),` are. For a click-tracked link without placeholders, create it via the `,_jsx(_components.a,{href:`/api-reference/v2/links/shorten-link`,children:`Shorten Link`}),` endpoint and put the returned short URL in your body.`]})}),`\n`,_jsx(ParamField,{body:`linkOverrides`,type:`object`,id:`param-link-overrides`,children:_jsxs(_components.p,{children:[`Per-placeholder link targets, keyed `,_jsx(_components.code,{children:`link1`}),` … `,_jsx(_components.code,{children:`link99`}),` (max 10 entries). Each entry sets `,_jsx(_components.strong,{children:`exactly one`}),` of `,_jsx(_components.code,{children:`offerId`}),` (an active account-owned SMS offer), `,_jsx(_components.code,{children:`partnershipOfferId`}),` (an active, account-owned offer with offer management enabled; requires the Partnerships product), or `,_jsx(_components.code,{children:`customUrl`}),` (an absolute HTTPS URL of at most 2,048 characters on a public hostname, not an IP literal). A `,_jsx(_components.code,{children:`customUrl`}),` authority must not contain macros. Each referenced `,_jsx(_components.code,{children:`{{linkN}}`}),` is replaced with a freshly minted short URL; body placeholders without a matching override remain unchanged, and unreferenced entries create no affiliate or offer-access state. Requires `,_jsx(_components.code,{children:`wrap_links: true`}),`. `,_jsx(_components.code,{children:`productId`}),` is not supported.`]})}),`\n`,_jsx(ParamField,{body:`interstitialMode`,type:`string`,id:`param-interstitial-mode`,children:_jsxs(_components.p,{children:[`Interstitial page for every tracked link in this message, shown before the short link redirects. One of `,_jsx(_components.code,{children:`none`}),` (redirect straight away, even if the referenced SMS offer has its own interstitial), `,_jsx(_components.code,{children:`list_default`}),` (the sending list’s default interstitial page; a list without one redirects straight away), or `,_jsx(_components.code,{children:`custom`}),` (the page described by `,_jsx(_components.code,{children:`interstitial`}),`). Omit it to keep each referenced SMS offer’s own setting. Requires `,_jsx(_components.code,{children:`wrap_links: true`}),` and at least one `,_jsx(_components.code,{children:`{{linkN}}`}),` placeholder backed by `,_jsx(_components.code,{children:`linkOverrides`}),`; applies to all of them, including every `,_jsx(_components.code,{children:`customUrl`}),` link, so put an opt-out or unsubscribe page behind a tracked link only if you want it shown there too.`]})}),`\n`,_jsx(ParamField,{body:`interstitial`,type:`object`,id:`param-interstitial`,children:_jsxs(_components.p,{children:[`Custom interstitial page for this message’s tracked links; supplying it implies `,_jsx(_components.code,{children:`interstitialMode: \"custom\"`}),`, and it must not be empty. Keys, all optional: `,_jsx(_components.code,{children:`title`}),`, `,_jsx(_components.code,{children:`description`}),`, `,_jsx(_components.code,{children:`cta`}),` (button text), `,_jsx(_components.code,{children:`meta_title`}),`, `,_jsx(_components.code,{children:`meta_description`}),` (page metadata), `,_jsx(_components.code,{children:`meta_image`}),` (absolute HTTP(S) URL used for the Open Graph image and the blurred background), `,_jsx(_components.code,{children:`meta_favicon`}),` (absolute HTTP(S) URL or inline SVG markup), `,_jsx(_components.code,{children:`auto_redirect`}),` (boolean; continues automatically after a short pause) and `,_jsx(_components.code,{children:`redirect_text`}),` (the button text while auto-redirecting). Text values are limited to 2,000 characters, `,_jsx(_components.code,{children:`meta_image`}),` to 2,048 characters, `,_jsx(_components.code,{children:`meta_favicon`}),` to 4,096 UTF-8 bytes on this endpoint. Unknown keys are rejected. `,_jsx(_components.code,{children:`/v2/send-raw`}),` mints no tracked links and refuses both fields with `,_jsx(_components.code,{children:`400 interstitial_requires_links`}),`.`]})}),`\n`,_jsx(ParamField,{body:`contact_data`,type:`object`,id:`param-contact-data`,children:_jsxs(_components.p,{children:[`Optional per-contact data for macro substitution. Supports `,_jsx(_components.code,{children:`first_name`}),` (string), `,_jsx(_components.code,{children:`last_name`}),` (string), `,_jsx(_components.code,{children:`custom_fields`}),` (object), and `,_jsx(_components.code,{children:`timezone`}),` (string). These values are used to populate template variables like `,_jsx(_components.code,{children:`{{first_name}}`}),` in the message body. Trackly fills `,_jsx(_components.code,{children:`{{contactId}}`}),` and `,_jsx(_components.code,{children:`{{listContactId}}`}),` itself from the recipient’s subscription to the sending list; they resolve to an empty string when the recipient is not on the list and cannot be set through `,_jsx(_components.code,{children:`contact_data`}),`.`]})}),`\n`,_jsx(ParamField,{body:`metadata`,type:`object`,id:`param-metadata`,children:_jsx(_components.p,{children:`Optional key-value metadata dictionary. Ordinary sends currently accept but do not retain this field. Trial sends retain encrypted metadata and include it in events where outgoing-message correlation is proven.`})}),`\n`,_jsx(Heading,{level:`2`,id:`response-fields`,children:`Response Fields`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success`,children:_jsx(_components.p,{children:`Whether the message was successfully queued.`})}),`\n`,_jsx(ResponseField,{name:`message_id`,type:`string`,id:`param-message-id`,children:_jsx(_components.p,{children:`An opaque, variable-length message identifier for tracking delivery and clicks.`})}),`\n`,_jsx(ResponseField,{name:`status`,type:`string`,id:`param-status`,children:_jsxs(_components.p,{children:[`Current message status. Will be `,_jsx(_components.code,{children:`\"queued\"`}),` on successful submission.`]})}),`\n`,_jsx(ResponseField,{name:`message_type`,type:`string`,id:`param-message-type`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`\"mms\"`}),` for an MMS request. Omitted for SMS.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`examples`,children:`Examples`}),`\n`,_jsxs(RequestExample,{children:[_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`9`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`9`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.tracklysms.com/api/v2/send`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Api-Key: trk_your_api_key_here\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"to\": \"+14155551234\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"list_number\": \"+18005551000\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"body\": \"Hello! Your order is confirmed. Ref: {{messageId}}\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"wrap_links\": true`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Python`,numberOfLines:`18`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`18`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`response `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.post(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.tracklysms.com/api/v2/send\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` headers`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Api-Key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"trk_your_api_key_here\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"application/json\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` json`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"to\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"+14155551234\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"list_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"+18005551000\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"body\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Hello! Your order is confirmed. Ref: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{{`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`messageId`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"wrap_links\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`True`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`data `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` response.json()`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"message_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`])`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Node.js`,numberOfLines:`16`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`16`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` fetch`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://api.tracklysms.com/api/v2/send\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` method:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"POST\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` headers:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Api-Key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"trk_your_api_key_here\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"application/json\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` body:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` JSON`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`stringify`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` to:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"+14155551234\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` list_number:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"+18005551000\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` body:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Hello! Your order is confirmed. Ref: {{messageId}}\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` wrap_links:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }),`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` data`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` response`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`json`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`();`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`console`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`log`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`data`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`message_id`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`]})})})]}),`\n`,_jsxs(ResponseExample,{children:[_jsx(CodeBlock,{filename:`Success (201)`,numberOfLines:`5`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"a1b2c3d4\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"queued\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Error (400)`,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Invalid recipient phone number format\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"invalid_phone\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`2`,id:`error-codes`,children:`Error Codes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`HTTP Status`}),_jsx(_components.th,{children:`Error Code`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`missing_to`})}),_jsxs(_components.td,{children:[`The `,_jsx(_components.code,{children:`to`}),` field is required but was not provided.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`missing_list_number`})}),_jsxs(_components.td,{children:[`The `,_jsx(_components.code,{children:`list_number`}),` field is required but was not provided.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`missing_body`})}),_jsxs(_components.td,{children:[`The SMS `,_jsx(_components.code,{children:`body`}),` field is required but was not provided.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_mms_media`})}),_jsxs(_components.td,{children:[`MMS media, subject, or caption fail the `,_jsx(_components.a,{href:`/guides/mms#request-requirements`,children:`request requirements`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`mms_not_supported`})}),_jsx(_components.td,{children:`The sending number does not support MMS.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`mms_account_disabled`})}),_jsx(_components.td,{children:`MMS is not enabled for this account.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`insufficient_scope`})}),_jsxs(_components.td,{children:[`The API key needs explicit `,_jsx(_components.code,{children:`sends.send`}),` and `,_jsx(_components.code,{children:`mms.send`}),` grants for MMS.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_phone`})}),_jsxs(_components.td,{children:[`The `,_jsx(_components.code,{children:`to`}),` field is not a valid E.164 phone number.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_list_number`})}),_jsxs(_components.td,{children:[`The `,_jsx(_components.code,{children:`list_number`}),` field is not a valid E.164 phone number.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_contact_data`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`contact_data`}),` or a supported macro field has the wrong JSON type, or an RCS contact value contains invalid Unicode.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_rcs_text`})}),_jsx(_components.td,{children:`An RCS list was selected and the submitted or rendered body contains invalid Unicode.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_wrap_links`})}),_jsxs(_components.td,{children:[`Non-empty `,_jsx(_components.code,{children:`linkOverrides`}),` used a `,_jsx(_components.code,{children:`wrap_links`}),` value that was not a JSON boolean.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`list_not_found`})}),_jsx(_components.td,{children:`The sending list was not found or does not belong to your account.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`webhook_not_configured`})}),_jsx(_components.td,{children:`Webhook verification required before sending (BYOC lists).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`pending_confirmation`})}),_jsx(_components.td,{children:`The recipient has not confirmed their double opt-in yet, so they cannot be messaged.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`doi_expired`})}),_jsx(_components.td,{children:`The recipient never confirmed their double opt-in and the confirmation window has expired.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`warmup_limit`})}),_jsx(_components.td,{children:`The recipient is not yet eligible to be messaged under the list’s warm-up schedule.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`contact_suppressed`})}),_jsx(_components.td,{children:`The recipient is opted out or blocked and cannot receive the message.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`link_overrides_require_wrap_links`})}),_jsxs(_components.td,{children:[`A non-empty `,_jsx(_components.code,{children:`linkOverrides`}),` object was supplied without the literal `,_jsx(_components.code,{children:`wrap_links: true`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`link_override_invalid`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`linkOverrides`}),` has the wrong type, a key or entry is malformed, more than 10 entries were supplied, an entry does not set exactly one supported arm, or a URL exceeds 2,048 characters before or after macro expansion.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`link_override_unsafe_url`})}),_jsxs(_components.td,{children:[`A `,_jsx(_components.code,{children:`customUrl`}),` is malformed, is not HTTPS, names an IP address or restricted hostname, contains userinfo, or contains a macro in its authority.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`interstitial_invalid`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`interstitialMode`}),` is not `,_jsx(_components.code,{children:`none`}),`, `,_jsx(_components.code,{children:`list_default`}),` or `,_jsx(_components.code,{children:`custom`}),`; `,_jsx(_components.code,{children:`custom`}),` was requested without an `,_jsx(_components.code,{children:`interstitial`}),` object; `,_jsx(_components.code,{children:`interstitial`}),` is an empty object with no mode; a non-empty `,_jsx(_components.code,{children:`interstitial`}),` was combined with `,_jsx(_components.code,{children:`none`}),` or `,_jsx(_components.code,{children:`list_default`}),`; or `,_jsx(_components.code,{children:`interstitial`}),` is not an object, has an unknown key, a wrong value type, an over-long value, or a `,_jsx(_components.code,{children:`meta_image`}),` / `,_jsx(_components.code,{children:`meta_favicon`}),` that is not an HTTP(S) URL (or inline SVG for the favicon).`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`interstitial_requires_links`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`interstitialMode`}),` or `,_jsx(_components.code,{children:`interstitial`}),` was supplied without `,_jsx(_components.code,{children:`wrap_links: true`}),` and a `,_jsx(_components.code,{children:`{{linkN}}`}),` placeholder backed by `,_jsx(_components.code,{children:`linkOverrides`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`partnerships_not_enabled`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`partnershipOfferId`}),` requires the Partnerships product on the account.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`offer_not_found`})}),_jsxs(_components.td,{children:[`A referenced `,_jsx(_components.code,{children:`offerId`}),` is missing, inactive, or belongs to another account.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`partnership_offer_not_found`})}),_jsxs(_components.td,{children:[`A referenced `,_jsx(_components.code,{children:`partnershipOfferId`}),` is missing, inactive, does not have offer management enabled, or belongs to another account.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`409`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`offer_access_not_active`})}),_jsxs(_components.td,{children:[`Your access to the referenced `,_jsx(_components.code,{children:`partnershipOfferId`}),` is paused or has not been approved.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`409`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`no_domain_configured`})}),_jsx(_components.td,{children:`A referenced override needs a short URL, but neither the sending list nor the account has a link-shortener domain configured.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`list_not_allowed_for_key`})}),_jsxs(_components.td,{children:[`The API key’s `,_jsx(_components.code,{children:`send_policy.list_numbers`}),` does not include this `,_jsx(_components.code,{children:`list_number`}),`. Applies to sandbox keys too.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`429`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`daily_cap_exceeded`})}),_jsxs(_components.td,{children:[`The API key’s `,_jsx(_components.code,{children:`daily_send_cap`}),` is reached for today (UTC). Sandbox sends do not count.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`503`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`send_cap_unavailable`})}),_jsx(_components.td,{children:`The daily quota check or reservation could not be confirmed; the send was refused. An uncertain reservation may still count toward today’s cap. Retry with backoff.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`503`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`mms_unavailable`})}),_jsx(_components.td,{children:`MMS sending is currently unavailable.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`503`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`idempotency_unavailable`})}),_jsxs(_components.td,{children:[`An MMS request supplied an `,_jsx(_components.code,{children:`Idempotency-Key`}),`, but its reservation could not be confirmed. This attempt did not run.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`502`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`kafka_producer_failure`})}),_jsxs(_components.td,{children:[`Publication was not confirmed; delivery may still occur and daily quota remains charged. The body includes `,_jsx(_components.code,{children:`errorCode: \"KAFKA_PRODUCER_FAILURE\"`}),`. Reconcile the message ID when available before considering another send.`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Authenticated requests can also fail with `,_jsx(_components.code,{children:`401 invalid_credentials`}),`, `,_jsx(_components.code,{children:`403 account_suspended`}),`, or `,_jsx(_components.code,{children:`429 rate_limited`}),` — see `,_jsx(_components.a,{href:`/api-reference/v2/error-codes`,children:`Error Codes`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`next-steps`,children:`Next Steps`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Campaign Execution`,icon:`rocket`,href:`/guides/campaigns/execution`,children:_jsx(_components.p,{children:`How messages flow from queue to delivery`})}),_jsx(Card,{title:`Create Contact`,icon:`user-plus`,href:`/api-reference/v2/contacts/create-contact`,children:_jsx(_components.p,{children:`Add contacts before sending`})})]})]})}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 Single Message","api":"POST /v2/send","description":"Queue a single SMS or MMS message to a recipient phone number.","href":"/api-reference/v2/messages/send-single"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Body Parameters","slug":"body-parameters","depth":2,"children":[]},{"title":"Response Fields","slug":"response-fields","depth":2,"children":[]},{"title":"Examples","slug":"examples","depth":2,"children":[]},{"title":"Error Codes","slug":"error-codes","depth":2,"children":[]},{"title":"Next Steps","slug":"next-steps","depth":2,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"cURL","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"9\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -X\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> POST\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> https://api.tracklysms.com/api/v2/send\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -H\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"X-Api-Key: trk_your_api_key_here\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -H\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Content-Type: application/json\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -d\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> '{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"to\": \"+14155551234\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"list_number\": \"+18005551000\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"body\": \"Hello! Your order is confirmed. Ref: {{messageId}}\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"wrap_links\": true\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"Python","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"python\">\u003ccode language=\"python\" numberOfLines=\"18\">\u003cspan class=\"line\">\u003cspan style=\"color:#CF222E;--shiki-dark:#C586C0\">import\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> requests\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">response \u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> requests.post(\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"https://api.tracklysms.com/api/v2/send\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#9CDCFE\"> headers\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"X-Api-Key\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"trk_your_api_key_here\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Content-Type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"application/json\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#9CDCFE\"> json\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"to\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"+14155551234\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"list_number\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"+18005551000\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"body\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Hello! Your order is confirmed. Ref: \u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#569CD6\">{{\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">messageId\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#569CD6\">}}\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"wrap_links\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">True\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">)\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">data \u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> response.json()\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#DCDCAA\">print\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">(data[\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"message_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">])\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"Node.js","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"javascript\">\u003ccode language=\"javascript\" numberOfLines=\"16\">\u003cspan class=\"line\">\u003cspan style=\"color:#CF222E;--shiki-dark:#569CD6\">const\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#4FC1FF\"> response\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\"> =\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#C586C0\"> await\u003c/span>\u003cspan style=\"color:#8250DF;--shiki-dark:#DCDCAA\"> fetch\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">(\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://api.tracklysms.com/api/v2/send\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> method:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"POST\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> headers:\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"X-Api-Key\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"trk_your_api_key_here\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Content-Type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"application/json\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> body:\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#4FC1FF\"> JSON\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">.\u003c/span>\u003cspan style=\"color:#8250DF;--shiki-dark:#DCDCAA\">stringify\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">({\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> to:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"+14155551234\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> list_number:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"+18005551000\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> body:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Hello! Your order is confirmed. Ref: {{messageId}}\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> wrap_links:\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> true\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }),\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">});\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#CF222E;--shiki-dark:#569CD6\">const\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#4FC1FF\"> data\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\"> =\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#C586C0\"> await\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> response\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">.\u003c/span>\u003cspan style=\"color:#8250DF;--shiki-dark:#DCDCAA\">json\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">();\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">console\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">.\u003c/span>\u003cspan style=\"color:#8250DF;--shiki-dark:#DCDCAA\">log\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">(\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">data\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">.\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">message_id\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">);\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]},"response":{"type":"ResponseExample","children":[{"filename":"Success (201)","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"5\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"success\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"a1b2c3d4\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"queued\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"Error (400)","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"4\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Invalid recipient phone number format\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"code\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"invalid_phone\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Send Single Message","path":"/v2/send","servers":[{"url":"https://api.tracklysms.com/api"}],"method":"post","request":{"security":[{"title":"API Key Auth","parameters":{"header":{"X-Api-Key":{"type":"apiKey"}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"trial_campaign_id":[{"type":"string","description":"Account-owned testing group ID for a trial send. Mutually exclusive with `list_number` ."}],"to":[{"type":"string","description":"Recipient phone number in E.164 format (e.g. `+14155551234` ).","required":true}],"list_number":[{"type":"string","description":"Required for ordinary sends: the sending list phone number in E.164 format, belonging to your account. Omit it when using `trial_campaign_id` ."}],"body":[{"type":"string","description":"Required for SMS; optional or empty for MMS. An MMS caption may contain up to 4,096 characters. Use the `{{messageId}}` placeholder to insert the unique message ID into the body at send time."}],"media":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Non-empty array of hosted MMS attachments. Each object requires `url` and accepts optional `content_type` and `content_id` . Omit this field for SMS. See MMS for URL requirements, formats, and examples."}],"subject":[{"type":"string","description":"Optional MMS subject, up to 66 characters. Requires `media` ."}],"wrap_links":[{"type":"boolean","description":"Enables link processing for this message. Send the JSON value `true` or `false` . A non-empty `linkOverrides` object requires literal `true` ; other types return `invalid_wrap_links` . Raw URLs typed into `body` are still not auto-shortened — only `{{linkN}}` placeholders resolved through `linkOverrides` are. For a click-tracked link without placeholders, create it via the Shorten Link endpoint and put the returned short URL in your body."}],"linkOverrides":[{"type":"object","properties":{},"description":"Per-placeholder link targets, keyed `link1` … `link99` (max 10 entries). Each entry sets exactly one of `offerId` (an active account-owned SMS offer), `partnershipOfferId` (an active, account-owned offer with offer management enabled; requires the Partnerships product), or `customUrl` (an absolute HTTPS URL of at most 2,048 characters on a public hostname, not an IP literal). A `customUrl` authority must not contain macros. Each referenced `{{linkN}}` is replaced with a freshly minted short URL; body placeholders without a matching override remain unchanged, and unreferenced entries create no affiliate or offer-access state. Requires `wrap_links: true` . `productId` is not supported."}],"interstitialMode":[{"type":"string","description":"Interstitial page for every tracked link in this message, shown before the short link redirects. One of `none` (redirect straight away, even if the referenced SMS offer has its own interstitial), `list_default` (the sending list’s default interstitial page; a list without one redirects straight away), or `custom` (the page described by `interstitial` ). Omit it to keep each referenced SMS offer’s own setting. Requires `wrap_links: true` and at least one `{{linkN}}` placeholder backed by `linkOverrides` ; applies to all of them, including every `customUrl` link, so put an opt-out or unsubscribe page behind a tracked link only if you want it shown there too."}],"interstitial":[{"type":"object","properties":{},"description":"Custom interstitial page for this message’s tracked links; supplying it implies `interstitialMode: \"custom\"` , and it must not be empty. Keys, all optional: `title` , `description` , `cta` (button text), `meta_title` , `meta_description` (page metadata), `meta_image` (absolute HTTP(S) URL used for the Open Graph image and the blurred background), `meta_favicon` (absolute HTTP(S) URL or inline SVG markup), `auto_redirect` (boolean; continues automatically after a short pause) and `redirect_text` (the button text while auto-redirecting). Text values are limited to 2,000 characters, `meta_image` to 2,048 characters, `meta_favicon` to 4,096 UTF-8 bytes on this endpoint. Unknown keys are rejected. `/v2/send-raw` mints no tracked links and refuses both fields with `400 interstitial_requires_links` ."}],"contact_data":[{"type":"object","properties":{},"description":"Optional per-contact data for macro substitution. Supports `first_name` (string), `last_name` (string), `custom_fields` (object), and `timezone` (string). These values are used to populate template variables like `{{first_name}}` in the message body. Trackly fills `{{contactId}}` and `{{listContactId}}` itself from the recipient’s subscription to the sending list; they resolve to an empty string when the recipient is not on the list and cannot be set through `contact_data` ."}],"metadata":[{"type":"object","properties":{},"description":"Optional key-value metadata dictionary. Ordinary sends currently accept but do not retain this field. Trial sends retain encrypted metadata and include it in events where outgoing-message correlation is proven."}]}}],"examples":{"example":{"value":{"trial_campaign_id":"\u003cstring>","to":"\u003cstring>","list_number":"\u003cstring>","body":"\u003cstring>","media":[{}],"subject":"\u003cstring>","wrap_links":true,"linkOverrides":{},"interstitialMode":"\u003cstring>","interstitial":{},"contact_data":{},"metadata":{}}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"success":[{"type":"boolean","description":"Whether the message was successfully queued."}],"message_id":[{"type":"string","description":"An opaque, variable-length message identifier for tracking delivery and clicks."}],"status":[{"type":"string","description":"Current message status. Will be `\"queued\"` on successful submission."}],"message_type":[{"type":"string","description":"`\"mms\"` for an MMS request. Omitted for SMS."}]}}],"examples":{"example":{"value":{"success":true,"message_id":"\u003cstring>","status":"\u003cstring>","message_type":"\u003cstring>"}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"trackly","siteName":"Trackly SMS","title":"Send Single Message - Trackly SMS","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-21T02:21:35.138Z","originalFileLocation":"api-reference/v2/messages/send-single.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=\"Queue a single SMS or MMS message to a recipient phone number.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Trackly SMS\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/trackly/c-1xunGpYsfIbfFy/_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/trackly/c-1xunGpYsfIbfFy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/trackly/c-1xunGpYsfIbfFy/_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/trackly/c-1xunGpYsfIbfFy/_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/trackly/c-1xunGpYsfIbfFy/_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/trackly/c-1xunGpYsfIbfFy/_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/trackly/c-1xunGpYsfIbfFy/_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/trackly/c-1xunGpYsfIbfFy/_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/trackly/c-1xunGpYsfIbfFy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Send Single Message - Trackly SMS\">\u003cmeta data-mint-head property=\"og:description\" content=\"Queue a single SMS or MMS message to a recipient phone number.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Trackly SMS\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tracklysms.com/api-reference/v2/messages/send-single\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://trackly.mintlify.site/_mintlify/api/og/v2?division=Messages+%28v2%29\u0026amp;title=Send+Single+Message\u0026amp;description=Queue+a+single+SMS+or+MMS+message+to+a+recipient+phone+number.\u0026amp;theme=bb44b2f671ef6b99ad7abecb\u0026amp;signature=5b341cb59dafd5c906d8f6e9094cb8ad8885c0a0f436b0db03d58e3ec501e867\">\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 Single Message - Trackly SMS\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Queue a single SMS or MMS message to a recipient phone number.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://trackly.mintlify.site/_mintlify/api/og/v2?division=Messages+%28v2%29\u0026amp;title=Send+Single+Message\u0026amp;description=Queue+a+single+SMS+or+MMS+message+to+a+recipient+phone+number.\u0026amp;theme=bb44b2f671ef6b99ad7abecb\u0026amp;signature=5b341cb59dafd5c906d8f6e9094cb8ad8885c0a0f436b0db03d58e3ec501e867\">\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/trackly/c-1xunGpYsfIbfFy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Trackly SMS\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#84DE4D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tracklysms.com/api-reference/v2/messages/send-single\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v2/messages/send-single.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tracklysms.com/#organization\",\"name\":\"Trackly SMS\",\"url\":\"https://docs.tracklysms.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/trackly/m198FBazwIseN-2r/images/logo-light.svg?fit=max\u0026auto=format\u0026n=m198FBazwIseN-2r\u0026q=85\u0026s=675b2c397e9309f5fea1d36c1f87c412\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tracklysms.com#website\",\"name\":\"Trackly SMS\",\"url\":\"https://docs.tracklysms.com\",\"publisher\":{\"@id\":\"https://docs.tracklysms.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tracklysms.com/api-reference/v2/messages/send-single#webpage\",\"url\":\"https://docs.tracklysms.com/api-reference/v2/messages/send-single\",\"name\":\"Send Single Message\",\"description\":\"Queue a single SMS or MMS message to a recipient phone number.\",\"dateModified\":\"2026-11-21T02:21:35.138Z\",\"isPartOf\":{\"@id\":\"https://docs.tracklysms.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tracklysms.com/api-reference/v2/messages/send-single#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tracklysms.com/api-reference/v2/messages/send-single#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Trackly SMS\",\"item\":\"https://docs.tracklysms.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Send Single Message\",\"item\":\"https://docs.tracklysms.com/api-reference/v2/messages/send-single\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tracklysms.com/api-reference/v2/messages/send-single#apireference\",\"headline\":\"Send Single Message\",\"name\":\"Send Single Message\",\"description\":\"Queue a single SMS or MMS message to a recipient phone number.\",\"url\":\"https://docs.tracklysms.com/api-reference/v2/messages/send-single\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tracklysms.com/api-reference/v2/messages/send-single#webpage\"},\"dateModified\":\"2026-11-21T02:21:35.138Z\",\"publisher\":{\"@id\":\"https://docs.tracklysms.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tracklysms.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Trackly SMS\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Trackly SMS\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/v2/messages/send-single.md","siteName":"Trackly SMS","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"API Overview","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"}]},{"group":"V2 API Reference","pages":[{"title":"V2 API Overview","href":"/api-reference/v2/overview"},{"title":"Partner API Overview","href":"/api-reference/v2/partner-api-overview"},{"title":"Error Codes","href":"/api-reference/v2/error-codes"},{"title":"API Limits \u0026 Best Practices","href":"/api-reference/v2/rate-limiting"},{"title":"Idempotency","href":"/api-reference/v2/idempotency"},{"title":"Sandbox \u0026 Testing","href":"/api-reference/v2/sandbox"},{"title":"Who Am I","api":"GET /v2/auth/whoami","href":"/api-reference/v2/auth/whoami"},{"title":"Agent Setup Status","api":"GET /v2/agent/setup","href":"/api-reference/v2/auth/agent-setup"},{"title":"Delegated OAuth for REST Agents","href":"/api-reference/v2/auth/delegated-oauth"},{"title":"Pause Own Key","api":"POST /v2/auth/api-keys/self/pause","href":"/api-reference/v2/auth/pause"},{"title":"V1 to V2 Migration Guide","href":"/api-reference/v2/migration-guide"}]},{"group":"Agent Account Setup (v2)","pages":[{"title":"Start Agent Account Setup","api":"POST /v2/agent-onboarding","href":"/api-reference/v2/agent-onboarding/create"},{"title":"Get Agent Setup Status","api":"GET /v2/agent-onboarding/{intent_id}","href":"/api-reference/v2/agent-onboarding/get"}]},{"group":"Agent Number Registration (v2)","pages":[{"title":"Prepare SMS Number Registration","api":"POST /v2/agent/number-requests","href":"/api-reference/v2/agent-number-requests/create"},{"title":"Read SMS Number Registration","api":"GET /v2/agent/number-requests/{request_id}","href":"/api-reference/v2/agent-number-requests/get"},{"title":"Update SMS Number Registration","api":"PATCH /v2/agent/number-requests/{request_id}","href":"/api-reference/v2/agent-number-requests/update"},{"title":"Generate Private SMS Registration Preview","api":"POST /v2/agent/number-requests/{request_id}/preview","href":"/api-reference/v2/agent-number-requests/preview"}]},{"group":"Pending Sends (v2)","pages":[{"title":"Hold a Send for Approval","api":"POST /v2/pending-sends","href":"/api-reference/v2/pending-sends/create"},{"title":"List Pending Sends","api":"GET /v2/pending-sends","href":"/api-reference/v2/pending-sends/list"},{"title":"Get a Pending Send","api":"GET /v2/pending-sends/{id}","href":"/api-reference/v2/pending-sends/get"},{"title":"Cancel a Pending Send","api":"DELETE /v2/pending-sends/{id}","href":"/api-reference/v2/pending-sends/cancel"},{"title":"Send an Approved Send","api":"POST /v2/pending-sends/{id}/send","href":"/api-reference/v2/pending-sends/send"}]},{"group":"Partner Accounts (v2)","pages":[{"title":"Accounts \u0026 Hierarchy","href":"/api-reference/v2/accounts/overview"},{"title":"Create Child Account","api":"POST /v2/accounts/children","href":"/api-reference/v2/accounts/create-child"},{"title":"List Child Accounts","api":"GET /v2/accounts/children","href":"/api-reference/v2/accounts/list-children"},{"title":"Get Child Account","api":"GET /v2/accounts/children/{child_id}","href":"/api-reference/v2/accounts/get-child"},{"title":"Update Child Account","api":"PATCH /v2/accounts/children/{child_id}","href":"/api-reference/v2/accounts/update-child"},{"title":"Suspend Child Account","api":"POST /v2/accounts/children/{child_id}/suspend","href":"/api-reference/v2/accounts/suspend-child"},{"title":"Reactivate Child Account","api":"POST /v2/accounts/children/{child_id}/reactivate","href":"/api-reference/v2/accounts/reactivate-child"},{"title":"Create API Key","api":"POST /v2/accounts/children/{child_id}/api-keys","href":"/api-reference/v2/accounts/create-api-key"},{"title":"List API Keys","api":"GET /v2/accounts/children/{child_id}/api-keys","href":"/api-reference/v2/accounts/list-api-keys"},{"title":"Rotate API Key","api":"POST /v2/accounts/children/{child_id}/api-keys/{key_id}/rotate","href":"/api-reference/v2/accounts/rotate-api-key"},{"title":"Revoke API Key","api":"POST /v2/accounts/children/{child_id}/api-keys/{key_id}/revoke","href":"/api-reference/v2/accounts/revoke-api-key"}]},{"group":"Trial SMS (v2)","pages":[{"title":"Trial Status","api":"GET /v2/trial","href":"/api-reference/v2/trial/status"},{"title":"Trial Testing Groups","description":"Create, inspect and close customer-owned testing groups through the existing API-key scopes.","href":"/api-reference/v2/trial/groups"}]},{"group":"Messages (v2)","pages":[{"title":"Send Single Message","api":"POST /v2/send","href":"/api-reference/v2/messages/send-single"},{"title":"Send Bulk Messages","api":"POST /v2/send/bulk","description":"Queue SMS and MMS messages in a single bulk request.","href":"/api-reference/v2/messages/send-bulk"},{"title":"Send Raw Single Message","api":"POST /v2/send-raw","href":"/api-reference/v2/messages/send-raw-single"},{"title":"Send Raw Bulk Messages","api":"POST /v2/send-raw/bulk","href":"/api-reference/v2/messages/send-raw-bulk"},{"title":"Preflight a Send","api":"POST /v2/messages/preflight","href":"/api-reference/v2/messages/preflight"},{"title":"List Messages","api":"GET /v2/messages","href":"/api-reference/v2/messages/list-messages"},{"title":"Get Message","api":"GET /v2/messages/{messageId}","href":"/api-reference/v2/messages/get-message"},{"title":"Reconciliation","href":"/api-reference/v2/messages/reconciliation"}]},{"group":"Contacts (v2)","pages":[{"title":"List Contacts","api":"GET /v2/contacts","href":"/api-reference/v2/contacts/list-contacts"},{"title":"Create Contact","api":"POST /v2/contacts","href":"/api-reference/v2/contacts/create-contact"},{"title":"Update Contact","api":"PUT /v2/contacts","href":"/api-reference/v2/contacts/update-contact"},{"title":"Bulk Create Contacts","api":"POST /v2/contacts/bulk","href":"/api-reference/v2/contacts/bulk-create"},{"title":"Get Contact","api":"GET /v2/contacts/{phone_number}","href":"/api-reference/v2/contacts/get-contact"},{"title":"Delete Contact","api":"DELETE /v2/contacts","href":"/api-reference/v2/contacts/delete-contact"},{"title":"Resubscribe Contact","api":"POST /v2/contacts/resubscribe","href":"/api-reference/v2/contacts/resubscribe"}]},{"group":"Lists (v2)","pages":[{"title":"List All Sending Lists","api":"GET /v2/lists","href":"/api-reference/v2/lists/list-all"},{"title":"Get a Sending List","api":"GET /v2/lists/{list_id}","href":"/api-reference/v2/lists/get-list"},{"title":"Check RCS Reachability","api":"POST /v2/lists/{list_id}/rcs-capability-check","href":"/api-reference/v2/lists/rcs-capability-check"}]},{"group":"Number Requests (v2)","pages":[{"title":"List Number Requests","api":"GET /v2/number-requests","href":"/api-reference/v2/number-requests/list-all"},{"title":"Create Number Draft","api":"POST /v2/number-requests/drafts","href":"/api-reference/v2/number-requests/create-draft"},{"title":"Confirm Business for Number Request","api":"PUT /v2/number-requests/{request_id}/business","href":"/api-reference/v2/number-requests/confirm-business"},{"title":"Submit Number Draft","api":"POST /v2/number-requests/{request_id}/submit","href":"/api-reference/v2/number-requests/submit-draft"},{"title":"Create Number Request","api":"POST /v2/number-requests","href":"/api-reference/v2/number-requests/create-request"},{"title":"Get Number Request","api":"GET /v2/number-requests/{request_id}","href":"/api-reference/v2/number-requests/get-request"},{"title":"Get Registration Readiness","api":"GET /v2/number-requests/{request_id}/readiness","href":"/api-reference/v2/number-requests/get-readiness"},{"title":"Recheck Registration Readiness","api":"POST /v2/number-requests/{request_id}/readiness","href":"/api-reference/v2/number-requests/recheck-readiness"},{"title":"Get Registration Attempt History","api":"GET /v2/number-requests/{request_id}/readiness/history","href":"/api-reference/v2/number-requests/readiness-history"},{"title":"Update Number Request","api":"PATCH /v2/number-requests/{request_id}","href":"/api-reference/v2/number-requests/update-request"},{"title":"Look Up International Requirements","api":"GET /v2/number-requests/international-requirements","href":"/api-reference/v2/number-requests/lookup-requirements"},{"title":"Get International Requirements","api":"GET /v2/number-requests/{request_id}/international-requirements","href":"/api-reference/v2/number-requests/get-requirements"},{"title":"Update International Requirements","api":"PATCH /v2/number-requests/{request_id}/international-requirements","href":"/api-reference/v2/number-requests/update-requirements"},{"title":"Correct Resource Request","api":"POST /v2/number-requests/{request_id}/correction","href":"/api-reference/v2/number-requests/correct-request"}]},{"group":"Business Verification (v2)","pages":[{"title":"Business Verification in Number Requests","href":"/api-reference/v2/business-profiles/lifecycle"},{"title":"List Business Profiles","api":"GET /v2/business-profiles","href":"/api-reference/v2/business-profiles/list-all"},{"title":"Get Business Profile","api":"GET /v2/business-profiles/{profile_id}","href":"/api-reference/v2/business-profiles/get-profile"},{"title":"Create Business Profile","api":"POST /v2/business-profiles","href":"/api-reference/v2/business-profiles/create-profile"},{"title":"Validate Business Profile","api":"POST /v2/business-profiles/validate","href":"/api-reference/v2/business-profiles/validate-profile"},{"title":"Update Business Profile","api":"PATCH /v2/business-profiles/{profile_id}","href":"/api-reference/v2/business-profiles/update-profile"},{"title":"Dispute Suggested Business Name","api":"POST /v2/business-profiles/{profile_id}/dispute","href":"/api-reference/v2/business-profiles/dispute-profile"},{"title":"Renew Business Verification","api":"POST /v2/business-profiles/{profile_id}/verification","href":"/api-reference/v2/business-profiles/renew-verification"},{"title":"List Verification Submissions","api":"GET /v2/business-profiles/{profile_id}/submissions","href":"/api-reference/v2/business-profiles/list-submissions"},{"title":"Upload Supporting Document","api":"POST /v2/business-profiles/{profile_id}/documents","href":"/api-reference/v2/business-profiles/upload-document"},{"title":"List Supporting Documents","api":"GET /v2/business-profiles/{profile_id}/documents","href":"/api-reference/v2/business-profiles/list-documents"},{"title":"Download Supporting Document","api":"GET /v2/business-profiles/{profile_id}/documents/{doc_id}","href":"/api-reference/v2/business-profiles/download-document"},{"title":"Delete Supporting Document","api":"DELETE /v2/business-profiles/{profile_id}/documents/{doc_id}","href":"/api-reference/v2/business-profiles/delete-document"}]},{"group":"Creatives (v2)","pages":[{"title":"List All Creatives","api":"GET /v2/creatives","href":"/api-reference/v2/creatives/list-creatives"},{"title":"Create a Creative","api":"POST /v2/creatives","href":"/api-reference/v2/creatives/create-creative"},{"title":"Get a Creative","api":"GET /v2/creatives/{id}","href":"/api-reference/v2/creatives/get-creative"},{"title":"Update a Creative","api":"PUT /v2/creatives/{id}","href":"/api-reference/v2/creatives/update-creative"},{"title":"Delete a Creative","api":"DELETE /v2/creatives/{id}","href":"/api-reference/v2/creatives/delete-creative"}]},{"group":"Audiences (v2)","pages":[{"title":"List Audiences","api":"GET /v2/audiences","href":"/api-reference/v2/audiences/list-audiences"},{"title":"Create Audience","api":"POST /v2/audiences","href":"/api-reference/v2/audiences/create-audience"},{"title":"Get Audience","api":"GET /v2/audiences/{id}","href":"/api-reference/v2/audiences/get-audience"},{"title":"Update Audience","api":"PUT /v2/audiences/{id}","href":"/api-reference/v2/audiences/update-audience"},{"title":"Delete Audience","api":"DELETE /v2/audiences/{id}","href":"/api-reference/v2/audiences/delete-audience"},{"title":"Get Audience Size","api":"GET /v2/audiences/{id}/size","href":"/api-reference/v2/audiences/get-audience-size"},{"title":"Audience Filter DSL","href":"/api-reference/v2/audience-filter-dsl"}]},{"group":"Offers (v2)","pages":[{"title":"List Offers","api":"GET /v2/offers","href":"/api-reference/v2/offers/list-offers"},{"title":"Create Offer","api":"POST /v2/offers","href":"/api-reference/v2/offers/create-offer"},{"title":"Get Offer","api":"GET /v2/offers/{id}","href":"/api-reference/v2/offers/get-offer"},{"title":"Update Offer","api":"PUT /v2/offers/{id}","href":"/api-reference/v2/offers/update-offer"},{"title":"Delete Offer","api":"DELETE /v2/offers/{id}","href":"/api-reference/v2/offers/delete-offer"}]},{"group":"Schedules (v2)","pages":[{"title":"List Schedules","api":"GET /v2/schedules","href":"/api-reference/v2/schedules/list-schedules"},{"title":"Create Schedule or Blast","api":"POST /v2/schedules","href":"/api-reference/v2/schedules/create-schedule"},{"title":"Get Schedule","api":"GET /v2/schedules/{id}","href":"/api-reference/v2/schedules/get-schedule"},{"title":"Update Schedule","api":"PUT /v2/schedules/{id}","href":"/api-reference/v2/schedules/update-schedule"},{"title":"Delete Schedule","api":"DELETE /v2/schedules/{id}","href":"/api-reference/v2/schedules/delete-schedule"}]},{"group":"Journeys (v2)","pages":[{"title":"List Journeys","api":"GET /v2/journeys","href":"/api-reference/v2/journeys/list-journeys"},{"title":"Create Journey","api":"POST /v2/journeys","href":"/api-reference/v2/journeys/create-journey"},{"title":"Get Journey","api":"GET /v2/journeys/{journey_id}","href":"/api-reference/v2/journeys/get-journey"},{"title":"Update Journey","api":"PUT /v2/journeys/{journey_id}","href":"/api-reference/v2/journeys/update-journey"},{"title":"Archive Journey","api":"DELETE /v2/journeys/{journey_id}","href":"/api-reference/v2/journeys/delete-journey"},{"title":"Update Journey Status","api":"PUT /v2/journeys/{journey_id}/status","href":"/api-reference/v2/journeys/update-journey-status"},{"title":"Duplicate Journey","api":"POST /v2/journeys/{journey_id}/duplicate","href":"/api-reference/v2/journeys/duplicate-journey"},{"title":"Get Journey Options","api":"GET /v2/journeys/options","href":"/api-reference/v2/journeys/get-journey-options"},{"title":"Refresh Custom Fields","api":"POST /v2/journeys/refresh-custom-fields","href":"/api-reference/v2/journeys/refresh-custom-fields"},{"title":"Get Journey Statistics","api":"GET /v2/journeys/{journey_id}/stats","href":"/api-reference/v2/journeys/get-journey-stats"}]},{"group":"Revenue (v2)","pages":[{"title":"Record Revenue","api":"POST /v2/revenue","href":"/api-reference/v2/revenue/record-revenue"},{"title":"Bulk Record Revenue","api":"POST /v2/revenue/bulk","href":"/api-reference/v2/revenue/bulk-revenue"}]},{"group":"Usage \u0026 Billing (v2)","pages":[{"title":"Get Current Balance","api":"GET /v2/billing/balance","href":"/api-reference/v2/usage/billing-balance"},{"title":"Usage Summary","api":"GET /v2/usage/summary","href":"/api-reference/v2/usage/usage-summary"},{"title":"List Billing Records","api":"GET /v2/billing/records","href":"/api-reference/v2/usage/billing-records"},{"title":"Get Billing Statement","api":"GET /v2/billing/statements/{period}","href":"/api-reference/v2/usage/billing-statements"}]},{"group":"Data Import (v2)","pages":[{"title":"Import Send History","api":"POST /v2/history/sends","href":"/api-reference/v2/history/import-sends"},{"title":"Import Click History","api":"POST /v2/history/clicks","href":"/api-reference/v2/history/import-clicks"},{"title":"Import Revenue History","api":"POST /v2/history/revenue","href":"/api-reference/v2/history/import-revenue"},{"title":"Clear History","api":"DELETE /v2/history/clear","href":"/api-reference/v2/history/clear-history"}]},{"group":"Links (v2)","pages":[{"title":"Create Link","api":"POST /v2/links","href":"/api-reference/v2/links/create-link"},{"title":"Shorten Link","api":"POST /v2/links/shorten","href":"/api-reference/v2/links/shorten-link"}]},{"group":"Clicks (v2)","pages":[{"title":"List Click Evidence","api":"GET /v2/clicks","href":"/api-reference/v2/clicks/list-clicks"}]},{"group":"Webhooks (v2)","pages":[{"title":"Webhook Events","href":"/api-reference/v2/webhooks/events"},{"title":"Webhook Signing \u0026 Verification","href":"/api-reference/v2/webhooks/signing"},{"title":"Create Webhook Endpoint","api":"POST /v2/webhooks","href":"/api-reference/v2/webhooks/create-endpoint"},{"title":"List Webhook Endpoints","api":"GET /v2/webhooks","href":"/api-reference/v2/webhooks/list-endpoints"},{"title":"Get Webhook Endpoint","api":"GET /v2/webhooks/{endpoint_id}","href":"/api-reference/v2/webhooks/get-endpoint"},{"title":"Update Webhook Endpoint","api":"PATCH /v2/webhooks/{endpoint_id}","href":"/api-reference/v2/webhooks/update-endpoint"},{"title":"Delete Webhook Endpoint","api":"DELETE /v2/webhooks/{endpoint_id}","href":"/api-reference/v2/webhooks/delete-endpoint"},{"title":"Rotate Signing Secret","api":"POST /v2/webhooks/{endpoint_id}/rotate-secret","href":"/api-reference/v2/webhooks/rotate-secret"},{"title":"List Deliveries","api":"GET /v2/webhooks/{endpoint_id}/deliveries","href":"/api-reference/v2/webhooks/list-deliveries"},{"title":"Replay a Delivery","api":"POST /v2/webhooks/deliveries/{delivery_id}/replay","href":"/api-reference/v2/webhooks/replay-delivery"},{"title":"Bulk Replay Deliveries","api":"POST /v2/webhooks/deliveries/replay","href":"/api-reference/v2/webhooks/bulk-replay"}]},{"group":"Phone Validation (v1)","pages":[{"title":"Validate Phone Number","api":"POST /v1/phone/validate","href":"/api-reference/phone/validate"},{"title":"Validate Phone Numbers (Batch)","api":"POST /v1/phone/validate/batch","href":"/api-reference/phone/batch-validate"}]},{"group":"Voice Calls (v1)","pages":[{"title":"Start calling with Trackly","href":"/api-reference/voice/get-started"},{"title":"Connect Your Salesforce Dialer","href":"/api-reference/voice/salesforce"},{"title":"Salesforce Integration Reference","href":"/api-reference/voice/salesforce-configuration"},{"title":"Voice Calls API Overview","href":"/api-reference/voice/overview"},{"title":"Queue Webhooks","href":"/api-reference/voice/webhooks"},{"title":"List Calling Numbers","api":"GET /v1/voice/calling-numbers","href":"/api-reference/voice/numbers/list-calling-numbers"},{"title":"Search Calling Numbers","api":"POST /v1/voice/calling-numbers/search","href":"/api-reference/voice/numbers/search-calling-numbers"},{"title":"Quote a Calling Number","api":"POST /v1/voice/calling-numbers/quote","href":"/api-reference/voice/numbers/quote-calling-number"},{"title":"Acquire a Calling Number","api":"POST /v1/voice/number-acquisitions","href":"/api-reference/voice/numbers/acquire-calling-number"},{"title":"Get a Number Acquisition","api":"GET /v1/voice/number-acquisitions/{operationId}","href":"/api-reference/voice/numbers/get-number-acquisition"},{"title":"Record a Voice Opt-Out","api":"POST /v1/voice/opt-outs","href":"/api-reference/voice/record-opt-out"},{"title":"Screen a Calling Recipient","api":"POST /v1/voice/recipient-screenings","href":"/api-reference/voice/recipient-screening"},{"title":"Place a Call","api":"POST /v1/voice/calls","href":"/api-reference/voice/calls/place-call"},{"title":"List Calls","api":"GET /v1/voice/calls","href":"/api-reference/voice/calls/list-calls"},{"title":"Get a Call","api":"GET /v1/voice/calls/{callId}","href":"/api-reference/voice/calls/get-call"},{"title":"Answer a Call","api":"POST /v1/voice/calls/{callId}/answer","href":"/api-reference/voice/calls/answer-call"},{"title":"Hang Up a Call","api":"POST /v1/voice/calls/{callId}/hangup","href":"/api-reference/voice/calls/hangup-call"},{"title":"Monitor a Call","api":"POST /v1/voice/calls/{callId}/monitor","href":"/api-reference/voice/calls/monitor-call"},{"title":"Browser Sessions","href":"/api-reference/voice/calls/browser-sessions"},{"title":"Browser Calls","href":"/api-reference/voice/calls/browser-calls"},{"title":"Listen to a Call in the Browser","href":"/api-reference/voice/calls/browser-monitor"},{"title":"Hold, Resume, and Transfer a Browser Call","href":"/api-reference/voice/calls/browser-call-controls"},{"title":"Choose Call Listeners","href":"/api-reference/voice/monitor-grants"},{"title":"Start Recording","api":"POST /v1/voice/calls/{callId}/recording/start","href":"/api-reference/voice/calls/start-recording"},{"title":"Stop Recording","api":"POST /v1/voice/calls/{callId}/recording/stop","href":"/api-reference/voice/calls/stop-recording"},{"title":"List Recordings","api":"GET /v1/voice/calls/{callId}/recording","href":"/api-reference/voice/calls/list-recordings"},{"title":"Download a Recording File","api":"GET /v1/voice/calls/{callId}/recording/files/{fileId}","href":"/api-reference/voice/calls/download-recording"},{"title":"Create a Queue","api":"POST /v1/voice/queues","href":"/api-reference/voice/queues/create-queue"},{"title":"List Queues","api":"GET /v1/voice/queues","href":"/api-reference/voice/queues/list-queues"},{"title":"Get a Queue","api":"GET /v1/voice/queues/{queueId}","href":"/api-reference/voice/queues/get-queue"},{"title":"Dequeue a Call","api":"POST /v1/voice/queues/{queueId}/dequeue","href":"/api-reference/voice/queues/dequeue"},{"title":"Create an Agent","api":"POST /v1/voice/agents","href":"/api-reference/voice/agents/create-agent"},{"title":"List Agents","api":"GET /v1/voice/agents","href":"/api-reference/voice/agents/list-agents"}]},{"group":"API Reference (v1 - Deprecated)","pages":[{"title":"Send Single Message","api":"POST /v1/messages","href":"/api-reference/messages/send-single"},{"title":"Send Bulk Messages","api":"POST /v1/messages/bulk","href":"/api-reference/messages/send-bulk"},{"title":"List Contacts","api":"GET /v1/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create Contact","api":"POST /v1/contacts","href":"/api-reference/contacts/create-contact"},{"title":"Get Contact","api":"GET /v1/contacts/{msisdn}","href":"/api-reference/contacts/get-contact"},{"title":"Delete Contact","api":"DELETE /v1/contacts/{msisdn}","href":"/api-reference/contacts/delete-contact"},{"title":"Error Codes","href":"/api-reference/errors"}]}]}]},{"anchor":"API Status","href":"https://status.tracklysms.com","icon":"signal"},{"anchor":"Discord","href":"https://discord.gg/trackly","icon":"discord"},{"anchor":"Changelog","icon":"list","pages":[{"title":"Changelog","href":"/resources/changelog"}]}]},"basePath":"","title":"Send Single Message - Trackly SMS","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js"]}