page

Required

Integer

This parameter represents the page number. If this value is not specified, it will be considered as one by default. Each page will have a batch size of 20( 20 templates will be returned in a page).

Example: /v2/email-templates?page=1

MOE-APPKEY

Required

{"MOE-APPKEY": "APP ID"}

This is the APP ID of your MoEngage account. The MOE-APPKEY has to be passed along with the request. You can find your MoEngage APP ID in the MoEngage Dashboard API Settings. Navigation: Settings -> API -> General Settings -> DATA API section. For more information, refer to Authentication.

Note: You can also fetch the APP ID from the following navigation: Settings -> App -> General Settings.

Content-Type

Required

{"Content-Type": "application/json"}

Set the Content-Type header to application/json.

Authorization

Required

{"Authorization": "Basic bmF2ZWVua3VtYXI6bW9lbmdhZ2U=="}

This is the authentication parameter for access control and needs to be passed along with the request. The DATA API ID and DATA API KEY need to be picked up from the DATA API Settings in MoEngage Dashboard, and a Basic Authorization header needs to be created and set in the header. Navigation: Settings -> API -> General Settings -> DATA API section. For more information, refer to Authentication.

This field contains the status of the request and denotes whether it was successful or not.

Example: "status": "success", "status": "error"

This field contains the id of the created template when the request is successful and the error details in case of an unsuccessful request.

Successful Request

The data object contains the following fields in the case of a successful request:

Structure:

    "data": {

        "templates": [

        {
           "template_id": "<Template ID 1>",
            "template_name": "<TemplateName>",
            "is_archived": <true/false>,
            "builder_supported": false,
            "editor": "Froala Editor",
            "created_date": "<Creation Timestamp>",
            "updated_at": "<Updation Timestamp>",
            "updated_by": "<details about who created or updated the template>"
        },
        {
           "template_id": "<Template ID 2>",
            "template_name": "<TemplateName>",
            "is_archived": <true/false>,
            "builder_supported": false,
            "editor": "Froala Editor",
            "created_date": "<Creation Timestamp>",
            "updated_at": "<Updation Timestamp>",
            "updated_by": "<details about who created or updated the template>"
        },
        {
           "template_id": "<Template ID 3>",
            "template_name": "<TemplateName>",
            "is_archived": <true/false>,
            "builder_supported": false,
            "editor": "Froala Editor",
            "created_date": "<Creation Timestamp>",
            "updated_at": "<Updation Timestamp>",
            "updated_by": "<details about who created or updated the template>"
        },...{}

         ],

       "no_of_templates": "<no of templates returned in the page>"

}

For each of the templates fetched, the following information is available:

        "template_id": "<Template id - the unique identifier that is created at the time of template creation>",

        "template_name": "<name of the template being fetched>",

        "is_archived": "false",

        "builder_supported": "false",

        "editor": "Froala Editor",

        "created_date": "<timestamp of template creation>",

        "updated_at": "<timestamp of when the template was last updated>",

        "updated_by": "<details about who created or updated the template"

Note:

• For the Froala editor, the builder_supported value is false. Thus, for all the templates created using APIs, this would be false. Also, the number of templates returned is also available in the response.

Unsuccessful Request

The data object contains the following fields in the case of errors:

Structure:

 "data": {

    "code": "<error_code>", 

    "title": "<type of error>",

    "description": "<error_message>"

}

The error object contains the following fields:

• code - This field contains the error code and is a String. Example: 400 (for a Bad Request), 401( for Authentication failures), and so on. This field is present in the response only in the case of errors.
• title - This field contains the type of error encountered. Example: Bad Request, Authentication Required, and so on. This field is present in the response only in the case of errors.
• description - This field describes why the request has failed and is a String. Example: 'MOE-APPKEY header is invalid or empty'.

200

Success

This response is returned when the request is processed successfully. 

400

Bad Request

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.

401

Authorization Failure

This response is returned when the authorization parameters are missing in the HTTP Auth Header.

429

Rate Limit Breach

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.

5xx

Internal Server Error

This response is returned when the system runs into an unexpected error.