Checks current sending eligibility without submitting a message or charging message usage. Billing checks may repair account state or contact the billing provider. Use it to validate a recipient, preview segment count and cost, and inspect blockers. Works with live and sandbox keys; warm-up and later execution checks can still refuse a send.For a confirmation-required key, confirmation_required: true makes direct-send eligible false. This is expected: resolve other blockers, then hold the SMS for human approval. Pending approvals do not support MMS. Do not disable confirmation to make preflight eligible.
Body Parameters
string
required
Recipient phone number (E.164).
string
required
Sending list phone number (E.164). Must belong to your account.
string
Required for SMS; optional or empty for MMS. An MMS caption may contain up to 4,096 characters.
array
Non-empty array of hosted MMS attachments. Uses the same media fields and limits as an immediate send. No attachment is fetched.
string
Optional MMS subject, up to 66 characters. Requires media.
Response Fields
boolean
Whether the message would be accepted for sending. Equals the AND of all binding checks: sender_ready, byoc_webhook_ready, not_suppressed, billing_ok, byoc_required_ok, list_allowed_for_key, daily_send_cap_ok, and send_policy_available, with confirmation_required false. MMS also requires mms_supported, mms_enabled, and mms_key_enabled. within_tcpa_hours is advisory only and does not affect eligible.
object
Per-gate results.
Show checks
boolean
When true, the key requires human approval and eligible is false for a direct send. Hold the SMS for approval instead.
boolean
False when current confirmation policy cannot be verified; direct-send eligibility is false.
boolean
The sending list exists, is active, and belongs to you.
boolean
Present for MMS. The sending number supports MMS.
boolean
Present for MMS. The global MMS rollout and this account’s MMS gate are enabled.
boolean
Present for MMS. The key has explicit sends.send and mms.send grants and is not blocked by owner or admin policy.
boolean
For BYOC lists, the delivery webhook is verified.
boolean
The recipient is not opted out or blocked.
boolean
Advisory.true if the current time is within the recipient’s TCPA calling window, false if in quiet hours. Computed only for +1 numbers (defaults true otherwise). The raw API send path does not enforce quiet hours — enforce it yourself if you need to.
boolean
The account’s billing is in good standing.
boolean
The account is allowed to send from this list (free-tier accounts must use a BYOC list).
boolean
The calling key’s send_policy.list_numbers (see Who Am I) is empty or includes this list_number.
boolean
The key passes the daily-cap check. Every live key, including an uncapped key, requires an available authoritative policy store; an outage or invalid stored daily cap reports false. Capped live keys also need room left for today (UTC). Sandbox requests with a valid stored cap pass without reading or consuming quota. A successful preflight does not reserve quota or guarantee a later send will be admitted.
string
mms for an MMS request. Omitted for SMS.
integer | null
Number of SMS segments the body would use. null for MMS.
string | null
GSM-7 or UCS-2 for SMS; null for MMS.
number | null
Marginal SMS cost at the account’s current tier and cycle position. null for MMS or a child pooled to its parent’s billing.
string
Currency of estimated_cost (e.g. usd).
string
How the estimate was derived, why a pooled child’s cost is managed by its parent, or why MMS pricing is not estimated.
boolean | null
Whether the recipient is an active contact on the list. false means the recipient is on the list but their membership is inactive; null means the recipient has no membership on that list, or the sending list could not be resolved.
to, list_number, or an SMS body is missing or empty.
400
invalid_mms_media
MMS attachments, subject, or caption fail validation.
400
invalid_phone
to is not a valid E.164 number.
400
invalid_list_number
list_number is not a valid E.164 number.
400
invalid_rcs_text
An RCS list was selected and body contains invalid Unicode.
400
invalid_contact_data
An RCS list was selected and a contact macro value contains invalid Unicode.
Warm-up is not evaluated by preflight. A warm-up-gated list may pass preflight but still defer a live send.
{"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/preflight","slug":"/api-reference/v2/messages/preflight","pageMetadata":{"title":"Preflight a Send","api":"POST /v2/messages/preflight","description":"Check sending eligibility, segment count, and estimated cost without submitting a message.","href":"/api-reference/v2/messages/preflight"},"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: \"Check sending eligibility, segment count, and estimated cost without submitting a message.\"\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},{Expandable,Heading,Note,ParamField,ResponseField,Table}=_components;if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Checks current sending eligibility without submitting a message or charging message usage. Billing checks may repair account state or contact the billing provider. Use it to validate a recipient, preview segment count and cost, and inspect blockers. Works with live and `,_jsx(_components.a,{href:`/api-reference/v2/sandbox`,children:`sandbox`}),` keys; warm-up and later execution checks can still refuse a send.`]}),`\n`,_jsxs(_components.p,{children:[`For a confirmation-required key, `,_jsx(_components.code,{children:`confirmation_required: true`}),` makes direct-send `,_jsx(_components.code,{children:`eligible`}),` false. This is expected: resolve other blockers, then `,_jsx(_components.a,{href:`/agents/send-with-approval`,children:`hold the SMS for human approval`}),`. Pending approvals do not support MMS. Do not disable confirmation to make preflight eligible.`]}),`\n`,_jsx(Heading,{level:`2`,id:`body-parameters`,children:`Body Parameters`}),`\n`,_jsx(ParamField,{body:`to`,type:`string`,required:true,id:`param-to`,children:_jsx(_components.p,{children:`Recipient phone number (E.164).`})}),`\n`,_jsx(ParamField,{body:`list_number`,type:`string`,required:true,id:`param-list-number`,children:_jsx(_components.p,{children:`Sending list phone number (E.164). Must belong to your account.`})}),`\n`,_jsx(ParamField,{body:`body`,type:`string`,id:`param-body`,children:_jsx(_components.p,{children:`Required for SMS; optional or empty for MMS. An MMS caption may contain up to 4,096 characters.`})}),`\n`,_jsx(ParamField,{body:`media`,type:`array`,id:`param-media`,children:_jsxs(_components.p,{children:[`Non-empty array of hosted MMS attachments. Uses the same `,_jsx(_components.a,{href:`/guides/mms#request-requirements`,children:`media fields and limits`}),` as an immediate send. No attachment is fetched.`]})}),`\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(Heading,{level:`2`,id:`response-fields`,children:`Response Fields`}),`\n`,_jsx(ResponseField,{name:`eligible`,type:`boolean`,id:`param-eligible`,children:_jsxs(_components.p,{children:[`Whether the message would be accepted for sending. Equals the AND of all `,_jsx(_components.strong,{children:`binding`}),` checks: `,_jsx(_components.code,{children:`sender_ready`}),`, `,_jsx(_components.code,{children:`byoc_webhook_ready`}),`, `,_jsx(_components.code,{children:`not_suppressed`}),`, `,_jsx(_components.code,{children:`billing_ok`}),`, `,_jsx(_components.code,{children:`byoc_required_ok`}),`, `,_jsx(_components.code,{children:`list_allowed_for_key`}),`, `,_jsx(_components.code,{children:`daily_send_cap_ok`}),`, and `,_jsx(_components.code,{children:`send_policy_available`}),`, with `,_jsx(_components.code,{children:`confirmation_required`}),` false. MMS also requires `,_jsx(_components.code,{children:`mms_supported`}),`, `,_jsx(_components.code,{children:`mms_enabled`}),`, and `,_jsx(_components.code,{children:`mms_key_enabled`}),`. `,_jsx(_components.code,{children:`within_tcpa_hours`}),` is `,_jsx(_components.strong,{children:`advisory only`}),` and does not affect `,_jsx(_components.code,{children:`eligible`}),`.`]})}),`\n`,_jsxs(ResponseField,{name:`checks`,type:`object`,id:`param-checks`,children:[_jsx(_components.p,{children:`Per-gate results.`}),_jsxs(Expandable,{title:`checks`,children:[_jsxs(ResponseField,{name:`confirmation_required`,type:`boolean`,id:`param-confirmation-required`,children:[`When true, the key requires human approval and `,_jsx(_components.code,{children:`eligible`}),` is false for a direct send. Hold the SMS for approval instead.`]}),_jsx(ResponseField,{name:`send_policy_available`,type:`boolean`,id:`param-send-policy-available`,children:`False when current confirmation policy cannot be verified; direct-send eligibility is false.`}),_jsx(ResponseField,{name:`sender_ready`,type:`boolean`,id:`param-sender-ready`,children:`The sending list exists, is active, and belongs to you.`}),_jsx(ResponseField,{name:`mms_supported`,type:`boolean`,id:`param-mms-supported`,children:`Present for MMS. The sending number supports MMS.`}),_jsx(ResponseField,{name:`mms_enabled`,type:`boolean`,id:`param-mms-enabled`,children:`Present for MMS. The global MMS rollout and this account’s MMS gate are enabled.`}),_jsxs(ResponseField,{name:`mms_key_enabled`,type:`boolean`,id:`param-mms-key-enabled`,children:[`Present for MMS. The key has explicit `,_jsx(_components.code,{children:`sends.send`}),` and `,_jsx(_components.code,{children:`mms.send`}),` grants and is not blocked by owner or admin policy.`]}),_jsx(ResponseField,{name:`byoc_webhook_ready`,type:`boolean`,id:`param-byoc-webhook-ready`,children:`For BYOC lists, the delivery webhook is verified.`}),_jsx(ResponseField,{name:`not_suppressed`,type:`boolean`,id:`param-not-suppressed`,children:`The recipient is not opted out or blocked.`}),_jsxs(ResponseField,{name:`within_tcpa_hours`,type:`boolean`,id:`param-within-tcpa-hours`,children:[_jsx(_components.strong,{children:`Advisory.`}),` `,_jsx(_components.code,{children:`true`}),` if the current time is within the recipient’s TCPA calling window, `,_jsx(_components.code,{children:`false`}),` if in quiet hours. Computed only for `,_jsx(_components.code,{children:`+1`}),` numbers (defaults `,_jsx(_components.code,{children:`true`}),` otherwise). The raw API send path does not enforce quiet hours — enforce it yourself if you need to.`]}),_jsx(ResponseField,{name:`billing_ok`,type:`boolean`,id:`param-billing-ok`,children:`The account’s billing is in good standing.`}),_jsx(ResponseField,{name:`byoc_required_ok`,type:`boolean`,id:`param-byoc-required-ok`,children:`The account is allowed to send from this list (free-tier accounts must use a BYOC list).`}),_jsxs(ResponseField,{name:`list_allowed_for_key`,type:`boolean`,id:`param-list-allowed-for-key`,children:[`The calling key’s `,_jsx(_components.code,{children:`send_policy.list_numbers`}),` (see `,_jsx(_components.a,{href:`/api-reference/v2/auth/whoami`,children:`Who Am I`}),`) is empty or includes this `,_jsx(_components.code,{children:`list_number`}),`.`]}),_jsxs(ResponseField,{name:`daily_send_cap_ok`,type:`boolean`,id:`param-daily-send-cap-ok`,children:[`The key passes the daily-cap check. Every live key, including an uncapped key, requires an available authoritative policy store; an outage or invalid stored daily cap reports `,_jsx(_components.code,{children:`false`}),`. Capped live keys also need room left for today (UTC). Sandbox requests with a valid stored cap pass without reading or consuming quota. A successful preflight does not reserve quota or guarantee a later send will be admitted.`]})]})]}),`\n`,_jsxs(ResponseField,{name:`message_type`,type:`string`,id:`param-message-type`,children:[_jsx(_components.code,{children:`mms`}),` for an MMS request. Omitted for SMS.`]}),`\n`,_jsxs(ResponseField,{name:`segment_count`,type:`integer | null`,id:`param-segment-count`,children:[`Number of SMS segments the body would use. `,_jsx(_components.code,{children:`null`}),` for MMS.`]}),`\n`,_jsxs(ResponseField,{name:`encoding`,type:`string | null`,id:`param-encoding`,children:[_jsx(_components.code,{children:`GSM-7`}),` or `,_jsx(_components.code,{children:`UCS-2`}),` for SMS; `,_jsx(_components.code,{children:`null`}),` for MMS.`]}),`\n`,_jsxs(ResponseField,{name:`estimated_cost`,type:`number | null`,id:`param-estimated-cost`,children:[`Marginal SMS cost at the account’s current tier and cycle position. `,_jsx(_components.code,{children:`null`}),` for MMS or a child pooled to its parent’s billing.`]}),`\n`,_jsxs(ResponseField,{name:`currency`,type:`string`,id:`param-currency`,children:[`Currency of `,_jsx(_components.code,{children:`estimated_cost`}),` (e.g. `,_jsx(_components.code,{children:`usd`}),`).`]}),`\n`,_jsx(ResponseField,{name:`cost_basis`,type:`string`,id:`param-cost-basis`,children:`How the estimate was derived, why a pooled child’s cost is managed by its parent, or why MMS pricing is not estimated.`}),`\n`,_jsxs(ResponseField,{name:`contact_on_list`,type:`boolean | null`,id:`param-contact-on-list`,children:[`Whether the recipient is an active contact on the list. `,_jsx(_components.code,{children:`false`}),` means the recipient is on the list but their membership is inactive; `,_jsx(_components.code,{children:`null`}),` means the recipient has no membership on that list, or the sending list could not be resolved.`]}),`\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:`invalid_payload`})}),_jsx(_components.td,{children:`The body is not a JSON object.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`missing_fields`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`to`}),`, `,_jsx(_components.code,{children:`list_number`}),`, or an SMS `,_jsx(_components.code,{children:`body`}),` is missing or empty.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_mms_media`})}),_jsx(_components.td,{children:`MMS attachments, subject, or caption fail validation.`})]}),_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:[_jsx(_components.code,{children:`to`}),` is not a valid E.164 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:[_jsx(_components.code,{children:`list_number`}),` is not a valid E.164 number.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_rcs_text`})}),_jsxs(_components.td,{children:[`An RCS list was selected and `,_jsx(_components.code,{children:`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_contact_data`})}),_jsx(_components.td,{children:`An RCS list was selected and a contact macro value contains invalid Unicode.`})]})]})]}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`Warm-up is not evaluated by preflight. A warm-up-gated list may pass preflight but still defer a live send.`})})]})}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":"Preflight a Send","api":"POST /v2/messages/preflight","description":"Check sending eligibility, segment count, and estimated cost without submitting a message.","href":"/api-reference/v2/messages/preflight"}}},"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},{CodeBlock,Expandable,Heading,Note,ParamField,RequestExample,ResponseExample,ResponseField,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,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:[`Checks current sending eligibility without submitting a message or charging message usage. Billing checks may repair account state or contact the billing provider. Use it to validate a recipient, preview segment count and cost, and inspect blockers. Works with live and `,_jsx(_components.a,{href:`/api-reference/v2/sandbox`,children:`sandbox`}),` keys; warm-up and later execution checks can still refuse a send.`]}),`\n`,_jsxs(_components.p,{children:[`For a confirmation-required key, `,_jsx(_components.code,{children:`confirmation_required: true`}),` makes direct-send `,_jsx(_components.code,{children:`eligible`}),` false. This is expected: resolve other blockers, then `,_jsx(_components.a,{href:`/agents/send-with-approval`,children:`hold the SMS for human approval`}),`. Pending approvals do not support MMS. Do not disable confirmation to make preflight eligible.`]}),`\n`,_jsx(Heading,{level:`2`,id:`body-parameters`,children:`Body Parameters`}),`\n`,_jsx(ParamField,{body:`to`,type:`string`,required:true,id:`param-to`,children:_jsx(_components.p,{children:`Recipient phone number (E.164).`})}),`\n`,_jsx(ParamField,{body:`list_number`,type:`string`,required:true,id:`param-list-number`,children:_jsx(_components.p,{children:`Sending list phone number (E.164). Must belong to your account.`})}),`\n`,_jsx(ParamField,{body:`body`,type:`string`,id:`param-body`,children:_jsx(_components.p,{children:`Required for SMS; optional or empty for MMS. An MMS caption may contain up to 4,096 characters.`})}),`\n`,_jsx(ParamField,{body:`media`,type:`array`,id:`param-media`,children:_jsxs(_components.p,{children:[`Non-empty array of hosted MMS attachments. Uses the same `,_jsx(_components.a,{href:`/guides/mms#request-requirements`,children:`media fields and limits`}),` as an immediate send. No attachment is fetched.`]})}),`\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(Heading,{level:`2`,id:`response-fields`,children:`Response Fields`}),`\n`,_jsx(ResponseField,{name:`eligible`,type:`boolean`,id:`param-eligible`,children:_jsxs(_components.p,{children:[`Whether the message would be accepted for sending. Equals the AND of all `,_jsx(_components.strong,{children:`binding`}),` checks: `,_jsx(_components.code,{children:`sender_ready`}),`, `,_jsx(_components.code,{children:`byoc_webhook_ready`}),`, `,_jsx(_components.code,{children:`not_suppressed`}),`, `,_jsx(_components.code,{children:`billing_ok`}),`, `,_jsx(_components.code,{children:`byoc_required_ok`}),`, `,_jsx(_components.code,{children:`list_allowed_for_key`}),`, `,_jsx(_components.code,{children:`daily_send_cap_ok`}),`, and `,_jsx(_components.code,{children:`send_policy_available`}),`, with `,_jsx(_components.code,{children:`confirmation_required`}),` false. MMS also requires `,_jsx(_components.code,{children:`mms_supported`}),`, `,_jsx(_components.code,{children:`mms_enabled`}),`, and `,_jsx(_components.code,{children:`mms_key_enabled`}),`. `,_jsx(_components.code,{children:`within_tcpa_hours`}),` is `,_jsx(_components.strong,{children:`advisory only`}),` and does not affect `,_jsx(_components.code,{children:`eligible`}),`.`]})}),`\n`,_jsxs(ResponseField,{name:`checks`,type:`object`,id:`param-checks`,children:[_jsx(_components.p,{children:`Per-gate results.`}),_jsxs(Expandable,{title:`checks`,children:[_jsxs(ResponseField,{name:`confirmation_required`,type:`boolean`,id:`param-confirmation-required`,children:[`When true, the key requires human approval and `,_jsx(_components.code,{children:`eligible`}),` is false for a direct send. Hold the SMS for approval instead.`]}),_jsx(ResponseField,{name:`send_policy_available`,type:`boolean`,id:`param-send-policy-available`,children:`False when current confirmation policy cannot be verified; direct-send eligibility is false.`}),_jsx(ResponseField,{name:`sender_ready`,type:`boolean`,id:`param-sender-ready`,children:`The sending list exists, is active, and belongs to you.`}),_jsx(ResponseField,{name:`mms_supported`,type:`boolean`,id:`param-mms-supported`,children:`Present for MMS. The sending number supports MMS.`}),_jsx(ResponseField,{name:`mms_enabled`,type:`boolean`,id:`param-mms-enabled`,children:`Present for MMS. The global MMS rollout and this account’s MMS gate are enabled.`}),_jsxs(ResponseField,{name:`mms_key_enabled`,type:`boolean`,id:`param-mms-key-enabled`,children:[`Present for MMS. The key has explicit `,_jsx(_components.code,{children:`sends.send`}),` and `,_jsx(_components.code,{children:`mms.send`}),` grants and is not blocked by owner or admin policy.`]}),_jsx(ResponseField,{name:`byoc_webhook_ready`,type:`boolean`,id:`param-byoc-webhook-ready`,children:`For BYOC lists, the delivery webhook is verified.`}),_jsx(ResponseField,{name:`not_suppressed`,type:`boolean`,id:`param-not-suppressed`,children:`The recipient is not opted out or blocked.`}),_jsxs(ResponseField,{name:`within_tcpa_hours`,type:`boolean`,id:`param-within-tcpa-hours`,children:[_jsx(_components.strong,{children:`Advisory.`}),` `,_jsx(_components.code,{children:`true`}),` if the current time is within the recipient’s TCPA calling window, `,_jsx(_components.code,{children:`false`}),` if in quiet hours. Computed only for `,_jsx(_components.code,{children:`+1`}),` numbers (defaults `,_jsx(_components.code,{children:`true`}),` otherwise). The raw API send path does not enforce quiet hours — enforce it yourself if you need to.`]}),_jsx(ResponseField,{name:`billing_ok`,type:`boolean`,id:`param-billing-ok`,children:`The account’s billing is in good standing.`}),_jsx(ResponseField,{name:`byoc_required_ok`,type:`boolean`,id:`param-byoc-required-ok`,children:`The account is allowed to send from this list (free-tier accounts must use a BYOC list).`}),_jsxs(ResponseField,{name:`list_allowed_for_key`,type:`boolean`,id:`param-list-allowed-for-key`,children:[`The calling key’s `,_jsx(_components.code,{children:`send_policy.list_numbers`}),` (see `,_jsx(_components.a,{href:`/api-reference/v2/auth/whoami`,children:`Who Am I`}),`) is empty or includes this `,_jsx(_components.code,{children:`list_number`}),`.`]}),_jsxs(ResponseField,{name:`daily_send_cap_ok`,type:`boolean`,id:`param-daily-send-cap-ok`,children:[`The key passes the daily-cap check. Every live key, including an uncapped key, requires an available authoritative policy store; an outage or invalid stored daily cap reports `,_jsx(_components.code,{children:`false`}),`. Capped live keys also need room left for today (UTC). Sandbox requests with a valid stored cap pass without reading or consuming quota. A successful preflight does not reserve quota or guarantee a later send will be admitted.`]})]})]}),`\n`,_jsxs(ResponseField,{name:`message_type`,type:`string`,id:`param-message-type`,children:[_jsx(_components.code,{children:`mms`}),` for an MMS request. Omitted for SMS.`]}),`\n`,_jsxs(ResponseField,{name:`segment_count`,type:`integer | null`,id:`param-segment-count`,children:[`Number of SMS segments the body would use. `,_jsx(_components.code,{children:`null`}),` for MMS.`]}),`\n`,_jsxs(ResponseField,{name:`encoding`,type:`string | null`,id:`param-encoding`,children:[_jsx(_components.code,{children:`GSM-7`}),` or `,_jsx(_components.code,{children:`UCS-2`}),` for SMS; `,_jsx(_components.code,{children:`null`}),` for MMS.`]}),`\n`,_jsxs(ResponseField,{name:`estimated_cost`,type:`number | null`,id:`param-estimated-cost`,children:[`Marginal SMS cost at the account’s current tier and cycle position. `,_jsx(_components.code,{children:`null`}),` for MMS or a child pooled to its parent’s billing.`]}),`\n`,_jsxs(ResponseField,{name:`currency`,type:`string`,id:`param-currency`,children:[`Currency of `,_jsx(_components.code,{children:`estimated_cost`}),` (e.g. `,_jsx(_components.code,{children:`usd`}),`).`]}),`\n`,_jsx(ResponseField,{name:`cost_basis`,type:`string`,id:`param-cost-basis`,children:`How the estimate was derived, why a pooled child’s cost is managed by its parent, or why MMS pricing is not estimated.`}),`\n`,_jsxs(ResponseField,{name:`contact_on_list`,type:`boolean | null`,id:`param-contact-on-list`,children:[`Whether the recipient is an active contact on the list. `,_jsx(_components.code,{children:`false`}),` means the recipient is on the list but their membership is inactive; `,_jsx(_components.code,{children:`null`}),` means the recipient has no membership on that list, or the sending list could not be resolved.`]}),`\n`,_jsx(Heading,{level:`2`,id:`examples`,children:`Examples`}),`\n`,_jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`4`,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:`4`,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/messages/preflight`}),_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\"`}),_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:` '{ \"to\": \"+14155551234\", \"list_number\": \"+18005551000\", \"body\": \"Hello!\" }'`})]}),`\n`]})})})}),`\n`,_jsxs(ResponseExample,{children:[_jsx(CodeBlock,{filename:`Eligible (200)`,numberOfLines:`19`,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:`19`,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:` \"eligible\"`}),_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:` \"checks\"`}),_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:` \"sender_ready\"`}),_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:` \"byoc_webhook_ready\"`}),_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:` \"not_suppressed\"`}),_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:` \"within_tcpa_hours\"`}),_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:` \"billing_ok\"`}),_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:` \"byoc_required_ok\"`}),_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:` \"list_allowed_for_key\"`}),_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:` \"daily_send_cap_ok\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\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:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"segment_count\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_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:` \"encoding\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"GSM-7\"`}),_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:` \"estimated_cost\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0.0045`}),_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:` \"currency\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"usd\"`}),_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:` \"cost_basis\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"estimated at current cycle position; final unit cost is positional within the pooled period\"`}),_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:` \"contact_on_list\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Pooled child (200)`,numberOfLines:`10`,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:`10`,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:` \"eligible\"`}),_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:` \"checks\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"sender_ready\"`}),_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:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"byoc_webhook_ready\"`}),_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:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"not_suppressed\"`}),_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:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"within_tcpa_hours\"`}),_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:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"billing_ok\"`}),_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:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"byoc_required_ok\"`}),_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:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"list_allowed_for_key\"`}),_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:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"daily_send_cap_ok\"`}),_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:` \"segment_count\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_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:` \"encoding\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"GSM-7\"`}),_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:` \"estimated_cost\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_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:` \"currency\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"usd\"`}),_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:` \"cost_basis\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"cost is managed by the parent account (pooled billing)\"`}),_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:` \"contact_on_list\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\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:`invalid_payload`})}),_jsx(_components.td,{children:`The body is not a JSON object.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`missing_fields`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`to`}),`, `,_jsx(_components.code,{children:`list_number`}),`, or an SMS `,_jsx(_components.code,{children:`body`}),` is missing or empty.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_mms_media`})}),_jsx(_components.td,{children:`MMS attachments, subject, or caption fail validation.`})]}),_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:[_jsx(_components.code,{children:`to`}),` is not a valid E.164 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:[_jsx(_components.code,{children:`list_number`}),` is not a valid E.164 number.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_rcs_text`})}),_jsxs(_components.td,{children:[`An RCS list was selected and `,_jsx(_components.code,{children:`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_contact_data`})}),_jsx(_components.td,{children:`An RCS list was selected and a contact macro value contains invalid Unicode.`})]})]})]}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`Warm-up is not evaluated by preflight. A warm-up-gated list may pass preflight but still defer a live send.`})})]})}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":"Preflight a Send","api":"POST /v2/messages/preflight","description":"Check sending eligibility, segment count, and estimated cost without submitting a message.","href":"/api-reference/v2/messages/preflight"}}}},"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":[]}],"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=\"4\">\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/messages/preflight\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\"\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\"> '{ \"to\": \"+14155551234\", \"list_number\": \"+18005551000\", \"body\": \"Hello!\" }'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]},"response":{"type":"ResponseExample","children":[{"filename":"Eligible (200)","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=\"19\">\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\"> \"eligible\"\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\"> \"checks\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"sender_ready\"\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\"> \"byoc_webhook_ready\"\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\"> \"not_suppressed\"\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\"> \"within_tcpa_hours\"\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\"> \"billing_ok\"\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\"> \"byoc_required_ok\"\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\"> \"list_allowed_for_key\"\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\"> \"daily_send_cap_ok\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\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:#116329;--shiki-dark:#9CDCFE\"> \"segment_count\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">1\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"encoding\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"GSM-7\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"estimated_cost\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">0.0045\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"currency\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"usd\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"cost_basis\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"estimated at current cycle position; final unit cost is positional within the pooled period\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"contact_on_list\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\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":"Pooled child (200)","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=\"10\">\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\"> \"eligible\"\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\"> \"checks\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: { \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"sender_ready\"\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>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"byoc_webhook_ready\"\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>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"not_suppressed\"\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>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"within_tcpa_hours\"\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>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"billing_ok\"\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>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"byoc_required_ok\"\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>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"list_allowed_for_key\"\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>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"daily_send_cap_ok\"\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\"> \"segment_count\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">1\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"encoding\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"GSM-7\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"estimated_cost\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"currency\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"usd\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"cost_basis\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"cost is managed by the parent account (pooled billing)\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"contact_on_list\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\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":"Preflight a Send","path":"/v2/messages/preflight","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":{"to":[{"type":"string","description":"Recipient phone number (E.164).","required":true}],"list_number":[{"type":"string","description":"Sending list phone number (E.164). Must belong to your account.","required":true}],"body":[{"type":"string","description":"Required for SMS; optional or empty for MMS. An MMS caption may contain up to 4,096 characters."}],"media":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Non-empty array of hosted MMS attachments. Uses the same media fields and limits as an immediate send. No attachment is fetched."}],"subject":[{"type":"string","description":"Optional MMS subject, up to 66 characters. Requires `media` ."}]}}],"examples":{"example":{"value":{"to":"\u003cstring>","list_number":"\u003cstring>","body":"\u003cstring>","media":[{}],"subject":"\u003cstring>"}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"eligible":[{"type":"boolean","description":"Whether the message would be accepted for sending. Equals the AND of all binding checks: `sender_ready` , `byoc_webhook_ready` , `not_suppressed` , `billing_ok` , `byoc_required_ok` , `list_allowed_for_key` , `daily_send_cap_ok` , and `send_policy_available` , with `confirmation_required` false. MMS also requires `mms_supported` , `mms_enabled` , and `mms_key_enabled` . `within_tcpa_hours` is advisory only and does not affect `eligible` ."}],"checks":[{"type":"object","properties":{"confirmation_required":[{"type":"boolean","description":"When true, the key requires human approval and `eligible` is false for a direct send. Hold the SMS for approval instead."}],"send_policy_available":[{"type":"boolean","description":"False when current confirmation policy cannot be verified; direct-send eligibility is false."}],"sender_ready":[{"type":"boolean","description":"The sending list exists, is active, and belongs to you."}],"mms_supported":[{"type":"boolean","description":"Present for MMS. The sending number supports MMS."}],"mms_enabled":[{"type":"boolean","description":"Present for MMS. The global MMS rollout and this account’s MMS gate are enabled."}],"mms_key_enabled":[{"type":"boolean","description":"Present for MMS. The key has explicit `sends.send` and `mms.send` grants and is not blocked by owner or admin policy."}],"byoc_webhook_ready":[{"type":"boolean","description":"For BYOC lists, the delivery webhook is verified."}],"not_suppressed":[{"type":"boolean","description":"The recipient is not opted out or blocked."}],"within_tcpa_hours":[{"type":"boolean","description":"Advisory. `true` if the current time is within the recipient’s TCPA calling window, `false` if in quiet hours. Computed only for `+1` numbers (defaults `true` otherwise). The raw API send path does not enforce quiet hours — enforce it yourself if you need to."}],"billing_ok":[{"type":"boolean","description":"The account’s billing is in good standing."}],"byoc_required_ok":[{"type":"boolean","description":"The account is allowed to send from this list (free-tier accounts must use a BYOC list)."}],"list_allowed_for_key":[{"type":"boolean","description":"The calling key’s `send_policy.list_numbers` (see Who Am I ) is empty or includes this `list_number` ."}],"daily_send_cap_ok":[{"type":"boolean","description":"The key passes the daily-cap check. Every live key, including an uncapped key, requires an available authoritative policy store; an outage or invalid stored daily cap reports `false` . Capped live keys also need room left for today (UTC). Sandbox requests with a valid stored cap pass without reading or consuming quota. A successful preflight does not reserve quota or guarantee a later send will be admitted."}]},"description":"Per-gate results."}],"message_type":[{"type":"string","description":"`mms` for an MMS request. Omitted for SMS."}],"segment_count":[{"type":"object","properties":{},"description":"Number of SMS segments the body would use. `null` for MMS."}],"encoding":[{"type":"object","properties":{},"description":"`GSM-7` or `UCS-2` for SMS; `null` for MMS."}],"estimated_cost":[{"type":"object","properties":{},"description":"Marginal SMS cost at the account’s current tier and cycle position. `null` for MMS or a child pooled to its parent’s billing."}],"currency":[{"type":"string","description":"Currency of `estimated_cost` (e.g. `usd` )."}],"cost_basis":[{"type":"string","description":"How the estimate was derived, why a pooled child’s cost is managed by its parent, or why MMS pricing is not estimated."}],"contact_on_list":[{"type":"object","properties":{},"description":"Whether the recipient is an active contact on the list. `false` means the recipient is on the list but their membership is inactive; `null` means the recipient has no membership on that list, or the sending list could not be resolved."}]}}],"examples":{"example":{"value":{"eligible":true,"checks":{"confirmation_required":true,"send_policy_available":true,"sender_ready":true,"mms_supported":true,"mms_enabled":true,"mms_key_enabled":true,"byoc_webhook_ready":true,"not_suppressed":true,"within_tcpa_hours":true,"billing_ok":true,"byoc_required_ok":true,"list_allowed_for_key":true,"daily_send_cap_ok":true},"message_type":"\u003cstring>","segment_count":{},"encoding":{},"estimated_cost":{},"currency":"\u003cstring>","cost_basis":"\u003cstring>","contact_on_list":{}}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"trackly","siteName":"Trackly SMS","title":"Preflight a Send - Trackly SMS","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-21T02:21:35.138Z","originalFileLocation":"api-reference/v2/messages/preflight.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=\"Check sending eligibility, segment count, and estimated cost without submitting a message.\">\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=\"Preflight a Send - Trackly SMS\">\u003cmeta data-mint-head property=\"og:description\" content=\"Check sending eligibility, segment count, and estimated cost without submitting a message.\">\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/preflight\">\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=Preflight+a+Send\u0026amp;description=Check+sending+eligibility%2C+segment+count%2C+and+estimated+cost+without+submitting+a+message.\u0026amp;theme=bb44b2f671ef6b99ad7abecb\u0026amp;signature=9ce48c76c335d8614737329970bf03424d96e9059143b0cdf89fb2b19f8d407a\">\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=\"Preflight a Send - Trackly SMS\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Check sending eligibility, segment count, and estimated cost without submitting a message.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://trackly.mintlify.site/_mintlify/api/og/v2?division=Messages+%28v2%29\u0026amp;title=Preflight+a+Send\u0026amp;description=Check+sending+eligibility%2C+segment+count%2C+and+estimated+cost+without+submitting+a+message.\u0026amp;theme=bb44b2f671ef6b99ad7abecb\u0026amp;signature=9ce48c76c335d8614737329970bf03424d96e9059143b0cdf89fb2b19f8d407a\">\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/preflight\">\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/preflight.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/preflight#webpage\",\"url\":\"https://docs.tracklysms.com/api-reference/v2/messages/preflight\",\"name\":\"Preflight a Send\",\"description\":\"Check sending eligibility, segment count, and estimated cost without submitting a message.\",\"dateModified\":\"2026-11-21T02:21:35.138Z\",\"isPartOf\":{\"@id\":\"https://docs.tracklysms.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tracklysms.com/api-reference/v2/messages/preflight#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tracklysms.com/api-reference/v2/messages/preflight#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Messages (v2)\",\"item\":\"https://docs.tracklysms.com/api-reference/v2/messages/send-single\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Preflight a Send\",\"item\":\"https://docs.tracklysms.com/api-reference/v2/messages/preflight\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tracklysms.com/api-reference/v2/messages/preflight#apireference\",\"headline\":\"Preflight a Send\",\"name\":\"Preflight a Send\",\"description\":\"Check sending eligibility, segment count, and estimated cost without submitting a message.\",\"url\":\"https://docs.tracklysms.com/api-reference/v2/messages/preflight\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tracklysms.com/api-reference/v2/messages/preflight#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/preflight.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","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","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","description":"Queue raw SMS and MMS messages in a single bulk request.","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","description":"List and filter sent messages, with cursor pagination and an updated_since reconciliation watermark.","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":"Preflight a Send - 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"]}