This API sends a test Push or Email campaign to specific users or identifiers before launching it to your entire audience. You can only test campaigns created via the API, not campaigns created through the MoEngage dashboard.
This API is available on request and isn’t enabled by default. To enable it for your workspace, contact your Customer Success Manager or raise a support ticket.
Rate Limits
Rate Limit Name
Rate Limit
Test campaign per second
The total number of test campaign requests per second per client allowed is 10.
Test campaign per minute
The total number of test campaign requests per minute per client allowed is 100.
Test campaign per hour
The total number of test campaign requests per hour per client allowed is 6000.
Notes
Breaching the limits will reject the request.
Per hour and per day limits will consider the calculation based on the last hour and last 24 hrs respectively.
Authorizations
Authorization
string
header
required
Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.
Username: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
Password: Use your API Key, which you can find within the Campaign report/Business events/Custom templates/Catalog API/Inform Report tile.
For more information on authentication and getting your credentials, refer here.
Headers
MOE-APPKEY
string
required
This is the Workspace ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
MOE-PROJECT-CODE
string
This is the project ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at Settings > Account > Portfolio > Project ID. Note: This parameter is mandatory for workspaces with the Portfolio feature enabled.
Body
application/json
Test campaign configuration including content and target test users.
Note: Use the tabs below to select your campaign type. The schema will adapt based on the selected channel.
Push Campaign
Email Campaign
request_id
string
required
A unique identifier for this test request.
Example:
"test_push_12345"
channel
enum<string>
required
The communication channel (automatically set to PUSH for this tab).
Available options:
PUSH
basic_details
object
required
Contains the basic information about the Push campaign.
Show child attributes
campaign_content
object
required
Contains the content and variations for the Push campaign.
Show child attributes
test_campaign_meta
object
required
Metadata for specifying test recipients for Push campaigns.
Show child attributes
personalization_details
object
Override values for personalizing campaign content during testing.
Important:
When you pass personalization details in the personalization_details object of this API, MoEngage uses those details to personalize the user attributes or event attributes present in the content instead of the attributes present in the user profile.
You can use this API only for 10 users at a time.
The same personalization details are used across all users. For example, you pass the first name as Dave in personalization details, you have used the first name in the content, and there are 10 users. In this case, all 10 users will get the same first name (Dave).
Show child attributes
Response
Test campaign sent successfully
Response after successfully sending a test campaign.
data
object
Object containing test results for each identifier.
Each key is an identifier value with its delivery status.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"MoEngage","colors":{"primary":"#2E69FF","light":"#6691FF","dark":"#2554CC"},"logo":{"light":"https://mintcdn.com/moengage/VG5pJbeZsDUmdCZM/logo/light.svg?fit=max\u0026auto=format\u0026n=VG5pJbeZsDUmdCZM\u0026q=85\u0026s=28ca5909311cb6ffe01738e1503b5e64","dark":"https://mintcdn.com/moengage/VG5pJbeZsDUmdCZM/logo/dark.svg?fit=max\u0026auto=format\u0026n=VG5pJbeZsDUmdCZM\u0026q=85\u0026s=728a767d8fb8d3434575a28de18d08c5","href":"https://www.moengage.com/docs/"},"favicon":"https://mintcdn.com/moengage/bJi_ZHRHKldZCdcW/logo/favicon.svg?fit=max\u0026auto=format\u0026n=bJi_ZHRHKldZCdcW\u0026q=85\u0026s=9d13744d3b616913967983f324947bb5","api":{"examples":{"languages":["curl"]}},"appearance":{"default":"system"},"background":{"decoration":"gradient","color":{"light":"#FFFFFF","dark":"#121212"}},"navbar":{"links":[{"href":"/user-guide/contact-support/raise-a-support-ticket-through-moengage-dashboard","label":"Support"},{"href":"https://www.moengage.com/request-demo","label":"Request Demo"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.moengage.com/"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/moengage","x":"https://x.com/i/flow/login?redirect_after_login=%2Fmoengage","youtube":"https://www.youtube.com/c/MoEngage_Global","facebook":"https://www.facebook.com/moengage","github":"https://github.com/moengage"},"links":[{"header":"Support","items":[{"label":"Contact Support","href":"https://www.moengage.com/docs/user-guide/contact-support/raise-a-support-ticket-through-moengage-dashboard"},{"label":"AIRA Support Bot","href":"https://www.moengage.com/docs/user-guide/contact-support/aira-support-bot/aira-overview"},{"label":"Suggest a Feature","href":"https://www.moengage.com/docs/user-guide/contact-support/suggest-a-feature"},{"label":"System Status","href":"https://status.moengage.com"}]},{"header":"Learn","items":[{"label":"MoEngage Academy","href":"https://academy.moengage.com/student/catalog"},{"label":"Use Cases","href":"https://www.moengage.com/docs/use-cases/introduction"},{"label":"Release Notes","href":"https://www.moengage.com/docs/release-notes/subscribe-to-release-notes"},{"label":"Blog","href":"https://www.moengage.com/blog"}]},{"header":"For AI Tools","items":[{"label":"Setup Guide","href":"https://www.moengage.com/docs/documentation-access-to-agents"},{"label":"llms.txt","href":"https://www.moengage.com/docs/llms.txt"},{"label":"llms-full.txt","href":"https://www.moengage.com/docs/llms-full.txt"}]}]},"seo":{"metatags":{"google-site-verification":"ICNaPDX9oefbF09W1b5_U9PDnlkyfyKSRbIap6_dW6o"},"indexing":"all"},"fonts":{"heading":{"family":"circular","source":"https://app-cdn.moengage.com/images/Fonts/CircularXXWeb-Regular.woff2","format":"woff2"},"body":{"family":"circular","source":"https://app-cdn.moengage.com/images/Fonts/CircularXXWeb-Regular.woff2","format":"woff2"}},"styling":{"eyebrows":"breadcrumbs","latex":true},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"interaction":{"drilldown":true},"navigation":{"languages":[{"language":"en","href":""},{"language":"ja","href":"ja"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"moengage","hasAudioNarration":false,"actualSubdomain":"moengage","customDomains":["moengage.com"],"gitSource":{"type":"github","owner":"moengage","repo":"moengage-documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":false,"contextualFeedback":{"allowEmail":true},"issues":false,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afac4bdf20ad22eaaeea9d1","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"en","tag":"Guide","count":1187},{"language":"ja","tag":"ガイド","count":1180},{"language":"en","tag":"User Guide","count":798},{"language":"ja","tag":"ユーザーガイド","count":798},{"language":"en","tag":"Campaigns and Channels","count":437},{"language":"ja","tag":"キャンペーンとチャネル","count":437},{"language":"en","tag":"Partner Integrations","count":390},{"language":"ja","tag":"パートナー統合","count":383},{"language":"en","tag":"SDKs","count":341},{"language":"en","tag":"Developer Guide (SDKs)","count":330},{"language":"ja","tag":"SDK","count":308},{"language":"ja","tag":"開発者ガイド(SDK)","count":297},{"language":"en","tag":"Use Cases","count":218},{"language":"ja","tag":"ユースケース","count":218},{"language":"en","tag":"API Guide","count":185},{"language":"ja","tag":"APIガイド","count":183},{"language":"en","tag":"Endpoints","count":179},{"language":"ja","tag":"エンドポイント","count":177},{"language":"en","tag":"Release Notes","count":140},{"language":"ja","tag":"リリースノート","count":136}],"searchSettings":{"maxResults":8,"isFiltersEnabled":true}},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"deflection":{"enabled":false,"type":"email"}},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"69a03c84f0b21f38ae93fdfb","deploymentId":"68bea8f8fe02728a34cf2acf","questionText":"How do I track user events?","status":"active","generatedBy":"manual","createdAt":"2026-02-26T12:28:52.454Z","updatedAt":"2026-02-26T12:28:52.454Z","__v":0}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/docs/_mintlify/custom/moengage/0a209f0cf9e21c6c/style.css"}],"page":{"pagePath":"api/test-campaigns/test-campaign","slug":"/api/test-campaigns/test-campaign","pageMetadata":{"title":"Test Campaign","description":"This API sends a test Push or Email campaign to specific users or identifiers before launching it to your entire audience. You can only test campaigns created via the API, not campaigns created through the MoEngage dashboard.\n","deprecated":null,"version":null,"openapi":"/api/campaigns/campaigns.yaml post /campaigns/test","href":"/api/test-campaigns/test-campaign","autogeneratedByOpenApi":true},"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: \"This API sends a test Push or Email campaign to specific users or identifiers before launching it to your entire audience. You can only test campaigns created via the API, not campaigns created through the MoEngage dashboard.\"\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={li:`li`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Note,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsx(_components.p,{children:`This API is available on request and isn’t enabled by default. To enable it for your workspace, contact your Customer Success Manager or raise a support ticket.`})}),`\n`,_jsx(Heading,{level:`4`,id:`rate-limits`,children:`Rate Limits`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`Rate Limit Name`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Rate Limit`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`Test campaign per second`}),_jsx(_components.td,{style:{textAlign:`left`},children:`The total number of test campaign requests per second per client allowed is 10.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`Test campaign per minute`}),_jsx(_components.td,{style:{textAlign:`left`},children:`The total number of test campaign requests per minute per client allowed is 100.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`Test campaign per hour`}),_jsx(_components.td,{style:{textAlign:`left`},children:`The total number of test campaign requests per hour per client allowed is 6000.`})]})]})]}),`\n`,_jsxs(Note,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Notes`})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Breaching the limits will reject the request.`}),`\n`,_jsx(_components.li,{children:`Per hour and per day limits will consider the calculation based on the last hour and last 24 hrs respectively.`}),`\n`]})]})]})}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":"Test Campaign","description":"This API sends a test Push or Email campaign to specific users or identifiers before launching it to your entire audience. You can only test campaigns created via the API, not campaigns created through the MoEngage dashboard.\n","deprecated":null,"version":null,"openapi":"/api/campaigns/campaigns.yaml post /campaigns/test","href":"/api/test-campaigns/test-campaign","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Rate Limits","slug":"rate-limits","depth":4,"children":[]}],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/moengage/992523b3cb2256cd/script.js"],"openApiReferenceData":{"operation":{"operationId":"test_campaign","summary":"Test Campaign","description":"This API sends a test Push or Email campaign to specific users or identifiers before launching it to your entire audience. You can only test campaigns created via the API, not campaigns created through the MoEngage dashboard.\n","x-mint":{"content":"\u003cNote>\nThis API is available on request and isn't enabled by default. To enable it for your workspace, contact your Customer Success Manager or raise a support ticket.\n\u003c/Note>\n\n#### Rate Limits\n\n| Rate Limit Name | Rate Limit |\n| :--- | :--- |\n| Test campaign per second | The total number of test campaign requests per second per client allowed is 10. |\n| Test campaign per minute | The total number of test campaign requests per minute per client allowed is 100. |\n| Test campaign per hour | The total number of test campaign requests per hour per client allowed is 6000. | \n\n\u003cNote>\n **Notes**\n * Breaching the limits will reject the request.\n * Per hour and per day limits will consider the calculation based on the last hour and last 24 hrs respectively.\n\u003c/Note>\n"},"tags":["Test Campaigns"],"parameters":["05b947b6-07e3-47de-ac52-1a2d9b782904","e355cde1-d5b5-4f5b-95a2-f164dd402838"],"requestBody":"c2904a71-c3de-4bb4-9ecd-8871a7644900","responses":{"200":"1ad23fd1-8256-42ac-9548-cef7381c46ca","400":"9f5be74f-f962-4fe7-80d6-55c2e2161792","401":"d940ac3d-77e9-4181-b1a1-8151650f5f81","500":"8a91bedf-5fd9-4bc5-a873-707789fa25ca"},"method":"post","type":"path","servers":["5e246dbb-bb10-4650-8d40-2730b1c3a1a8"],"security":["959f046a-3fb3-4068-b8d8-bc2950061e93"],"path":"/campaigns/test","baseUrlOptions":["https://api-{dc}.moengage.com/core-services/v1"],"title":"Test Campaign","codeSamples":[],"requestExampleLanguages":["bash"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"05b947b6-07e3-47de-ac52-1a2d9b782904":{"name":"MOE-APPKEY","in":"header","required":true,"description":"This is the Workspace ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at **Settings** > **Account** > **APIs** > **Workspace ID (earlier app id)**.\n","schema":{"type":"string","isRequired":true,"description":"This is the Workspace ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at **Settings** > **Account** > **APIs** > **Workspace ID (earlier app id)**.\n","uniqueKey":"","typeLabel":"string"},"example":"YOUR_WORKSPACE_ID"},"e355cde1-d5b5-4f5b-95a2-f164dd402838":{"name":"MOE-PROJECT-CODE","in":"header","schema":{"type":"string","description":"This is the project ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at **Settings** > **Account** > **Portfolio** > **Project ID**. **Note**: This parameter is mandatory for workspaces with the [Portfolio](https://www.moengage.com/docs/user-guide/settings/account/portfolio/portfolio) feature enabled.\n","uniqueKey":"","typeLabel":"string"},"description":"This is the project ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at **Settings** > **Account** > **Portfolio** > **Project ID**. **Note**: This parameter is mandatory for workspaces with the [Portfolio](https://www.moengage.com/docs/user-guide/settings/account/portfolio/portfolio) feature enabled.\n","example":"YOUR_PROJECT_ID_XXXX"}},"requestBody":{"description":"Test campaign configuration including content and target test users.\n**Note:** Use the tabs below to select your campaign type. The schema will adapt based on the selected channel.","required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Push Campaign","required":["request_id","channel","basic_details","campaign_content","test_campaign_meta"],"properties":{"request_id":{"type":"string","description":"A unique identifier for this test request.","example":"test_push_12345","isRequired":true,"uniqueKey":"oneOf.0.request_id","typeLabel":"string"},"channel":{"type":"string","enum":["PUSH"],"description":"The communication channel (automatically set to PUSH for this tab).","isRequired":true,"uniqueKey":"oneOf.0.channel","typeLabel":"enum\u003cstring>"},"basic_details":{"type":"object","description":"Contains the basic information about the Push campaign.","required":["name","platforms","platform_specific_details"],"properties":{"name":{"type":"string","description":"The name of the campaign.","example":"Summer Sale Push Notification","isRequired":true,"uniqueKey":"oneOf.0.basic_details.name","typeLabel":"string"},"platforms":{"type":"array","items":{"type":"string","enum":["ANDROID","IOS","WEB"],"uniqueKey":"oneOf.0.basic_details.platforms.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The platforms to target for this Push campaign.","example":["ANDROID","IOS"],"isRequired":true,"uniqueKey":"oneOf.0.basic_details.platforms","typeLabel":"enum\u003cstring>[]"},"platform_specific_details":{"type":"object","description":"Platform-specific configuration details.","properties":{"android":{"type":"object","properties":{"push_amp_plus_enabled":{"type":"boolean","description":"Whether Push Amp+ feature is enabled for this campaign.","default":false,"uniqueKey":"oneOf.0.basic_details.platform_specific_details.android.push_amp_plus_enabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.0.basic_details.platform_specific_details.android","typeLabel":"object"},"ios":{"type":"object","properties":{"send_to_all_eligible_device":{"type":"boolean","description":"Whether to send the campaign to all eligible devices.","uniqueKey":"oneOf.0.basic_details.platform_specific_details.ios.send_to_all_eligible_device","typeLabel":"boolean"},"exclude_provisional_push_devices":{"type":"boolean","description":"Whether to exclude provisional push devices.","uniqueKey":"oneOf.0.basic_details.platform_specific_details.ios.exclude_provisional_push_devices","typeLabel":"boolean"},"send_to_only_provisional_push_enabled_devices":{"type":"boolean","description":"Whether to send only to provisional push-enabled devices.","uniqueKey":"oneOf.0.basic_details.platform_specific_details.ios.send_to_only_provisional_push_enabled_devices","typeLabel":"boolean"}},"description":"**Note:** You must pass one of these keys as true for iOS.\n","uniqueKey":"oneOf.0.basic_details.platform_specific_details.ios","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.0.basic_details.platform_specific_details","typeLabel":"object"},"business_event":{"type":"string","description":"The business event to be mapped to the campaign.\n\n**Required** for BUSINESS_EVENT_TRIGGERED campaigns.\n","example":"user_signup","uniqueKey":"oneOf.0.basic_details.business_event","typeLabel":"string"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.basic_details.tags.items.[INDEX]","typeLabel":"string"},"description":"Tags that provide context about the campaign's nature or theme.","example":["activation","summer_sale"],"uniqueKey":"oneOf.0.basic_details.tags","typeLabel":"string[]"},"team":{"type":"string","description":"The name of the team collaborating on this campaign.\nFor more information, refer to [Teams in MoEngage](/user-guide/settings/account/team-management/teams-in-moengage).\n","example":"marketing_team","uniqueKey":"oneOf.0.basic_details.team","typeLabel":"string"},"broadcast_live_activity_id":{"type":"string","description":"The broadcast live activity ID for iOS Live Activities.\n\n**Required** when platform is iOS and delivery_type is BROADCAST_LIVE_ACTIVITY.\n","example":"live_check123","uniqueKey":"oneOf.0.basic_details.broadcast_live_activity_id","typeLabel":"string"},"geofences":{"type":"object","description":"Geofence location details for location-triggered campaigns.\n\n**Required** for LOCATION_TRIGGERED campaigns.\n","required":["name","latitude","longitude","radius","response_time_value","response_time_granularity","triggered_at"],"properties":{"name":{"type":"string","description":"The unique name of the geofence location being targeted.","isRequired":true,"uniqueKey":"oneOf.0.basic_details.geofences.name","typeLabel":"string"},"latitude":{"type":"string","description":"The latitude coordinate for the center of the geofence area.","isRequired":true,"uniqueKey":"oneOf.0.basic_details.geofences.latitude","typeLabel":"string"},"longitude":{"type":"string","description":"The longitude coordinate for the center of the geofence area.","isRequired":true,"uniqueKey":"oneOf.0.basic_details.geofences.longitude","typeLabel":"string"},"radius":{"type":"string","description":"The radius in meters from the center point that defines the boundary of the geofence.","isRequired":true,"uniqueKey":"oneOf.0.basic_details.geofences.radius","typeLabel":"string"},"response_time_value":{"type":"string","description":"The numeric value for the time to wait before sending the message after the trigger condition is met.","isRequired":true,"uniqueKey":"oneOf.0.basic_details.geofences.response_time_value","typeLabel":"string"},"response_time_granularity":{"type":"string","enum":["MINUTES","HOURS","DAYS"],"description":"The time unit for the response_time_value.","isRequired":true,"uniqueKey":"oneOf.0.basic_details.geofences.response_time_granularity","typeLabel":"enum\u003cstring>"},"triggered_at":{"type":"string","enum":["ENTRY","EXIT","dwell"],"description":"The user action that triggers the campaign (when user enters/exits the geofence).","isRequired":true,"uniqueKey":"oneOf.0.basic_details.geofences.triggered_at","typeLabel":"enum\u003cstring>"},"dwell_time_value":{"type":"string","description":"The numeric value for the time to wait before sending the message after the trigger condition is met.\n\n**Required** when triggered_at is set to \"dwell\".\n","uniqueKey":"oneOf.0.basic_details.geofences.dwell_time_value","typeLabel":"string"},"dwell_time_granularity":{"type":"string","enum":["MINUTES","HOURS","DAYS"],"description":"The time unit for the dwell_time_value.\n\n**Required** when triggered_at is set to \"dwell\".\n","uniqueKey":"oneOf.0.basic_details.geofences.dwell_time_granularity","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.basic_details.geofences","typeLabel":"object"},"send_to_triggered_platform_only":{"type":"boolean","description":"Whether to send the campaign only to the platform that triggered the event. Applicable for event-triggered campaigns.","uniqueKey":"oneOf.0.basic_details.send_to_triggered_platform_only","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"oneOf.0.basic_details","typeLabel":"object"},"campaign_content":{"type":"object","description":"Contains the content and variations for the Push campaign.","required":["content"],"properties":{"content":{"type":"object","description":"The actual Push campaign content.","required":["push"],"properties":{"push":{"type":"object","description":"Push notification content for Android, iOS, and Web platforms.","properties":{"android":{"type":"object","description":"Android push notification content.","required":["template_type"],"properties":{"template_type":{"type":"string","enum":["BASIC","STYLIZED_BASIC","SIMPLE_IMAGE_CAROUSEL","IMAGE_BANNER_WITH_TEXT","TIMER","TIMER_WITH_PROGRESS_BAR","Custom"],"description":"The type of Android push template.\n\n**Note:** If you are passing a template ID, set template_type to \"Custom\".\n","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.template_type","typeLabel":"enum\u003cstring>"},"custom_template_id":{"type":"string","description":"The ID of the custom template.\n\n**Required** when template_type is \"Custom\".\n","uniqueKey":"oneOf.0.campaign_content.content.push.android.custom_template_id","typeLabel":"string"},"custom_template_version":{"type":"integer","description":"The version of the custom template.","uniqueKey":"oneOf.0.campaign_content.content.push.android.custom_template_version","typeLabel":"integer"},"basic_details":{"type":"object","description":"Basic details for the Android push notification. \n\nFields vary by template_type. All templates support common fields like title, message, default_click_action.\n","required":["notification_channel","title","message","default_click_action","default_click_action_value"],"properties":{"notification_channel":{"type":"string","description":"The Android notification channel where the push will be sent.","example":"general","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.notification_channel","typeLabel":"string"},"title":{"type":"string","description":"The main title of the push notification.","example":"Limited Time Offer!","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.title","typeLabel":"string"},"message":{"type":"string","description":"The message body of the push notification.\n\nYou can use HTML in the message parameter to apply rich text formatting, including text color and styles.\n","example":"Get 50% off on all items. Shop now!","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.message","typeLabel":"string"},"default_click_action":{"type":"string","enum":["DEEPLINKING","NAVIGATE_TO_A_SCREEN","RICH_LANDING"],"description":"The action performed when the main body of the notification is clicked.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.default_click_action","typeLabel":"enum\u003cstring>"},"default_click_action_value":{"type":"string","description":"The URL or deep link to open when the notification is clicked.","example":"https://example.com/sale","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.default_click_action_value","typeLabel":"string"},"include_app_name_and_time":{"type":"boolean","description":"Whether to include the application's name and timestamp within the banner image.\n\n**Supported Templates:** Image Banner with Text\n","uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.include_app_name_and_time","typeLabel":"boolean"},"background_color_code":{"type":"string","description":"The hex code for the notification's background color.\n\n**Supported Templates:** Stylized Basic, Simple Image Carousel, Image Banner with Text\n","example":"#9a4444","uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.background_color_code","typeLabel":"string"},"app_name_color_code":{"type":"string","description":"The hex code for the color of the application's name text.\n\n**Supported Templates:** Stylized Basic, Simple Image Carousel, Image Banner with Text\n","example":"#dea1a1","uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.app_name_color_code","typeLabel":"string"},"notification_control_color":{"type":"string","enum":["LIGHT","DARK"],"description":"The color scheme for the notification's control elements (action buttons).\n\n**Supported Templates:** Stylized Basic, Simple Image Carousel, Image Banner with Text\n","uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.notification_control_color","typeLabel":"enum\u003cstring>"},"include_title_and_message":{"type":"boolean","description":"Whether to include the notification's title and message text within the banner image.\n\n**Supported Templates:** Image Banner with Text\n","uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.include_title_and_message","typeLabel":"boolean"},"apply_background_color_in_text_editor":{"type":"boolean","description":"Whether to apply the specified background color within the rich text editor for preview.\n\n**Supported Templates:** Stylized Basic, Simple Image Carousel, Image Banner with Text\n","uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.apply_background_color_in_text_editor","typeLabel":"boolean"},"summary":{"type":"string","description":"The summary text for the notification.","uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.summary","typeLabel":"string"},"image_url":{"type":"string","format":"uri","description":"The image URL for the push notification.","example":"https://example.com/images/promo.jpg","uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.image_url","typeLabel":"string\u003curi>"},"image_scaling":{"type":"string","enum":["FIT_INSIDE_IMAGE_CONTAINER","FILL_IMAGE_CONTAINER"],"description":"The scaling behavior for images within the carousel template.\n\n**Supported Templates:** Simple Image Carousel, Image Banner with Text\n","uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.image_scaling","typeLabel":"enum\u003cstring>"},"banner_image_url":{"type":"string","format":"uri","description":"The URL for the background image used in the Image Banner Text template.\n\n**Required for:** Image Banner with Text template\n","uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.banner_image_url","typeLabel":"string\u003curi>"},"input_gif_url":{"type":"string","format":"uri","description":"The URL for the GIF media used in the push campaign content.\n\n**Supported Templates:** Basic\n","uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.input_gif_url","typeLabel":"string\u003curi>"},"collapsed_push_notification":{"type":"string","description":"The configuration for the notification's collapsed state (view before user expands it).\n\n**Supported Templates:** Image Banner with Text\n","example":"SAME_AS_TEMPLATE_BACKUP","uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.collapsed_push_notification","typeLabel":"string"},"carousel_content":{"type":"object","description":"Configuration for image carousel in Simple Image Carousel template.\n\n**Required for:** Simple Image Carousel template\n","required":["slider_transition","slide_data"],"properties":{"slider_transition":{"type":"string","enum":["manual","automatic"],"description":"The transition type for the carousel slides.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.carousel_content.slider_transition","typeLabel":"enum\u003cstring>"},"slide_data":{"type":"array","description":"Array of slide configurations.","items":{"type":"object","required":["image_url"],"properties":{"image_url":{"type":"string","format":"uri","description":"The image URL for this slide.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.carousel_content.slide_data.items.[INDEX].image_url","typeLabel":"string\u003curi>"},"image_click_action":{"type":"string","enum":["DEEPLINKING","RICH_LANDING","NAVIGATE_TO_A_SCREEN"],"description":"The click action for this slide's image.","uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.carousel_content.slide_data.items.[INDEX].image_click_action","typeLabel":"enum\u003cstring>"},"image_click_action_value":{"type":"string","description":"The click action value for this slide's image.\n\n**Required** when image_click_action is provided.\n","uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.carousel_content.slide_data.items.[INDEX].image_click_action_value","typeLabel":"string"},"key_value_pairs":{"type":"array","items":{"type":"object","description":"A key-value pair for custom data.","required":["key","value"],"properties":{"key":{"type":"string","description":"The key name.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.carousel_content.slide_data.items.[INDEX].key_value_pairs.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"The value.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.carousel_content.slide_data.items.[INDEX].key_value_pairs.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.carousel_content.slide_data.items.[INDEX].key_value_pairs.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.carousel_content.slide_data.items.[INDEX].key_value_pairs","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.carousel_content.slide_data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.carousel_content.slide_data","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.carousel_content","typeLabel":"object"},"key_value_pairs":{"type":"array","items":{"type":"object","description":"A key-value pair for custom data.","required":["key","value"],"properties":{"key":{"type":"string","description":"The key name.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.key_value_pairs.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"The value.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.key_value_pairs.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.key_value_pairs.items.[INDEX]","typeLabel":"object"},"description":"Custom key-value pairs for the notification payload.","uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details.key_value_pairs","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.campaign_content.content.push.android.basic_details","typeLabel":"object"},"timer":{"type":"object","description":"Timer configuration for Timer and Timer with Progress Bar templates.\n\n**Required for:** TIMER and TIMER_WITH_PROGRESS_BAR templates\n","required":["timer_ends_at","personalized_value"],"properties":{"timer_ends_at":{"type":"string","enum":["DURATION","SPECIFIC_TIME_USER_TIMEZONE","SPECIFIC_TIME_CAMPAIGN_TIMEZONE"],"description":"How the timer's endpoint is determined.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.timer.timer_ends_at","typeLabel":"enum\u003cstring>"},"personalized_value":{"type":"boolean","description":"Whether the timer duration is personalized per user.\n\nIf false, all users get the same duration.\n","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.timer.personalized_value","typeLabel":"boolean"},"specific_time":{"type":"string","format":"date-time","description":"The specific time when the timer ends.\n\n**Required** when personalized_value is true.\n","uniqueKey":"oneOf.0.campaign_content.content.push.android.timer.specific_time","typeLabel":"string\u003cdate-time>"},"time_period":{"type":"string","description":"The time period for the timer.\n\n**Required** when timer_ends_at is SPECIFIC_TIME_USER_TIMEZONE or SPECIFIC_TIME_CAMPAIGN_TIMEZONE.\n","uniqueKey":"oneOf.0.campaign_content.content.push.android.timer.time_period","typeLabel":"string"},"duration_hour":{"type":"string","description":"The number of hours the timer will run for.\n\n**Required** when personalized_value is false.\n","example":"2","uniqueKey":"oneOf.0.campaign_content.content.push.android.timer.duration_hour","typeLabel":"string"},"duration_minute":{"type":"string","description":"The number of minutes the timer will run for (in addition to hours).\n\n**Required** when personalized_value is false.\n","example":"30","uniqueKey":"oneOf.0.campaign_content.content.push.android.timer.duration_minute","typeLabel":"string"}},"uniqueKey":"oneOf.0.campaign_content.content.push.android.timer","typeLabel":"object"},"buttons":{"type":"array","description":"Action buttons for the notification.","items":{"type":"object","description":"Action button configuration for Android push notifications.","required":["btn_name","click_action_type","click_action_value"],"properties":{"btn_name":{"type":"string","description":"The text to be displayed on the button.","example":"Shop Now","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.buttons.items.[INDEX].btn_name","typeLabel":"string"},"click_action_type":{"type":"string","enum":["DEEPLINKING","NAVIGATE_TO_A_SCREEN","RICH_LANDING","CALL","SHARE","COPY","SET_USER_ATTRIBUTE","TRACK_EVENT","CUSTOM_ACTION"],"description":"The type of action to perform when the button is clicked.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.buttons.items.[INDEX].click_action_type","typeLabel":"enum\u003cstring>"},"click_action_value":{"type":"string","description":"The URL or deep link to open for the button's action.","example":"https://example.com/product","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.buttons.items.[INDEX].click_action_value","typeLabel":"string"},"click_action_name":{"type":"string","description":"The name of the click action.","uniqueKey":"oneOf.0.campaign_content.content.push.android.buttons.items.[INDEX].click_action_name","typeLabel":"string"},"key_value_pairs":{"type":"array","items":{"type":"object","description":"A key-value pair for custom data.","required":["key","value"],"properties":{"key":{"type":"string","description":"The key name.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.buttons.items.[INDEX].key_value_pairs.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"The value.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.buttons.items.[INDEX].key_value_pairs.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"oneOf.0.campaign_content.content.push.android.buttons.items.[INDEX].key_value_pairs.items.[INDEX]","typeLabel":"object"},"description":"Custom key-value pairs specific to this button's click event.","uniqueKey":"oneOf.0.campaign_content.content.push.android.buttons.items.[INDEX].key_value_pairs","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.campaign_content.content.push.android.buttons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.campaign_content.content.push.android.buttons","typeLabel":"object[]"},"advanced":{"type":"object","description":"Advanced configuration options for Android push notifications.","properties":{"coupon_code":{"type":"string","description":"The coupon code to be included in the push payload.","example":"SUMMER50","uniqueKey":"oneOf.0.campaign_content.content.push.android.advanced.coupon_code","typeLabel":"string"},"icon_type_in_notification":{"type":"string","description":"The icon type to be included in the push payload.","example":"app_icon","uniqueKey":"oneOf.0.campaign_content.content.push.android.advanced.icon_type_in_notification","typeLabel":"string"},"use_large_icon":{"type":"boolean","description":"Whether to use a large icon in the notification.","uniqueKey":"oneOf.0.campaign_content.content.push.android.advanced.use_large_icon","typeLabel":"boolean"},"make_notification_sticky":{"type":"boolean","description":"When enabled, the user cannot swipe away the notification.\n","uniqueKey":"oneOf.0.campaign_content.content.push.android.advanced.make_notification_sticky","typeLabel":"boolean"},"dismiss_button_text":{"type":"string","description":"The text to display on the dismiss button.\n\n**Required** when make_notification_sticky is true or auto_dismiss_notification is true.\n","uniqueKey":"oneOf.0.campaign_content.content.push.android.advanced.dismiss_button_text","typeLabel":"string"},"auto_dismiss_notification":{"type":"boolean","description":"Whether the notification can be auto-dismissed.","uniqueKey":"oneOf.0.campaign_content.content.push.android.advanced.auto_dismiss_notification","typeLabel":"boolean"},"auto_dismiss_notification_time_value":{"type":"integer","description":"The time value after which to auto-dismiss the notification.\n\n**Required** when auto_dismiss_notification is true.\n","uniqueKey":"oneOf.0.campaign_content.content.push.android.advanced.auto_dismiss_notification_time_value","typeLabel":"integer"},"auto_dismiss_notification_time_granularity":{"type":"string","enum":["DAYS","HOURS","MINUTES"],"description":"The time unit for auto-dismiss.\n\n**Required** when auto_dismiss_notification is true.\n","uniqueKey":"oneOf.0.campaign_content.content.push.android.advanced.auto_dismiss_notification_time_granularity","typeLabel":"enum\u003cstring>"},"group_key":{"type":"string","description":"The group key used to identify and categorize related push notifications.\n\n**Note:**\n- Use the same group key for all push notifications you want to group\n- MoEngage automatically modifies the group key to ensure it doesn't exceed 45 characters\n- Non-Latin scripts, special characters, and spaces are removed\n","uniqueKey":"oneOf.0.campaign_content.content.push.android.advanced.group_key","typeLabel":"string"},"collapse_replace_key":{"type":"string","description":"The update key used to identify and update related push notifications.\n\nEnsure you use the same update key for all push notifications intended to update each other.\n","uniqueKey":"oneOf.0.campaign_content.content.push.android.advanced.collapse_replace_key","typeLabel":"string"}},"uniqueKey":"oneOf.0.campaign_content.content.push.android.advanced","typeLabel":"object"},"template_backup":{"type":"object","description":"Fallback notification content for when the template cannot be rendered.\n\n**Required for:** Stylized Basic, Simple Image Carousel, Image Banner with Text, Timer, and Timer with Progress Bar templates\n","required":["title","message","default_click_action","default_click_action_value"],"properties":{"title":{"type":"string","description":"The title for the fallback notification.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.template_backup.title","typeLabel":"string"},"message":{"type":"string","description":"The message body for the fallback notification.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.template_backup.message","typeLabel":"string"},"default_click_action":{"type":"string","enum":["DEEPLINKING","NAVIGATE_TO_A_SCREEN","RICH_LANDING"],"description":"The default click action for the fallback notification.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.template_backup.default_click_action","typeLabel":"enum\u003cstring>"},"default_click_action_value":{"type":"string","description":"The URL or deep link for the fallback's click action.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.template_backup.default_click_action_value","typeLabel":"string"},"summary":{"type":"string","description":"The summary for the fallback notification.","uniqueKey":"oneOf.0.campaign_content.content.push.android.template_backup.summary","typeLabel":"string"},"image_url":{"type":"string","format":"uri","description":"The URL of an image for the fallback notification.","uniqueKey":"oneOf.0.campaign_content.content.push.android.template_backup.image_url","typeLabel":"string\u003curi>"},"key_value_pairs":{"type":"array","items":{"type":"object","description":"A key-value pair for custom data.","required":["key","value"],"properties":{"key":{"type":"string","description":"The key name.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.template_backup.key_value_pairs.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"The value.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.android.template_backup.key_value_pairs.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"oneOf.0.campaign_content.content.push.android.template_backup.key_value_pairs.items.[INDEX]","typeLabel":"object"},"description":"Custom key-value pairs specific to the fallback payload.","uniqueKey":"oneOf.0.campaign_content.content.push.android.template_backup.key_value_pairs","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.campaign_content.content.push.android.template_backup","typeLabel":"object"}},"uniqueKey":"oneOf.0.campaign_content.content.push.android","typeLabel":"object"},"ios":{"type":"object","description":"iOS push notification content.","required":["template_type"],"properties":{"template_type":{"type":"string","enum":["BASIC","STYLIZED_BASIC","SIMPLE_IMAGE_CAROUSEL","Custom"],"description":"The type of iOS push template.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.ios.template_type","typeLabel":"enum\u003cstring>"},"custom_template_id":{"type":"string","description":"The ID of the custom template.\n\n**Required** when template_type is \"Custom\".\n","uniqueKey":"oneOf.0.campaign_content.content.push.ios.custom_template_id","typeLabel":"string"},"custom_template_version":{"type":"integer","description":"The version of the custom template.","uniqueKey":"oneOf.0.campaign_content.content.push.ios.custom_template_version","typeLabel":"integer"},"basic_details":{"type":"object","description":"Basic details for the iOS push notification.","required":["title","message"],"properties":{"title":{"type":"string","description":"The main title of the push notification.","example":"New Message","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.title","typeLabel":"string"},"message":{"type":"string","description":"The main body text of the notification.","example":"You have a new message waiting for you","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.message","typeLabel":"string"},"background_color_code":{"type":"string","description":"The hexadecimal color code for the notification's background.\n\n**Supported Templates:** Simple Image Carousel, Stylized Basic\n","example":"#a0a0a0","uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.background_color_code","typeLabel":"string"},"apply_background_color_in_text_editor":{"type":"boolean","description":"Whether to apply the background color within the text editor view.\n\n**Supported Templates:** Simple Image Carousel, Stylized Basic\n","uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.apply_background_color_in_text_editor","typeLabel":"boolean"},"subtitle":{"type":"string","description":"The subtitle displayed below the main title.","uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.subtitle","typeLabel":"string"},"allow_bg_refresh":{"type":"boolean","description":"Whether to allow the app to be woken up in the background to refresh content.","uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.allow_bg_refresh","typeLabel":"boolean"},"rich_media_type":{"type":"string","enum":["Image","Video","GIF"],"description":"The type of rich media to be included in the notification.\n\n**Supported Templates:** Basic\n","uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.rich_media_type","typeLabel":"enum\u003cstring>"},"rich_media_value":{"type":"string","format":"uri","description":"The URL of the rich media asset specified in the rich_media_type field.\n\n**Supported Templates:** Basic\n","uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.rich_media_value","typeLabel":"string\u003curi>"},"image_url":{"type":"string","format":"uri","description":"The URL of a large image to be displayed within the notification content.\n\n**Note:** Required when template_type is SIMPLE_IMAGE_CAROUSEL.\n","uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.image_url","typeLabel":"string\u003curi>"},"input_gif_url":{"type":"string","format":"uri","description":"The URL for the GIF media used in the push campaign content.\n\n**Supported Templates:** Basic, Stylized Basic\n","uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.input_gif_url","typeLabel":"string\u003curi>"},"carousel_content":{"type":"object","description":"Configuration for image carousel in Simple Image Carousel template.\n\n**Required for:** Simple Image Carousel template\n","required":["slider_transition","slide_data"],"properties":{"slider_transition":{"type":"string","enum":["MANUAL","AUTOMATIC"],"description":"The transition type for the carousel slides.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.carousel_content.slider_transition","typeLabel":"enum\u003cstring>"},"slide_data":{"type":"array","description":"Array of slide configurations.","items":{"type":"object","required":["image_url"],"properties":{"image_url":{"type":"string","format":"uri","description":"The image URL for this slide.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.carousel_content.slide_data.items.[INDEX].image_url","typeLabel":"string\u003curi>"},"image_click_action":{"type":"string","enum":["DEEPLINKING","RICH_LANDING","NAVIGATE_TO_A_SCREEN"],"description":"The click action for this slide's image.","uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.carousel_content.slide_data.items.[INDEX].image_click_action","typeLabel":"enum\u003cstring>"},"image_click_action_value":{"type":"string","description":"The click action value for this slide's image.","uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.carousel_content.slide_data.items.[INDEX].image_click_action_value","typeLabel":"string"},"key_value_pairs":{"type":"array","items":{"type":"object","description":"A key-value pair for custom data.","required":["key","value"],"properties":{"key":{"type":"string","description":"The key name.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.carousel_content.slide_data.items.[INDEX].key_value_pairs.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"The value.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.carousel_content.slide_data.items.[INDEX].key_value_pairs.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.carousel_content.slide_data.items.[INDEX].key_value_pairs.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.carousel_content.slide_data.items.[INDEX].key_value_pairs","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.carousel_content.slide_data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.carousel_content.slide_data","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.carousel_content","typeLabel":"object"},"default_click_action":{"type":"string","enum":["DEEPLINKING","NAVIGATE_TO_A_SCREEN","RICH_LANDING"],"description":"The action performed when the main body of the notification is tapped.","uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.default_click_action","typeLabel":"enum\u003cstring>"},"default_click_action_value":{"type":"string","description":"The URL or deep link associated with the default click action.","uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.default_click_action_value","typeLabel":"string"},"key_value_pairs":{"type":"array","items":{"type":"object","description":"A key-value pair for custom data.","required":["key","value"],"properties":{"key":{"type":"string","description":"The key name.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.key_value_pairs.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"The value.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.key_value_pairs.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.key_value_pairs.items.[INDEX]","typeLabel":"object"},"description":"Custom key-value pairs sent with the push payload for in-app handling.","uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details.key_value_pairs","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.campaign_content.content.push.ios.basic_details","typeLabel":"object"},"buttons":{"type":"array","description":"Action buttons for the notification.","items":{"type":"object","description":"Action button configuration for iOS push notifications.","required":["button_category"],"properties":{"button_category":{"type":"string","description":"The pre-defined category name for a set of interactive buttons configured in the app.\n","example":"MOE_PUSH_TEMPLATE","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.ios.buttons.items.[INDEX].button_category","typeLabel":"string"}},"uniqueKey":"oneOf.0.campaign_content.content.push.ios.buttons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.campaign_content.content.push.ios.buttons","typeLabel":"object[]"},"advanced":{"type":"object","description":"Advanced configuration options for iOS push notifications.","properties":{"coupon_code":{"type":"string","description":"The coupon code to be included in the push payload.","uniqueKey":"oneOf.0.campaign_content.content.push.ios.advanced.coupon_code","typeLabel":"string"},"sound_file":{"type":"string","description":"The name of a custom sound file located in the app bundle to play upon receiving the notification.","uniqueKey":"oneOf.0.campaign_content.content.push.ios.advanced.sound_file","typeLabel":"string"},"enable_ios_badge":{"type":"boolean","description":"Whether this campaign allows the notification to increment the app's badge count.","uniqueKey":"oneOf.0.campaign_content.content.push.ios.advanced.enable_ios_badge","typeLabel":"boolean"},"group_key":{"type":"string","description":"The group key used to identify and categorize related push notifications.\n\n**Note:**\n- Use the same group key for all push notifications you want to group\n- MoEngage automatically modifies the group key to ensure it doesn't exceed 45 characters\n- Non-Latin scripts, special characters, and spaces are removed\n","uniqueKey":"oneOf.0.campaign_content.content.push.ios.advanced.group_key","typeLabel":"string"},"collapse_replace_key":{"type":"string","description":"The update key used to identify and update related push notifications.\n\nEnsure you use the same update key for all push notifications intended to update each other.\n","uniqueKey":"oneOf.0.campaign_content.content.push.ios.advanced.collapse_replace_key","typeLabel":"string"}},"uniqueKey":"oneOf.0.campaign_content.content.push.ios.advanced","typeLabel":"object"},"template_backup":{"type":"object","description":"Fallback notification content for when the template cannot be rendered.\n\n**Required for:** Stylized Basic and Simple Image Carousel templates\n","required":["title","message"],"properties":{"title":{"type":"string","description":"The title for the fallback notification.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.ios.template_backup.title","typeLabel":"string"},"message":{"type":"string","description":"The message body for the fallback notification.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.ios.template_backup.message","typeLabel":"string"},"subtitle":{"type":"string","description":"The subtitle for the fallback notification.","uniqueKey":"oneOf.0.campaign_content.content.push.ios.template_backup.subtitle","typeLabel":"string"},"allow_bg_refresh":{"type":"boolean","description":"Whether to enable background app refresh for the fallback notification.","uniqueKey":"oneOf.0.campaign_content.content.push.ios.template_backup.allow_bg_refresh","typeLabel":"boolean"},"rich_media_type":{"type":"string","enum":["Image","Video","GIF"],"description":"The type of media attachment for the fallback.","uniqueKey":"oneOf.0.campaign_content.content.push.ios.template_backup.rich_media_type","typeLabel":"enum\u003cstring>"},"rich_media_value":{"type":"string","format":"uri","description":"The URL of the media attachment for the fallback.","uniqueKey":"oneOf.0.campaign_content.content.push.ios.template_backup.rich_media_value","typeLabel":"string\u003curi>"},"default_click_action":{"type":"string","enum":["DEEPLINKING","NAVIGATE_TO_A_SCREEN","RICH_LANDING"],"description":"The default click action for the fallback notification.","uniqueKey":"oneOf.0.campaign_content.content.push.ios.template_backup.default_click_action","typeLabel":"enum\u003cstring>"},"default_click_action_value":{"type":"string","description":"The URL or deep link for the fallback's click action.","uniqueKey":"oneOf.0.campaign_content.content.push.ios.template_backup.default_click_action_value","typeLabel":"string"},"key_value_pairs":{"type":"array","items":{"type":"object","description":"A key-value pair for custom data.","required":["key","value"],"properties":{"key":{"type":"string","description":"The key name.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.ios.template_backup.key_value_pairs.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"The value.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.ios.template_backup.key_value_pairs.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"oneOf.0.campaign_content.content.push.ios.template_backup.key_value_pairs.items.[INDEX]","typeLabel":"object"},"description":"Custom key-value pairs specific to the fallback payload.","uniqueKey":"oneOf.0.campaign_content.content.push.ios.template_backup.key_value_pairs","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.campaign_content.content.push.ios.template_backup","typeLabel":"object"}},"uniqueKey":"oneOf.0.campaign_content.content.push.ios","typeLabel":"object"},"web":{"type":"object","description":"Web push notification content.","required":["template_type","basic_details"],"properties":{"template_type":{"type":"string","enum":["BASIC"],"description":"The template type for web push (currently only BASIC is supported).","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.web.template_type","typeLabel":"enum\u003cstring>"},"basic_details":{"type":"object","description":"Basic details for the Web push notification.","required":["title","message","redirect_url"],"properties":{"title":{"type":"string","description":"The title text displayed at the top of the notification.","example":"Special Offer","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.web.basic_details.title","typeLabel":"string"},"message":{"type":"string","description":"The main body text of the notification.","example":"Check out our latest deals!","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.web.basic_details.message","typeLabel":"string"},"redirect_url":{"type":"string","format":"uri","description":"The URL that the user is redirected to when they click the main body of the notification.","example":"https://example.com/offers","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.web.basic_details.redirect_url","typeLabel":"string\u003curi>"},"image_url":{"type":"string","format":"uri","description":"The URL of a large image to be displayed within the notification content.","uniqueKey":"oneOf.0.campaign_content.content.push.web.basic_details.image_url","typeLabel":"string\u003curi>"},"auto_dismiss_notification":{"type":"boolean","description":"Whether the notification should auto-dismiss.","uniqueKey":"oneOf.0.campaign_content.content.push.web.basic_details.auto_dismiss_notification","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.web.basic_details","typeLabel":"object"},"buttons":{"type":"array","description":"Action buttons for the notification.","items":{"type":"object","description":"Action button configuration for Web push notifications.","required":["title"],"properties":{"title":{"type":"string","description":"The text displayed on the button.","example":"View Offer","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push.web.buttons.items.[INDEX].title","typeLabel":"string"},"icon_url":{"type":"string","format":"uri","description":"The URL of an icon to be displayed next to the button text.","uniqueKey":"oneOf.0.campaign_content.content.push.web.buttons.items.[INDEX].icon_url","typeLabel":"string\u003curi>"},"url":{"type":"string","format":"uri","description":"The destination URL that the user is redirected to when they click this button.","uniqueKey":"oneOf.0.campaign_content.content.push.web.buttons.items.[INDEX].url","typeLabel":"string\u003curi>"}},"uniqueKey":"oneOf.0.campaign_content.content.push.web.buttons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.campaign_content.content.push.web.buttons","typeLabel":"object[]"},"advanced":{"type":"object","description":"Advanced configuration options for Web push notifications.","properties":{"icon_image_type":{"type":"string","enum":["DEFAULT","ICON_URL"],"description":"The type of icon to use for the notification.","uniqueKey":"oneOf.0.campaign_content.content.push.web.advanced.icon_image_type","typeLabel":"enum\u003cstring>"},"icon_url":{"type":"string","format":"uri","description":"The URL for a custom notification icon.","uniqueKey":"oneOf.0.campaign_content.content.push.web.advanced.icon_url","typeLabel":"string\u003curi>"}},"uniqueKey":"oneOf.0.campaign_content.content.push.web.advanced","typeLabel":"object"}},"uniqueKey":"oneOf.0.campaign_content.content.push.web","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content.push","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.0.campaign_content.content","typeLabel":"object"},"locales":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.campaign_content.locales.items.[INDEX]","typeLabel":"string"},"description":"List of locales for multi-language campaigns.\nYou can send campaigns in multiple languages using locales.\n","example":["en-US","es-ES","default"],"uniqueKey":"oneOf.0.campaign_content.locales","typeLabel":"string[]"},"variation_details":{"type":"object","description":"Configuration for A/B testing variations.","required":["distribution_type","no_of_variations"],"properties":{"distribution_type":{"type":"string","enum":["SHERPA","MANUAL"],"description":"The distribution type for variations.","isRequired":true,"uniqueKey":"oneOf.0.campaign_content.variation_details.distribution_type","typeLabel":"enum\u003cstring>"},"no_of_variations":{"type":"integer","description":"The number of variations for the campaign.","minimum":1,"example":2,"isRequired":true,"uniqueKey":"oneOf.0.campaign_content.variation_details.no_of_variations","typeLabel":"integer"},"manual_distribution_percentage":{"type":"object","description":"Manual percentage distribution for each variation.\n\n**Required** when distribution_type is MANUAL.\n","additionalProperties":{"type":"string","uniqueKey":"oneOf.0.campaign_content.variation_details.manual_distribution_percentage.additionalProperties","typeLabel":"string"},"example":{"variation_1":"50","variation_2":"45"},"uniqueKey":"oneOf.0.campaign_content.variation_details.manual_distribution_percentage","typeLabel":"object"},"sherpa_campaign_duration":{"type":"integer","description":"The Sherpa campaign duration.\n\n**Required** when distribution_type is SHERPA.\n","uniqueKey":"oneOf.0.campaign_content.variation_details.sherpa_campaign_duration","typeLabel":"integer"},"sherpa_distribution_metric":{"type":"string","enum":["OPEN RATE","CLICK RATE","BOTH"],"description":"The Sherpa distribution metric.\n\n**Required** when distribution_type is SHERPA.\n","uniqueKey":"oneOf.0.campaign_content.variation_details.sherpa_distribution_metric","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.campaign_content.variation_details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.0.campaign_content","typeLabel":"object"},"test_campaign_meta":{"type":"object","description":"Metadata for specifying test recipients for Push campaigns.","required":["identifier","identifier_values"],"properties":{"identifier":{"type":"string","enum":["USER_ATTRIBUTE_UNIQUE_ID","USER_ATTRIBUTE_USER_EMAIL","USER_ATTRIBUTE_USER_MOBILE","MOE_GAID","ADVERTISING_IDENTIFIER","PUSH_ID","CUSTOM_SEGMENT"],"description":"The type of identifier used to target test users.\n\n- **USER_ATTRIBUTE_UNIQUE_ID**: Permanent internal user ID (e.g., USER_1138)\n- **USER_ATTRIBUTE_USER_EMAIL**: User's email address (e.g., [email protected])\n- **USER_ATTRIBUTE_USER_MOBILE**: User's mobile number (e.g., +14155550101)\n- **MOE_GAID**: Google Advertising ID from Android device\n- **ADVERTISING_IDENTIFIER**: Resettable advertising ID (GAID on Android, IDFA on iOS)\n- **PUSH_ID**: Unique device token for push notifications\n- **CUSTOM_SEGMENT**: User-defined segment for targeting\n","isRequired":true,"uniqueKey":"oneOf.0.test_campaign_meta.identifier","typeLabel":"enum\u003cstring>"},"identifier_values":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.test_campaign_meta.identifier_values.items.[INDEX]","typeLabel":"string"},"description":"Array of identifier values to send the test campaign to.","example":["user_12345","user_67890"],"isRequired":true,"uniqueKey":"oneOf.0.test_campaign_meta.identifier_values","typeLabel":"string[]"},"locale_name":{"type":"string","description":"The locale name to use for the test campaign (when using multi-locale campaigns).","uniqueKey":"oneOf.0.test_campaign_meta.locale_name","typeLabel":"string"},"variation":{"type":"string","description":"The variation name to use for the test campaign (when using A/B testing).","example":"variation_1","uniqueKey":"oneOf.0.test_campaign_meta.variation","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.test_campaign_meta","typeLabel":"object"},"personalization_details":{"type":"object","description":"Override values for personalizing campaign content during testing.\n\n**Important**: \n - When you pass personalization details in the personalization_details object of this API, MoEngage uses those details to personalize the user attributes or event attributes present in the content instead of the attributes present in the user profile.\n - You can use this API only for 10 users at a time.\n - The same personalization details are used across all users. For example, you pass the first name as Dave in personalization details, you have used the first name in the content, and there are 10 users. In this case, all 10 users will get the same first name (Dave).\n","properties":{"user_attributes":{"type":"object","additionalProperties":true,"description":"Key-value pairs for user attribute personalization.\n\nThe same values are used for all test recipients.\n","example":{"First Name":"John","Last Name":"Doe","Email":"[email protected]"},"uniqueKey":"oneOf.0.personalization_details.user_attributes","typeLabel":"object"},"event_attributes":{"type":"object","additionalProperties":true,"description":"Key-value pairs for event attribute personalization.\n\nIf you pass only a subset of attributes, remaining values are picked from the user profile.\n","example":{"Campaign Name":"Test Campaign","Campaign Channel":"Email"},"uniqueKey":"oneOf.0.personalization_details.event_attributes","typeLabel":"object"}},"uniqueKey":"oneOf.0.personalization_details","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"Push Campaign · object"},{"type":"object","title":"Email Campaign","required":["request_id","channel","basic_details","connector","campaign_content","test_campaign_meta"],"properties":{"request_id":{"type":"string","description":"A unique identifier for this test request.","example":"test_email_12345","isRequired":true,"uniqueKey":"oneOf.1.request_id","typeLabel":"string"},"channel":{"type":"string","enum":["EMAIL"],"description":"The communication channel (automatically set to EMAIL for this tab).","isRequired":true,"uniqueKey":"oneOf.1.channel","typeLabel":"enum\u003cstring>"},"basic_details":{"type":"object","description":"Contains the basic information about the Email campaign.","required":["name","content_type","user_attribute_identifier"],"properties":{"name":{"type":"string","description":"The name of the campaign.","example":"Summer Sale Email","isRequired":true,"uniqueKey":"oneOf.1.basic_details.name","typeLabel":"string"},"content_type":{"type":"string","enum":["PROMOTIONAL","TRANSACTIONAL"],"description":"The type of content in the campaign.","isRequired":true,"uniqueKey":"oneOf.1.basic_details.content_type","typeLabel":"enum\u003cstring>"},"user_attribute_identifier":{"type":"string","description":"The user attribute that stores the email address.\n\nStandard identifier is `MOE_EMAIL_ID`.\n","example":"MOE_EMAIL_ID","default":"MOE_EMAIL_ID","isRequired":true,"uniqueKey":"oneOf.1.basic_details.user_attribute_identifier","typeLabel":"string"},"business_event":{"type":"string","description":"The business event to be mapped to the campaign.\n\n**Required** for BUSINESS_EVENT_TRIGGERED campaigns.\n","example":"user_signup","uniqueKey":"oneOf.1.basic_details.business_event","typeLabel":"string"},"subscription_category":{"type":"string","description":"The subscription category for promotional email campaigns.\nThis targets only users who have opted-in to receive communication about this category.\n\n**Required** for PROMOTIONAL email campaigns.\n","example":"music","uniqueKey":"oneOf.1.basic_details.subscription_category","typeLabel":"string"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.basic_details.tags.items.[INDEX]","typeLabel":"string"},"description":"Tags that provide context about the campaign's nature or theme.","example":["activation","summer_sale"],"uniqueKey":"oneOf.1.basic_details.tags","typeLabel":"string[]"},"team":{"type":"string","description":"The name of the team collaborating on this campaign.\nFor more information, refer to [Teams in MoEngage](/user-guide/settings/account/team-management/teams-in-moengage).\n","example":"marketing_team","uniqueKey":"oneOf.1.basic_details.team","typeLabel":"string"},"send_only_double_opt_in_users":{"type":"boolean","description":"Whether to send the campaign only to users who have completed double opt-in.\n\nWhen `false` or omitted, the campaign sends to all eligible users.\n\nEnsure the Double Opt-In feature is enabled for your workspace.\n","default":false,"example":true,"uniqueKey":"oneOf.1.basic_details.send_only_double_opt_in_users","typeLabel":"boolean"},"deduplication_attribute":{"type":"string","description":"The user attribute used for brand deduplication.\n\nPass `\"\"` (empty string) or omit the field to treat the campaign as single-brand. For multi-brand deduplication, pass the backend attribute name that stores the brand identifier (for example, `u_em`).\n\nAlways use the backend attribute name (for example, `u_em`), not the display label (for example, `Email (Standard)`).\n\nEnsure the Brand Deduplication feature is enabled for your workspace.\n","default":"","example":"u_em","uniqueKey":"oneOf.1.basic_details.deduplication_attribute","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.basic_details","typeLabel":"object"},"connector":{"type":"object","description":"Email connector configuration for sending email campaigns.","required":["connector_type","connector_name"],"properties":{"connector_type":{"type":"string","description":"The type of connector service (e.g., SENDGRID, AWS SES, etc.).","example":"SENDGRID","isRequired":true,"uniqueKey":"oneOf.1.connector.connector_type","typeLabel":"string"},"connector_name":{"type":"string","description":"The name of the connector configuration.","example":"default","isRequired":true,"uniqueKey":"oneOf.1.connector.connector_name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.connector","typeLabel":"object"},"campaign_content":{"type":"object","description":"Contains the content and variations for the Email campaign.","required":["content"],"properties":{"content":{"type":"object","description":"The actual Email campaign content.","required":["email"],"properties":{"email":{"type":"object","description":"Email campaign content.","required":["subject","sender_name","from_address","reply_to_address"],"properties":{"subject":{"type":"string","description":"The subject line of the email.","example":"Exclusive Summer Sale - 50% Off!","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.subject","typeLabel":"string"},"sender_name":{"type":"string","description":"The name of the sender that appears in the email.","example":"MoEngage Team","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.sender_name","typeLabel":"string"},"from_address":{"type":"string","format":"email","description":"The sender's email address.","example":"[email protected]","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.from_address","typeLabel":"string\u003cemail>"},"reply_to_address":{"type":"string","format":"email","description":"The reply-to email address.","example":"[email protected]","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.reply_to_address","typeLabel":"string\u003cemail>"},"preview_text":{"type":"string","description":"The preview text shown in email clients.","example":"Dont miss out on our biggest sale of the season","uniqueKey":"oneOf.1.campaign_content.content.email.preview_text","typeLabel":"string"},"cc_ids":{"type":"array","items":{"type":"string","format":"email","uniqueKey":"oneOf.1.campaign_content.content.email.cc_ids.items.[INDEX]","typeLabel":"string\u003cemail>"},"description":"Email addresses to CC.","uniqueKey":"oneOf.1.campaign_content.content.email.cc_ids","typeLabel":"string\u003cemail>[]"},"bcc_ids":{"type":"array","items":{"type":"string","format":"email","uniqueKey":"oneOf.1.campaign_content.content.email.bcc_ids.items.[INDEX]","typeLabel":"string\u003cemail>"},"description":"Email addresses to BCC.","uniqueKey":"oneOf.1.campaign_content.content.email.bcc_ids","typeLabel":"string\u003cemail>[]"},"html_content":{"type":"string","description":"The HTML content of the email.\n\n**Optional** if custom_template_id is provided.\n","example":"\u003c!DOCTYPE html>\u003chtml>\u003chead>\u003c/head>\u003cbody>\u003cp>Hello {{UserAttribute['First Name']}}\u003c/p>\u003c/body>\u003c/html>","uniqueKey":"oneOf.1.campaign_content.content.email.html_content","typeLabel":"string"},"email_editor":{"type":"string","enum":["Froala Editor","Ace Editor"],"description":"The HTML editor used for the email campaign.\n\n- **Required** if you want to create the campaign using the `Ace Editor`.\n- **Optional** if you want to use the default `Froala Editor`.\n","example":"Ace Editor","uniqueKey":"oneOf.1.campaign_content.content.email.email_editor","typeLabel":"enum\u003cstring>"},"custom_template_id":{"type":"string","description":"The ID of a custom email template.\n\n**Optional** if html_content is provided.\n\nWhen this field is provided, the following fields are not required:\n- subject\n- preview_text\n- sender_name\n","uniqueKey":"oneOf.1.campaign_content.content.email.custom_template_id","typeLabel":"string"},"custom_template_version":{"type":"integer","description":"The version of the custom template.","uniqueKey":"oneOf.1.campaign_content.content.email.custom_template_version","typeLabel":"integer"},"attachments":{"type":"array","items":{"type":"object","properties":{"file_type":{"type":"string","enum":["URL","PERSONALIZED_ATTACHMENT"],"uniqueKey":"oneOf.1.campaign_content.content.email.attachments.items.[INDEX].file_type","typeLabel":"enum\u003cstring>"},"url":{"type":"string","uniqueKey":"oneOf.1.campaign_content.content.email.attachments.items.[INDEX].url","typeLabel":"string"},"s3_keys":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.campaign_content.content.email.attachments.items.[INDEX].s3_keys.items.[INDEX]","typeLabel":"string"},"description":"S3 object keys backing an attachment stored in S3.","example":["attachments/2026/06/invoice-001.pdf"],"uniqueKey":"oneOf.1.campaign_content.content.email.attachments.items.[INDEX].s3_keys","typeLabel":"string[]"}},"uniqueKey":"oneOf.1.campaign_content.content.email.attachments.items.[INDEX]","typeLabel":"object"},"description":"Attachments to include in the email.","uniqueKey":"oneOf.1.campaign_content.content.email.attachments","typeLabel":"object[]"},"gmail_annotations":{"type":"object","description":"Gmail Annotations shown in Gmail's Promotions tab. Two annotation types are supported: `deal_card` and `product_carousel`. These are mutually exclusive — include only one per campaign.\n\n**Note:** `gmail_annotations` is only supported when `content_type` is `PROMOTIONAL`. Using it with `TRANSACTIONAL` returns a `400` error.\n","required":["send_email_if_personalization_fails","sender_logo","sender_logo_type"],"properties":{"send_email_if_personalization_fails":{"type":"boolean","description":"Whether to send the email if personalization of any Gmail annotation field fails.\n\n**Required** when `gmail_annotations` is present.\n","example":true,"isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.send_email_if_personalization_fails","typeLabel":"boolean"},"sender_logo":{"type":"string","description":"The sender logo shown in the Gmail annotation.\n\nAccepts a valid HTTPS URL or a MoEngage personalization token.\n\n**Required** when `gmail_annotations` is present.\n","example":"https://example.com/logo.png","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.sender_logo","typeLabel":"string"},"sender_logo_type":{"type":"string","enum":["image_url","uploaded_image"],"description":"The source type of the sender logo.\n\n**Required** when `sender_logo` is provided.\n","example":"image_url","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.sender_logo_type","typeLabel":"enum\u003cstring>"},"deal_card":{"type":"object","description":"The Deal Card annotation.\n\n**Optional.** Use either `deal_card` or `product_carousel` — not both.\n","required":["description","discount_code","availability_starts","availability_ends"],"properties":{"description":{"type":"string","description":"Short deal description shown in the Gmail annotation.\n\n**Required** when `deal_card` is present.\n","example":"Get 20% off on all orders above $50","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.deal_card.description","typeLabel":"string"},"discount_code":{"type":"string","description":"Promo or discount code displayed with the deal.\n\n**Required** when `deal_card` is present.\n","example":"SAVE20","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.deal_card.discount_code","typeLabel":"string"},"availability_starts":{"type":"string","description":"ISO 8601 datetime indicating when the deal becomes active. Use the timezone of the promotion, not your server or API caller timezone. Ensure the timezone matches the promotion's local timezone so the deal displays the correct active and expiry times for your audience.\n\n**Accepted formats:**\n- UTC (`Z` suffix): `YYYY-MM-DDTHH:mm:ssZ` (for example, `2026-06-01T00:00:00Z`).\n- Positive offset: `YYYY-MM-DDTHH:mm:ss+HH:MM` (for example, `2026-06-01T00:00:00+05:30` for IST).\n- Negative offset: `YYYY-MM-DDTHH:mm:ss-HH:MM` (for example, `2026-06-01T00:00:00-07:00` for US Pacific PDT).\n\n**Common offsets:** IST `+05:30`, SGT `+08:00`, GST `+04:00`, CET `+01:00` or `+02:00` (DST), EST `-05:00`, EDT `-04:00`, PST `-08:00`, PDT `-07:00`, UTC `Z` or `+00:00`.\n\n**Required** when `deal_card` is present.\n","example":"2026-06-01T00:00:00Z","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.deal_card.availability_starts","typeLabel":"string"},"availability_ends":{"type":"string","description":"ISO 8601 datetime indicating when the deal expires. Same format as `availability_starts`.\n\nUse the timezone of the promotion, not your server or API caller timezone. Ensure the timezone matches the promotion's local timezone so the deal displays the correct active and expiry times for your audience.\n\nMust be at least 1 hour after `availability_starts`.\n\n**Required** when `deal_card` is present.\n","example":"2026-06-30T23:59:59Z","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.deal_card.availability_ends","typeLabel":"string"}},"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.deal_card","typeLabel":"object"},"product_carousel":{"type":"object","description":"The Product Carousel annotation.\n\n**Optional.** Use either `product_carousel` or `deal_card` — not both.\n","required":["type"],"properties":{"type":{"type":"string","enum":["MANUAL","PRODUCT_SET"],"description":"The source type for the product carousel.\n\n- `MANUAL`: Specify products directly in the request using `manual_data`.\n- `PRODUCT_SET`: Pull products dynamically from a MoEngage Catalog product set using `product_set_data`. Requires the Product Sets feature to be enabled for your workspace.\n\n**Required** when `product_carousel` is present.\n","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.product_carousel.type","typeLabel":"enum\u003cstring>"},"manual_data":{"type":"object","description":"Products specified directly in the request.\n\n**Required** when `product_carousel.type` is `MANUAL`.\n","required":["currency","products"],"properties":{"currency":{"type":"string","description":"ISO 4217 currency code applied to all products in the carousel.\n\n**Required** when `manual_data` is present.\n","example":"USD","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.product_carousel.manual_data.currency","typeLabel":"string"},"products":{"type":"array","description":"List of products to display in the carousel.\n\n**Required** when `manual_data` is present. Minimum 2 products.\n","minItems":2,"items":{"type":"object","description":"A single product entry in a manual product carousel. All fields below are required for each product.","required":["id","headline","original_price","discount_value","discount_type","promo_url","product_image"],"properties":{"id":{"type":"string","description":"Unique product identifier.\n\n**Required** for each product.\n","example":"prod-001","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.product_carousel.manual_data.products.items.[INDEX].id","typeLabel":"string"},"headline":{"type":"string","description":"Product name shown in the annotation.\n\n**Required** for each product.\n","example":"Wireless Headphones","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.product_carousel.manual_data.products.items.[INDEX].headline","typeLabel":"string"},"original_price":{"type":"string","description":"Original price of the product as a numeric string.\n\n**Required** for each product.\n","example":"199.99","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.product_carousel.manual_data.products.items.[INDEX].original_price","typeLabel":"string"},"discount_value":{"type":"string","description":"Discount amount as a numeric string. Interpreted as a percentage or absolute value depending on `discount_type`.\n\n**Required** for each product.\n","example":"30","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.product_carousel.manual_data.products.items.[INDEX].discount_value","typeLabel":"string"},"discount_type":{"type":"string","enum":["PERCENT","VALUE"],"description":"How `discount_value` is interpreted.\n\n- `PERCENT`: `discount_value` is a percentage.\n- `VALUE`: `discount_value` is an absolute amount in `currency`.\n\n**Required** for each product.\n","example":"PERCENT","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.product_carousel.manual_data.products.items.[INDEX].discount_type","typeLabel":"enum\u003cstring>"},"promo_url":{"type":"string","description":"Product landing page URL. Must be a valid HTTPS URL.\n\n**Required** for each product.\n","example":"https://example.com/products/prod-001","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.product_carousel.manual_data.products.items.[INDEX].promo_url","typeLabel":"string"},"product_image":{"type":"string","description":"Product image URL. Must be a valid HTTPS URL. Cannot be empty.\n\n**Required** for each product.\n","example":"https://example.com/images/prod-001.png","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.product_carousel.manual_data.products.items.[INDEX].product_image","typeLabel":"string"}},"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.product_carousel.manual_data.products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.product_carousel.manual_data.products","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.product_carousel.manual_data","typeLabel":"object"},"product_set_data":{"type":"object","description":"Reference to a MoEngage Catalog product set.\n\n**Required** when `product_carousel.type` is `PRODUCT_SET`.\n","required":["product_set","image_url","headline","promo_url","product_count"],"properties":{"product_set":{"type":"string","description":"Product set ID from MoEngage Catalog. Must be valid and exist in your workspace.\n\n**Required** when `product_set_data` is present.\n","example":"product_set_12345","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.product_carousel.product_set_data.product_set","typeLabel":"string"},"image_url":{"type":"string","description":"Fallback image URL if a product set image is unavailable.\n\n**Required** when `product_set_data` is present.\n","example":"https://example.com/images/fallback.png","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.product_carousel.product_set_data.image_url","typeLabel":"string"},"headline":{"type":"string","description":"Label shown for the product carousel.\n\n**Required** when `product_set_data` is present.\n","example":"Recommended For You","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.product_carousel.product_set_data.headline","typeLabel":"string"},"promo_url":{"type":"string","description":"Destination URL when the user clicks the annotation.\n\n**Required** when `product_set_data` is present.\n","example":"https://example.com/shop","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.product_carousel.product_set_data.promo_url","typeLabel":"string"},"product_count":{"type":"integer","description":"Number of products to display.\n\n**Required** when `product_set_data` is present. Minimum 2, maximum 9.\n","minimum":2,"maximum":9,"example":3,"isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.product_carousel.product_set_data.product_count","typeLabel":"integer"}},"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.product_carousel.product_set_data","typeLabel":"object"}},"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations.product_carousel","typeLabel":"object"}},"uniqueKey":"oneOf.1.campaign_content.content.email.gmail_annotations","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content.email","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.1.campaign_content.content","typeLabel":"object"},"locales":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.campaign_content.locales.items.[INDEX]","typeLabel":"string"},"description":"List of locales for multi-language campaigns.\nYou can send campaigns in multiple languages using locales.\n","example":["en-US","es-ES","default"],"uniqueKey":"oneOf.1.campaign_content.locales","typeLabel":"string[]"},"variation_details":{"type":"object","description":"Configuration for A/B testing variations.","required":["distribution_type","no_of_variations"],"properties":{"distribution_type":{"type":"string","enum":["SHERPA","MANUAL"],"description":"The distribution type for variations.","isRequired":true,"uniqueKey":"oneOf.1.campaign_content.variation_details.distribution_type","typeLabel":"enum\u003cstring>"},"no_of_variations":{"type":"integer","description":"The number of variations for the campaign.","minimum":1,"example":2,"isRequired":true,"uniqueKey":"oneOf.1.campaign_content.variation_details.no_of_variations","typeLabel":"integer"},"manual_distribution_percentage":{"type":"object","description":"Manual percentage distribution for each variation.\n\n**Required** when distribution_type is MANUAL.\n","additionalProperties":{"type":"string","uniqueKey":"oneOf.1.campaign_content.variation_details.manual_distribution_percentage.additionalProperties","typeLabel":"string"},"example":{"variation_1":"50","variation_2":"45"},"uniqueKey":"oneOf.1.campaign_content.variation_details.manual_distribution_percentage","typeLabel":"object"},"sherpa_campaign_duration":{"type":"integer","description":"The Sherpa campaign duration.\n\n**Required** when distribution_type is SHERPA.\n","uniqueKey":"oneOf.1.campaign_content.variation_details.sherpa_campaign_duration","typeLabel":"integer"},"sherpa_distribution_metric":{"type":"string","enum":["OPEN RATE","CLICK RATE","BOTH"],"description":"The Sherpa distribution metric.\n\n**Required** when distribution_type is SHERPA.\n","uniqueKey":"oneOf.1.campaign_content.variation_details.sherpa_distribution_metric","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.campaign_content.variation_details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.1.campaign_content","typeLabel":"object"},"test_campaign_meta":{"type":"object","description":"Metadata for specifying test recipients for Email campaigns.\n","required":["identifier","identifier_values"],"properties":{"identifier":{"type":"string","enum":["EMAIL","ID","CUSTOM_SEGMENT","MOBILE_NUMBER"],"description":"The type of identifier used to target test users.\n\n- **EMAIL**: Email address (content will not be personalized with user profile data)\n- **ID**: User ID from your system\n- **CUSTOM_SEGMENT**: User-defined segment\n- **MOBILE_NUMBER**: User's mobile phone number\n","isRequired":true,"uniqueKey":"oneOf.1.test_campaign_meta.identifier","typeLabel":"enum\u003cstring>"},"identifier_values":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.test_campaign_meta.identifier_values.items.[INDEX]","typeLabel":"string"},"description":"Array of identifier values to send the test campaign to.\n\n**Note:** Maximum 10 users at a time.\n","maxItems":10,"example":["[email protected]","[email protected]"],"isRequired":true,"uniqueKey":"oneOf.1.test_campaign_meta.identifier_values","typeLabel":"string[]"},"locale_name":{"type":"string","description":"The locale name to use for the test campaign (when using multi-locale campaigns).","example":"en-US","uniqueKey":"oneOf.1.test_campaign_meta.locale_name","typeLabel":"string"},"variation":{"type":"string","description":"The variation name to use for the test campaign (when using A/B testing).","example":"variation_1","uniqueKey":"oneOf.1.test_campaign_meta.variation","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.test_campaign_meta","typeLabel":"object"},"utm_params":{"type":"object","description":"UTM parameters for tracking campaign performance.","required":["utm_source","utm_medium"],"properties":{"utm_source":{"type":"string","description":"The source of the traffic (e.g., YouTube, Instagram, Google).\n\n**Required** when using UTM parameters.\n","example":"google","isRequired":true,"uniqueKey":"oneOf.1.utm_params.utm_source","typeLabel":"string"},"utm_medium":{"type":"string","description":"The channel type (e.g., Push, SMS, Email).\n\n**Required** when using UTM parameters.\n","example":"email","isRequired":true,"uniqueKey":"oneOf.1.utm_params.utm_medium","typeLabel":"string"},"utm_campaign":{"type":"string","description":"The name of the campaign (e.g., Newyear, Bigbillionday).","example":"summer_sale","uniqueKey":"oneOf.1.utm_params.utm_campaign","typeLabel":"string"},"utm_term":{"type":"string","description":"Search terms for paid traffic (e.g., Mobile+sale).","uniqueKey":"oneOf.1.utm_params.utm_term","typeLabel":"string"},"utm_content":{"type":"string","description":"The content element that differentiates links (e.g., banner, video).","uniqueKey":"oneOf.1.utm_params.utm_content","typeLabel":"string"},"utm_custom":{"type":"string","description":"Custom UTM parameter (maximum of 5 custom parameters).","uniqueKey":"oneOf.1.utm_params.utm_custom","typeLabel":"string"}},"uniqueKey":"oneOf.1.utm_params","typeLabel":"object"},"personalization_details":{"type":"object","description":"Override values for personalizing campaign content during testing.\n\n**Important**: \n - When you pass personalization details in the personalization_details object of this API, MoEngage uses those details to personalize the user attributes or event attributes present in the content instead of the attributes present in the user profile.\n - You can use this API only for 10 users at a time.\n - The same personalization details are used across all users. For example, you pass the first name as Dave in personalization details, you have used the first name in the content, and there are 10 users. In this case, all 10 users will get the same first name (Dave).\n","properties":{"user_attributes":{"type":"object","additionalProperties":true,"description":"Key-value pairs for user attribute personalization.\n\nThe same values are used for all test recipients.\n","example":{"First Name":"John","Last Name":"Doe","Email":"[email protected]"},"uniqueKey":"oneOf.1.personalization_details.user_attributes","typeLabel":"object"},"event_attributes":{"type":"object","additionalProperties":true,"description":"Key-value pairs for event attribute personalization.\n\nIf you pass only a subset of attributes, remaining values are picked from the user profile.\n","example":{"Campaign Name":"Test Campaign","Campaign Channel":"Email"},"uniqueKey":"oneOf.1.personalization_details.event_attributes","typeLabel":"object"}},"uniqueKey":"oneOf.1.personalization_details","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"Email Campaign · object"}],"uniqueKey":"","typeLabel":"Push Campaign · object | Email Campaign · object"},"examples":{"push_test_basic":{"title":"push_test_basic","summary":"Push - Test with User ID","value":{"request_id":"test_push_123","channel":"PUSH","basic_details":{"name":"Flash Sale Push Test","platforms":["ANDROID","IOS"],"platform_specific_details":{"android":{"push_amp_plus_enabled":true},"ios":{"send_to_all_eligible_device":true,"exclude_provisional_push_devices":false,"send_to_only_provisional_push_enabled_devices":false}}},"campaign_content":{"content":{"push":{"android":{"template_type":"BASIC","basic_details":{"notification_channel":"general","title":"Test: Flash Sale!","message":"Testing message content","default_click_action":"DEEPLINKING","default_click_action_value":"https://example.com/sale"}},"ios":{"template_type":"BASIC","basic_details":{"title":"Test: Flash Sale!","message":"Testing message content","default_click_action":"DEEPLINKING","default_click_action_value":"https://example.com/sale"}}}}},"test_campaign_meta":{"identifier":"USER_ATTRIBUTE_UNIQUE_ID","identifier_values":["user_12345"]}}},"email_test_with_personalization":{"title":"email_test_with_personalization","summary":"Email - Test with Personalization","value":{"request_id":"test_email_456","channel":"EMAIL","basic_details":{"name":"Newsletter Test","content_type":"PROMOTIONAL","subscription_category":"marketing","user_attribute_identifier":"MOE_EMAIL_ID"},"connector":{"connector_type":"SENDGRID","connector_name":"default"},"campaign_content":{"content":{"email":{"subject":"Test: Weekly Newsletter","preview_text":"Testing email content","sender_name":"MoEngage Store","from_address":"[email protected]","reply_to_address":"[email protected]","html_content":"\u003c!DOCTYPE html>\u003chtml>\u003cbody>\u003cp>Hi {{UserAttribute['First Name']}},\u003c/p>\u003cp>Testing personalized content\u003c/p>\u003c/body>\u003c/html>"}}},"personalization_details":{"user_attributes":{"First Name":"John","Last Name":"Doe"},"event_attributes":{"Campaign Name":"Test Campaign"}},"test_campaign_meta":{"identifier":"EMAIL","identifier_values":["[email protected]","[email protected]"]}}},"email_test_locale_variation":{"title":"email_test_locale_variation","summary":"Email - Test with Locale \u0026 Variation","value":{"request_id":"test_email_locale","channel":"EMAIL","basic_details":{"name":"Multi-locale Test","content_type":"PROMOTIONAL","subscription_category":"marketing","user_attribute_identifier":"MOE_EMAIL_ID"},"connector":{"connector_type":"SENDGRID","connector_name":"default"},"campaign_content":{"locales":["en-US","es-ES","default"],"content":{"en-US":{"variation_1":{"email":{"subject":"Test EN","sender_name":"Store","from_address":"[email protected]","reply_to_address":"[email protected]","html_content":"\u003chtml>\u003cbody>English content\u003c/body>\u003c/html>"}}}}},"test_campaign_meta":{"identifier":"ID","identifier_values":["user_001"],"locale_name":"en-US","variation":"variation_1"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"1ad23fd1-8256-42ac-9548-cef7381c46ca":{"description":"Test campaign sent successfully","content":{"application/json":{"schema":{"type":"object","description":"Response after successfully sending a test campaign.","properties":{"data":{"type":"object","additionalProperties":{"type":"object","properties":{"status":{"type":"string","enum":["success","failed"],"description":"The status of the test campaign delivery for this identifier.","uniqueKey":"data.additionalProperties.status","typeLabel":"enum\u003cstring>"},"failure_reason":{"type":"string","description":"The reason for failure (only present if status is \"failed\").","uniqueKey":"data.additionalProperties.failure_reason","typeLabel":"string"}},"uniqueKey":"data.additionalProperties","typeLabel":"object"},"description":"Object containing test results for each identifier.\n\nEach key is an identifier value with its delivery status.\n","example":{"user_12345":{"status":"success"},"user_67890":{"status":"failed","failure_reason":"User not found"}},"uniqueKey":"data","typeLabel":"object"},"message":{"type":"string","description":"A success message.","example":"Test campaign created successfully","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"success":{"title":"success","summary":"Successful Test","value":{"data":{"user_12345":{"status":"success"}},"message":"Test campaign created successfully"}},"partial_success":{"title":"partial_success","summary":"Partial Success","value":{"data":{"[email protected]":{"status":"success"},"[email protected]":{"status":"failed","failure_reason":"User not found"}},"message":"Test campaign created successfully"}}},"exampleType":"examples"}},"exampleType":"examples"},"9f5be74f-f962-4fe7-80d6-55c2e2161792":{"description":"Bad Request - Missing or invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"The error code (e.g., \"400 Bad Request\").","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Description of why the request failed.","uniqueKey":"error.message","typeLabel":"string"},"target":{"type":"string","description":"The target of the error.","uniqueKey":"error.target","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"target":{"type":"string","uniqueKey":"error.details.items.[INDEX].target","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"},"request_id":{"type":"string","description":"The request ID associated with this error.","uniqueKey":"error.request_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"ProjectCodeError":{"title":"ProjectCodeError","summary":"Missing Project Code","value":{"error":{"code":"400 Bad Request","message":"MOE-PROJECT-CODE header missing in request","target":"MOE-PROJECT-CODE","details":{"target":"MOE-PROJECT-CODE","message":"MOE-PROJECT-CODE header missing in request"},"request_id":"tb6bUhTAH0"}}},"InvalidProjectCode":{"title":"InvalidProjectCode","summary":"Invalid Project Code","value":{"error":{"code":"400 Bad Request","message":"Invalid MOE-PROJECT-CODE received in request","target":"MOE-PROJECT-CODE","details":[{"target":"MOE-PROJECT-CODE","message":"Invalid MOE-PROJECT-CODE received in request"}],"request_id":"qTmKEBCUZo"}}}},"exampleType":"examples"}},"exampleType":"examples"},"d940ac3d-77e9-4181-b1a1-8151650f5f81":{"description":"Authentication Failure - Invalid or missing authentication credentials","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"The error code (e.g., \"400 Bad Request\").","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Description of why the request failed.","uniqueKey":"error.message","typeLabel":"string"},"target":{"type":"string","description":"The target of the error.","uniqueKey":"error.target","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"target":{"type":"string","uniqueKey":"error.details.items.[INDEX].target","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"},"request_id":{"type":"string","description":"The request ID associated with this error.","uniqueKey":"error.request_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"401 Authentication error","message":"Authentication required","details":[{"code":"InvalidValue","target":"APP_SECRET_KEY","message":[{"code":"InvalidValue","target":"APP_SECRET_KEY","message":"Invalid APP_SECRET_KEY is provided."}]}],"request_id":""}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"401 Authentication error","message":"Authentication required","details":[{"code":"InvalidValue","target":"APP_SECRET_KEY","message":[{"code":"InvalidValue","target":"APP_SECRET_KEY","message":"Invalid APP_SECRET_KEY is provided."}]}],"request_id":""}}}},"exampleType":"examples"}},"exampleType":"examples"},"8a91bedf-5fd9-4bc5-a873-707789fa25ca":{"description":"Internal Server Error - Unexpected system error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"The error code (e.g., \"400 Bad Request\").","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Description of why the request failed.","uniqueKey":"error.message","typeLabel":"string"},"target":{"type":"string","description":"The target of the error.","uniqueKey":"error.target","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"target":{"type":"string","uniqueKey":"error.details.items.[INDEX].target","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"},"request_id":{"type":"string","description":"The request ID associated with this error.","uniqueKey":"error.request_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"500 Internal Server Error","message":"Something went wrong. Please contact Moengage team","target":"string","details":[{"message":"Expecting value: line 1 column 1 (char 0)","target":""}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"500 Internal Server Error","message":"Something went wrong. Please contact Moengage team","target":"string","details":[{"message":"Expecting value: line 1 column 1 (char 0)","target":""}]}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"959f046a-3fb3-4068-b8d8-bc2950061e93":{"BasicAuth":{"type":"http","scheme":"basic","description":"Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.\n\n- **Username**: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at **Settings** > **Account** > **APIs** > **Workspace ID (earlier app id)**.\n- **Password**: Use your API Key, which you can find within the **Campaign report/Business events/Custom templates/Catalog API/Inform Report** tile.\n\nFor more information on authentication and getting your credentials, refer [here](https://www.moengage.com/docs/api/introduction#getting-your-credentials).\n","scopes":[],"schemeName":"BasicAuth"}}},"servers":{"5e246dbb-bb10-4650-8d40-2730b1c3a1a8":{"url":"https://api-{dc}.moengage.com/core-services/v1","description":"MoEngage Campaigns API Server","variables":{"dc":{"default":"01","description":"The ‘dc’ in the API Endpoint URL refers to the MoEngage Data Center (DC). MoEngage hosts each customer in a different DC. You can find your DC number and replace the value of ‘dc’ in the URL by referring to the DC and API endpoint mapping [here](/api/introduction#data-centers). Your MoEngage Data Center (DC) can be 01, 02, 03, 04, 05, 06, or 101."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.\n\n- **Username**: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at **Settings** > **Account** > **APIs** > **Workspace ID (earlier app id)**.\n- **Password**: Use your API Key, which you can find within the **Campaign report/Business events/Custom templates/Catalog API/Inform Report** tile.\n\nFor more information on authentication and getting your credentials, refer [here](https://www.moengage.com/docs/api/introduction#getting-your-credentials).\n","scopes":[],"schemeName":"BasicAuth"},"schema":{"title":"Basic Auth","type":"object","description":"Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.\n\n- **Username**: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at **Settings** > **Account** > **APIs** > **Workspace ID (earlier app id)**.\n- **Password**: Use your API Key, which you can find within the **Campaign report/Business events/Custom templates/Catalog API/Inform Report** tile.\n\nFor more information on authentication and getting your credentials, refer [here](https://www.moengage.com/docs/api/introduction#getting-your-credentials).\n","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"BasicAuth","name":"Authorization"}],"title":"BasicAuth"}]},"originalFileLocation":"api/campaigns/campaigns.yaml"},"subdomain":"moengage","siteName":"MoEngage","title":"Test Campaign - MoEngage","relatedPagesConfig":{"enabled":false,"limit":3,"mode":"manual"},"contextualStarterQuestions":[{"_id":"69b015bc7104f9460ee447db","deploymentId":"68bea8f8fe02728a34cf2acf","questionText":"Can I test dashboard campaigns?","status":"active","generatedBy":"contextual","path":"api/test-campaigns/test-campaign","createdAt":"2026-03-10T12:59:40.304Z","updatedAt":"2026-03-10T12:59:40.304Z","__v":0},{"_id":"69b015bc7104f9460ee447da","deploymentId":"68bea8f8fe02728a34cf2acf","questionText":"What campaign types can I test?","status":"active","generatedBy":"contextual","path":"api/test-campaigns/test-campaign","createdAt":"2026-03-10T12:59:40.304Z","updatedAt":"2026-03-10T12:59:40.304Z","__v":0},{"_id":"69b015bc7104f9460ee447d9","deploymentId":"68bea8f8fe02728a34cf2acf","questionText":"How do I test a campaign?","status":"active","generatedBy":"contextual","path":"api/test-campaigns/test-campaign","createdAt":"2026-03-10T12:59:40.304Z","updatedAt":"2026-03-10T12:59:40.304Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api/test-campaigns/test-campaign","matchLevel":0},"ja":{"href":"/ja/api/test-campaigns/test-campaign","matchLevel":1}}},"lastModified":"2026-11-10T10:30:22.878Z","originalFileLocation":"api/test-campaigns/test-campaign.mdx","locale":"en"},"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=\"This API sends a test Push or Email campaign to specific users or identifiers before launching it to your entire audience. You can only test campaigns created via the API, not campaigns created through the MoEngage dashboard.\">\u003cmeta data-mint-head name=\"application-name\" content=\"MoEngage\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/moengage/FFhO5ttvrbE72kxs/_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=\"/docs/mintlify-assets/_mintlify/favicons/moengage/FFhO5ttvrbE72kxs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/moengage/FFhO5ttvrbE72kxs/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/moengage/FFhO5ttvrbE72kxs/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/moengage/FFhO5ttvrbE72kxs/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/moengage/FFhO5ttvrbE72kxs/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/moengage/FFhO5ttvrbE72kxs/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/moengage/FFhO5ttvrbE72kxs/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/moengage/FFhO5ttvrbE72kxs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Test Campaign - MoEngage\">\u003cmeta data-mint-head property=\"og:description\" content=\"This API sends a test Push or Email campaign to specific users or identifiers before launching it to your entire audience. You can only test campaigns created via the API, not campaigns created through the MoEngage dashboard.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"MoEngage\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://moengage.com/docs/api/test-campaigns/test-campaign\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://moengage.mintlify.site/docs/_mintlify/api/og/v2?division=Campaigns+%28Legacy%29\u0026amp;title=Test+Campaign\u0026amp;description=This+API+sends+a+test+Push+or+Email+campaign+to+specific+users+or+identifiers+before+launching+it+to+your+entire+audience.+You+can+only+test+campaigns+created+v\u0026amp;theme=f5f8670d2a6207083c52605d\u0026amp;signature=e45cfd12d8987f3dbab615c24cf3906bbc32da17a17872fc001416cfd2de441e\">\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=\"Test Campaign - MoEngage\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This API sends a test Push or Email campaign to specific users or identifiers before launching it to your entire audience. You can only test campaigns created via the API, not campaigns created through the MoEngage dashboard.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://moengage.mintlify.site/docs/_mintlify/api/og/v2?division=Campaigns+%28Legacy%29\u0026amp;title=Test+Campaign\u0026amp;description=This+API+sends+a+test+Push+or+Email+campaign+to+specific+users+or+identifiers+before+launching+it+to+your+entire+audience.+You+can+only+test+campaigns+created+v\u0026amp;theme=f5f8670d2a6207083c52605d\u0026amp;signature=e45cfd12d8987f3dbab615c24cf3906bbc32da17a17872fc001416cfd2de441e\">\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=\"/docs/mintlify-assets/_mintlify/favicons/moengage/FFhO5ttvrbE72kxs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"MoEngage\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2E69FF\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"ICNaPDX9oefbF09W1b5_U9PDnlkyfyKSRbIap6_dW6o\">\u003clink data-mint-head rel=\"canonical\" href=\"https://moengage.com/docs/api/test-campaigns/test-campaign\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api/test-campaigns/test-campaign.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://moengage.com/docs/api/test-campaigns/test-campaign\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://moengage.com/docs/ja/api/test-campaigns/test-campaign\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://moengage.com/docs/api/test-campaigns/test-campaign\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://moengage.com/#organization\",\"name\":\"MoEngage\",\"url\":\"https://moengage.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/moengage/VG5pJbeZsDUmdCZM/logo/light.svg?fit=max\u0026auto=format\u0026n=VG5pJbeZsDUmdCZM\u0026q=85\u0026s=28ca5909311cb6ffe01738e1503b5e64\"}},{\"@type\":\"WebSite\",\"@id\":\"https://moengage.com/docs#website\",\"name\":\"MoEngage\",\"url\":\"https://moengage.com/docs\",\"publisher\":{\"@id\":\"https://moengage.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://moengage.com/docs/api/test-campaigns/test-campaign#webpage\",\"url\":\"https://moengage.com/docs/api/test-campaigns/test-campaign\",\"name\":\"Test Campaign\",\"description\":\"This API sends a test Push or Email campaign to specific users or identifiers before launching it to your entire audience. You can only test campaigns created via the API, not campaigns created through the MoEngage dashboard.\",\"dateModified\":\"2026-11-10T10:30:22.878Z\",\"isPartOf\":{\"@id\":\"https://moengage.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://moengage.com/docs/api/test-campaigns/test-campaign#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://moengage.com/docs/api/test-campaigns/test-campaign#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://moengage.com/docs/api/data/data-overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Campaigns\",\"item\":\"https://moengage.com/docs/api/campaigns/campaign-draft-overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Campaigns (Legacy)\",\"item\":\"https://moengage.com/docs/api/campaigns/campaigns-overview\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Test Campaign\",\"item\":\"https://moengage.com/docs/api/test-campaigns/test-campaign\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://moengage.com/docs/api/test-campaigns/test-campaign#apireference\",\"headline\":\"Test Campaign\",\"name\":\"Test Campaign\",\"description\":\"This API sends a test Push or Email campaign to specific users or identifiers before launching it to your entire audience. You can only test campaigns created via the API, not campaigns created through the MoEngage dashboard.\",\"url\":\"https://moengage.com/docs/api/test-campaigns/test-campaign\",\"mainEntityOfPage\":{\"@id\":\"https://moengage.com/docs/api/test-campaigns/test-campaign#webpage\"},\"dateModified\":\"2026-11-10T10:30:22.878Z\",\"publisher\":{\"@id\":\"https://moengage.com/#organization\"},\"isPartOf\":{\"@id\":\"https://moengage.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"MoEngage\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"MoEngage\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api/test-campaigns/test-campaign.md","siteName":"MoEngage","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"User Guide","pages":[{"title":"User Guide","href":"/user-guide/introduction"}]},{"tab":"Developer Guide (SDKs)","pages":[{"title":"Developer Guide (SDKs)","href":"/developer-guide/introduction"}]},{"tab":"API Guide","groups":[{"group":"API Documentation","pages":[{"title":"API Documentation","sidebarTitle":"Overview","icon":"rocket","href":"/api/introduction"},{"group":"Authentication","icon":"key","pages":[{"group":"OAuth 2.0","pages":[{"title":"OAuth 2.0 Overview","icon":"file-magnifying-glass","href":"/api/oauth/oauth-overview"},{"title":"Generate Access Token","deprecated":null,"version":null,"openapi":"/api/oauth/oauth.yaml post /v1/oauth/token","href":"/api/oauth/generate-access-token"},{"title":"Refresh Access Token","deprecated":null,"version":null,"openapi":"/api/oauth/oauth.yaml post /v1/oauth/refresh","href":"/api/oauth/refresh-access-token"}]},{"title":"AWS STS Auth","href":"/api/aws-sts/aws-sts-overview"}]},{"title":"Rate Limits","icon":"gauge","href":"/api/rate-limits"}]},{"group":"Endpoints","icon":"code","pages":[{"group":"Data","icon":"database","pages":[{"title":"Data Overview","icon":"file-magnifying-glass","href":"/api/data/data-overview"},{"group":"User","icon":"user","pages":[{"title":"Track User","deprecated":null,"version":null,"openapi":"/api/data/data.yaml post /customer/{app_id}","href":"/api/user/track-user"},{"title":"Get User","deprecated":null,"version":null,"openapi":"/api/data/data.yaml post /customers/export","href":"/api/user/get-user"},{"title":"Merge Users","deprecated":null,"version":null,"openapi":"/api/data/data.yaml post /customer/merge","href":"/api/user/merge-users"},{"title":"Delete Users","deprecated":null,"version":null,"openapi":"/api/data/data.yaml post /customer/delete","href":"/api/user/delete-users"}]},{"group":"Event","icon":"calendar","pages":[{"title":"Track Event","deprecated":null,"version":null,"openapi":"/api/data/data.yaml post /event/{Workspace_ID}","href":"/api/event/track-event"}]},{"group":"Bulk","icon":"layer-group","pages":[{"title":"Bulk Import Users and Events","deprecated":null,"version":null,"openapi":"/api/data/data.yaml post /transition/{Workspace_ID}","href":"/api/bulk/bulk-import-users-and-events"}]},{"group":"Device","icon":"mobile","pages":[{"title":"Track Device","deprecated":null,"version":null,"openapi":"/api/data/data.yaml post /device/{app_id}","href":"/api/device/track-device"},{"title":"Device Opt-out","deprecated":null,"version":null,"openapi":"/api/data/data.yaml post /devices/manage","href":"/api/device/device-opt-out"}]},{"group":"File Import","icon":"file-import","pages":[{"title":"File Import Overview","icon":"file-magnifying-glass","href":"/api/data/file-import-overview"},{"title":"Trigger File Imports","deprecated":null,"version":null,"openapi":"/api/data/data.yaml post /fileimports/trigger/{schedule_id}","href":"/api/file-import/trigger-file-imports"},{"title":"Import Details","deprecated":null,"version":null,"openapi":"/api/data/data.yaml post /fileimports/import/status","href":"/api/file-import/import-details"},{"title":"Import File Run History","deprecated":null,"version":null,"openapi":"/api/data/data.yaml post /fileimports/import/run/history","href":"/api/file-import/import-file-run-history"}]},{"group":"Tracking","icon":"chart-line","pages":[{"title":"Track App Install","deprecated":null,"version":null,"openapi":"/api/data/data.yaml get /installInfo","href":"/api/tracking/track-app-install"}]},{"group":"Utilities","icon":"wrench","pages":[{"title":"Test Connection API","deprecated":null,"version":null,"openapi":"/api/data/data.yaml post /integrations/authentication","href":"/api/utilities/test-connection-api"}]},{"title":"Streams","icon":"webhook","href":"/api/data/moengage-streams"},{"group":"GDPR/CCPA","icon":"shield-check","pages":[{"title":"GDPR or CCPA Overview","icon":"file-magnifying-glass","href":"/api/gdpr-ccpa/gdpr-ccpa-overview"},{"title":"Submit a GDPR / CCPA Data Request","deprecated":null,"version":null,"openapi":"/api/gdpr-ccpa/gdpr-ccpa.yaml post /opengdpr_requests/{appId}","href":"/api/gdpr/submit-a-gdpr-ccpa-data-request"}]}]},{"group":"Business Events","icon":"calendar-check","pages":[{"group":"Business Events (V5)","icon":"bolt","pages":[{"title":"Business Events API (V5): Overview","icon":"bolt","href":"/api/business-events/business-events-v5/business-events-v5-overview"},{"title":"Trigger Business Event (V5)","deprecated":null,"version":null,"openapi":"/api/business-events/business-events-v5/business-events-v5.yaml post /v5/business-events/triggers","href":"/api/business-events/trigger-business-event-v5"},{"title":"List Business Events","deprecated":null,"version":null,"openapi":"/api/business-events/business-events-v5/business-events-v5.yaml get /v5/business-events","href":"/api/business-events/list-business-events"},{"title":"Search Business Events (V5)","deprecated":null,"version":null,"openapi":"/api/business-events/business-events-v5/business-events-v5.yaml post /v5/business-events/search","href":"/api/business-events/search-business-events-v5"}]},{"group":"Business Events (Legacy)","icon":"clock-rotate-left","pages":[{"title":"Business Events API (Legacy): Overview","icon":"clock-rotate-left","href":"/api/business-events/business-events-legacy/business-events-overview"},{"title":"Create Business Event","deprecated":null,"version":null,"openapi":"/api/business-events/business-events-legacy/business-events.yaml post /business_event","href":"/api/business-events/create-business-event"},{"title":"Trigger Business Event","deprecated":null,"version":null,"openapi":"/api/business-events/business-events-legacy/business-events.yaml post /business_event/trigger","href":"/api/business-events/trigger-business-event"},{"title":"Search Business Events","deprecated":null,"version":null,"openapi":"/api/business-events/business-events-legacy/business-events.yaml post /business_event/search","href":"/api/business-events/search-business-events"}]}]},{"group":"Content","icon":"file-lines","pages":[{"group":"Templates","icon":"rectangle-list","pages":[{"group":"Custom In-App Templates","icon":"mobile-screen","pages":[{"title":"In-app Templates Overview","icon":"file-magnifying-glass","href":"/api/in-app-templates/in-app-templates-overview"},{"title":"Create In-app Template","deprecated":null,"version":null,"openapi":"/api/in-app-templates/in-app-templates.yaml post /custom-templates/inapp","href":"/api/in-app-templates/create-in-app-template"},{"title":"Update In-app Template","deprecated":null,"version":null,"openapi":"/api/in-app-templates/in-app-templates.yaml put /custom-templates/inapp","href":"/api/in-app-templates/update-in-app-template"},{"title":"Search In-app Templates","deprecated":null,"version":null,"openapi":"/api/in-app-templates/in-app-templates.yaml post /custom-templates/inapp/search","href":"/api/in-app-templates/search-in-app-templates"}]},{"group":"Custom OSM Templates","icon":"window-restore","pages":[{"title":"OSM Templates Overview","icon":"file-magnifying-glass","href":"/api/osm-templates/osm-templates-overview"},{"title":"Create OSM Template","deprecated":null,"version":null,"openapi":"/api/osm-templates/osm-templates.yaml post /custom-templates/osm","href":"/api/osm-templates/create-osm-template"},{"title":"Update OSM Template","deprecated":null,"version":null,"openapi":"/api/osm-templates/osm-templates.yaml put /custom-templates/osm","href":"/api/osm-templates/update-osm-template"},{"title":"Search OSM Templates","deprecated":null,"version":null,"openapi":"/api/osm-templates/osm-templates.yaml post /custom-templates/osm/search","href":"/api/osm-templates/search-osm-templates"}]},{"group":"Custom SMS Templates","icon":"comment-sms","pages":[{"title":"SMS Templates Overview","icon":"file-magnifying-glass","href":"/api/sms-templates/sms-templates-overview"},{"title":"Create SMS Template","deprecated":null,"version":null,"openapi":"/api/sms-templates/sms-templates.yaml post /custom-templates/sms","href":"/api/sms-templates/create-sms-template"},{"title":"Update SMS Template","deprecated":null,"version":null,"openapi":"/api/sms-templates/sms-templates.yaml put /custom-templates/sms","href":"/api/sms-templates/update-sms-template"},{"title":"Search SMS Templates","deprecated":null,"version":null,"openapi":"/api/sms-templates/sms-templates.yaml post /custom-templates/sms/search","href":"/api/sms-templates/search-sms-templates"}]},{"group":"Custom Email Templates V1","icon":"envelope-open-text","pages":[{"title":"Email Templates (V1) Overview","icon":"file-magnifying-glass","href":"/api/email-templates-1/email-templates-1-overview"},{"title":"Create Email Template (V1)","deprecated":null,"version":null,"openapi":"/api/email-templates-1/email-templates-1.yaml post /email-templates","href":"/api/email-templates/create-email-template-v1"},{"title":"Get All Templates","deprecated":null,"version":null,"openapi":"/api/email-templates-1/email-templates-1.yaml get /email-templates","href":"/api/email-templates/get-all-templates"},{"title":"Get Specific Template","deprecated":null,"version":null,"openapi":"/api/email-templates-1/email-templates-1.yaml get /email-templates/{id}","href":"/api/email-templates/get-specific-template"},{"title":"Update Specific Template","deprecated":null,"version":null,"openapi":"/api/email-templates-1/email-templates-1.yaml put /email-templates/{id}","href":"/api/email-templates/update-specific-template"},{"title":"Bulk Create/Update Templates","deprecated":null,"version":null,"openapi":"/api/email-templates-1/email-templates-1.yaml put /bulk/email-templates","href":"/api/email-templates/bulk-createupdate-templates"}]},{"group":"Custom Email Templates V2","icon":"envelope","pages":[{"title":"Email Templates (V2) Overview","icon":"file-magnifying-glass","href":"/api/email-templates-2/email-templates-2-overview"},{"title":"Create Email Template (V2)","deprecated":null,"version":null,"openapi":"/api/email-templates-2/email-templates-2.yaml post /custom-templates/email","href":"/api/email-templates/create-email-template-v2"},{"title":"Search Email Template","deprecated":null,"version":null,"openapi":"/api/email-templates-2/email-templates-2.yaml post /custom-templates/email/search","href":"/api/email-templates/search-email-template"},{"title":"Update Email Template","deprecated":null,"version":null,"openapi":"/api/email-templates-2/email-templates-2.yaml put /custom-templates/email","href":"/api/email-templates/update-email-template"}]},{"group":"Custom Push Templates","icon":"bell","pages":[{"title":"Push Templates Overview","icon":"file-magnifying-glass","href":"/api/push-templates/push-templates-overview"},{"title":"Create Push Template","deprecated":null,"version":null,"openapi":"/api/push-templates/push-templates.yaml post /custom-templates/push","href":"/api/templates/create-push-template"},{"title":"Update Push Template","deprecated":null,"version":null,"openapi":"/api/push-templates/push-templates.yaml put /custom-templates/push","href":"/api/templates/update-push-template"},{"title":"Search for Push Templates","deprecated":null,"version":null,"openapi":"/api/push-templates/push-templates.yaml post /custom-templates/push/search","href":"/api/templates/search-for-push-templates"}]}]},{"group":"Content Blocks","icon":"cubes","pages":[{"title":"Content Blocks Overview","icon":"file-magnifying-glass","href":"/api/content-blocks/content-blocks-overview"},{"title":"Create Content Block","deprecated":null,"version":null,"openapi":"/api/content-blocks/content-blocks.yaml post /content-blocks","href":"/api/content-blocks/create-content-block"},{"title":"Update Content Block","deprecated":null,"version":null,"openapi":"/api/content-blocks/content-blocks.yaml put /content-blocks","href":"/api/content-blocks/update-content-block"},{"title":"Get Specific Content Blocks","deprecated":null,"version":null,"openapi":"/api/content-blocks/content-blocks.yaml post /content-blocks/get-by-ids","href":"/api/content-blocks/get-specific-content-blocks"},{"title":"Search Content Blocks","deprecated":null,"version":null,"openapi":"/api/content-blocks/content-blocks.yaml post /content-blocks/search","href":"/api/content-blocks/search-content-blocks"}]},{"group":"Content APIs","icon":"plug","pages":[{"title":"Content APIs Overview","icon":"file-magnifying-glass","href":"/api/content-apis/content-apis-overview"},{"title":"List Content APIs","deprecated":null,"version":null,"openapi":"/api/content-apis/content-apis.yaml get /v5/content-apis","href":"/api/content-apis/list-content-apis"},{"title":"Test Content API","deprecated":null,"version":null,"openapi":"/api/content-apis/content-apis.yaml post /v5/content-apis/{id}/test","href":"/api/content-apis/test-content-api"}]},{"group":"Locales","icon":"language","pages":[{"title":"Locales Overview","icon":"file-magnifying-glass","href":"/api/locales/locales-overview"},{"title":"List Locales","deprecated":null,"version":null,"openapi":"/api/locales/locales.yaml get /v5/locales","href":"/api/locales/list-locales"}]},{"group":"Recommendations","icon":"wand-magic-sparkles","pages":[{"title":"Recommendations Overview","icon":"file-magnifying-glass","href":"/api/recommendations/recommendations-overview"},{"title":"Fetch All Recommendations","deprecated":null,"version":null,"openapi":"/api/recommendations/recommendations.yaml get /recommendations","href":"/api/recommendations/fetch-all-recommendations"},{"title":"Fetch Recommendation Details","deprecated":null,"version":null,"openapi":"/api/recommendations/recommendations.yaml get /recommendations/{recommendation_id}","href":"/api/recommendations/fetch-recommendation-details"},{"title":"Fetch Recommendation Results","deprecated":null,"version":null,"openapi":"/api/recommendations/recommendations.yaml post /recommendations/{recommendation_id}/items","href":"/api/recommendations/fetch-recommendation-results"}]},{"group":"Coupons","icon":"ticket","pages":[{"title":"Coupon Management Overview","icon":"file-magnifying-glass","href":"/api/coupons/coupons-overview"},{"title":"Create a Coupon List","deprecated":null,"version":null,"openapi":"/api/coupons/coupons.yaml post /coupon-list","href":"/api/coupon-lists/create-a-coupon-list"},{"title":"Fetch All Coupon Lists","deprecated":null,"version":null,"openapi":"/api/coupons/coupons.yaml get /coupon-list","href":"/api/coupon-lists/fetch-all-coupon-lists"},{"title":"Fetch Coupon List Details","deprecated":null,"version":null,"openapi":"/api/coupons/coupons.yaml get /coupon-list/{coupon_list_id}","href":"/api/coupon-lists/fetch-coupon-list-details"},{"title":"Update a Coupon List","deprecated":null,"version":null,"openapi":"/api/coupons/coupons.yaml patch /coupon-list/{coupon_list_id}","href":"/api/coupon-lists/update-a-coupon-list"},{"title":"Activate Coupon List","deprecated":null,"version":null,"openapi":"/api/coupons/coupons.yaml put /coupon-list/{coupon_list_id}/activate","href":"/api/coupon-lists/activate-coupon-list"},{"title":"Archive a Coupon List","deprecated":null,"version":null,"openapi":"/api/coupons/coupons.yaml put /coupon-list/{coupon_list_id}/archive","href":"/api/coupon-lists/archive-a-coupon-list"},{"title":"Upload a Coupon File to the Coupon List","deprecated":null,"version":null,"openapi":"/api/coupons/coupons.yaml post /coupon-list/{coupon_list_id}/files","href":"/api/coupon-files/upload-a-coupon-file-to-the-coupon-list"},{"title":"Fetch All Coupon Files From Coupon List","deprecated":null,"version":null,"openapi":"/api/coupons/coupons.yaml get /coupon-list/{coupon_list_id}/files","href":"/api/coupon-files/fetch-all-coupon-files-from-coupon-list"},{"title":"Fetch a Coupon File from Coupon List","deprecated":null,"version":null,"openapi":"/api/coupons/coupons.yaml get /coupon-list/{coupon_list_id}/files/{coupon_file_id}","href":"/api/coupon-files/fetch-a-coupon-file-from-coupon-list"},{"title":"Delete a Coupon File from the Coupon List","deprecated":null,"version":null,"openapi":"/api/coupons/coupons.yaml delete /coupon-list/{coupon_list_id}/files/{coupon_file_id}","href":"/api/coupon-files/delete-a-coupon-file-from-the-coupon-list"},{"title":"Generate Usage Report","deprecated":null,"version":null,"openapi":"/api/coupons/coupons.yaml post /coupon-list/{coupon_list_id}/usage-report","href":"/api/reports/generate-usage-report"}]},{"group":"Catalog","icon":"box","pages":[{"title":"Catalog Overview","icon":"file-magnifying-glass","href":"/api/catalog/catalog-overview"},{"title":"Create Catalog","deprecated":null,"version":null,"openapi":"/api/catalog/catalog.yaml post /catalog","href":"/api/catalog/create-catalog"},{"title":"Add Catalog Attributes","deprecated":null,"version":null,"openapi":"/api/catalog/catalog.yaml patch /catalog/{catalog_id}/attributes","href":"/api/catalog/add-catalog-attributes"},{"title":"Add Items","deprecated":null,"version":null,"openapi":"/api/catalog/catalog.yaml post /catalog/{catalog_id}/items","href":"/api/items/add-items"},{"title":"Get Items","deprecated":null,"version":null,"openapi":"/api/catalog/catalog.yaml post /catalog/{catalog_id}/items/search","href":"/api/items/get-items"},{"title":"Update Items","deprecated":null,"version":null,"openapi":"/api/catalog/catalog.yaml patch /catalog/{catalog_id}/items","href":"/api/items/update-items"},{"title":"Delete Items","deprecated":null,"version":null,"openapi":"/api/catalog/catalog.yaml post /catalog/{catalog_id}/items/bulk-delete","href":"/api/items/delete-items"}]}]},{"group":"Flows","icon":"diagram-project","pages":[{"title":"Flows Overview","href":"/api/flows/flows-overview"},{"title":"Search Flows","deprecated":null,"version":null,"openapi":"/api/flows/flows.yaml post /v5/flows/search","href":"/api/flows/search-flows"},{"title":"Get a Single Flow","deprecated":null,"version":null,"openapi":"/api/flows/flows.yaml get /v5/flows/{flow_id}","href":"/api/flows/get-a-single-flow"},{"title":"Get a Specific Version of a Flow","deprecated":null,"version":null,"openapi":"/api/flows/flows.yaml get /v5/flows/{flow_id}/versions/{version_id}","href":"/api/flows/get-a-specific-version-of-a-flow"},{"title":"Update Flow Status","deprecated":null,"version":null,"openapi":"/api/flows/flows.yaml patch /v5/flows/{flow_id}/status","href":"/api/flows/update-flow-status"}]},{"group":"Offerings","icon":"gift","pages":[{"title":"Offerings Overview","icon":"gift","href":"/api/offerings/offerings-overview"},{"title":"List Offerings","deprecated":null,"version":null,"openapi":"/api/offerings/offerings.yaml get /v5/offers","href":"/api/public-offerings/list-offerings"},{"title":"Get Offering","deprecated":null,"version":null,"openapi":"/api/offerings/offerings.yaml get /v5/offers/{offer_id}","href":"/api/public-offerings/get-offering"},{"title":"Create Offering","deprecated":null,"version":null,"openapi":"/api/offerings/offerings.yaml post /v5/offers","href":"/api/public-offerings/create-offering"},{"title":"Update Offering","deprecated":null,"version":null,"openapi":"/api/offerings/offerings.yaml patch /v5/offers/{offer_id}","href":"/api/public-offerings/update-offering"},{"title":"List Offer Templates","deprecated":null,"version":null,"openapi":"/api/offerings/offerings.yaml get /v5/offers/templates","href":"/api/public-offerings/list-offer-templates"},{"title":"Get Offer Template","deprecated":null,"version":null,"openapi":"/api/offerings/offerings.yaml get /v5/offers/templates/{template_id}","href":"/api/public-offerings/get-offer-template"}]},{"group":"Campaigns","icon":"paper-plane","pages":[{"group":"Campaigns","icon":"file-pen","pages":[{"title":"Campaigns Overview","icon":"file-magnifying-glass","href":"/api/campaigns/campaign-draft-overview"},{"title":"Create Campaign Draft (V5)","deprecated":null,"version":null,"openapi":"/api/campaigns/campaign-draft.yaml post /v5/campaigns","href":"/api/create-campaigns/create-campaign-draft-v5"},{"title":"Campaign content reference","icon":"layout-template","href":"/api/campaigns/campaign-content-reference"},{"title":"Audience and delivery reference","icon":"users-viewfinder","href":"/api/campaigns/audience-scheduling-delivery-reference"},{"title":"Get Campaign (V5)","deprecated":null,"version":null,"openapi":"/api/campaigns/campaign-draft.yaml get /v5/campaigns/{campaign_id}","href":"/api/get-campaign-details/get-campaign-v5"},{"title":"Update Campaign (V5)","deprecated":null,"version":null,"openapi":"/api/campaigns/campaign-draft.yaml patch /v5/campaigns/{campaign_id}","href":"/api/update-campaigns/update-campaign-v5"},{"title":"Validate Campaign (V5)","deprecated":null,"version":null,"openapi":"/api/campaigns/campaign-draft.yaml post /v5/campaigns/{campaign_id}/validate","href":"/api/create-campaigns/validate-campaign-v5"},{"title":"Update Campaign Status (V5)","deprecated":null,"version":null,"openapi":"/api/campaigns/campaign-draft.yaml patch /v5/campaigns/{campaign_id}/status","href":"/api/update-campaigns/update-campaign-status-v5"},{"title":"Search Campaigns (V5)","deprecated":null,"version":null,"openapi":"/api/campaigns/campaign-draft.yaml post /v5/campaigns/search","href":"/api/get-campaign-details/search-campaigns-v5"},{"title":"Test Campaign (V5)","deprecated":null,"version":null,"openapi":"/api/campaigns/campaign-draft.yaml post /v5/campaigns/test","href":"/api/test-campaigns/test-campaign-v5"},{"title":"Get Campaign Meta (V5)","deprecated":null,"version":null,"openapi":"/api/campaigns/campaign-draft.yaml post /v5/campaigns/meta","href":"/api/get-campaign-details/get-campaign-meta-v5"},{"title":"Personalized Preview (V5)","deprecated":null,"version":null,"openapi":"/api/campaigns/campaign-draft.yaml post /v5/personalizations/previews","href":"/api/personalized-preview/personalized-preview-v5"}]},{"group":"Campaigns (Legacy)","icon":"paper-plane","pages":[{"title":"Campaigns (Legacy) Overview","icon":"file-magnifying-glass","href":"/api/campaigns/campaigns-overview"},{"title":"Create Campaign","deprecated":null,"version":null,"openapi":"/api/campaigns/campaigns.yaml post /campaigns","href":"/api/create-campaigns/create-campaign"},{"title":"Update Campaign (V1 — Legacy)","deprecated":null,"version":null,"openapi":"/api/campaigns/campaigns.yaml patch /campaigns/{campaign_id}","href":"/api/update-campaigns/update-campaign-v1-—-legacy"},{"title":"Search Campaigns","deprecated":null,"version":null,"openapi":"/api/campaigns/campaigns.yaml post /campaigns/search","href":"/api/get-campaign-details/search-campaigns"},{"title":"V1 vs. V5 Search Campaigns: Behavioral Differences","description":"A comparison of behavioral, structural, and field-level differences between the V1 and V5 Search Campaigns APIs to help you understand what has changed.","href":"/api/campaigns/search-campaigns-v5-migration"},{"title":"Test Campaign","deprecated":null,"version":null,"openapi":"/api/campaigns/campaigns.yaml post /campaigns/test","href":"/api/test-campaigns/test-campaign"},{"title":"Personalized Preview","description":"This API shows a preview of personalized content for a specific user before sending a Push, Email, or SMS campaign. This API retrieves personalized message content with all user/event attributes resolved. Use this API to validate your personalization logic and see exactly how content will appear to specific users before launching campaigns. \n","deprecated":null,"version":null,"openapi":"/api/campaigns/campaigns.yaml post /personalization/preview","href":"/api/test-campaigns/personalized-preview"},{"title":"Get Campaign Meta (V1 — Legacy)","deprecated":null,"version":null,"openapi":"/api/campaigns/campaigns.yaml post /campaigns/meta","href":"/api/get-campaign-details/get-campaign-meta-v1-—-legacy"},{"title":"Change Campaign Status","deprecated":null,"version":null,"openapi":"/api/campaigns/campaigns.yaml post /campaigns/status","href":"/api/update-campaigns/change-campaign-status"},{"title":"Get Child Campaigns","deprecated":null,"version":null,"openapi":"/api/campaigns/campaigns.yaml post /campaigns/{parent_campaign_id}/executions","href":"/api/get-campaign-details/get-child-campaigns"},{"title":"Update Global Control Group","deprecated":null,"version":null,"openapi":"/api/campaigns/campaigns.yaml put /global-control-group/users","href":"/api/update-campaigns/update-global-control-group"}]},{"group":"Campaign Report and Stats","icon":"chart-bar","pages":[{"title":"Campaign Stats and Reports Overview","icon":"file-magnifying-glass","href":"/api/stats-report/stats-report-overview"},{"title":"Get Campaign Stats","deprecated":null,"version":null,"openapi":"/api/stats-report/stats-report.yaml post /core-services/v1/campaign-stats","href":"/api/stats/get-campaign-stats"},{"title":"Download Campaign Report","deprecated":null,"version":null,"openapi":"/api/stats-report/stats-report.yaml get /campaign_reports/rest_api/{APP_ID}/{FILENAME}","href":"/api/campaign-reports/download-campaign-report"}]}]},{"group":"Messaging","icon":"envelope","pages":[{"title":"Messaging API Overview","icon":"envelope","href":"/api/messaging/messaging-api-overview"},{"title":"Trigger Message","deprecated":null,"version":null,"openapi":"/api/campaigns/campaign-draft.yaml post /v5/campaigns/{campaign_id}/send","href":"/api/trigger/trigger-message"}]},{"group":"Analyze","icon":"chart-line","tag":"NEW","pages":[{"group":"Dashboards","icon":"objects-column","pages":[{"title":"Custom Dashboards Overview","icon":"file-magnifying-glass","href":"/api/analytics/analytics-overview"},{"title":"List Dashboards","deprecated":null,"version":null,"openapi":"/api/analytics/analytics.yaml get /v5/analytics/dashboards","href":"/api/dashboards/list-dashboards"},{"title":"Get Dashboard Charts","deprecated":null,"version":null,"openapi":"/api/analytics/analytics.yaml get /v5/analytics/dashboards/{dashboard_id}/charts","href":"/api/dashboards/get-dashboard-charts"},{"title":"Get Chart Data","deprecated":null,"version":null,"openapi":"/api/analytics/analytics.yaml get /v5/analytics/dashboards/{dashboard_id}/charts/{chart_id}","href":"/api/dashboards/get-chart-data"}]},{"group":"Analytics","icon":"chart-mixed","pages":[{"title":"Analytics Query APIs Overview","icon":"chart-mixed","href":"/api/analytics-query/analytics-query-overview"},{"title":"Register a Behavior Query","deprecated":null,"version":null,"openapi":"/api/analytics-query/analytics-query.yaml post /v5/analytics/behavior","href":"/api/analytics-queries/register-a-behavior-query"},{"title":"Register a Funnels Query","deprecated":null,"version":null,"openapi":"/api/analytics-query/analytics-query.yaml post /v5/analytics/funnels","href":"/api/analytics-queries/register-a-funnels-query"},{"title":"Register a Retention Query","deprecated":null,"version":null,"openapi":"/api/analytics-query/analytics-query.yaml post /v5/analytics/retention","href":"/api/analytics-queries/register-a-retention-query"},{"title":"Register a Session-Source Query","deprecated":null,"version":null,"openapi":"/api/analytics-query/analytics-query.yaml post /v5/analytics/session-source","href":"/api/analytics-queries/register-a-session-source-query"},{"title":"Register a User Analysis Query","deprecated":null,"version":null,"openapi":"/api/analytics-query/analytics-query.yaml post /v5/analytics/user-analysis","href":"/api/analytics-queries/register-a-user-analysis-query"},{"title":"Get Query Status","deprecated":null,"version":null,"openapi":"/api/analytics-query/analytics-query.yaml get /v5/analytics/query/{request_id}/status","href":"/api/analytics-queries/get-query-status"},{"title":"Get Query Results","deprecated":null,"version":null,"openapi":"/api/analytics-query/analytics-query.yaml get /v5/analytics/query/{request_id}/results","href":"/api/analytics-queries/get-query-results"}]}]},{"group":"Segments","icon":"users","pages":[{"title":"Segments Overview","icon":"file-magnifying-glass","href":"/api/custom-segments/custom-segments-overview"},{"group":"File Segments","icon":"file-csv","pages":[{"title":"Create File Segment","deprecated":null,"version":null,"openapi":"/api/custom-segments/custom-segments.yaml post /v2/custom-segments/file-segment","href":"/api/file-segments/create-file-segment"},{"title":"Add Users to File Segment","deprecated":null,"version":null,"openapi":"/api/custom-segments/custom-segments.yaml put /v2/custom-segments/file-segment/add-users","href":"/api/file-segments/add-users-to-file-segment"},{"title":"Remove Users from File Segment","deprecated":null,"version":null,"openapi":"/api/custom-segments/custom-segments.yaml put /v2/custom-segments/file-segment/remove-users","href":"/api/file-segments/remove-users-from-file-segment"},{"title":"Replace Users from File Segment","deprecated":null,"version":null,"openapi":"/api/custom-segments/custom-segments.yaml put /v2/custom-segments/file-segment/replace","href":"/api/file-segments/replace-users-from-file-segment"}]},{"group":"Filter Segments","icon":"filter","pages":[{"title":"List Segments","deprecated":null,"version":null,"openapi":"/api/custom-segments/custom-segments.yaml get /v3/custom-segments","href":"/api/filter-segments/list-segments"},{"title":"Create Filter Segment","deprecated":null,"version":null,"openapi":"/api/custom-segments/custom-segments.yaml post /v3/custom-segments","href":"/api/filter-segments/create-filter-segment"},{"title":"Get Segment by ID","deprecated":null,"version":null,"openapi":"/api/custom-segments/custom-segments.yaml get /v3/custom-segments/{id}","href":"/api/filter-segments/get-segment-by-id"},{"title":"Update Filter Segment","deprecated":null,"version":null,"openapi":"/api/custom-segments/custom-segments.yaml patch /v3/custom-segments/{id}","href":"/api/filter-segments/update-filter-segment"}]},{"group":"Cohort Sync","icon":"users-gear","pages":[{"title":"Sync Cohort Members","deprecated":null,"version":null,"openapi":"/api/cohort-audience/cohort-audience.yaml post /v1/integrations/cohortsync","href":"/api/cohort-sync/sync-cohort-members"}]},{"group":"Manage Segments","icon":"sliders","pages":[{"title":"Archive Segment","deprecated":null,"version":null,"openapi":"/api/custom-segments/custom-segments.yaml patch /v2/custom-segments/archive","href":"/api/manage-segments/archive-segment"},{"title":"Unarchive Segment","deprecated":null,"version":null,"openapi":"/api/custom-segments/custom-segments.yaml patch /v2/custom-segments/unarchive","href":"/api/manage-segments/unarchive-segment"}]}]},{"group":"Subscriptions","icon":"envelope-circle-check","pages":[{"group":"Email Subscription","icon":"envelope","pages":[{"title":"Email Subscription Overview","icon":"file-magnifying-glass","href":"/api/email-subscription/email-subscription-overview"},{"title":"Bulk Resubscribe Users","deprecated":null,"version":null,"openapi":"/api/email-subscription/email-subscription.yaml post /emails/v1.0/bulk-resubscribe","href":"/api/resubscribe/bulk-resubscribe-users"},{"title":"Update User Email Opt-in Preferences","deprecated":null,"version":null,"openapi":"/api/email-subscription/email-subscription.yaml put /v1.0/opt-in-management/user-preferences","href":"/api/opt-in-management/update-user-email-opt-in-preferences"}]},{"group":"Subscription Categories","icon":"list-check","pages":[{"group":"Subscription Categories (V5)","pages":[{"title":"Subscription Categories (V5)","icon":"file-magnifying-glass","href":"/api/subscription-categories/subscription-categories-v5/subscription-categories-overview-v5"},{"title":"Get Subscription Categories (V5)","deprecated":null,"version":null,"openapi":"/api/subscription-categories/subscription-categories-v5/subscription-categories-v5.yaml get /v5/subscription-categories","href":"/api/subscription-categories/get-subscription-categories-v5"},{"title":"Get Subscription Preferences (V5)","deprecated":null,"version":null,"openapi":"/api/subscription-categories/subscription-categories-v5/subscription-categories-v5.yaml get /v5/subscription-preferences","href":"/api/subscription-preferences/get-subscription-preferences-v5"},{"title":"Update Subscription Preferences (V5)","deprecated":null,"version":null,"openapi":"/api/subscription-categories/subscription-categories-v5/subscription-categories-v5.yaml patch /v5/subscription-preferences","href":"/api/subscription-preferences/update-subscription-preferences-v5"}]},{"group":"Subscription Categories (Legacy)","pages":[{"title":"Subscription Categories (Legacy)","icon":"file-magnifying-glass","href":"/api/subscription-categories/subscription-categories-legacy/subscription-categories-overview-legacy"},{"title":"Get Subscription Preferences","deprecated":null,"version":null,"openapi":"/api/subscription-categories/subscription-categories-legacy/subscription-categories-legacy.yaml get /category-subscription/user-preferences","href":"/api/subscription-preferences/get-subscription-preferences"},{"title":"Update Subscription Preferences","deprecated":null,"version":null,"openapi":"/api/subscription-categories/subscription-categories-legacy/subscription-categories-legacy.yaml put /category-subscription/user-preferences","href":"/api/subscription-preferences/update-subscription-preferences"},{"title":"Bulk Update Subscription Preferences","deprecated":null,"version":null,"openapi":"/api/subscription-categories/subscription-categories-legacy/subscription-categories-legacy.yaml post /category-subscription/user-preferences","href":"/api/subscription-preferences/bulk-update-subscription-preferences"}]}]}]},{"group":"Push","icon":"bell","pages":[{"title":"Push Overview","icon":"file-magnifying-glass","href":"/api/push/push-overview"},{"title":"Push API (V5)","openapi":"api/push/push-v5.yaml POST /v5/push/notifications","href":"/api/push/push-api"},{"title":"Push API (v2.1, Legacy)","openapi":"api/push/push-v2-1.yaml POST /v2.1/transaction/sendpush","href":"/api/push/push-api-v2-1-legacy"},{"title":"Push API (v2, Legacy)","openapi":"api/push/push.yaml POST /transaction/sendpush","href":"/api/push/push-api-v2-legacy"}]},{"group":"Cards","icon":"rectangle-history","pages":[{"title":"Cards Overview","icon":"file-magnifying-glass","href":"/api/cards/cards-overview"},{"title":"Fetch Cards for User","deprecated":null,"version":null,"openapi":"/api/cards/cards.yaml post /cards/fetch","href":"/api/cards/fetch-cards-for-user"},{"title":"Delete Cards for User","deprecated":null,"version":null,"openapi":"/api/cards/cards.yaml delete /cards/delete","href":"/api/cards/delete-cards-for-user"}]},{"group":"Inform","icon":"message","pages":[{"title":"Inform Overview","icon":"file-magnifying-glass","href":"/api/inform/inform-overview"},{"title":"Send Transactional Alert","deprecated":null,"version":null,"openapi":"/api/inform/inform.yaml post /alerts/send","href":"/api/transactional-alerts/send-transactional-alert"}]},{"group":"Live Activities","icon":"circle-play","pages":[{"title":"Live Activities Overview","icon":"file-magnifying-glass","href":"/api/live-activities/live-activities-overview"},{"title":"Start Broadcast Live Activity","deprecated":null,"version":null,"openapi":"/api/live-activities/live-activities.yaml post /live-activity/broadcast/start","href":"/api/live-activities/start-broadcast-live-activity"},{"title":"Update Broadcast Live Activity","deprecated":null,"version":null,"openapi":"/api/live-activities/live-activities.yaml post /live-activity/broadcast/update","href":"/api/live-activities/update-broadcast-live-activity"},{"title":"End Broadcast Live Activity","deprecated":null,"version":null,"openapi":"/api/live-activities/live-activities.yaml post /live-activity/broadcast/end","href":"/api/live-activities/end-broadcast-live-activity"}]},{"group":"Personalize","icon":"bullseye-arrow","pages":[{"title":"Personalize Overview","icon":"file-magnifying-glass","href":"/api/personalize-experience/personalize-overview"},{"title":"Fetch Experience","deprecated":null,"version":null,"openapi":"/api/personalize-experience/personalize-experience.yaml post /experiences/fetch","href":"/api/experiences/fetch-experience"},{"title":"Fetch Experience Metadata","deprecated":null,"version":null,"openapi":"/api/personalize-experience/personalize-experience.yaml get /experiences/metadata","href":"/api/experiences/fetch-experience-metadata"},{"title":"Track Experience Events","deprecated":null,"version":null,"openapi":"/api/personalize-experience/personalize-experience.yaml post /experiences/events","href":"/api/events/track-experience-events"}]},{"group":"Message Archival","icon":"box-archive","pages":[{"title":"Message Archival Overview","icon":"file-magnifying-glass","href":"/api/message-archival/message-archival-overview"},{"title":"View Archived Message","deprecated":null,"version":null,"openapi":"/api/message-archival/message-archival.yaml post /archival/view","href":"/api/message-archival/view-archived-message"}]}]}]},{"tab":"AI \u0026 Intelligence","pages":[{"title":"AI \u0026 Intelligence","href":"/user-guide/ai-and-intelligence/overview"}]},{"tab":"Partner Integrations","pages":[{"title":"Partner Integrations","href":"/partner-guide/introduction"}]},{"tab":"Use Cases","pages":[{"title":"Use Cases","href":"/use-cases/introduction"}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release-notes/subscribe-to-release-notes"}]}]},{"language":"ja","pages":[{"title":"ja","href":"/ja/api/test-campaigns/test-campaign"}]}]},"basePath":"","title":"Test Campaign - MoEngage","buildId":"dpl_Aw98ji4XvBsgtZwL1VrkUF9ehFqz","deploymentId":"dpl_Aw98ji4XvBsgtZwL1VrkUF9ehFqz","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CQGbdtm4.js","utils-D88A1f-Z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChqWdz1A.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-yBrxdh_6.js","snippetPresets-BgqDrFJC.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Duxc2rZw.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C7jidOil.js","shallow-xkjpHm-U.js","getApiPlaygroundDisplay-fE3rVpvL.js","CodeSnippet-LgxljKed.js","CodeSnippets-D-pXWDHq.js","Page-C2-BijcO.js","getPastedJson-CLRcu-uo.js","icon-Cxirpjgo.js","MethodPill-D49eqY5e.js","DuplicateIcon-CivCz5Rp.js","createIcon-D71qL3f5.js","DynamicMarkdown-BcGRTrw6.js","SectionHeading-DzaqmmSD.js","axios-vUo_bRtp.js","Markdown-CZqUYmMp.js","clsx-B6IZIRsp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-B0ZV6X5T.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-MqLyPtsW.js"]}