Overview
The MoEngage Coupon Management API allows you to organize and distribute unique, single-use coupon codes at scale. Use these endpoints to automate the lifecycle of coupon lists—from creation and file uploads to activation, archival, and detailed usage reporting.Authentication is handled via Basic Auth. Use your Workspace ID as the username and your API Key as the password.
Coupon API Endpoints
The Coupon Management API is categorized into three functional areas:Coupon Lists (Metadata & Status)
- Create a Coupon List - Define a new category for unique codes.
- Fetch All Coupon Lists - Retrieve a list of active or archived coupon containers.
- Fetch Coupon List Details - Get real-time counts of available vs. total coupons.
- Update a Coupon List - Modify names, expiry dates, or alert settings.
- Activate Coupon List - Reactivate archived lists with a new expiry date.
- Archive a Coupon List - Transition a list to inactive and delete associated codes.
Coupon Files (Inventory Management)
- Upload Coupon File - Populate a list via a hosted file URL.
- Fetch All Coupon Files - Track the status of all uploaded batches.
- Fetch a Coupon File - Check the processing status (e.g., PENDING) of a specific file.
- Delete a Coupon File - Remove specific batches (useful for correcting upload errors).
Reports
- Generate Usage Report - Request a CSV report sent via email detailing which user received which code.
Rate Limits & Constraints
Notes
Payload Limits:
- Manual uploads are limited to 64 MB.
- URL-based uploads are limited to 100 MB.
- Each coupon list can hold a maximum of 100 million codes.
- Creating a coupon list only creates the “container.” You must use the Upload Coupon File API to add actual codes before the list can be used in campaigns.
- When you archive a list, all coupon codes within that list are permanently deleted. Campaigns relying on this list will immediately stop being able to allocate codes.