{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OTPIQ Documentation","description":"Documentation for OTPIQ, this platform provide a robust documentations for OTPIQ.","colors":{"primary":"#ff4607","light":"#ff4607","dark":"#ff4607"},"logo":{"light":"https://mintcdn.com/otpiq-1357e998/3-VBVMjm43QBa28a/logo/light.svg?fit=max\u0026auto=format\u0026n=3-VBVMjm43QBa28a\u0026q=85\u0026s=9b624d5b3613b277ef5bdee89a8587c9","dark":"https://mintcdn.com/otpiq-1357e998/3-VBVMjm43QBa28a/logo/dark.svg?fit=max\u0026auto=format\u0026n=3-VBVMjm43QBa28a\u0026q=85\u0026s=6a0fecbd7d92706833062be734be6712"},"favicon":"https://mintcdn.com/otpiq-1357e998/3-VBVMjm43QBa28a/favicon.ico?fit=max\u0026auto=format\u0026n=3-VBVMjm43QBa28a\u0026q=85\u0026s=e5451ce4d987406ab23309bc6fb2cde5","navbar":{"links":[{"href":"mailto:info@otpiq.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.otpiq.com"}},"footer":{"socials":{"x":"https://x.com/otp_iq","github":"https://github.com/otpiq","linkedin":"https://www.linkedin.com/company/106088956"}},"contextual":{"options":["copy","view","chatgpt","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"otpiq-1357e998","hasAudioNarration":false,"actualSubdomain":"otpiq-1357e998","customDomains":["docs.otpiq.com"],"gitSource":{"type":"github","owner":"sarkarkurdish","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a534f9c3fa2eb468bd54efa","collectionId":"86fd766b-422c-4832-b6ea-050dce9d23c7","schemaVersion":"v3"},"entitlements":{},"buildId":"6ae940077d7c68bafb5be42d:success","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"API reference","count":18},{"language":"default","tag":"Help Center","count":13},{"language":"default","tag":"WhatsApp Campaigns Endpoints","count":9},{"language":"default","tag":"Useful articles","count":6},{"language":"default","tag":"WhatsApp Business API","count":4},{"language":"default","tag":"Messaging \u0026 SMS Endpoints","count":3},{"language":"default","tag":"Delivery Reports Endpoints","count":2},{"language":"default","tag":"Getting started","count":2},{"language":"default","tag":"Project Endpoints","count":1},{"language":"default","tag":"API documentation","count":1}]},"assistantConfig":{"enableStarterQuestions":false},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/whatsapp/campaigns/send-sample","slug":"/api-reference/whatsapp/campaigns/send-sample","pageMetadata":{"title":"Send Sample","description":"Create and immediately start a child sample campaign from a draft or scheduled main campaign","openapi":"POST /whatsapp/campaigns/{_id}/sample","href":"/api-reference/whatsapp/campaigns/send-sample"},"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: \"Create and immediately start a child sample campaign from a draft or scheduled main campaign\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Info}=_components;if(!Info)_missingMdxReference(`Info`,true);return _jsx(Info,{children:_jsx(_components.p,{children:`Sending a sample campaign does not modify the parent campaign. It’s a great way to test your template and parameters before a full broadcast.`})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Send Sample","description":"Create and immediately start a child sample campaign from a draft or scheduled main campaign","openapi":"POST /whatsapp/campaigns/{_id}/sample","href":"/api-reference/whatsapp/campaigns/send-sample"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["WhatsApp Campaigns"],"summary":"Send a sample campaign","description":"Create and immediately start a child sample campaign from a draft or scheduled main campaign","operationId":"createWhatsAppSampleCampaign","parameters":["e9408c26-9e2b-4e62-a2b3-b1a6e50044dd"],"requestBody":"68485cba-be7a-4f6c-b8b7-89ed917baa33","responses":{"201":"d9cc5972-3660-4d49-96e1-87a011bd863b","400":"fc1f4dff-b09b-4a05-8393-cc16a0214531","401":"3e2f2b23-0e83-4ef0-9528-75b4b6769bbd","403":"f42706d7-aaca-4397-ab15-089c3516aa6f","404":"657dbedc-1ab7-4dcf-b7d6-9b721e884f0b"},"method":"post","type":"path","servers":["52cb902f-1ed2-4da5-aa4a-043ad9246f14"],"security":["08c00a83-488a-43c5-9bc9-885af09be218"],"path":"/whatsapp/campaigns/{_id}/sample","baseUrlOptions":["https://api.otpiq.com/api"],"title":"Send a sample campaign","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e9408c26-9e2b-4e62-a2b3-b1a6e50044dd":{"name":"_id","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$","isRequired":true,"description":"Campaign MongoDB id returned on create","uniqueKey":"","typeLabel":"string"},"example":"664abc123def456789012346","description":"Campaign MongoDB id returned on create"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["recipients"],"properties":{"recipients":{"type":"array","minItems":1,"maxItems":1000,"items":{"type":"object","required":["phoneNumber"],"properties":{"phoneNumber":{"type":"string","minLength":8,"maxLength":20,"description":"Digits only, international format (e.g. 9647712345678)","example":"9647712345678","isRequired":true,"uniqueKey":"recipients.items.[INDEX].phoneNumber","typeLabel":"string"},"templateParameters":{"type":"object","properties":{"body":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"recipients.items.[INDEX].templateParameters.body.additionalProperties","typeLabel":"string"},"description":"Body variable values keyed by placeholder index (e.g. `\"1\"`, `\"2\"`)","uniqueKey":"recipients.items.[INDEX].templateParameters.body","typeLabel":"object"},"header":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"recipients.items.[INDEX].templateParameters.header.additionalProperties","typeLabel":"string"},"description":"Header variable values keyed by placeholder index, or media URLs:\n`imageUrl`, `videoUrl`, `documentUrl` depending on template header format\n","uniqueKey":"recipients.items.[INDEX].templateParameters.header","typeLabel":"object"},"buttons":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"recipients.items.[INDEX].templateParameters.buttons.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"recipients.items.[INDEX].templateParameters.buttons.additionalProperties","typeLabel":"object"},"description":"Button URL variables keyed by button index, then variable index","uniqueKey":"recipients.items.[INDEX].templateParameters.buttons","typeLabel":"object"}},"additionalProperties":false,"description":"Required when the template has variables; omit otherwise","uniqueKey":"recipients.items.[INDEX].templateParameters","typeLabel":"object"}},"uniqueKey":"recipients.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"recipients","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"recipients":[{"phoneNumber":"9647712345678","templateParameters":{"body":{},"header":{},"buttons":{}}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"d9cc5972-3660-4d49-96e1-87a011bd863b":{"description":"Sample campaign created and started","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"data":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[a-fA-F0-9]{24}$","uniqueKey":"data._id","typeLabel":"string"},"campaignId":{"type":"string","pattern":"^wac_[a-z0-9]+$","description":"Human-readable campaign reference (e.g. wac_abc123)","uniqueKey":"data.campaignId","typeLabel":"string"},"name":{"type":"string","uniqueKey":"data.name","typeLabel":"string"},"status":{"type":"string","enum":["draft","scheduled","running","completed","failed"],"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"category":{"type":"string","enum":["MARKETING","UTILITY"],"uniqueKey":"data.category","typeLabel":"enum\u003cstring>"},"template":{"oneOf":[{"type":"string","description":"MongoDB id or populated object with name, language, category","uniqueKey":"data.template.oneOf.0","typeLabel":"string"},{"type":"object","description":"MongoDB id or populated object with name, language, category","additionalProperties":true,"uniqueKey":"data.template.oneOf.1","typeLabel":"object"}],"uniqueKey":"data.template","typeLabel":"string | object"},"phoneNumber":{"oneOf":[{"type":"string","description":"MongoDB id or populated object with displayPhoneNumber, phoneNumber, verifiedName","uniqueKey":"data.phoneNumber.oneOf.0","typeLabel":"string"},{"type":"object","description":"MongoDB id or populated object with displayPhoneNumber, phoneNumber, verifiedName","additionalProperties":true,"uniqueKey":"data.phoneNumber.oneOf.1","typeLabel":"object"}],"uniqueKey":"data.phoneNumber","typeLabel":"string | object"},"scheduleType":{"type":"string","enum":["now","schedule"],"description":"Exactly two allowed values:\n- `now` — save as draft; start manually via POST `.../start` (`scheduledFor` not used)\n- `schedule` — **requires** `scheduledFor` (future datetime); saves as `scheduled`; auto-starts at that time\n","uniqueKey":"data.scheduleType","typeLabel":"enum\u003cstring>"},"scheduledFor":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.scheduledFor.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.scheduledFor.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.scheduledFor","typeLabel":"string\u003cdate-time> | null"},"startedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.startedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.startedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.startedAt","typeLabel":"string\u003cdate-time> | null"},"completedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.completedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.completedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.completedAt","typeLabel":"string\u003cdate-time> | null"},"totalRecipients":{"type":"integer","uniqueKey":"data.totalRecipients","typeLabel":"integer"},"sentCount":{"type":"integer","uniqueKey":"data.sentCount","typeLabel":"integer"},"deliveredCount":{"type":"integer","uniqueKey":"data.deliveredCount","typeLabel":"integer"},"failedCount":{"type":"integer","uniqueKey":"data.failedCount","typeLabel":"integer"},"estimatedTotalCost":{"type":"number","description":"Total estimated cost in IQD (set when recipients are attached)","uniqueKey":"data.estimatedTotalCost","typeLabel":"number"},"reservedAmount":{"type":"number","description":"Credits reserved at start in IQD","uniqueKey":"data.reservedAmount","typeLabel":"number"},"reconciledAmount":{"type":"number","description":"Final billed amount after delivery reconciliation","uniqueKey":"data.reconciledAmount","typeLabel":"number"},"billingStatus":{"type":"string","enum":["none","reserved","reconciled"],"uniqueKey":"data.billingStatus","typeLabel":"enum\u003cstring>"},"isSampleCampaign":{"type":"boolean","uniqueKey":"data.isSampleCampaign","typeLabel":"boolean"},"sampleOfCampaign":{"oneOf":[{"type":"string","description":"Parent campaign when this is a sample send","uniqueKey":"data.sampleOfCampaign.oneOf.0","typeLabel":"string"},{"type":"object","description":"Parent campaign when this is a sample send","additionalProperties":true,"uniqueKey":"data.sampleOfCampaign.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"data.sampleOfCampaign.oneOf.2","typeLabel":"null"}],"uniqueKey":"data.sampleOfCampaign","typeLabel":"string | object | null"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"data.updatedAt","typeLabel":"string\u003cdate-time>"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"_id":"\u003cstring>","campaignId":"\u003cstring>","name":"\u003cstring>","status":"draft","category":"MARKETING","template":"\u003cstring>","phoneNumber":"\u003cstring>","scheduleType":"now","scheduledFor":"2023-11-07T05:31:56Z","startedAt":"2023-11-07T05:31:56Z","completedAt":"2023-11-07T05:31:56Z","totalRecipients":123,"sentCount":123,"deliveredCount":123,"failedCount":123,"estimatedTotalCost":123,"reservedAmount":123,"reconciledAmount":123,"billingStatus":"none","isSampleCampaign":true,"sampleOfCampaign":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"fc1f4dff-b09b-4a05-8393-cc16a0214531":{"description":"Validation or business rule error","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"unsupportedPhoneNumbers":{"type":"array","items":{"type":"string","uniqueKey":"unsupportedPhoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"Present when one or more recipient countries are unsupported","uniqueKey":"unsupportedPhoneNumbers","typeLabel":"string[]"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":"Recipients cannot exceed 1000 per request"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"Recipients cannot exceed 1000 per request"}}},"exampleType":"examples"}},"exampleType":"examples"},"3e2f2b23-0e83-4ef0-9528-75b4b6769bbd":{"description":"Missing, invalid, or unknown API key","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"example":{"message":"Unauthorized, please use your project api key"},"examples":{"Example":{"title":"Example","value":{"message":"Unauthorized, please use your project api key"}}},"exampleType":"examples"}},"exampleType":"examples"},"f42706d7-aaca-4397-ab15-089c3516aa6f":{"description":"Forbidden (IP allowlist, dev key restrictions, etc.)","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"unsupportedPhoneNumbers":{"type":"array","items":{"type":"string","uniqueKey":"unsupportedPhoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"Present when one or more recipient countries are unsupported","uniqueKey":"unsupportedPhoneNumbers","typeLabel":"string[]"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"\u003cstring>","unsupportedPhoneNumbers":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"657dbedc-1ab7-4dcf-b7d6-9b721e884f0b":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"unsupportedPhoneNumbers":{"type":"array","items":{"type":"string","uniqueKey":"unsupportedPhoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"Present when one or more recipient countries are unsupported","uniqueKey":"unsupportedPhoneNumbers","typeLabel":"string[]"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":"Campaign not found"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"Campaign not found"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"08c00a83-488a-43c5-9bc9-885af09be218":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Project API key (`sk_live…` or `sk_dev…`). Send it as `Authorization: Bearer \u003capi_key>`.","scopes":[]}}},"servers":{"52cb902f-1ed2-4da5-aa4a-043ad9246f14":{"url":"https://api.otpiq.com/api","description":"Production API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Project API key (`sk_live…` or `sk_dev…`). Send it as `Authorization: Bearer \u003capi_key>`.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Project API key (`sk_live…` or `sk_dev…`). Send it as `Authorization: Bearer \u003capi_key>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"otpiq-1357e998","siteName":"OTPIQ Documentation","title":"Send Sample - OTPIQ Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-20T11:07:05.796Z","originalFileLocation":"api-reference/whatsapp/campaigns/send-sample.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=\"Create and immediately start a child sample campaign from a draft or scheduled main campaign\">\u003cmeta data-mint-head name=\"application-name\" content=\"OTPIQ Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/otpiq-1357e998/1JzE0wbYZphf8Bey/_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/otpiq-1357e998/1JzE0wbYZphf8Bey/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/otpiq-1357e998/1JzE0wbYZphf8Bey/_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/otpiq-1357e998/1JzE0wbYZphf8Bey/_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/otpiq-1357e998/1JzE0wbYZphf8Bey/_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/otpiq-1357e998/1JzE0wbYZphf8Bey/_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/otpiq-1357e998/1JzE0wbYZphf8Bey/_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/otpiq-1357e998/1JzE0wbYZphf8Bey/_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/otpiq-1357e998/1JzE0wbYZphf8Bey/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Send Sample - OTPIQ Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create and immediately start a child sample campaign from a draft or scheduled main campaign\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OTPIQ Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.otpiq.com/api-reference/whatsapp/campaigns/send-sample\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://otpiq-1357e998.mintlify.app/_mintlify/api/og/v2?division=WhatsApp+Campaigns+Endpoints\u0026amp;title=Send+Sample\u0026amp;description=Create+and+immediately+start+a+child+sample+campaign+from+a+draft+or+scheduled+main+campaign\u0026amp;theme=e42692449f8ea3db087586d1\u0026amp;signature=18dbc6c951bca5b70a5b12477cb953517c238447f047291a74220fd80d1253fd\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Send Sample - OTPIQ Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create and immediately start a child sample campaign from a draft or scheduled main campaign\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://otpiq-1357e998.mintlify.app/_mintlify/api/og/v2?division=WhatsApp+Campaigns+Endpoints\u0026amp;title=Send+Sample\u0026amp;description=Create+and+immediately+start+a+child+sample+campaign+from+a+draft+or+scheduled+main+campaign\u0026amp;theme=e42692449f8ea3db087586d1\u0026amp;signature=18dbc6c951bca5b70a5b12477cb953517c238447f047291a74220fd80d1253fd\">\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/otpiq-1357e998/1JzE0wbYZphf8Bey/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OTPIQ Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff4607\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.otpiq.com/api-reference/whatsapp/campaigns/send-sample\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/whatsapp/campaigns/send-sample.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.otpiq.com/#organization\",\"name\":\"OTPIQ Documentation\",\"url\":\"https://docs.otpiq.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/otpiq-1357e998/3-VBVMjm43QBa28a/logo/light.svg?fit=max\u0026auto=format\u0026n=3-VBVMjm43QBa28a\u0026q=85\u0026s=9b624d5b3613b277ef5bdee89a8587c9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.otpiq.com#website\",\"name\":\"OTPIQ Documentation\",\"url\":\"https://docs.otpiq.com\",\"publisher\":{\"@id\":\"https://docs.otpiq.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.otpiq.com/api-reference/whatsapp/campaigns/send-sample#webpage\",\"url\":\"https://docs.otpiq.com/api-reference/whatsapp/campaigns/send-sample\",\"name\":\"Send Sample\",\"description\":\"Create and immediately start a child sample campaign from a draft or scheduled main campaign\",\"dateModified\":\"2026-06-20T11:07:05.796Z\",\"isPartOf\":{\"@id\":\"https://docs.otpiq.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.otpiq.com/api-reference/whatsapp/campaigns/send-sample#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.otpiq.com/api-reference/whatsapp/campaigns/send-sample#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"WhatsApp Campaigns Endpoints\",\"item\":\"https://docs.otpiq.com/api-reference/whatsapp/campaigns/create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Send Sample\",\"item\":\"https://docs.otpiq.com/api-reference/whatsapp/campaigns/send-sample\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.otpiq.com/api-reference/whatsapp/campaigns/send-sample#apireference\",\"headline\":\"Send Sample\",\"name\":\"Send Sample\",\"description\":\"Create and immediately start a child sample campaign from a draft or scheduled main campaign\",\"url\":\"https://docs.otpiq.com/api-reference/whatsapp/campaigns/send-sample\",\"mainEntityOfPage\":{\"@id\":\"https://docs.otpiq.com/api-reference/whatsapp/campaigns/send-sample#webpage\"},\"dateModified\":\"2026-06-20T11:07:05.796Z\",\"publisher\":{\"@id\":\"https://docs.otpiq.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.otpiq.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OTPIQ Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"OTPIQ Documentation","nav":{"global":null,"tabs":[{"tab":"Help Center","pages":[{"title":"Help Center","href":""}]},{"tab":"API reference","groups":[{"group":"API documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Project Endpoints","pages":[{"title":"Get Project Info","openapi":"GET /info","href":"/api-reference/endpoint/get"}]},{"group":"Messaging \u0026 SMS Endpoints","pages":[{"title":"Send SMS","openapi":"POST /sms","href":"/api-reference/messaging/post"},{"title":"Track SMS","openapi":"GET /sms/track/{smsId}","href":"/api-reference/messaging/track"},{"title":"International SMS Pricing","openapi":"GET /international-sms-pricing","href":"/api-reference/messaging/international-sms-pricing"}]},{"group":"Sender ID Endpoints","pages":[{"title":"Get Sender IDs","openapi":"GET /sender-ids","href":"/api-reference/sender-id/get"}]},{"group":"Delivery Reports Endpoints","pages":[{"title":"Generate Delivery Report","openapi":"POST /reports/generate","href":"/api-reference/reports/generate"},{"title":"List Delivery Reports","openapi":"GET /reports","href":"/api-reference/reports/list"}]},{"group":"WhatsApp Endpoints","pages":[{"title":"List WhatsApp Resources","openapi":"GET /whatsapp/resources","href":"/api-reference/whatsapp/resources"}]},{"group":"WhatsApp Campaigns Endpoints","pages":[{"title":"Create Campaign","openapi":"POST /whatsapp/campaigns","href":"/api-reference/whatsapp/campaigns/create"},{"title":"Get Recipient Schema","openapi":"GET /whatsapp/campaigns/recipient-payload","href":"/api-reference/whatsapp/campaigns/get-recipient-payload"},{"title":"Attach Recipients","description":"Append recipients to a draft or scheduled campaign","openapi":"POST /whatsapp/campaigns/{_id}/recipients","href":"/api-reference/whatsapp/campaigns/attach-recipients"},{"title":"Send Sample","openapi":"POST /whatsapp/campaigns/{_id}/sample","href":"/api-reference/whatsapp/campaigns/send-sample"},{"title":"Start Campaign","description":"Reserve project credits and enqueue the campaign for sending","openapi":"POST /whatsapp/campaigns/{_id}/start","href":"/api-reference/whatsapp/campaigns/start"},{"title":"List Campaigns","openapi":"GET /whatsapp/campaigns","href":"/api-reference/whatsapp/campaigns/list"},{"title":"Get Campaign Details","openapi":"GET /whatsapp/campaigns/{_id}","href":"/api-reference/whatsapp/campaigns/get"},{"title":"Update Campaign","openapi":"PATCH /whatsapp/campaigns/{_id}","href":"/api-reference/whatsapp/campaigns/update"},{"title":"Delete Campaign","openapi":"DELETE /whatsapp/campaigns/{_id}","href":"/api-reference/whatsapp/campaigns/delete"}]}]}]},"basePath":"","title":"Send Sample - OTPIQ Documentation","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}