Jump to Content
Guides
API Reference
Changelog
v2.0
v3.0
Core API
UGC API
App Developer API
Help Center
API Reference
Search
Core API
UGC API
App Developer API
Help Center
v2.0
API Reference
Privacy
All
Pages
Start typing to search…
JUMP TO
General
Welcome
Authentication
Guidelines & Conventions
Actions
Record a Customer Action
post
Adjust a Customer's Point Balance
post
Remove a Customer from an Action Based VIP Tier
put
Customers
Create/Update Customer Records
post
Set Customer Birthday
post
Set/Update Customer Anniversary
post
Get Customer Anniversary
get
Remove Customer Anniversary
del
Fetch Customer Details
get
Fetch All Recently Updated Customers
get
Point Redemptions
Create Redemption
post
Approve Redemption Cancellation
post
Redemption Options
Upload Coupon Codes
post
Get Active Redemption Options
get
Get Redemption Code Data
get
Referrals
Identify Referrer
post
Send Referral Emails
post
Campaigns
Get Active Campaigns
get
Orders
Create Order
post
Refunds
Create Refund
post
VIP Tiers
Fetch VIP Tiers
get
Privacy
Data exists
get
User data
get
Anonymize user
del
Webhook Events
Intro to Webhook Events
Coupon Earned (Awarded)
Coupon Earned (Redeemed)
Custom Reward Redeemed
Customer Birthday
Customer Birthday Captured
Customer Anniversary
Customer Anniversary Captured
Donation Created
Loyalty Opt In / Out
Points Changed
Points Earned
Points Reminder
Points Expiration Reminder
Redemption Below Threshold
Redemption Cancellation Request
Redemption Reminder
Referral Link Share
Referral Link Share (New)
Referral Share Reminder
Referral Product Share Link
Referral Product Share Reminder
Referral Completed
Referral Completed (New)
VIP Tier Earned
VIP Tier Lost
VIP Tier Status Changed
Commerce Cloud Integration Disabled
Powered by
Privacy
Ask AI
Check for any existing user data in the Yotpo loyalty system.
