curl --request PUT \
--url https://api-{dc}.moengage.com/v1.0/custom-templates/email \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"external_template_id": "{{external_template_id}}",
"basic_details": {
"subject": "Email_Subject",
"email_content": "<!DOCTYPE html><html><head><title>My Short HTML</title></head><body><h1>Hello, World!</h1><p>This is a simple HTML example.</p></body></html>",
"thumbnail_url": "{{template_thumbnail_thumbnail_url}}",
"sender_name": "Sender_Name",
"preview_text": "Preview_text",
"attachments": []
},
"meta_info": {
"created_by": "[email protected]",
"template_id": "{{template_id}}",
"template_name": "{{template_name}}",
"template_version": "{{template_version}}",
"locale": "{{Locale_name}}",
"variation": 1
},
"update_campaigns": true,
"update_latest_version": false
}
'{
"external_template_id": "d05a44f0-a7cf-471a-bcb6-63054800a367"
}Update Email Template
This API updates an email template by specifying its external template ID. You can specify whether the updated version of the template can be used in active campaigns in the request.
curl --request PUT \
--url https://api-{dc}.moengage.com/v1.0/custom-templates/email \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"external_template_id": "{{external_template_id}}",
"basic_details": {
"subject": "Email_Subject",
"email_content": "<!DOCTYPE html><html><head><title>My Short HTML</title></head><body><h1>Hello, World!</h1><p>This is a simple HTML example.</p></body></html>",
"thumbnail_url": "{{template_thumbnail_thumbnail_url}}",
"sender_name": "Sender_Name",
"preview_text": "Preview_text",
"attachments": []
},
"meta_info": {
"created_by": "[email protected]",
"template_id": "{{template_id}}",
"template_name": "{{template_name}}",
"template_version": "{{template_version}}",
"locale": "{{Locale_name}}",
"variation": 1
},
"update_campaigns": true,
"update_latest_version": false
}
'{
"external_template_id": "d05a44f0-a7cf-471a-bcb6-63054800a367"
}Rate Limit
The rate limit is 100 Requests Per Minute.Authorizations
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
This field contains the unique identifier that is generated during the creation of the template.
This field contains the email content. This is where you define the email template being created.
Show child attributes
Show child attributes
This field contains information about the template being created, such as the name, version, and ID of the template and the creator's details.
Show child attributes
Show child attributes
This field contains a flag that is used to update all the campaigns that are currently using the template being updated to the newer version(that is being updated in this request). The default value for this flag is false.
When the update_campaigns flag is true, all the campaigns running with this template will get updated to the latest version of the template, and when it is false, the new version of the template will be created, but there will be no change made to the template used in the existing campaigns.
If the value is "true," this API does not create a new version of the template but only updates its contents.
This field contains the name of the team to which this template should be assigned.
Team-based template management lets you create separate templates for different teams within your workspace (for example, a template created by the Marketing team and another by the Engineering team), so that each team's campaigns use their own templates.
team_nameis mandatory if teams are enabled for your workspace.- If teams are enabled for your workspace and this field is not passed, the template will not be updated and the request will fail with an error.
- Team-based template management is currently released behind a feature flag and may not be enabled for your workspace. If this flag is not enabled and you pass
team_name, the request will fail. Reach out to your Customer Success Manager (CSM) to get this setting enabled before using this field. - If teams are not enabled for your workspace, do not pass this field. Existing integrations that use
team_id(or that do not pass any team information) are unaffected and continue to work as before.
Response
This response is returned when the request is processed successfully.
This field contains the unique template id corresponding to a successful template updation request.