Create SMS Template

This API creates an SMS template in MoEngage. It helps you upload templates created outside the MoEngage ecosystem to MoEngage and use them for campaign creation.

POST /custom-templates/sms

Create SMS Template

cURL

curl --request POST \
  --url https://api-{dc}.moengage.com/v1.0/custom-templates/sms \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "basic_details": {
    "message": "Hello {{UserAttribute['first_name']}}, your order is on its way!"
  },
  "meta_info": {
    "created_by": "[e-mail]",
    "template_id": "shipping_update_v1",
    "template_name": "Shipping Update Template",
    "template_version": "1"
  }
}
EOF

200

success

{
  "external_template_id": "d05a44f0-a7cf-471a-bcb6-63054800a367"
}

Rate Limit

The rate limit is 100 RPM. You can upload a maximum of 100 templates per channel.

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 details of the SMS template to be created.

basic_details · object · required

This field contains the basic details of the SMS template.

Show child attributes

meta_info · object · required

This field contains information about the template being created.

Show child attributes

Response

200

application/json

Success. This response is returned when the template is created successfully.

external_template_id · string<uuid>

This field contains the unique ID assigned to the newly created template by MoEngage.