{
"title": "Internal Server Error",
"message": "An unexpected error was encountered while processing this request. Please contact MoEngage Team"
}
We are introducing mandatory pagination, effective November 15, 2025, all calls to this API must include the following two parameters:
page: The page number of the results you wish to fetch.
entries: The number of templates to return per page, with a maximum value of 15.
Please update all integrations to include these parameters. API requests submitted without them after the effective date will result in an error and fail to execute.
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.
Body
application/json
A JSON object containing filters for the search. You can send empty filters to fetch all the push templates. Searches for push templates based on a variety of filter criteria.
Note:
You can send empty filters to fetch all the push templates.
You can send only template_ids if you want specific older versions of the push template. In other cases, you will receive the latest version of the template.
This field indicates the name of the template. When this value is specified, the template that matches the name specified in this field will be returned.
This field indicates the list of platforms. Allowed values: ANDROID, IOS. When specified, the templates whose platform matches that specified in this list will be returned.
This field indicates the template source that created the template. For example: ["API", "MOENGAGE"]. When specified, the templates whose source matches that specified in this list will be returned.
This field indicates the template style. Allowed values: BASIC, STYLIZED. When specified, the templates whose template style matches that specified in this list will be returned.
This field indicates whether the template is a custom one or a pre-built one. Allowed values: CUSTOM, PRE_BUILT. When specified, the templates whose template type matches that specified in this list will be returned.
This field indicates the user who created the template. When specified, the templates for which the created_by user information matches that specified in this list will be returned. Example: ["[email protected]", "[email protected]"]
This field indicates the user who updated the template. When specified, the templates for which the updated_by user information matches that specified in this list will be returned. Example: ["[email protected]", "[email protected]"]
This field indicates the sorting parameters for the search result and the sort order. Example: "sort_params":[{"template_name": "ASCENDING","last_modified_date": "ASCENDING","last_modified_by": "ASCENDING"}]
This field indicates the list of the template ids that must be fetched. When this value is specified, the template that matches the id specified in this field will be returned. You can send only template_ids if you want specific older versions of the push template. In other cases, you will receive the latest version of the template. Example: "template_ids":[{"external_template_id": "e1c95cb8-4f15-4f22-ae73-e9f47c9925c8", "version": 1}]
Show child attributes
Response
This response is returned when the request is processed successfully.
This field contains the list of push templates that satisfy the search criteria.
Show child attributes
{"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":"6aed9e350e1747ee9b9b0553","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"en","tag":"Guide","count":1188},{"language":"ja","tag":"ガイド","count":1180},{"language":"en","tag":"User Guide","count":799},{"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":338},{"language":"en","tag":"Developer Guide (SDKs)","count":327},{"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":183},{"language":"ja","tag":"APIガイド","count":183},{"language":"en","tag":"Endpoints","count":177},{"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":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","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/templates/search-for-push-templates","slug":"/api/templates/search-for-push-templates","pageMetadata":{"title":"Search for Push Templates","description":"This API searches the push templates created in your MoEngage account.\n","deprecated":null,"version":null,"openapi":"/api/push-templates/push-templates.yaml post /custom-templates/push/search","href":"/api/templates/search-for-push-templates","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 searches the push templates created in your MoEngage account.\"\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`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Note}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsxs(Note,{children:[_jsx(_components.p,{children:`We are introducing mandatory pagination, effective November 15, 2025, all calls to this API must include the following two parameters:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`page`}),`: The page number of the results you wish to fetch.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`entries`}),`: The number of templates to return per page, with a maximum value of 15.`]}),`\n`]}),_jsx(_components.p,{children:`Please update all integrations to include these parameters. API requests submitted without them after the effective date will result in an error and fail to execute.`})]}),`\n`,_jsx(Heading,{level:`4`,id:`rate-limit`,children:`Rate Limit`}),`\n`,_jsx(_components.p,{children:`The rate limit is 100 RPM (request per minute).`})]})}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":"Search for Push Templates","description":"This API searches the push templates created in your MoEngage account.\n","deprecated":null,"version":null,"openapi":"/api/push-templates/push-templates.yaml post /custom-templates/push/search","href":"/api/templates/search-for-push-templates","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Rate Limit","slug":"rate-limit","depth":4,"children":[]}],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/moengage/992523b3cb2256cd/script.js"],"openApiReferenceData":{"operation":{"tags":["Templates"],"summary":"Search for Push Templates","description":"This API searches the push templates created in your MoEngage account.\n","x-mint":{"content":"\u003cNote>\nWe are introducing mandatory pagination, effective November 15, 2025, all calls to this API must include the following two parameters:\n\n* **page**: The page number of the results you wish to fetch.\n* **entries**: The number of templates to return per page, with a maximum value of 15.\n\nPlease update all integrations to include these parameters. API requests submitted without them after the effective date will result in an error and fail to execute.\n\u003c/Note>\n\n\n#### Rate Limit\nThe rate limit is 100 RPM (request per minute). \n"},"operationId":"searchPushTemplates","requestBody":"57b2a957-4519-45f0-b980-7df8479341e3","responses":{"200":"0cbda1ab-e4e5-46cc-a098-7669389a4a10","400":"1cb78418-2043-436b-af62-4dda32161bad","429":"28124a13-9e7e-4c47-80e6-cb293d1f8002","500":"b2bfb7c1-f7f6-4060-95d1-e132a12a9971"},"method":"post","type":"path","servers":["231db400-a198-463b-ab88-914d1ac453b1"],"security":["bd7917f0-5a8d-4734-8b35-c0649665aa8d"],"path":"/custom-templates/push/search","baseUrlOptions":["https://api-{dc}.moengage.com/v1.0"],"title":"Search for Push Templates","codeSamples":[],"requestExampleLanguages":["bash"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"A JSON object containing filters for the search. **You can send empty filters to fetch all the push templates.** Searches for push templates based on a variety of filter criteria. \n**Note:** \n- You can send empty filters to fetch all the push templates.\n- You can send only template_ids if you want specific older versions of the push template. In other cases, you will receive the latest version of the template.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["page","entries"],"properties":{"page":{"type":"integer","description":"The page number of the results you wish to fetch.","default":1,"isRequired":true,"uniqueKey":"page","typeLabel":"integer"},"entries":{"type":"integer","description":"The number of templates to return per page, with a maximum value of 15.","default":10,"maximum":15,"isRequired":true,"uniqueKey":"entries","typeLabel":"integer"},"template_name":{"type":"string","description":"This field indicates the name of the template. When this value is specified, the template that matches the name specified in this field will be returned.","uniqueKey":"template_name","typeLabel":"string"},"platform":{"type":"array","items":{"type":"string","enum":["ANDROID","IOS"],"uniqueKey":"platform.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"This field indicates the list of platforms. Allowed values: ANDROID, IOS. When specified, the templates whose platform matches that specified in this list will be returned.","uniqueKey":"platform","typeLabel":"enum\u003cstring>[]"},"template_source":{"type":"array","items":{"type":"string","enum":["API","MOENGAGE"],"uniqueKey":"template_source.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"This field indicates the template source that created the template. For example: [\"API\", \"MOENGAGE\"]. When specified, the templates whose source matches that specified in this list will be returned.","uniqueKey":"template_source","typeLabel":"enum\u003cstring>[]"},"template_style":{"type":"array","items":{"type":"string","enum":["BASIC","STYLIZED"],"uniqueKey":"template_style.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"This field indicates the template style. Allowed values: BASIC, STYLIZED. When specified, the templates whose template style matches that specified in this list will be returned.","uniqueKey":"template_style","typeLabel":"enum\u003cstring>[]"},"template_type":{"type":"array","items":{"type":"string","enum":["CUSTOM","PRE_BUILT"],"uniqueKey":"template_type.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"This field indicates whether the template is a custom one or a pre-built one. Allowed values: CUSTOM, PRE_BUILT. When specified, the templates whose template type matches that specified in this list will be returned.","uniqueKey":"template_type","typeLabel":"enum\u003cstring>[]"},"created_by":{"type":"array","items":{"type":"string","format":"email","uniqueKey":"created_by.items.[INDEX]","typeLabel":"string\u003cemail>"},"description":"This field indicates the user who created the template. When specified, the templates for which the created_by user information matches that specified in this list will be returned. Example: [\"[email protected]\", \"[email protected]\"]","uniqueKey":"created_by","typeLabel":"string\u003cemail>[]"},"updated_by":{"type":"array","items":{"type":"string","format":"email","uniqueKey":"updated_by.items.[INDEX]","typeLabel":"string\u003cemail>"},"description":"This field indicates the user who updated the template. When specified, the templates for which the updated_by user information matches that specified in this list will be returned. Example: [\"[email protected]\", \"[email protected]\"]","uniqueKey":"updated_by","typeLabel":"string\u003cemail>[]"},"sort_params":{"type":"array","items":{"type":"object","properties":{"template_name":{"type":"string","enum":["ASCENDING","DESCENDING"],"description":"Sort by Template Name","uniqueKey":"sort_params.items.[INDEX].template_name","typeLabel":"enum\u003cstring>"},"last_modified_date":{"type":"string","enum":["ASCENDING","DESCENDING"],"description":"Sort by Last Modified Date","uniqueKey":"sort_params.items.[INDEX].last_modified_date","typeLabel":"enum\u003cstring>"},"last_modified_by":{"type":"string","enum":["ASCENDING","DESCENDING"],"description":"Sort by Last Modified By","uniqueKey":"sort_params.items.[INDEX].last_modified_by","typeLabel":"enum\u003cstring>"}},"uniqueKey":"sort_params.items.[INDEX]","typeLabel":"object"},"description":"This field indicates the sorting parameters for the search result and the sort order. Example: \"sort_params\":[{\"template_name\": \"ASCENDING\",\"last_modified_date\": \"ASCENDING\",\"last_modified_by\": \"ASCENDING\"}]","uniqueKey":"sort_params","typeLabel":"object[]"},"template_ids":{"type":"array","items":{"type":"object","properties":{"external_template_id":{"type":"string","format":"uuid","description":"The unique identifier of the template.","uniqueKey":"template_ids.items.[INDEX].external_template_id","typeLabel":"string\u003cuuid>"},"version":{"type":"integer","description":"The version number of the template.","uniqueKey":"template_ids.items.[INDEX].version","typeLabel":"integer"}},"uniqueKey":"template_ids.items.[INDEX]","typeLabel":"object"},"description":"This field indicates the list of the template ids that must be fetched. When this value is specified, the template that matches the id specified in this field will be returned. You can send only template_ids if you want specific older versions of the push template. In other cases, you will receive the latest version of the template. Example: \"template_ids\":[{\"external_template_id\": \"e1c95cb8-4f15-4f22-ae73-e9f47c9925c8\", \"version\": 1}]","uniqueKey":"template_ids","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"ComplexSearch":{"title":"ComplexSearch","value":{"page":1,"entries":10,"template_name":"NAME_OF_THE_TEMPLATE(PARTIAL SEARCH)/ID_OF_TEMPLATE","platform":["ANDROID","IOS"],"template_source":["API","MOENGAGE"],"template_style":["BASIC","STYLIZED"],"template_type":["CUSTOM","PRE_BUILT"],"created_by":["[email protected]","[email protected]"],"updated_by":["[email protected]","[email protected]"],"sort_params":[{"last_modified_date":"DESCENDING"}],"template_ids":[{"external_template_id":"ID_OF_TEMPLATE","version":1}]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"0cbda1ab-e4e5-46cc-a098-7669389a4a10":{"description":"This response is returned when the request is processed successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"external_template_id":{"type":"string","format":"uuid","description":"Unique template identifier.","uniqueKey":"data.items.[INDEX].external_template_id","typeLabel":"string\u003cuuid>"},"version":{"type":"integer","description":"Template version number.","uniqueKey":"data.items.[INDEX].version","typeLabel":"integer"},"ANDROID":{"type":"object","description":"This field contains the definition of the template for the Android platform.\n","properties":{"basic_details":{"type":"object","description":"The basic_details JSON object contains the core information like title, message, and summary.","required":["title","message","default_click_action","default_click_action_value"],"properties":{"title":{"type":"string","description":"This field contains the title of the message.","isRequired":true,"uniqueKey":"data.items.[INDEX].ANDROID.basic_details.title","typeLabel":"string"},"message":{"type":"string","description":"This field contains the message content.","isRequired":true,"uniqueKey":"data.items.[INDEX].ANDROID.basic_details.message","typeLabel":"string"},"default_click_action":{"type":"string","enum":["NAVIGATE_TO_A_SCREEN","DEEPLINKING","RICH_LANDING"],"description":"This field describes the default action that should happen when a user clicks on the push notification. The allowed values are:\n1. NAVIGATE_TO_A_SCREEN\n2. DEEPLINKING\n3. RICH_LANDING\n","isRequired":true,"uniqueKey":"data.items.[INDEX].ANDROID.basic_details.default_click_action","typeLabel":"enum\u003cstring>"},"default_click_action_value":{"type":"string","description":"This field contains information about which screen or URL or the rich landing URL information the user should navigate to based on the click action defined above. For example, if default_click_action is NAVIGATE_TO_A_SCREEN, the screen details in the app that the user should land on when they click on the push notification should be specified in default_click_action_value.","isRequired":true,"uniqueKey":"data.items.[INDEX].ANDROID.basic_details.default_click_action_value","typeLabel":"string"},"summary":{"type":"string","description":"This field contains a brief description of the message content.","uniqueKey":"data.items.[INDEX].ANDROID.basic_details.summary","typeLabel":"string"},"app_name_color_code":{"type":"string","description":"This field contains the specification for the color of the app name in the push notification. This is available only for the Android platform. This option is not available for the Basic Notification template. Example: \"app_name_color_code\": \"#5450ea\"\n\n**Note**: Only hexadecimal values are supported.\n","uniqueKey":"data.items.[INDEX].ANDROID.basic_details.app_name_color_code","typeLabel":"string"},"notification_control_color":{"type":"string","enum":["Light","Dark"],"description":"This field contains the specification for the notification control color. Allowed Values, Light, Dark. This is available only for the Android platform. This option is not available for the Basic Notification template.","uniqueKey":"data.items.[INDEX].ANDROID.basic_details.notification_control_color","typeLabel":"enum\u003cstring>"},"background_color_code":{"type":"string","description":"This field contains the specification for the background color of the message in the push notification. This is available only for the Android platform. This option is not available for the Basic Notification template. Example: \"background_color_code\": \"#f5e6cd\"\n\n**Note**: Only hexadecimal values are supported.\n","uniqueKey":"data.items.[INDEX].ANDROID.basic_details.background_color_code","typeLabel":"string"},"apply_background_color":{"type":"boolean","description":"This field contains information about whether the background color should be applied to the fields with a text editor (Title, Message, and Summary). It is recommended to enable this option for lighter font colors. This option is not available for the Basic Notification template.","uniqueKey":"data.items.[INDEX].ANDROID.basic_details.apply_background_color","typeLabel":"boolean"},"image_url":{"type":"string","format":"uri","description":"This field contains the URL of the image to be added to the notification. Allowed file formats, jpg, jpeg, png, gif.","uniqueKey":"data.items.[INDEX].ANDROID.basic_details.image_url","typeLabel":"string\u003curi>"},"input_gif_url":{"type":"string","format":"uri","description":"This field contains the URL of the image to be added to the notification. This is supported only for Android Basic Template.","uniqueKey":"data.items.[INDEX].ANDROID.basic_details.input_gif_url","typeLabel":"string\u003curi>"},"key_value_pairs":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"The key for the data pair.","isRequired":true,"uniqueKey":"data.items.[INDEX].ANDROID.basic_details.key_value_pairs.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"The value for the data pair.","isRequired":true,"uniqueKey":"data.items.[INDEX].ANDROID.basic_details.key_value_pairs.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"data.items.[INDEX].ANDROID.basic_details.key_value_pairs.items.[INDEX]","typeLabel":"object"},"description":"This field contains the list of key-value pairs. For example:\n[{\"key\" : \"user\",\"value\": \"john\"}]\n","uniqueKey":"data.items.[INDEX].ANDROID.basic_details.key_value_pairs","typeLabel":"object[]"}},"uniqueKey":"data.items.[INDEX].ANDROID.basic_details","typeLabel":"object"},"buttons":{"type":"array","items":{"type":"object","properties":{"btn_name":{"type":"string","description":"This field contains the name of the button.","isRequired":true,"uniqueKey":"data.items.[INDEX].ANDROID.buttons.items.[INDEX].btn_name","typeLabel":"string"},"click_action_type":{"type":"string","description":"This field contains the click action associated with the button. The allowed values are:\n1. NAVIGATE_TO_A_SCREEN\n2. DEEPLINKING\n3. RICH_LANDING\n4. CALL\n5. SHARE\n6. COPY\n7. SET_USER_ATTRIBUTE\n8. TRACK_EVENT\n9. CUSTOM_ACTION\n\nFor more information, refer to [Click Actions Supported for Android](/user-guide/campaigns-and-channels/mobile-push/notification-features-and-behavior/notification-actions).\n","enum":["NAVIGATE_TO_A_SCREEN","DEEPLINKING","RICH_LANDING","CALL","SHARE","COPY","SET_USER_ATTRIBUTE","TRACK_EVENT","CUSTOM_ACTION"],"isRequired":true,"uniqueKey":"data.items.[INDEX].ANDROID.buttons.items.[INDEX].click_action_type","typeLabel":"enum\u003cstring>"},"click_action_value":{"type":"string","description":"This field contains information about which screen or URL the user should navigate to or the action that should happen for the click action type defined for the button. For example, if click_action_type is NAVIGATE_TO_A_SCREEN, the screen details in the app that the user should land on when they click the button should be specified in click_action_value.","isRequired":true,"uniqueKey":"data.items.[INDEX].ANDROID.buttons.items.[INDEX].click_action_value","typeLabel":"string"},"click_action_name":{"type":"string","description":"This field is used when the click action is chosen as SET_USER_ATTRIBUTE or TRACK_EVENT. In both these cases, a KV pair input is required, and the key is set in this field while the value is set for the same in click_action_value.","uniqueKey":"data.items.[INDEX].ANDROID.buttons.items.[INDEX].click_action_name","typeLabel":"string"},"key_value_pairs":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"The key for the data pair.","isRequired":true,"uniqueKey":"data.items.[INDEX].ANDROID.buttons.items.[INDEX].key_value_pairs.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"The value for the data pair.","isRequired":true,"uniqueKey":"data.items.[INDEX].ANDROID.buttons.items.[INDEX].key_value_pairs.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"data.items.[INDEX].ANDROID.buttons.items.[INDEX].key_value_pairs.items.[INDEX]","typeLabel":"object"},"description":"This field contains the list of key-value pairs. For example:\n[{\"key\" : \"user\",\"value\": \"john\"}]\n","uniqueKey":"data.items.[INDEX].ANDROID.buttons.items.[INDEX].key_value_pairs","typeLabel":"object[]"}},"required":["btn_name","click_action_type","click_action_value"],"uniqueKey":"data.items.[INDEX].ANDROID.buttons.items.[INDEX]","typeLabel":"object"},"description":"The buttons object contains the list of buttons in the notification and is optional.","uniqueKey":"data.items.[INDEX].ANDROID.buttons","typeLabel":"object[]"},"advanced":{"type":"object","description":"The advanced JSON object contains options like coupon codes, icon types, and dismissal settings.","properties":{"coupon_code":{"type":"string","description":"This field contains the coupon code.","uniqueKey":"data.items.[INDEX].ANDROID.advanced.coupon_code","typeLabel":"string"},"icon_type_in_notification":{"type":"string","enum":["appicon","upload","url"],"description":"This field contains the type of icon to be used in the notification. Allowed Values: appicon, upload, url.","uniqueKey":"data.items.[INDEX].ANDROID.advanced.icon_type_in_notification","typeLabel":"enum\u003cstring>"},"large_icon_url":{"type":"string","format":"uri","description":"This field contains the URL that contains the large icon to be added to the notification.","uniqueKey":"data.items.[INDEX].ANDROID.advanced.large_icon_url","typeLabel":"string\u003curi>"},"auto_dismiss_notification":{"type":"boolean","description":"This field contains information about whether notification should be auto-dismissed from the user's notification tray.","uniqueKey":"data.items.[INDEX].ANDROID.advanced.auto_dismiss_notification","typeLabel":"boolean"},"dismissal_time_multiplier":{"type":"string","enum":["DAYS","HOURS","MINUTES"],"description":"This field contains the time duration in days, hours, or minutes, and this will be multiplied with the dismissal_time_value to calculate the duration, after which the notification will automatically be removed from the user's notification tray after the push notification is delivered to the user. Allowed Values: DAYS, HOURS, MINUTES. For example, if you want the notification to be dismissed in two hours, specify the dismissal_time_multiplier as HOURS and the dismissal_time_value as 2.","uniqueKey":"data.items.[INDEX].ANDROID.advanced.dismissal_time_multiplier","typeLabel":"enum\u003cstring>"},"dismissal_time_value":{"type":"integer","description":"This field contains the value that will be multiplied with the dismissal_time_multiplier to arrive at the time duration, after which the notification will automatically be removed from the user's notification tray after the push notification is delivered to the user. For example, if you want the notification to be dismissed in thirty minutes, specify the dismissal_time_multiplier as MINUTES and the dismissal_time_value as 30.","uniqueKey":"data.items.[INDEX].ANDROID.advanced.dismissal_time_value","typeLabel":"integer"},"make_notification_sticky":{"type":"boolean","description":"This field contains information about whether the notification should be made sticky in the user's notification tray. If this value is true, the notifications cannot be dismissed by swiping or clicking. The user would have to click on the dismiss button provided in the notification to dismiss it. This option is not available for the Basic Notification template.","uniqueKey":"data.items.[INDEX].ANDROID.advanced.make_notification_sticky","typeLabel":"boolean"},"dismiss_button_text":{"type":"string","description":"This field contains the name of the dismiss button when sticky notifications are turned on. This option is not available for the Basic Notification template.","uniqueKey":"data.items.[INDEX].ANDROID.advanced.dismiss_button_text","typeLabel":"string"},"group_key":{"type":"string","description":"This field denotes the group key used to identify and categorize related push notifications.\n\n**Note**:\n* Ensure you use the same group key for all push notifications you want to group.\n* MoEngage automatically modifies the group key to ensure it does not exceed the 45-character limit. MoEngage removes non-Latin scripts, special characters, and spaces to restrict the key composition to ASCII characters exclusively.\n","uniqueKey":"data.items.[INDEX].ANDROID.advanced.group_key","typeLabel":"string"},"collapse_replace_key":{"type":"string","description":"This field denotes the update key used to identify and update related push notifications. Ensure you use the same update key for all push notifications intended to update each other.","uniqueKey":"data.items.[INDEX].ANDROID.advanced.collapse_replace_key","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].ANDROID.advanced","typeLabel":"object"},"template_backup":{"type":"object","description":"Some of the options available in the higher SDK versions are not supported for devices that have lower SDK versions (versions lesser than **Android SDK version 10.3.00**). In such cases, a backup notification is sent, and this information is configured in the Template Backup section. **Note**: This option does not apply to the Basic notification template and is applicable only to the Stylized basic template.","properties":{"title":{"type":"string","description":"This field contains the title of the message.","isRequired":true,"uniqueKey":"data.items.[INDEX].ANDROID.template_backup.title","typeLabel":"string"},"message":{"type":"string","description":"This field contains the message content.","isRequired":true,"uniqueKey":"data.items.[INDEX].ANDROID.template_backup.message","typeLabel":"string"},"default_click_action":{"type":"string","enum":["NAVIGATE_TO_A_SCREEN","DEEPLINKING","RICH_LANDING"],"description":"This field describes the default action that should happen when a user clicks on the push notification. The allowed values are:\n1. NAVIGATE_TO_A_SCREEN\n2. DEEPLINKING\n3. RICH_LANDING\n","isRequired":true,"uniqueKey":"data.items.[INDEX].ANDROID.template_backup.default_click_action","typeLabel":"enum\u003cstring>"},"default_click_action_value":{"type":"string","description":"This field contains information about which screen or URL or the rich landing URL information the user should navigate to based on the click action defined above. For example, if default_click_action is NAVIGATE_TO_A_SCREEN, the screen details in the app that the user should land on should be specified in default_click_action_value.","isRequired":true,"uniqueKey":"data.items.[INDEX].ANDROID.template_backup.default_click_action_value","typeLabel":"string"},"summary":{"type":"string","description":"This field contains a brief description of the message content.","uniqueKey":"data.items.[INDEX].ANDROID.template_backup.summary","typeLabel":"string"},"image_url":{"type":"string","format":"uri","description":"This field contains the URL of the image to be added to the notification. Allowed file formats: jpg, jpeg, png, gif","uniqueKey":"data.items.[INDEX].ANDROID.template_backup.image_url","typeLabel":"string\u003curi>"},"key_value_pairs":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"The key for the data pair.","isRequired":true,"uniqueKey":"data.items.[INDEX].ANDROID.template_backup.key_value_pairs.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"The value for the data pair.","isRequired":true,"uniqueKey":"data.items.[INDEX].ANDROID.template_backup.key_value_pairs.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"data.items.[INDEX].ANDROID.template_backup.key_value_pairs.items.[INDEX]","typeLabel":"object"},"description":"This field contains the list of key-value pairs. For example:\n[{\"key\" : \"user\",\"value\": \"john\"}]\n","uniqueKey":"data.items.[INDEX].ANDROID.template_backup.key_value_pairs","typeLabel":"object[]"}},"required":["title","message","default_click_action","default_click_action_value"],"uniqueKey":"data.items.[INDEX].ANDROID.template_backup","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].ANDROID","typeLabel":"object"},"IOS":{"type":"object","description":"This field contains the definition of the template for the iOS platform.\n","properties":{"basic_details":{"type":"object","description":"The basic_details JSON object contains the core information like title, subtitle, and message.","required":["title","message","default_click_action_value"],"properties":{"title":{"type":"string","description":"This field contains the title of the message.","isRequired":true,"uniqueKey":"data.items.[INDEX].IOS.basic_details.title","typeLabel":"string"},"message":{"type":"string","description":"This field contains the message.","isRequired":true,"uniqueKey":"data.items.[INDEX].IOS.basic_details.message","typeLabel":"string"},"default_click_action_value":{"type":"string","description":"This field contains information about which screen or URL or the rich landing URL information the user should navigate to based on the click action defined above. For example, if default_click_action is NAVIGATE_TO_A_SCREEN, the screen details in the app that the user should land on when they click on the push notification should be specified in default_click_action_value.","isRequired":true,"uniqueKey":"data.items.[INDEX].IOS.basic_details.default_click_action_value","typeLabel":"string"},"subtitle":{"type":"string","description":"This field contains the subtitle of the message.","uniqueKey":"data.items.[INDEX].IOS.basic_details.subtitle","typeLabel":"string"},"background_color_code":{"type":"string","example":"#f5e6cd","description":"This field contains the specification for the background color of the message in the push notification. This option is not available for the Basic Notification template. Example: \"background_color_code\": \"#f5e6cd\"","uniqueKey":"data.items.[INDEX].IOS.basic_details.background_color_code","typeLabel":"string"},"apply_background_color":{"type":"boolean","description":"This field contains information about whether the background color should be applied to the fields with a text editor (Title, Subtitle, and Message). It is recommended to enable this option for lighter font colors. This option is not available for the Basic Notification template.","uniqueKey":"data.items.[INDEX].IOS.basic_details.apply_background_color","typeLabel":"boolean"},"default_click_action":{"type":"string","enum":["NAVIGATE_TO_A_SCREEN","DEEPLINKING","RICH_LANDING"],"description":"This field describes the default action that should happen when a user clicks on the push notification. The allowed values are:\n1. NAVIGATE_TO_A_SCREEN\n2. DEEPLINKING\n3. RICH_LANDING\n\nThe NAVIGATE_TO_A_SCREEN option should be used to take the user to the specified navigation screen, DEEPLINKING should be used to take to user to a deep-linked URI, and RICH_LANDING option should be used to take the user to a rich landing page (Web View in App).\n","uniqueKey":"data.items.[INDEX].IOS.basic_details.default_click_action","typeLabel":"enum\u003cstring>"},"key_value_pairs":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"The key for the data pair.","isRequired":true,"uniqueKey":"data.items.[INDEX].IOS.basic_details.key_value_pairs.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"The value for the data pair.","isRequired":true,"uniqueKey":"data.items.[INDEX].IOS.basic_details.key_value_pairs.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"data.items.[INDEX].IOS.basic_details.key_value_pairs.items.[INDEX]","typeLabel":"object"},"description":"This field contains the list of key-value pairs. For example: [{\"key\" : \"user\",\"value\": \"john\"}]","uniqueKey":"data.items.[INDEX].IOS.basic_details.key_value_pairs","typeLabel":"object[]"},"rich_media_type":{"type":"string","enum":["IMAGE","AUDIO","VIDEO","GIF"],"description":"This field contains the type of rich media to be added to the notification. Allowed values: IMAGE, AUDIO, VIDEO, GIF. This option is not available for the Stylized Basic template.","uniqueKey":"data.items.[INDEX].IOS.basic_details.rich_media_type","typeLabel":"enum\u003cstring>"},"rich_media_value":{"type":"string","format":"uri","description":"This field contains the URL of the rich media to be added to the notification. This option is not available for the Stylized Basic template.","uniqueKey":"data.items.[INDEX].IOS.basic_details.rich_media_value","typeLabel":"string\u003curi>"},"allow_bg_refresh":{"type":"boolean","description":"This field indicates whether the app should be allowed to refresh in the background.","uniqueKey":"data.items.[INDEX].IOS.basic_details.allow_bg_refresh","typeLabel":"boolean"}},"uniqueKey":"data.items.[INDEX].IOS.basic_details","typeLabel":"object"},"buttons":{"type":"array","items":{"type":"object","properties":{"button_category":{"type":"string","description":"This field contains the category of the button. To add a button_category, you will need to implement an actionable notification.","uniqueKey":"data.items.[INDEX].IOS.buttons.items.[INDEX].button_category","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].IOS.buttons.items.[INDEX]","typeLabel":"object"},"description":"The buttons object contains the list of buttons in the notification and is optional.","uniqueKey":"data.items.[INDEX].IOS.buttons","typeLabel":"object[]"},"advanced":{"type":"object","description":"The advanced JSON object contains options like coupon code and sound files.","properties":{"coupon_code":{"type":"string","description":"This field contains the coupon code.","uniqueKey":"data.items.[INDEX].IOS.advanced.coupon_code","typeLabel":"string"},"sound_file":{"type":"string","description":"This field contains the details of the sound file to be used for the notification in the user's device. This would be the sound the user would hear on their device upon receiving the notification.","uniqueKey":"data.items.[INDEX].IOS.advanced.sound_file","typeLabel":"string"},"enable_ios_badge":{"type":"boolean","description":"This field indicates whether the badge count should be shown in the app.","uniqueKey":"data.items.[INDEX].IOS.advanced.enable_ios_badge","typeLabel":"boolean"},"group_key":{"type":"string","description":"This field denotes the group key used to identify and categorize related push notifications.\n\n**Note**:\n* Ensure you use the same group key for all push notifications you want to group.\n* MoEngage automatically modifies the group key to ensure it does not exceed the 45-character limit. MoEngage removes non-Latin scripts, special characters, and spaces to restrict the key composition to ASCII characters exclusively.\n","uniqueKey":"data.items.[INDEX].IOS.advanced.group_key","typeLabel":"string"},"collapse_replace_key":{"type":"string","description":"This field denotes the update key used to identify and update related push notifications. Ensure you use the same update key for all push notifications intended to update each other.","uniqueKey":"data.items.[INDEX].IOS.advanced.collapse_replace_key","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].IOS.advanced","typeLabel":"object"},"template_backup":{"type":"object","description":"Some of the options available in the higher SDK versions are not supported for devices that have lower SDK versions (versions lesser than **iOS version 6.2.0**). In such cases, a backup notification is sent, and this information is configured in the Template Backup section. **Note**: This option does not apply to the Basic notification template and is applicable only to the Stylized basic template.","properties":{"title":{"type":"string","description":"This field contains the title of the message.","isRequired":true,"uniqueKey":"data.items.[INDEX].IOS.template_backup.title","typeLabel":"string"},"message":{"type":"string","description":"This field contains a brief description of the message content.","isRequired":true,"uniqueKey":"data.items.[INDEX].IOS.template_backup.message","typeLabel":"string"},"default_click_action":{"type":"string","enum":["NAVIGATE_TO_A_SCREEN","DEEPLINKING","RICH_LANDING"],"description":"This field describes the default action that should happen when a user clicks on the push notification. The allowed values are:\n1. NAVIGATE_TO_A_SCREEN\n2. DEEPLINKING\n3. RICH_LANDING\n","isRequired":true,"uniqueKey":"data.items.[INDEX].IOS.template_backup.default_click_action","typeLabel":"enum\u003cstring>"},"default_click_action_value":{"type":"string","description":"This field contains information about which screen or URL or the rich landing URL information the user should navigate to based on the click action defined above. For example, if default_click_action is NAVIGATE_TO_A_SCREEN, the screen details in the app that the user should land on when they click on the push notification should be specified in default_click_action_value.","isRequired":true,"uniqueKey":"data.items.[INDEX].IOS.template_backup.default_click_action_value","typeLabel":"string"},"subtitle":{"type":"string","description":"This field contains the message content.","uniqueKey":"data.items.[INDEX].IOS.template_backup.subtitle","typeLabel":"string"},"key_value_pairs":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"The key for the data pair.","isRequired":true,"uniqueKey":"data.items.[INDEX].IOS.template_backup.key_value_pairs.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"The value for the data pair.","isRequired":true,"uniqueKey":"data.items.[INDEX].IOS.template_backup.key_value_pairs.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"data.items.[INDEX].IOS.template_backup.key_value_pairs.items.[INDEX]","typeLabel":"object"},"description":"This field contains the list of key-value pairs. For example: [{\"key\" : \"user\",\"value\": \"john\"}]","uniqueKey":"data.items.[INDEX].IOS.template_backup.key_value_pairs","typeLabel":"object[]"},"rich_media_type":{"type":"string","enum":["IMAGE","AUDIO","VIDEO"],"description":"This field contains the type of rich media to be added to the notification. Allowed values: IMAGE, AUDIO, VIDEO. This option is not available for the Stylized Basic template.","uniqueKey":"data.items.[INDEX].IOS.template_backup.rich_media_type","typeLabel":"enum\u003cstring>"},"rich_media_value":{"type":"string","format":"uri","description":"This field contains the URL of the rich media to be added to the notification. This option is not available for the Stylized Basic template.","uniqueKey":"data.items.[INDEX].IOS.template_backup.rich_media_value","typeLabel":"string\u003curi>"},"allow_bg_refresh":{"type":"boolean","description":"This field indicates whether the app should be allowed to refresh in the background.","uniqueKey":"data.items.[INDEX].IOS.template_backup.allow_bg_refresh","typeLabel":"boolean"}},"required":["title","message","default_click_action","default_click_action_value"],"uniqueKey":"data.items.[INDEX].IOS.template_backup","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].IOS","typeLabel":"object"},"meta_info":{"type":"object","description":"Meta information about the template.","properties":{"platform":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].meta_info.platform.items.[INDEX]","typeLabel":"string"},"description":"List of supported platforms.","uniqueKey":"data.items.[INDEX].meta_info.platform","typeLabel":"string[]"},"template_style":{"type":"string","description":"Style of the template.","uniqueKey":"data.items.[INDEX].meta_info.template_style","typeLabel":"string"},"template_id":{"type":"string","description":"Template Identifier.","uniqueKey":"data.items.[INDEX].meta_info.template_id","typeLabel":"string"},"template_name":{"type":"string","description":"Name of the template.","uniqueKey":"data.items.[INDEX].meta_info.template_name","typeLabel":"string"},"template_version":{"type":"string","description":"Version string of the template.","uniqueKey":"data.items.[INDEX].meta_info.template_version","typeLabel":"string"},"updated_by":{"type":"string","description":"User who updated the template.","uniqueKey":"data.items.[INDEX].meta_info.updated_by","typeLabel":"string"},"channel":{"type":"string","description":"Channel type (e.g., PUSH).","uniqueKey":"data.items.[INDEX].meta_info.channel","typeLabel":"string"},"template_source":{"type":"string","description":"Source of the template (e.g., API).","uniqueKey":"data.items.[INDEX].meta_info.template_source","typeLabel":"string"},"template_type":{"type":"string","description":"Type of template (e.g., CUSTOM).","uniqueKey":"data.items.[INDEX].meta_info.template_type","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].meta_info","typeLabel":"object"},"created_by":{"type":"string","description":"User who created the template.","uniqueKey":"data.items.[INDEX].created_by","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp.","uniqueKey":"data.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_by":{"type":"string","description":"User who updated the template.","uniqueKey":"data.items.[INDEX].updated_by","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp.","uniqueKey":"data.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"description":"This field contains the list of push templates that satisfy the search criteria.","uniqueKey":"data","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"data":[{"external_template_id":"9b09875c-edda-42e9-8f9f-a7d0a9a2aa26","version":2,"ANDROID":{"basic_details":{"background_color_code":"#ffffff","notification_control_color":"Dark","apply_background_color":false,"title":"Winter Sale 50% Off","message":"Sample Message","summary":"Sample Summary","image_url":"","default_click_action":"RICH_LANDING","default_click_action_value":"https://www.google.com"},"buttons":[{"btn_name":"View Offers","click_action_type":"RICH_LANDING","click_action_value":"https://www.google.com"},{"btn_name":"Show More Like This","click_action_type":"RICH_LANDING","click_action_value":"https://www.google.com"}],"advanced":{"icon_type_in_notification":"appicon","make_notification_sticky":true,"dismiss_button_text":"Dismiss","auto_dismiss_notification":true,"dismissal_time_value":24,"dismissal_time_multiplier":"hours"},"template_backup":{"title":"Stylized Android Template","message":"Sample Stylized Android Template","default_click_action":"RICH_LANDING","default_click_action_value":"https://www.google.com"}},"IOS":{"basic_details":{}},"meta_info":{"platform":["ANDROID"],"template_style":"STYLIZED","template_id":"Stylizedandroid1","template_name":"Stylized Android Template 2","template_version":"1","updated_by":"Jane Doe","channel":"PUSH","template_source":"API","template_type":"CUSTOM"},"created_by":"John Doe","created_at":"2023-02-27T12:33:05.575000","updated_by":"Jane Doe","updated_at":"2023-02-27T12:33:05.575000"}]},"examples":{"Example":{"title":"Example","value":{"data":[{"external_template_id":"9b09875c-edda-42e9-8f9f-a7d0a9a2aa26","version":2,"ANDROID":{"basic_details":{"background_color_code":"#ffffff","notification_control_color":"Dark","apply_background_color":false,"title":"Winter Sale 50% Off","message":"Sample Message","summary":"Sample Summary","image_url":"","default_click_action":"RICH_LANDING","default_click_action_value":"https://www.google.com"},"buttons":[{"btn_name":"View Offers","click_action_type":"RICH_LANDING","click_action_value":"https://www.google.com"},{"btn_name":"Show More Like This","click_action_type":"RICH_LANDING","click_action_value":"https://www.google.com"}],"advanced":{"icon_type_in_notification":"appicon","make_notification_sticky":true,"dismiss_button_text":"Dismiss","auto_dismiss_notification":true,"dismissal_time_value":24,"dismissal_time_multiplier":"hours"},"template_backup":{"title":"Stylized Android Template","message":"Sample Stylized Android Template","default_click_action":"RICH_LANDING","default_click_action_value":"https://www.google.com"}},"IOS":{"basic_details":{}},"meta_info":{"platform":["ANDROID"],"template_style":"STYLIZED","template_id":"Stylizedandroid1","template_name":"Stylized Android Template 2","template_version":"1","updated_by":"Jane Doe","channel":"PUSH","template_source":"API","template_type":"CUSTOM"},"created_by":"John Doe","created_at":"2023-02-27T12:33:05.575000","updated_by":"Jane Doe","updated_at":"2023-02-27T12:33:05.575000"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"1cb78418-2043-436b-af62-4dda32161bad":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","example":"Authentication required","uniqueKey":"title","typeLabel":"string"},"description":{"type":"string","example":"MOE-APPKEY missing in Authentication Header","uniqueKey":"description","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"title":"Invalid Field Value","description":"Some of the field values are invalid","code":"nGpUNpDQ"},"examples":{"Example":{"title":"Example","value":{"title":"Invalid Field Value","description":"Some of the field values are invalid","code":"nGpUNpDQ"}}},"exampleType":"examples"}},"exampleType":"examples"},"28124a13-9e7e-4c47-80e6-cb293d1f8002":{"description":"This response is returned when the number of requests per minute has exceeded the rate limit.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","description":"This field contains the reason for the request's failure.","properties":{"code":{"type":"string","example":"400 Bad Request","description":"This field contains the error code that provides a brief explanation of the error and is a String. For example, 400 - Bad Request, 401- Authentication required, and so on. This field is present in the response only in the case of errors.","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Validation failed because of invalid request data","description":"This field describes why the request has failed and is a String. For example, in the case of a duplicate request (400- Bad Request), the following message will be present: 'Duplicate - template_id and template_version'.","uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","description":"This is a List of the error details objects.","items":{"type":"object","properties":{"code":{"type":"string","example":"MissingValue","description":"\u003cDescriptive Error Code>","uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"target":{"type":"string","example":"template_name","description":"\u003cDenotes the field causing the issue or a brief description of the error message in some cases >","uniqueKey":"error.details.items.[INDEX].target","typeLabel":"string"},"message":{"type":"string","example":"template_name value is required but value is passed empty.","description":"\u003cDescriptive Error Message>","uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"},"request_id":{"type":"string","example":"jUxStmFn","description":"This field contains the unique id pertaining to the request.","uniqueKey":"error.request_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"response_id":"OUUkHvcn","type":"custom_template","error":{"code":"Too Many Requests","message":"API rate limit breached. Current limit: n/m mins"}},"examples":{"Example":{"title":"Example","value":{"response_id":"OUUkHvcn","type":"custom_template","error":{"code":"Too Many Requests","message":"API rate limit breached. Current limit: n/m mins"}}}},"exampleType":"examples"}},"exampleType":"examples"},"b2bfb7c1-f7f6-4060-95d1-e132a12a9971":{"description":"This response is returned when the system runs into an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","example":"Internal Server Error","uniqueKey":"title","typeLabel":"string"},"message":{"type":"string","example":"An unexpected error was encountered while processing this request. Please contact MoEngage Team","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"Internal Server Error","message":"An unexpected error was encountered while processing this request. Please contact MoEngage Team"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"bd7917f0-5a8d-4734-8b35-c0649665aa8d":{"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":{"231db400-a198-463b-ab88-914d1ac453b1":{"url":"https://api-{dc}.moengage.com/v1.0","description":"MoEngage 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/push-templates/push-templates.yaml"},"subdomain":"moengage","siteName":"MoEngage","title":"Search for Push Templates - MoEngage","relatedPagesConfig":{"enabled":false,"limit":3,"mode":"manual"},"contextualStarterQuestions":[{"_id":"69b015ba7104f9460ee4478d","deploymentId":"68bea8f8fe02728a34cf2acf","questionText":"How do I search push templates?","status":"active","generatedBy":"contextual","path":"api/templates/search-for-push-templates","createdAt":"2026-03-10T12:59:38.896Z","updatedAt":"2026-03-10T12:59:38.896Z","__v":0},{"_id":"69b015ba7104f9460ee4478f","deploymentId":"68bea8f8fe02728a34cf2acf","questionText":"Are pagination parameters required?","status":"active","generatedBy":"contextual","path":"api/templates/search-for-push-templates","createdAt":"2026-03-10T12:59:38.896Z","updatedAt":"2026-03-10T12:59:38.896Z","__v":0},{"_id":"69b015ba7104f9460ee4478e","deploymentId":"68bea8f8fe02728a34cf2acf","questionText":"What's the rate limit for this API?","status":"active","generatedBy":"contextual","path":"api/templates/search-for-push-templates","createdAt":"2026-03-10T12:59:38.896Z","updatedAt":"2026-03-10T12:59:38.896Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api/templates/search-for-push-templates","matchLevel":0},"ja":{"href":"/ja/api/templates/search-for-push-templates","matchLevel":1}}},"lastModified":"2026-10-28T14:39:27.183Z","originalFileLocation":"api/templates/search-for-push-templates.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 searches the push templates created in your MoEngage account.\">\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=\"Search for Push Templates - MoEngage\">\u003cmeta data-mint-head property=\"og:description\" content=\"This API searches the push templates created in your MoEngage account.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"MoEngage\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://moengage.com/docs/api/templates/search-for-push-templates\">\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=Custom+Push+Templates\u0026amp;title=Search+for+Push+Templates\u0026amp;description=This+API+searches+the+push+templates+created+in+your+MoEngage+account.%0A\u0026amp;theme=c3ae899dab8a83c2adcd0e76\u0026amp;signature=da446e057c9be8a3dbac6adfc55f723f3ccd611d12367049b655b93c0dc85e97\">\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=\"Search for Push Templates - MoEngage\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This API searches the push templates created in your MoEngage account.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://moengage.mintlify.site/docs/_mintlify/api/og/v2?division=Custom+Push+Templates\u0026amp;title=Search+for+Push+Templates\u0026amp;description=This+API+searches+the+push+templates+created+in+your+MoEngage+account.%0A\u0026amp;theme=c3ae899dab8a83c2adcd0e76\u0026amp;signature=da446e057c9be8a3dbac6adfc55f723f3ccd611d12367049b655b93c0dc85e97\">\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/templates/search-for-push-templates\">\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/templates/search-for-push-templates.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://moengage.com/docs/api/templates/search-for-push-templates\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://moengage.com/docs/ja/api/templates/search-for-push-templates\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://moengage.com/docs/api/templates/search-for-push-templates\">\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/templates/search-for-push-templates#webpage\",\"url\":\"https://moengage.com/docs/api/templates/search-for-push-templates\",\"name\":\"Search for Push Templates\",\"description\":\"This API searches the push templates created in your MoEngage account.\",\"dateModified\":\"2026-10-28T14:39:27.183Z\",\"isPartOf\":{\"@id\":\"https://moengage.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://moengage.com/docs/api/templates/search-for-push-templates#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://moengage.com/docs/api/templates/search-for-push-templates#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://moengage.com/docs/api/data/data-overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Content\",\"item\":\"https://moengage.com/docs/api/in-app-templates/in-app-templates-overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Templates\",\"item\":\"https://moengage.com/docs/api/in-app-templates/in-app-templates-overview\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Custom Push Templates\",\"item\":\"https://moengage.com/docs/api/push-templates/push-templates-overview\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Search for Push Templates\",\"item\":\"https://moengage.com/docs/api/templates/search-for-push-templates\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://moengage.com/docs/api/templates/search-for-push-templates#apireference\",\"headline\":\"Search for Push Templates\",\"name\":\"Search for Push Templates\",\"description\":\"This API searches the push templates created in your MoEngage account.\",\"url\":\"https://moengage.com/docs/api/templates/search-for-push-templates\",\"mainEntityOfPage\":{\"@id\":\"https://moengage.com/docs/api/templates/search-for-push-templates#webpage\"},\"dateModified\":\"2026-10-28T14:39:27.183Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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","description":"This API updates an existing push notification template by creating a new version.\n","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","description":"Fetch, create, and manage reusable content blocks.","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","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","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":"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/templates/search-for-push-templates"}]}]},"basePath":"","title":"Search for Push Templates - MoEngage","buildId":"dpl_BSPUBxEoKhhK7HzXVDPxdPvWx4xc","deploymentId":"dpl_BSPUBxEoKhhK7HzXVDPxdPvWx4xc","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Do6EtGSl.js","utils-id4tQ6My.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-Byrixac4.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-nakYa3Zl.js","snippetPresets-Bq-pUS7h.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-CujTC_9K.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-FneVUsVu.js","shallow-DY9WpUCz.js","getApiPlaygroundDisplay-Bz8WpPfA.js","CodeSnippet-DgCuJg4G.js","CodeSnippets-Dub9c4T0.js","Page-CePXnjd1.js","getPastedJson-xdI8y2XB.js","icon--yVw5vkr.js","MethodPill-C47t7MdS.js","DuplicateIcon-BzwJ2LeC.js","createIcon-BzggGy84.js","DynamicMarkdown-AlxJK8VR.js","SectionHeading-CMlwFxdK.js","axios-vUo_bRtp.js","Markdown-BNgNrPsi.js","clsx-apD-Q0Oo.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-qmLwQyWY.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Dc4qTkWx.js"]}