Update OSM Template

curl --request PUT \ --url https://api-{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" } } '

{ "error": { "code": "400 Bad Request", "message": "Validation failed because of invalid request data", "details": [ { "code": "MissingValue", "target": "external_template_id", "message": "external_template_id value is required but value is passed empty." } ], "request_id": "cTRlnJaG" } }

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 Campaign report/Business events/Custom templates/Catalog API/Inform Report tile.

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

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.

Show child attributes

meta_info

object

required

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

Show child attributes

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.

Endpoints

Update OSM Template

Rate Limit

Authorizations

Body

Response

​Rate Limit

Authorizations

Body

Response

Rate Limit