Introduction

Trueloyal APIs are subject to rate limits to safeguard against spikes in traffic and ensure system stability. This document outlines Trueloyal's rate-limiting policies to help you use the Trueloyal API efficiently.

Rate Limits

Some API endpoints require stricter limits. So all API endpoints are grouped into categories for rate limiting. The rate limits apply on a category. Categories and the API limit to each category are listed below:

50 Write API requests per minute
50 Member Eligibility API requests per minute
100 General API requests per minute

If these limits are exceeded, the server will return an error with the "429 Too Many Requests" HTTP status code along with the following response body. Once this error is received, the API call should be retried using the “Exponential backoff retry” strategy.

Example response:

{
    "reason": "Rate limit exceeded",
    "error_code": "RATE_LIMIT_EXCEEDED",
    "success": false
}

📘
Please Note:

The rate limits mentioned apply to the standard plan. To check the rate limits applicable to your current plan, please write to your account manager at support@Trueloyal.com.

If you anticipate a surge in API requests due to any promotional activity or special campaigns, please notify us in advance. Send your request to your account manager to ensure smooth operation during high-traffic periods.

API Category

Write APIs

Create a Loyalty Member API
Update a Loyalty Member with Member ID
Update a Loyalty Member with Trueloyal Generated ID
Award Points
Redeem Points
Deduct Points
Return Points
Approve a Pending Award/Redeem Transaction using ID
Approve a Pending Award/Redeem Transaction using Unique Transaction Attribute
Reject a pending award/redeem transaction using ID
Reject a Pending Award/Redeem Transaction using Unique Transaction Attribute
Modify a pending Award Transaction with Transaction ID
Modify a pending Award Transaction using Unique Transaction Attribute
Reverse Points with Transaction ID
Reverse Points using Unique Transaction Attribute

Member Eligibility APIs

List all the Eligible Activities for a Member using Trueloyal Generated Member ID
List all the Eligible Activities for a Member using Member ID
Get Eligible Rewards with Member ID
Get Eligible Rewards with Trueloyal Generated Member ID

General APIs

Retrieve a Loyalty Member with Member ID
Retrieve a Loyalty Member with Trueloyal Generated ID
List Members
Delete a Loyalty Member with Member ID
Delete a Loyalty Member with Trueloyal Generated ID
List all activities
Retrieve an Activity using Activity ID
Retrieve an Activity using Trueloyal Generated ID
Retrieve Custom Attribute for an Activity using Activity ID
Retrieve Custom Attribute for an Activity using Trueloyal Generated ID
List All Rewards
Retrieve a Transaction with Transaction ID
Retrieve a Transaction using Unique Transaction Attribute
List all Transactions
List all Transactions with Member ID
List all Transactions with Trueloyal Generated Member ID
List all Tiers API