Jump to Content

Guides API Reference Changelog

v2.0

Core API UGC API App Developer API Help Center

API Reference

Core API UGC API App Developer API Help Center

v2.0

All

Pages

Start typing to search…

General

Welcome
Authentication
Guidelines & Conventions

Actions

Record a Customer Actionpost
Adjust a Customer's Point Balancepost
Remove a Customer from an Action Based VIP Tierput

Customers

Create/Update Customer Recordspost
Set Customer Birthdaypost
Set/Update Customer Anniversarypost
Get Customer Anniversaryget
Remove Customer Anniversarydel
Fetch Customer Detailsget
Fetch All Recently Updated Customersget

Point Redemptions

Create Redemptionpost
Approve Redemption Cancellationpost

Redemption Options

Upload Coupon Codespost
Get Active Redemption Optionsget
Get Redemption Code Dataget

Referrals

Identify Referrerpost
Send Referral Emailspost

Campaigns

Get Active Campaignsget

Orders

Create Orderpost

Refunds

Create Refundpost

VIP Tiers

Fetch VIP Tiersget

Privacy

Data existsget
User dataget
Anonymize userdel

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

Welcome

Introduction to the Yotpo Loyalty API — integrate rewards, referrals, and customer incentives into your platform.