Jump to Content
Home
User Documentation
API Documentation
Developer Documentation
Releases
Log In
API Documentation
Log In
Moon (Dark Mode)
Sun (Light Mode)
Home
User Documentation
API Documentation
Developer Documentation
Releases
Rich Text Meta
Search
All
Pages
Start typing to search…
JUMP TO
api documentation
Getting Started
Overview
Authentication
OAuth
Basic authentication
Auth for consumer or end-customer apps
Authorisation
Rate limits
API status codes
Timezone Management
Make your first API request
Customer (V1)
Add Customer
post
Update customer details
put
Update Customer Identifier
post
Search Customers
get
Get customer details
get
Get Customer Transactions
get
Get Customer Redemptions
get
Add/Update Customer Notes
post
Get Customer Notes
get
Get Customer Interactions
get
Get Referral Details
get
Add/Update Customer Preferences
post
Get Customer Preferences
get
Update Subscription Details
post
Get Subscription Details
get
Change identifier on Auth engine
post
Customer (V2)
Add Customer
post
Update Identifier/Issue Card
post
Upsert customer
post
Associate Customer
post
Get Customer Details
get
Get customer hierarchy in a user group
get
Update Customer Details
put
Update association details
put
Search Customers
get
Update Subscription Details
post
Get Subscription Details
get
Get Customer Tracker Details
get
Get Loyalty Events
get
Get Loyalty Details
get
Get Customer Tier
get
Get Detailed Customer Coupon Data
get
Get Retro Requests
get
Get Identifier Change Requests
get
Get Goodwill Requests
get
Add Customer Image
post
Delete Customer Image
delete
Link/Delink Card
post
Get Customer Status Log
get
Get Customer Subscription Log
get
Get Customer Image
get
Get user group customer tracker details
get
Get customer transactions
get
Get Customer Interactions
get
Status codes
Manual Tier Adjustment
post
Customer (V2 Lookup)
Update Customer Details
put
Get Customer Details
get
Get Customer ID
get
Update Customer Status
put
Get Subscription Details
get
Get Customer Loyalty Details
get
Get Retro Requests
get
Add Customer Image
post
Get Referrals (Lookup)
get
Get Customer Recommendations
get
Get Points Balance
get
Get Customer Tier
get
Get Points Conversion Schedule
get
Customer Labels
Add Labels
post
Get Org Labels
get
Tag Customers (to Labels)
post
Get Customer Labels
get
Search Customers by Label
get
Transaction
Transaction (V1)
Add Transaction
post
Add Transaction with Local Currency
post
Update Transaction Details
post
Cancel Transaction Lineitem
post
Get Transaction Details
get
Return Transaction
post
Retro Transaction
post
Transaction (V2)
Add/Return transaction (single)
post
Add/Return Transaction(bulk)
post
Update Transaction
put
Update Transactions in Bulk
put
Get Transaction Details
get
Get transaction details using bill number
get
Simulation transaction add
post
Expose Evaluation log for an event
post
Status codes
Transaction rejection
getRejectedTransactions
get
getReTriggerStatus
get
markFailed
put
retriggerTransactionAdd
post
Coupon
Coupon (V1.1 APIs)
Issue Coupon
Resend Coupon
get
Redeem Coupon
post
Get Coupon details
get
Get Customer Coupons
get
Is Coupon Redeemable
get
Get Coupon series details
get
Coupon (V2 APIs)
Create coupon series
post
Update coupon series
put
Get coupon series details
get
Issue single coupon
post
Issue bulk coupons
post
Issue multiple coupons to a customer from a series
post
Redeem single coupon
post
Redeem bulk coupons
post
Check if coupon is Redeemable
get
Reactivate redeemed coupon
post
Get coupon details
get
Get All Customer Coupons
get
Update coupon redeem field
put
Update coupon code expiry date
put
Revoke coupon
post
Coupon Upload (V1 APIs)
Upload Coupons (Batch)
post
Upload Redeemed Coupons
post
Get Uploaded Coupons' Status
get
Get Status of Redeemed Coupons
get
Cards
Generate Cards
post
Get Card Generation Log
get
Add Card (Single)
post
Update Card Details (Single)
put
Update Card Details (Bulk)
put
Get Card Details
get
Get Status Log
get
Limit Active Cards per Customer
post
Add Card Number to a Card Series
post
Add External Reference ID to Card
put
Points
Get Point Allocation Details by Event ID
get
Retrieve Expired Loyalty Points of a Customer
get
Retrieve Points‐Award Records Associated with a Specific Transaction ID
get
Get Custom Fields Associated with Coupon Redemption
get
Get Allocated Points Details with Expiry in Specified Date Range
get
Points (v2)
Request Goodwill points (Group)
post
Get Points Conversion Schedule
get
Get Points Balance
get
Get Points Transfer Summary
get
Get Points Expiry Schedule (Light API)
get
Get Points Expiry Schedule
get
Check if Points Transferable
post
Transfer Customer Points
post
Get Points Transfer Details
get
Reverse Redeemed Points
post
Group Points Transferrable
post
Transfer Group Points
post
Convert Promised Points
post
Update redeem points
put
Deduct points and alternate currencies from user
post
Deduct points and alternate currencies from user using userId
post
Points (v1.1)
Check If Points Redeemable
get
Issue Validation Code (to redeem points)
get
Redeem Points
post
Points Ledger
Get Customer Ledger Balance
get
Get Points Ledger Information
get
Get Points Ledger Explode info
get
Connected Org APIs
Get Points Ledger Information in Connected Orgs
get
Get Points Ledger Explode Info in Connected Orgs
get
Search APIs
Create search criteria
post
Retrieve search criteria details
get
Enable search index of older data
post
Perform search
post
Deactivate search criteria
delete
Create Data Field
post
Update Data Field
put
Get Data Field Detail
get
Perform Search (Cortex API)
post
Event Transformation for Cortex Search
Use Case
Quick Start
Enable or Update Custom Event Tranformation
post
Retrieve Custom Event Config Details for an Entity
get
Retrieve Custom Event Config Details of Org
get
FAQs
Best Practices
Badges
Create badges
post
Fixed Window Restriction in Badges
Update badges
put
Get badge by ID
get
Get all badges
get
Get fixed window details
get
Claim badge
post
Unclaim badge
post
Update activation status of badge
put
Enrol customers for badges
post
Issue badge (earn)
post
Multiple Badge Issuances
Issue badge to multiple customers
post
Import earned (issued) badges of customer
post
Revoke enrolled badges
post
Revoke issued badge
post
Get badges for customer
get
Get all customer badges
get
Get individual badge details of a customer
get
Create badges group
post
Update badges group
put
Get group by ID
get
Get all groups
get
Create custom field for badges
post
Update badge custom field
put
Get badge custom field by ID
get
Get all badge custom fields
get
Rewards Catalog
Reward Catalog Management
Create reward
post
Update Reward
put
Get reward details by ID
get
Adding revenue metadata against a reward
Reward Catalog Categories
Create Reward Category
post
Enable or Disable Reward Categories
put
Get Reward Category
get
Rich Text Content for Rewards
Create Rich Text Content Metadata for Rewards
post
Update Rich Text Content Metadata for Rewards
put
Get all Rich Text Content Metadata for specific brand
get
Adding Rich Text Content field for Reward
post
Reward Catalog Issuance
Issue single reward
post
Reward Issuance with Quantity and Redemption Value Details
Issue bulk reward
post
Idempotency Check for Issuing Reward
User-Centric Reward Queries
Get rewards for user
get
Get all reward transactions for a user
get
Get Reward Transaction Details using Reward Transaction ID
get
Get purchased rewards for user (New API)
get
Get available reward details for user by id
get
Brand-Level Reward Queries
Get all brand rewards using Brand ID
get
Get brand rewards
get
Get available brand rewards
get
Get Transaction Details by Customer ID and Reward Transaction ID
get
Reward Catalog Promotions
Create catalog promotion
post
Update catalog promotion
put
Get catalog promotion details
get
Get list of Catalog promotions
get
Disable Catalog promotion
put
Reward Catalog Custom Fields
Create custom field for reward
post
Update reward custom field
put
Get all custom fields
get
Reward Catalog Groups
Groups - Create reward group
post
Groups - Update rewards group
put
Groups - Get all rewards group
get
Groups - Get rewards group by ID
get
Points Restrictions
Points Restrictions - Create points restriction
post
Points - Update points restriction
put
Points - Get points constraints
get
Organization-Level Configuration
Organisation Level Configuration for Rewards Catalog
post
Get Organisation Level Configuration
get
Vendor Management & Redemption
Create a Vendor
post
Enable or Disable a Vendor
put
Get Vendor Details
get
Vendor List for Specific Brand
get
Update Vendor Redemption
put
Create Vendor Redemption
post
Get all vendor redemptions
get
Vendor Redemption Details by Redemption & Vendor ID
get
Get Vendor Redemption Details by Brand ID and Vendor ID
get
File Service
Upload images to file service
post
Fulfillment Status
Create fulfillment status
post
Update fulfillment status
put
Get fulfillment status
get
Update fulfillment status and transaction custom fields for issued rewards
put
Reward Expiry Reminders
Create Reward Expiry Reminder
post
Update Reward Expiry Reminder
put
Get Reward Expiry Reminder
get
Connected-Org APIs
Issue Reward in connected orgs
post
Get all available rewards for user in connected orgs
get
Get all reward transactions for a user in connected orgs
get
Get transaction details by reward transaction ID in connected orgs
get
Get purchased rewards for user in connected orgs
get
Get reward details by ID in connected orgs
get
Target/Milestone
Milestone & Streaks APIs
Create target groups
post
Update target group
put
Get target groups based on ID
get
Get associated target groups of a user
get
Get active targets
get
Get all target groups
get
Get target periods
get
Get targets details
get
Get target communication template
get
Upsert target communication
post
Get target channels
get
Delete target group
delete
Create target period
post
Update target period
put
Create targets (milestone)
post
Modify targets
put
Deactivate target
delete
Create unified target group
post
Update unified target
put
Create streaks
post
Edit streak
put
Create target based on Behavioural event
post
Create target based on EMF event
post
Create target group based on alternate currencies
post
Get all milestones (target)
get
Enrol/Re-enrol a customer to a milestone/streak
post
Unenrol users from a milestone and streak
post
Check the Validity of Milestone / Target Name
post
Get target events
get
User-Created Challenges
Connected Org APIs
Enroll/Re-Enroll a Customer to a Milestone or Streak
post
Unenroll a Customer to from Milestone or Streak
post
Get Associated Target Groups of a User
get
Data Scopes
Leaderboards
Get top ranked users
get
Get user rank across target groups
get
Loyalty Promotion
Introduction
Enrol/Issue Loyalty Promotion
post
Revoke Loyalty Promotions
post
Connected Org APIs
Get Loyalty Promotion List of a Customer (Connected Org)
get
User Created Challenge
Create Loyalty Promotion for UCC
post
Get details of all promotions
get
Get Promotion Details
Get Loyalty Promotion List for a Program
get
Get Loyalty Promotion by ID
get
Get Loyalty Promotions List for a Customer
get
Cart Promotions
Get Cart Promotion Settings
get
Get Cart Promotion Redemptions
get
Get Cart Promotions code API
get
Get Cart Promotions for a particular till
get
Get Lock unlock -Pending carts (Cart Promotion)
get
Get Cart Promotions Config API
get
Set Cart Promotion Settings
post
Earn Cart Promotion
post
Activate Cart Promotion
post
Deactivate Cart Promotion
post
Post Revoke Earned Cart Promotion
post
Post Earn Cart Promotions in Bulk
post
Evaluate Cart Promotions
post
Cancel Cart Evaluation - Cart Promotion
put
Post Cart Promotions Code link API
post
Get Cart Promotions for a Customer
get
Issue Cart Promotion
post
User Group
Add Group
post
Update User Group
put
Search user groups by name, ID, and mobile number
get
Delete User Group
delete
Join Member to Group
post
Remove group member
delete
Transfer Group Member
post
Get group transactions
get
Retrieve user group members list
get
Retrieve user group members list with cards & status details
get
Retrieve Primary & Secondary Member Details
get
Retrieve group slab/tier log history
get
Retrieve points expiry schedule of a group
get
Retrieve points conversion schedule
get
Status codes
Update permissions
put
Search for groups using the extended fields
post
Organization
Organization (V1)
Get Org Details
get
Get Org Entities
get
Get Org Configurations
get
Get Org Statistics
get
Get Top Selling Items
get
Get Org Custom Fields
get
Retrieve Brand ID
post
Get Org Payment Modes
get
Organization (V2)
Add Till
post
Update Till with Custom Fields
put
Get Custom Fields
get
Get Config Key Values
get
Get org till details
get
Get Active Tills
get
Get Loyalty Programs
get
Add Store
post
Retrieve org hierarchy details
get
Add Store in bulk
post
Get Till Id Details
Communications (v2)
Send communication message
post
Resend a communication message
post
Error code
Communications (v1)
Send communication message
post
Error code
Custom Fields
Create a Custom Field
post
Get Custom Fields
get
Tag Custom Field to an Entity
post
Audit logs
Get audit logs of entities
get
Get Audit Logs by event name
get
PII deletion
Add a PII deletion request
post
Update PII deletion status
put
Retrieve request status of PII deletion
get
Retrieve PII deletion request details
get
Error codes
Leads
Add Lead
patch
Add Lead Substatus
post
Update Lead Status
put
Update Lead Followups
post
Update Lead
put
Configure lead reasons
post
Get Lead Status Log
get
Get Lead follow-ups
get
Get Lead Reasons
get
Get Lead Details
get
Get Lead Substatus
get
Assign Lead
get
Search lead
get
Staff
Add Staff Account
post
Get Access Token
post
Edit Staff Details
post
Get Staff Details
get
Change Account Password
post
Send OTP
post
Validate OTP
post
Change Identifier (Send OTP)
post
Change Identifier (Validate OTP)
post
Transfer Staff User
post
Get Staff of Store/Zone
get
Logout Staff Account
get
Remove Staff Account
post
Behavioral Events
Create Event (Custom)
post
Update Event (Custom)
put
Get Org Events
get
Get Running Events Status
get
Get Customer Events
get
Disable Event
put
Add Webhook
post
Get Events Logs
get
Get Events Meta
get
Get event data using request ID
get
Search events
get
Post Event
post
Event notification logs
Get Event Log (by Request ID)
get
Get Event Log (by Reference ID)
get
Get Event Log (by Event ID)
get
Response code
Company
Add Company
post
Update Company
put
Get Company Details
get
Remove Company
delete
Get Org Companies
get
Get Companies by Extended Field Values
get
Request (V1)
Add Request
post
Approve Requests
post
Reject Requests
post
Get Request Details
get
Get Request Logs
get
Requests (V2)
Add Request
post
Update Request
put
Retrieve Request Status using ID
get
Retrieve Request Details using Type and Subtype
get
Status event notification
Error codes
(New) Request workflow
Create a request
Change customer status request
post
Points redemption request
post
Issue goodwill points request
post
Issue/Earn badge request
post
Enrol customers for badges
post
Retro transaction - Claim transaction
post
Approve or reject a request
put
Get details of all requests
get
Get details of a particular request
get
Error codes
Partner Program
Link Customer to Partner Program
post
Update Customer
post
Delink Customer
post
Get Customer Activity
get
Get customer activity history
get
User Authentication
Register User
post
Authorize User
post
Update Password
put
OTP
Generate OTP
post
OTP template guidelines
Validate OTP
post
Get OTP
get
Success and error codes
Product
Add Product
post
Get Product Details
get
Search Products
get
Add Product Attributes
post
Get Product Attributes
get
Get Product Categories
get
Get Product Brands
get
Get Product Colors
get
Get Product Sizes
get
Get Product Meta Sizes
get
Response codes
Store
Get Store Details
get
Get Store Staff Details
get
Get Store Tasks
get
Verify Store Login Credentials
get
Upload Store Logs
post
Upload Store Reports
post
Get Store Reports
get
Get Store Configurations
get
Verify Login Credentials
get
Store Locator API
Overview
Locate nearby stores
get
Retrieve Organization Sync Data
get
Store Locator Custom Fields
post
Retrieve Mapped Custom Field
get
Task
Add Tasks
post
Update Tasks
post
Get Tasks Metadata
get
Get Task Logs
get
Update Status Mappings
post
Get Status Mappings
get
Get Task Reminders
get
Create/Update Task Reminders
post
Retrieve Individual Task Details
get
Customer Authentication (Web/Mobile)
First factor authentication
Generate Authentication Token
post
Generate OTP
post
Validate OTP
post
Validate Password
post
Regenerate Authentication Token
post
Change Password
post
Forget Password
post
Status codes
Multi-factor authentication
Generate MFA token
post
Generate MFA OTP
post
Validate MFA OTP
post
MFA password flow
Regenerate token
post
Delete token
delete
Authentication configurations
Referral
Refer Customer
post
Get Referral Code
get
Validate Referral Code
get
DIY Template APIs
Create DIY Template
post
Retrieve Workspaces
get
Retrieve Blocks Supported by the Template
get
Private APIs
Other APIs
Get Transaction Earning
get
Trigger Walk-in Notifications on InStore
get
Update Currency Ratio
post
Generate Card/customer External ID
get
Configure Org Extended Field
post
Get Org Extended Fields
get
Create Store Associates
post
Feed (Scan Event)
post
Get Configured Card Limit per Customer
get
Get Org Sources
get
Get org configs
get
Retrieve extended field config details
get
Plugins
Shopify plugin
Magento plugin
Rich Text Support in Rewards API
Rich Text Meta
Rewards Core API
Rich Text
Rich Text Support in Rewards
Rich Text
Create Rich Text Meta
post
Powered by
Rich Text Meta
