Search SMS Templates

This API searches and retrieves a list of SMS templates, created in your MoEngage account, based on specified filter criteria.

POST /custom-templates/sms/search

Search SMS Templates

cURL

curl --request POST \
  --url https://api-{dc}.moengage.com/v1.0/custom-templates/sms/search \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "page": 1,
  "entries": 10,
  "template_source": [
    "API"
  ],
  "sort_params": [
    {
      "last_modified_date": "DESCENDING"
    }
  ]
}
'

200

{
  "data": [
    {
      "external_template_id": "b564524f-aa08-4149-a498-dbde0b7b3740",
      "version": 1,
      "basic_details": {
        "message": "Sample SMS Template message"
      },
      "meta_info": {
        "template_id": "CCIJASDA12345",
        "template_name": "CouponCodeTemplate1",
        "template_version": "1",
        "created_by": "Jane Doe",
        "channel": "SMS",
        "template_type": "CUSTOM"
      },
      "created_by": "Jane Doe",
      "created_at": "2023-02-27T12:33:05.575000",
      "updated_by": "John Doe",
      "updated_at": "2023-02-27T12:33:05.575000"
    }
  ]
}

Mandatory Pagination Update

We are introducing mandatory pagination, effective November 15, 2025, all calls to this API must include the following two parameters:

• page: The page number of the results you wish to fetch.
• entries: The number of templates to return per page, with a maximum value of 15.

Please update all integrations to include these parameters. API requests submitted without them after the effective date will result in an error and fail to execute.

Rate Limit

The rate limit is 100 RPM.

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

Use search filters to find SMS templates.

Notes:

• page and entries are mandatory effective November 15, 2025. All other fields are optional.
• You can send only template_ids if you want specific older versions of the SMS template. In other cases, you will receive the latest version of the template.

page · integer · default: 1 · required

This field contains the index of the pages to be returned in the search result

entries · integer · default: 15 · required

This field contains the number of templates to return per page.

Required range: x <= 15

template_name · string

This field indicates the name of the template. When this value is specified, the template that matches the name specified in this field will be returned (partial search is supported).

template_source · enum<string>[]

This field indicates the template source that created the template. When specified, templates whose source matches the one specified in this list will be returned.

Available options: API, MOENGAGE

template_type · enum<string>[]

This field indicates whether the template is a custom one or a pre-built one. When specified, templates whose template type matches the one specified in this list will be returned.

Available options: CUSTOM, PRE_BUILT

created_by · string<email>[]

This field indicates the user who created the template. When specified, the templates for which the created_by user information matches that specified in this list will be returned.

updated_by · string<email>[]

This field indicates the user who updated the template. When specified, the templates for which the updated_by user information matches that specified in this list will be returned.

sort_params · object[]

This field indicates the sorting parameters for the search result and the sort order.

Show child attributes

template_ids · object[]

This field indicates the list of template IDs that must be fetched. When this value is specified, the template that matches the ID specified in this field will be returned.

Show child attributes

Response

200

application/json

Search successful. Returns a list of templates.

data · object[]

Show child attributes