> ## Documentation Index > Fetch the complete documentation index at: https://moengage.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create Push Template > This API creates a new push notification template for one or more platforms (Android, iOS). #### Rate Limit The rate limit is 100 RPM (Requests Per Minute). ## OpenAPI ````yaml /api/push-templates/push-templates.yaml post /custom-templates/push openapi: 3.0.3 info: title: Push Templates API description: > An API for creating, updating, and searching for push notification templates for Android and iOS platforms. version: '1.0' x-logo: url: >- https://images.g2crowd.com/uploads/product/image/social_landscape/social_landscape_4cb13a53c5240c218206532439a2f15a/moengage.png altText: MoEngage Logo servers: - 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. security: - BasicAuth: [] paths: /custom-templates/push: post: tags: - Templates summary: Create Push Template description: > This API creates a new push notification template for one or more platforms (Android, iOS). operationId: createPushTemplate requestBody: description: >- A JSON object containing the template definitions for desired platforms and metadata. required: true content: application/json: schema: type: object properties: ANDROID: $ref: '#/components/schemas/AndroidPayload' IOS: $ref: '#/components/schemas/IosPayload' meta_info: $ref: '#/components/schemas/MetaInfoCreate' required: - meta_info examples: Stylized_Android_iOS: summary: 1. Stylized (Android & iOS) value: ANDROID: basic_details: app_name_color_code: APP_NAME_COLOR_CODE notification_control_color: Light/Dark background_color_code: BG_COLOR_CODE title: TITLE_OF_ANDROID_TEMPLATE message: MESSAGE_OF_ANDROID_TEMPLATE summary: SUMMARY image_url: IMAGE_URL default_click_action: DEEPLINKING/RICH_LANDING/NAVIGATE_TO_A_SCREEN default_click_action_value: CLICK_ACTION_URL_HERE key_value_pairs: - key: KEY value: ' VALUE' buttons: - btn_name: NAME_OF_THE_BUTTON click_action_type: >- NAVIGATE_TO_A_SCREEN/DEEPLINKING/RICH_LANDING/CALL/SHARE/COPY/SET_USER_ATTRIBUTE/TRACK_EVENT/CUSTOM_ACTION/SNOOZE/REMIND_LATER click_action_name: VALID_CLICK_ACTION_NAME_HERE click_action_value: CLICK_ACTION_URL_HERE advanced: coupon_code: COUPON_CODE icon_type_in_notification: appicon/url large_icon_url: LARGE_ICON_URL_HERE IF icon_type_in_notification is url auto_dismiss_notification: true dismissal_time_multiplier: days/hours/minutes dismissal_time_value: 1 make_notification_sticky: true dismiss_button_text: DISMISS_BUTTON_TEXT_HERE template_backup: title: TITLE_OF_ANDROID_BACKUP_TEMPLATE message: MESSAGE_OF_ANDROID_BACKUP_TEMPLATE summary: SUMMARY image_url: IMAGE_URL default_click_action: DEEPLINKING/RICH_LANDING/NAVIGATE_TO_A_SCREEN default_click_action_value: CLICK_ACTION_URL_HERE key_value_pairs: - key: KEY value: ' VALUE' IOS: basic_details: background_color_code: BG_COLOR_CODE title: TITLE_OF_IOS_TEMPLATE subtitle: SUBTITLE_OF_IOS_TEMPLATE message: MESSAGE_OF_IOS_TEMPLATE rich_media_value: RICH_MEDIA_URL_HERE default_click_action: DEEPLINKING/RICH_LANDING/NAVIGATE_TO_A_SCREEN default_click_action_value: CLICK_ACTION_URL_HERE allow_bg_refresh: true buttons: - button_category: CATEGORY_OF_BUTTON advanced: coupon_code: COUPON_CODE sound_file: SOUND_FILE enable_ios_badge: true template_backup: title: TITLE_OF_IOS_TEMPLATE subtitle: SUBTITLE_OF_IOS_TEMPLATE message: MESSAGE_OF_IOS_TEMPLATE rich_media_value: RICH_MEDIA_URL_HERE default_click_action: DEEPLINKING/RICH_LANDING/NAVIGATE_TO_A_SCREEN default_click_action_value: CLICK_ACTION_URL_HERE allow_bg_refresh: true meta_info: platform: - ANDROID - IOS template_style: BASIC/STYLIZED template_id: 1234567890 template_name: NAME_OF_THE_TEMPLATE template_version: VERSION_OF_THE_TEMPLATE created_by: USER_CREATED Stylized_Android_Only: summary: 2. Stylized (Android Only) value: ANDROID: basic_details: app_name_color_code: '#ffffff' notification_control_color: Light background_color_code: '#ffffff' title: TITLE_OF_ANDROID_TEMPLATE message: MESSAGE_OF_ANDROID_TEMPLATE summary: SUMMARY image_url: >- https://images.pexels.com/photos/248797/pexels-photo-248797.jpeg?w=1260&h=750&auto=compress&cs=tinysrgb default_click_action: NAVIGATE_TO_A_SCREEN default_click_action_value: com.moengage.sampleapp.info.InfoActivity key_value_pairs: - key: page value: ' 28' buttons: - btn_name: button1 click_action_type: DEEPLINKING click_action_name: click click_action_value: https://www.google.com advanced: coupon_code: COUPON_CODE icon_type_in_notification: appicon auto_dismiss_notification: true dismissal_time_multiplier: minutes dismissal_time_value: 1 make_notification_sticky: true dismiss_button_text: DISMISS_BUTTON_TEXT_HERE template_backup: title: TITLE_OF_ANDROID_BACKUP_TEMPLATE message: MESSAGE_OF_ANDROID_BACKUP_TEMPLATE summary: SUMMARY image_url: >- https://images.pexels.com/photos/248797/pexels-photo-248797.jpeg?w=1260&h=750&auto=compress&cs=tinysrgb default_click_action: NAVIGATE_TO_A_SCREEN default_click_action_value: com.moengage.sampleapp.info.InfoActivity key_value_pairs: - key: KEY value: ' VALUE' meta_info: platform: - ANDROID template_style: STYLIZED template_id: '12340' template_name: BT1 template_version: '1' created_by: User Stylized_iOS_Only: summary: 3. Stylized (iOS Only) value: IOS: basic_details: background_color_code: '#ffffff' title: TITLE_OF_IOS_TEMPLATE subtitle: SUBTITLE_OF_IOS_TEMPLATE message: MESSAGE_OF_IOS_TEMPLATE rich_media_value: RICH_MEDIA_URL_HERE default_click_action: RICH_LANDING default_click_action_value: https://www.google.com allow_bg_refresh: true buttons: - button_category: CATEGORY_OF_BUTTON advanced: coupon_code: COUPON_CODE sound_file: SOUND_FILE enable_ios_badge: true template_backup: title: TITLE_OF_IOS_TEMPLATE subtitle: SUBTITLE_OF_IOS_TEMPLATE message: MESSAGE_OF_IOS_TEMPLATE rich_media_value: RICH_MEDIA_URL_HERE default_click_action: DEEPLINKING default_click_action_value: https://www.google.com allow_bg_refresh: true meta_info: platform: - IOS template_style: STYLIZED template_id: '123404' template_name: only IOS template_version: '2' created_by: User Basic_Android_iOS: summary: 4. Basic (Android & iOS) value: ANDROID: basic_details: title: TITLE_OF_ANDROID_TEMPLATE message: MESSAGE_OF_ANDROID_TEMPLATE summary: SUMMARY image_url: >- https://images.pexels.com/photos/248797/pexels-photo-248797.jpeg?w=1260&h=750&auto=compress&cs=tinysrgb default_click_action: DEEPLINKING default_click_action_value: https://www.google.com key_value_pairs: - key: KEY value: ' VALUE' buttons: - btn_name: NAME_OF_THE_BUTTON click_action_type: DEEPLINKING click_action_name: Bhuvan click_action_value: https://www.google.com advanced: coupon_code: COUPON_CODE icon_type_in_notification: appicon auto_dismiss_notification: true dismissal_time_multiplier: minutes dismissal_time_value: 1 IOS: basic_details: title: TITLE_OF_IOS_TEMPLATE subtitle: SUBTITLE_OF_IOS_TEMPLATE message: MESSAGE_OF_IOS_TEMPLATE rich_media_value: RICH_MEDIA_URL_HERE default_click_action: DEEPLINKING default_click_action_value: https://www.google.com allow_bg_refresh: true buttons: - button_category: CATEGORY_OF_BUTTON advanced: coupon_code: COUPON_CODE sound_file: SOUND_FILE enable_ios_badge: true meta_info: platform: - ANDROID - IOS template_style: BASIC template_id: '12345' template_name: Basic template - Android and IOS template_version: '1' created_by: User1 Basic_Android_Only: summary: 5. Basic (Android Only) value: ANDROID: basic_details: title: TITLE_OF_ANDROID_TEMPLATE message: MESSAGE_OF_ANDROID_TEMPLATE summary: SUMMARY image_url: >- https://images.pexels.com/photos/248797/pexels-photo-248797.jpeg?w=1260&h=750&auto=compress&cs=tinysrgb default_click_action: DEEPLINKING default_click_action_value: https:wwww.google.com key_value_pairs: - key: KEY value: ' VALUE' buttons: - btn_name: NAME_OF_THE_BUTTON click_action_type: DEEPLINKING click_action_name: Bhuvan click_action_value: https:wwww.google.com advanced: coupon_code: COUPON_CODE icon_type_in_notification: appicon auto_dismiss_notification: true dismissal_time_multiplier: minutes dismissal_time_value: 1 meta_info: platform: - ANDROID template_style: BASIC template_id: '12345642' template_name: Basic_template-Only Android template_version: '1' created_by: User11 Basic_iOS_Only: summary: 6. Basic (iOS Only) value: IOS: basic_details: title: TITLE_OF_IOS_TEMPLATE subtitle: SUBTITLE_OF_IOS_TEMPLATE message: MESSAGE_OF_IOS_TEMPLATE rich_media_value: RICH_MEDIA_URL_HERE default_click_action: DEEPLINKING default_click_action_value: https://www.google.com allow_bg_refresh: true buttons: - button_category: CATEGORY_OF_BUTTON advanced: coupon_code: COUPON_CODE sound_file: SOUND_FILE enable_ios_badge: true meta_info: platform: - IOS template_style: BASIC template_id: '1234567' template_name: Basic template - Only IOS template_version: '1' created_by: User1 responses: '200': description: >- This response is returned when the request is processed successfully. content: application/json: schema: type: object properties: external_template_id: type: string format: uuid description: >- This field contains the unique template id corresponding to a successful template creation request and needs to be stored by you. This template id would be used for searching a specific template and updating it. example: d05a44f0-a7cf-471a-bcb6-63054800a367 '400': description: >- This response is returned when the required parameters are missing from the request or when the provided parameters are invalid, or when a template already exists with the same version, name, or id. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: ValidationFailure: summary: Validation Failure value: error: code: 400 Bad Request message: Validation failed because of invalid request data details: - code: NotSupported target: '[''summary'']' message: '[''summary''] are not expected in this request.' - code: MissingValue target: platform message: Template Body is missing for ANDROID. - code: MissingValue target: platform message: >- IOS is missing in meta_info but template body is passed for IOS. request_id: LMwPhRMB EmptyTemplateName: summary: Empty Template Name value: error: code: 400 Bad Request message: Validation failed because of invalid request data details: - code: MissingValue target: template_name message: >- template_name value is required but value is passed empty. request_id: jUxStmFn InvalidDataTypes: summary: Invalid Data Types value: error: code: 400 Bad Request message: Validation failed because of invalid request data details: - code: InvalidValue target: title message: title value is invalid. request_id: REQCNzcE MissingMandatoryFields: summary: Missing Mandatory Fields value: error: code: 400 Bad Request message: Validation failed because of invalid request data details: - code: MissingValue target: title message: title value is required but value is passed empty. request_id: eYXFWciv DuplicateTemplate: summary: Duplicate Template value: error: code: 400 Bad Request message: Duplicate - template_id and template_version details: - code: InvalidValue target: Duplicate - template_id and template_version message: >- template_id:basicios12 template_version:12 is already present. request_id: cLCcgLQj TemplateLimitBreach: summary: Template Limit Breach value: error: code: 400 Bad Request message: Maximum Template limit exceeded details: - code: NotSupported target: Maximum Template limit exceeded message: >- You have already created maximum allowed template allowed for client request_id: eLeZXIlW '401': description: >- This response is returned when the authorization parameters are missing in the HTTP Auth Header. content: application/json: schema: $ref: '#/components/schemas/SimpleErrorResponse' example: title: Authentication required description: MOE-APPKEY missing in Authentication Header '415': description: >- This response is returned when the header Content-Type is not provided/is not supported. content: application/json: schema: $ref: '#/components/schemas/SimpleErrorResponse' example: title: Unsupported media type description: Content type is not supported '429': description: >- This response is returned when the number of requests per minute has exceeded the rate limit or the number of templates has exceeded the allowed quota per channel. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: response_id: OUUkHvcn type: custom_template error: code: Too Many Requests message: 'API rate limit breached. Current limit: n/m mins' '500': description: >- This response is returned when the system runs into an unexpected error. content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' components: schemas: AndroidPayload: type: object description: > This field contains the definition of the template for the Android platform. 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. message: type: string description: This field contains the message content. summary: type: string description: This field contains a brief description of the message content. 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" **Note**: Only hexadecimal values are supported. 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. 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" **Note**: Only hexadecimal values are supported. 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. 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. 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. 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: 1. NAVIGATE_TO_A_SCREEN 2. DEEPLINKING 3. RICH_LANDING 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. key_value_pairs: type: array items: $ref: '#/components/schemas/KeyValue' description: | This field contains the list of key-value pairs. For example: [{"key" : "user","value": "john"}] buttons: type: array items: $ref: '#/components/schemas/AndroidButton' description: >- The buttons object contains the list of buttons in the notification and is optional. 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. 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. large_icon_url: type: string format: uri description: >- This field contains the URL that contains the large icon to be added to the notification. auto_dismiss_notification: type: boolean description: >- This field contains information about whether notification should be auto-dismissed from the user's notification tray. 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. 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. 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. 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. group_key: type: string description: > This field denotes the group key used to identify and categorize related push notifications. **Note**: * Ensure you use the same group key for all push notifications you want to group. * 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. 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. 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. message: type: string description: This field contains the message content. summary: type: string description: This field contains a brief description of the message content. 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 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: 1. NAVIGATE_TO_A_SCREEN 2. DEEPLINKING 3. RICH_LANDING 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. key_value_pairs: type: array items: $ref: '#/components/schemas/KeyValue' description: | This field contains the list of key-value pairs. For example: [{"key" : "user","value": "john"}] required: - title - message - default_click_action - default_click_action_value IosPayload: type: object description: | This field contains the definition of the template for the iOS platform. 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. subtitle: type: string description: This field contains the subtitle of the message. message: type: string description: This field contains the message. 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" 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. 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: 1. NAVIGATE_TO_A_SCREEN 2. DEEPLINKING 3. RICH_LANDING The 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). 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. key_value_pairs: type: array items: $ref: '#/components/schemas/KeyValue' description: >- This field contains the list of key-value pairs. For example: [{"key" : "user","value": "john"}] 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. 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. allow_bg_refresh: type: boolean description: >- This field indicates whether the app should be allowed to refresh in the background. buttons: type: array items: $ref: '#/components/schemas/IosButton' description: >- The buttons object contains the list of buttons in the notification and is optional. 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. 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. enable_ios_badge: type: boolean description: >- This field indicates whether the badge count should be shown in the app. group_key: type: string description: > This field denotes the group key used to identify and categorize related push notifications. **Note**: * Ensure you use the same group key for all push notifications you want to group. * 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. 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. 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. subtitle: type: string description: This field contains the message content. message: type: string description: This field contains a brief description of the message content. 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: 1. NAVIGATE_TO_A_SCREEN 2. DEEPLINKING 3. RICH_LANDING 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. key_value_pairs: type: array items: $ref: '#/components/schemas/KeyValue' description: >- This field contains the list of key-value pairs. For example: [{"key" : "user","value": "john"}] 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. 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. allow_bg_refresh: type: boolean description: >- This field indicates whether the app should be allowed to refresh in the background. required: - title - message - default_click_action - default_click_action_value MetaInfoCreate: type: object description: >- This field contains information about the template being created, such as the name, version, and id of the template, the template's platform, style, and the creator's details. required: - platform - template_style - template_id - template_name - template_version - created_by properties: platform: type: array items: type: string enum: - ANDROID - IOS description: >- This field contains the list of platforms where the template can be used. Allowed values: ANDROID, IOS template_style: type: string enum: - BASIC - STYLIZED description: >- This field contains the style of the template. Allowed values: BASIC, STYLIZED template_id: type: string description: >- This field contains the ID for the template and is unique. This ID should be generated by you and will be used for updating or retrieving the template using the template APIs. template_name: type: string description: >- This field contains the name of the template. This value should be generated by you and would be used for identifying the template. template_version: type: string description: >- This field contains the version of the template. This value should be generated by you and would be used for tracking the template's version. created_by: type: string description: >- This field contains details about who created the template. This value should be generated by you. For example, you can pass the email id of the user creating the template here. ErrorResponse: 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. 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'. details: type: array description: This is a List of the error details objects. items: type: object properties: code: type: string example: MissingValue description: target: type: string example: template_name description: >- message: type: string example: template_name value is required but value is passed empty. description: request_id: type: string example: jUxStmFn description: This field contains the unique id pertaining to the request. SimpleErrorResponse: type: object properties: title: type: string example: Authentication required description: type: string example: MOE-APPKEY missing in Authentication Header InternalServerErrorResponse: type: object properties: title: type: string example: Internal Server Error message: type: string example: >- An unexpected error was encountered while processing this request. Please contact MoEngage Team KeyValue: type: object properties: key: type: string description: The key for the data pair. value: type: string description: The value for the data pair. required: - key - value AndroidButton: type: object properties: btn_name: type: string description: This field contains the name of the button. click_action_type: type: string description: > This field contains the click action associated with the button. The allowed values are: 1. NAVIGATE_TO_A_SCREEN 2. DEEPLINKING 3. RICH_LANDING 4. CALL 5. SHARE 6. COPY 7. SET_USER_ATTRIBUTE 8. TRACK_EVENT 9. CUSTOM_ACTION 10. SNOOZE 11. REMIND_LATER For more information, refer to [Click Actions Supported for Android](/user-guide/campaigns-and-channels/mobile-push/notification-features-and-behavior/notification-actions). enum: - NAVIGATE_TO_A_SCREEN - DEEPLINKING - RICH_LANDING - CALL - SHARE - COPY - SET_USER_ATTRIBUTE - TRACK_EVENT - CUSTOM_ACTION - SNOOZE - REMIND_LATER 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. 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. key_value_pairs: type: array items: $ref: '#/components/schemas/KeyValue' description: | This field contains the list of key-value pairs. For example: [{"key" : "user","value": "john"}] required: - btn_name - click_action_type - click_action_value IosButton: 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. securitySchemes: 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'. - **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](https://www.moengage.com/docs/api/introduction#getting-your-credentials). ````