For AI agents: visit https://loyaltyapi.yotpo.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Home Recipes API Reference Changelog

Core API UGC API App Developer API Help Center

API Reference

Core API UGC API App Developer API Help Center

Home Recipes API Reference Changelog

General

Welcome
Authentication
Guidelines & Conventions

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
Get Customer Tagsget
Add Customer Tagsput
Remove Customer Tagsput

Orders

Create Orderpost

Refunds

Create Refundpost

Actions

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

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

VIP Tiers

Fetch VIP Tiersget

Privacy

Data existsget
User dataget
Anonymize userdel

Webhook Events

Intro to Webhook Events

Powered by

API Responses

Requests are processed asynchronously. If you receive a HTTP 200 OK response you can assume the request was received and will be processed successfully.

Updated 8 months ago

Did this page help you?

Updated 8 months ago

Did this page help you?