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
Loyalty & ReferralsLoyalty & Referrals
API ReferenceChangelog
Core APIUGC APIApp Developer APIHelp CenterLoyalty & Referrals
API Reference
Core APIUGC APIApp Developer APIHelp Center

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 

Send Referral Emails

You can use the following methods to build a custom referral program experience for your customers. logged-out customers can still participate.

Updated about 1 year ago


Welcome
Did this page help you?

Updated about 1 year ago


Welcome
Did this page help you?