Update SMS Template API

This API can be used to update an SMS 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.

API Endpoint

PUT https://api-0X.moengage.com/v1.0/custom-templates/sms

Each customer is hosted on a different data center; you can find your data center number (value of X) by checking the data center and API endpoint mapping page.

Authentication

The API request will be authenticated through Basic Authentication. Basic Authentication 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 as shown below:

{"Authorization":"Basic bmF2ZWVua3VtYXI6bW9lbmdhZ2U="}

The username and password details can be obtained from the MoEngage Dashboard. We've revamped the settings UI in the Dashboard. If you're using the API for the first time, follow these steps for the revamped and old UIs:

Revamped UI

Navigate to Settings -> Account -> APIs.
Click the Copy icon in the Campaign report/Business events/Custom templates tile in the API Keys section to copy the API Key.
Use the App ID as the username and the Push API Key as the password to generate the authentication header.

Old UI

Navigate to Settings -> APIs -> TRANSACTION PUSH/REPORT Settings.
Click on the Click here to show APP Secret link to view the API SECRET.
Use the APP ID as the username and the API SECRET as the password to generate the authentication header.

Request Headers

Key	Required	Sample Values	Description
Content-Type	Required	{"Content-Type": "application/json"}	Set the Content-Type header to application/json.
Authorization	Required	{"Authorization": "Basic bmF2ZWVua3VtYXI6bW9lbmdhZ2U=="}	This authentication parameter, used for access control, must be passed along with the request. To generate the authentication header, refer to Authentication.

Request Body

Key	Required	Values	Description
external_template_id	Required	String	This field contains the unique identifier that is generated during the creation of the template.
update_campaigns	Optional	Boolean	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.
basic_details	Required	JSON Object	This field contains the basic details of the SMS template. Structure of basic_details Object: "basic_details": { "message": "Sample Template message" } The basic_details object contains the following fields: message: This field contains the updated message template. It is a String and is mandatory.
meta_info	Mandatory	JSON Object	This field contains information about the template being created, such as the name, version, and id of the template and the creator's details. Structure of meta_info: "meta_info": { "template_name": "<template name>", "updated_by": "<email of the person updating the template>", "template_version": "OPTIONAL_VERSION_FIELD" } The meta_info object contains the following fields: template_name - This field contains the name of the template being updated. updated_by - This field contains the email id of the person updating the template. template_version - This field contains the version of the template. This is an optional field Note: All the fields in the meta_info object are String fields. All fields in the meta_info object except template_version are mandatory.

Response

Key

Data Type

Description

external_template_id

String

This field contains the unique template id corresponding to a successful template updation request.

error

JSON Object

This field contains the reason for the request's failure.

Structure:

"error": {

"code": "<error_code>",

"message": "<error_message>",

"details": [],

"request_id": "<unique identifier for the request>

}

The error object contains the following fields:

code - This field contains the error code that provides a brief explanation of the error and is a String. For example, 400 - Bad Request, 401- Authentication required, and so on. This field is present in the response only in the case of errors.
message - This field describes why the request has failed and is a String. For example, in the case of a duplicate request (400- Bad Request), the following message will be present: 'Duplicate - template_id and template_version'.
details - This is a List of the error details objects. Each object contains the following information:

{

"code": "<Descriptive Error Code>",

"target": "<Denotes the field causing the issue or a brief description of the error message in some cases >",

"message": "<Descriptive Error Message>"

}

request_id - This field contains the unique id pertaining to the request.

For example, in the case of a 400 request where the request is trying to update a template using an invalid template-id, the following error object is returned.

{
"error": {
"code": "400 Bad Request",
"message": "Invalid template id",
"details": [
{
"code": "Missing Value",
"target": "<template_id>",
"message": "<template_id>is invalid template id"
}
],
"request_id": "cLCcgLQj"
}

Response Codes

Status Code	Request State	Description
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.
5xx	Internal Server Error	This response is returned when the system runs into an unexpected error.

Rate Limit

The rate limit is 100 RPM.

Sample cURL Request

curl --location --request PUT 'https://api-{{0X}}.moengage.com/v1.0/custom-templates/sms' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Base64_ENCODED_APP_ID_APP_SECRET_KEY' \
--data '{
    "external_template_id": "ID_OF_TEMPLATE_TO_BE_UPDATED",
    "update_campaigns": false,
    "basic_details": {
        "message": "MESSAGE"
    },
    "meta_info": {
        "template_name": "NAME_OF_THE_TEMPLATE",
        "updated_by": "john.doe@yourbrand.com"
    }
}'

Sample Response

{
   "external_template_id": "eca024b7-a8ea-4f31-9154-5b80c85d18a9"
}

Sample Response for Invalid temnplate id
{
"error": {
   "code": "400 Bad Request",
    "message": "Invalid template id",
    "details": [
       {
          "code": "MissingValue",
          "target": "9925c8",
          "message": "9925c8 is invalid template id."
        }
     ],
     "request_id": "BTkUaYgU"
}
}

Sample Response for server side errors
{

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

Postman Collections

We have made it easy for you to test the APIs. Click here to view it in Postman.