Skip to main content
PUT
/
custom-templates
/
osm
Update OSM Template
curl --request PUT \
  --url https://api-0{dc}.moengage.com/v1.0/custom-templates/osm \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_template_id": "81e1a740-3e57-4c70-8ec7-ffc84d576498",
  "update_campaigns": false,
  "basic_details": {
    "payload": "<html><body><h1>Updated HTML Content</h1></body></html>"
  },
  "meta_info": {
    "template_name": "AD template updated API 1",
    "template_id": "133434477456",
    "template_version": "2",
    "updated_by": "testuser@moengage.com"
  }
}
'
{
  "external_template_id": "4a1afbc5-4c31-4f19-8c23-793e27af01aa"
}

​
Rate Limit

The rate limit is 100 RPM.

Authorizations

​
Authorization
string
header
required

The API request is authenticated through Basic Authentication. This sends a Base64-encoded string containing your username and password with every API request.

It encodes a username:password string in Base64 and appends the encoded string with Basic . This string is included in the authorization header: {"Authorization: "Basic Base64_ENCODED_WORKSPACEID_APIKEY=="}

Follow these steps to obtain the username and password from the MoEngage Dashboard:

  1. Navigate to Settings > Account > APIs.
  2. Copy the following details:
    • Username: Under Workspace ID (earlier App ID), click the copy icon.
    • Password: In the API keys section, click the copy icon in the Campaign report/Business events/Custom templates/Catalog API tile.

Body

application/json

The updated details for the OSM template.

​
external_template_id
string<uuid>
required

The unique identifier generated by MoEngage during template creation.

​
basic_details
object
required

Details about the template payload.

​
meta_info
object
required

Updates template information such as name, version, and updater details.

​
update_campaigns
boolean
default:false

Flag to update all campaigns currently using this template to the newer version.

  • true: All campaigns running with this template will be updated.
  • false: A new version of the template is created; existing campaigns remain unchanged.

Response

Template updated successfully.

​
external_template_id
string<uuid>

The unique ID of the updated template.