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>"Fetch the personalization templates available in the workspace.
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>"Rate Limit
The rate limit is 150 requests per minute, 500 requests per hour, and 1000 requests per day per consumer.Authorizations
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 MoEngage dashboard at Settings > Account > API keys.
- Password: Use an API key from Settings > Account > API keys.
Refer to API Key Dashboard for details on creating and managing API keys.
Headers
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
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_cursorfield of the immediate previous response. - Handling: Pass this token completely verbatim. Do not decode, alter, or modify the string in any way.
Number of templates per page. Default 20, maximum 100.
1 <= x <= 100Response
Paginated list of offer templates.
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.
template List of templates matching the applied pagination.
Show child attributes
Show child attributes
Pagination metadata included in list responses.
Show child attributes
Show child attributes