List Offer Templates

curl --request GET \
  --url https://api-{dc}.moengage.com/v5/offers/templates \
  --header 'Authorization: Basic <encoded-value>'

{
  "response_id": "resp_<trace-id>",
  "type": "template",
  "data": [
    {
      "id": "app_small",
      "value": "app_small",
      "label": "App small",
      "template_type": []
    }
  ],
  "pagination": {
    "next_cursor": null,
    "limit": 20,
    "has_more": false,
    "total_count": 1
  }
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "One or more fields failed validation.",
    "doc_url": "https://www.moengage.com/docs/api/offerings/offerings-overview",
    "details": [
      {
        "code": "OUT_OF_RANGE",
        "target": "limit",
        "message": "limit must be between 1 and 100."
      }
    ]
  },
  "response_id": "resp_<trace-id>"
}

"{\"code\":\"ER001\",\"target\":\"Authentication Invalid\",\"message\":\"Auth validation failed.\"}"

"{\"code\":\"ER001\",\"target\":\"Authentication Invalid\",\"message\":\"Auth validation failed.\"}"

{
  "response_id": "<string>",
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "doc_url": "https://www.moengage.com/docs/api/offerings/offerings-overview",
    "target": "<string>",
    "details": [
      {
        "code": "<string>",
        "target": "<string>",
        "message": "<string>"
      }
    ]
  }
}

"<html><body><h1>503 Service Temporarily Unavailable</h1></body></html>"

GET

offers

templates

List Offer Templates

curl --request GET \
  --url https://api-{dc}.moengage.com/v5/offers/templates \
  --header 'Authorization: Basic <encoded-value>'

{
  "response_id": "resp_<trace-id>",
  "type": "template",
  "data": [
    {
      "id": "app_small",
      "value": "app_small",
      "label": "App small",
      "template_type": []
    }
  ],
  "pagination": {
    "next_cursor": null,
    "limit": 20,
    "has_more": false,
    "total_count": 1
  }
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "One or more fields failed validation.",
    "doc_url": "https://www.moengage.com/docs/api/offerings/offerings-overview",
    "details": [
      {
        "code": "OUT_OF_RANGE",
        "target": "limit",
        "message": "limit must be between 1 and 100."
      }
    ]
  },
  "response_id": "resp_<trace-id>"
}

"{\"code\":\"ER001\",\"target\":\"Authentication Invalid\",\"message\":\"Auth validation failed.\"}"

"{\"code\":\"ER001\",\"target\":\"Authentication Invalid\",\"message\":\"Auth validation failed.\"}"

{
  "response_id": "<string>",
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "doc_url": "https://www.moengage.com/docs/api/offerings/offerings-overview",
    "target": "<string>",
    "details": [
      {
        "code": "<string>",
        "target": "<string>",
        "message": "<string>"
      }
    ]
  }
}

"<html><body><h1>503 Service Temporarily Unavailable</h1></body></html>"

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). Find it in the dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
Password: On your MoEngage workspace, navigate to Settings > Account > API keys. Use the Key listed within the Personalize tile.

For more information on authentication and getting your credentials, refer to Getting your credentials. Send the value in the Authorization header as Basic followed by Base64-encoding of appkey:apisecret (workspace ID and API key).

Headers

X-MOE-Request-Id

string<uuid>

Client-supplied trace ID (UUID v4). Echoed back in the X-MOE-Request-Id response header and in server logs. If omitted, the server generates a trace ID automatically.

Query Parameters

cursor

string

An opaque pagination token used to retrieve the next page of results.

Initial Request: Omit this parameter entirely on the first call to fetch the beginning of the list.
Subsequent Pages: Pass the exact string received from the next_cursor field of the immediate previous response.
Handling: Pass this token completely verbatim. Do not decode, alter, or modify the string in any way.

limit

integer

default:20

Number of templates per page. Default 20, maximum 100.

Required range: 1 <= x <= 100

Response

Paginated list of offer templates.

response_id

string

required

Stable trace identifier for this response. Format: "resp_" + X-MOE-Request-Id. Identical on retries that carry the same X-MOE-Request-Id header, enabling client-side deduplication and cross-log correlation.

type

enum<string>

required

Available options:

template

data

object[]

required

List of templates matching the applied pagination.

Show child attributes

pagination

object

required

Pagination metadata included in list responses.

Show child attributes

Update Offering Campaigns Overview

⌘I