Get All Templates

This API fetches the list of all the email templates available in your MoEngage account.

GET /email-templates

Get All Templates

cURL

curl --request GET \
  --url https://api-{dc}.moengage.com/v2/email-templates \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'MOE-APPKEY: <moe-appkey>'

200

{
  "status": "success",
  "data": {
    "templates": [
      {
        "template_id": "645a2bd910e0307e6d7f7717",
        "template_name": "Coupon_code_template",
        "is_archived": false,
        "builder_supported": false,
        "editor": "Froala Editor",
        "created_date": "2023-05-09 11:17:43.112000",
        "updated_at": "2023-05-09 11:18:37.692000",
        "updated_by": "[e-mail]"
      }
    ],
    "no_of_templates": 13
  }
}

{
  "status": "error",
  "data": {
    "code": 400,
    "title": "Invalid template id",
    "description": "Please provide a valid template id"
  }
}

{
  "status": "error",
  "data": {
    "code": 401,
    "title": "Authentication required",
    "description": "Invalid APP_ID used in Authentication Header"
  }
}

{
  "status": "error",
  "data": {
    "code": 429,
    "title": "rate limiter exception",
    "description": "Exceeded rate limit for this app"
  }
}

{
  "title": "Internal Server Error",
  "message": "An unexpected error was encountered while processing this request. Please contact MoEngage Team"
}

Rate Limit

The rate limits are at the workspace level, and a maximum of 1000 (sum of all the API requests per workspace) requests are allowed for a workspace per minute.

Authorizations

Authorization · string · header · required

Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.

• Username: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
• Password: Use your API Key, which you can find within the Data tile.

For more information on authentication and getting your credentials, refer here.

Headers

MOE-APPKEY · string · required

This is the Workspace ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).

Query Parameters

page · integer · default: 1

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:

1

Response

200

application/json

This response is returned when the request is processed successfully.

status · string

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

Example:

"success"

data · object

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

Show child attributes