Yotpo Loyalty & Referrals integration
Yotpo Loyalty & Referrals runs a store's points, rewards and referral program. With this API an agent can look up a loyalty customer (point balance, VIP tier, referral link, history), create or update customers and their birthday, anniversary and tags, record orders, refunds and custom actions that earn points, adjust point balances, redeem points for a reward coupon, upload coupon codes, list campaigns, redemption options and VIP tiers, get a referrer's link and send referral invitations, and answer privacy requests (check, export, anonymize). There is no sandbox: every call reaches the live program, and orders, actions and refunds are processed asynchronously. The v3.0 routes are not exposed here: reward instances and the VIP tiers program need a Yotpo access token minted from the store's API secret, and product potential points live on a separate storefront host (its per-customer variant needs a hash of the customer's email and the API key). Webhook registration lives in the Yotpo Core API. Authentication is the Loyalty API key and GUID from the Loyalty admin Settings page, sent in the X-API-KEY and X-GUID headers.
Say what should happen.
The workflow builds itself.
What you can do with Yotpo Loyalty & Referrals
Each of these is one operation on one endpoint, available both as a workflow step and as a tool an AI agent can call on its own. Nothing bundles several operations into one action, so what a run did stays readable afterwards.
Most endpoints run on the free plan. A few, mainly the ones that publish on your behalf, need a paid plan.
Customer anniversary, 3 operations
get_customer_anniversaryGet customer anniversaryGETReturns a customer's stored anniversary date (day, month, optional year), identified by customer_email. Pass campaign_id to get the date as resolved for one anniversary campaign.remove_customer_anniversaryRemove customer anniversaryDELETEDeletes a customer's stored anniversary date, identified by customer_email. After removal the customer no longer triggers anniversary-based campaigns.set_customer_anniversarySet customer anniversaryPOSTStores or replaces a customer's anniversary date (signup, first purchase or any date meaningful to your program), used by anniversary campaigns. day and month are required, year is optional; calling again replaces the date.
Customer, 2 operations
get_customerGet customerGETReturns one loyalty customer: point balance, points earned and expiring, VIP tier, spend. Send exactly one of customer_email, customer_id, pos_account_id or phone_number; with_referral_code and with_history add referral link and history.upsert_customerUpsert customerPOSTCreates a loyalty customer, or updates the one with this email or id. Use it when a customer is added outside the store's platform or changes email. Sending tags overwrites the customer's existing tags.
Data, 2 operations
anonymize_customer_dataAnonymize customer dataDELETEIrreversibly anonymizes a person's personal data (email, name, phone number) in Yotpo Loyalty, for a data-deletion request. all_stores=true applies it to every store in the organisation, false to this store only.request_customer_data_exportRequest customer data exportGETStarts an asynchronous export of a person's Loyalty data for a privacy request. Nothing is returned here: Yotpo emails the data as a JSON file to the Loyalty account's own email address.
Redemption code, 2 operations
get_redemption_codeGet redemption codeGETReturns who redeemed a discount: the redemption code record with the email of the customer who redeemed it, by third_party_id or code (pass one). Use it at checkout to check the shopper is the one who redeemed the code.upload_coupon_codesUpload coupon codesPOSTUploads up to 10,000 comma-separated coupon codes to a coupon-type redemption option's pool (id from list_redemption_options). Codes are handed out one per redemption; an empty pool makes redemptions return the code Pending.
Action, 1 operation
record_custom_actionRecord custom actionPOSTRecords a custom action (survey, review, app install) for a customer and awards points from every active Custom Action campaign whose name matches action_name. Processed asynchronously; check with get_customer (with_history=true).
Add, 1 operation
add_customer_tagsAdd customer tagsPUTAdds one or more tags to a customer. Duplicate tags (case-insensitive) are ignored. A maximum of 20 tags can be added per request, each up to 64 characters.
Adjust, 1 operation
adjust_customer_pointsAdjust customer pointsPOSTAdds points (positive point_adjustment_amount) or removes them (negative) from a customer's balance outside campaign earning, for goodwill credits or corrections. The adjustment appears in the points history. A 423 means retry in a few seconds.
Campaign, 1 operation
list_campaignsList campaignsGETLists the active campaigns customers can take part in (earning rules, referral, birthday). With with_status=true and a customer_email or customer_id, each campaign also carries that customer's status and eligibility.
Cancel all, 1 operation
remove_customer_from_action_vip_tierRemove customer from action vip tierPUTRevokes a customer's action-based VIP tier status (the tier entered through an action-based earning rule). type must be EnterHighestTier; other values return 422. Pass customer_email or customer_id (one is required).
Cancellation completed, 1 operation
approve_redemption_cancellationApprove redemption cancellationPOSTConfirms a Redemption Cancellation Request webhook, so the customer gets the redeemed points back: the final step of invalidating an imported coupon code for the In-Store widget. Pass the webhook's redemption id and code.
Customer birthday, 1 operation
set_customer_birthdaySet customer birthdayPOSTStores a customer's birthday, which birthday campaigns use to award points or rewards on that day. day and month are required, year is optional; calling again overwrites the stored birthday. Pass customer_email or customer_id (one is required).
Customer tag, 1 operation
list_customer_tagsList customer tagsGETReturns the tags currently assigned to a customer. Pass customer_email or customer_id (one is required). Neither returns 422.
Exist, 1 operation
check_customer_data_existsCheck customer data existsGETChecks synchronously whether Yotpo Loyalty holds data for an email address (response.has_data true or false), for a privacy request.
Order, 1 operation
create_orderCreate orderPOSTRecords a customer's order, applies it to every matching active campaign and awards the points or discounts due. Processed asynchronously; check points with get_customer (with_history=true). Pass coupon_code to deduct a delayed redemption.
Recent, 1 operation
list_recently_updated_customersList recently updated customersGETLists the customers updated in the last 7 days with their loyalty data, up to 500 per page. To page, pass metadata.next_page_info from the previous answer as page_info; it is null on the last page.
Redemption, 1 operation
create_redemptionCreate redemptionPOSTRedeems a customer's points for a redemption option: checks eligibility and balance, deducts the points and returns the generated coupon code in reward_text. With delay_points_deduction=true the points come off only when an order uses the code.
Redemption option, 1 operation
list_redemption_optionsList redemption optionsGETLists the redemption options (rewards) customers can buy with points. Filter with is_offline, discount_type, or a customer (email, id or phone) to get only the options that customer qualifies for. Pass an option's id to create_redemption.
Referrer, 1 operation
get_or_create_referrerGet or create referrerPOSTFinds or creates the customer as a referrer and returns their referral link, referral discount code and referral history (referral_receipts: sign-ups and completed referrals). Safe to repeat: an existing referrer is returned, not duplicated.
Refund, 1 operation
create_refundCreate refundPOSTRecords a refund against an order created with create_order (same order_id); the points earned are adjusted. Processed asynchronously: a 200 acknowledges receipt. Stores on Salesforce Commerce Cloud use a separate refunds route not exposed here.
Remove, 1 operation
remove_customer_tagsRemove customer tagsPUTRemoves one or more tags from a customer. Matching is case-insensitive. A maximum of 20 tags can be removed per request.
Share, 1 operation
send_referral_emailsSend referral emailsPOSTEmails referral invitations, on the referrer's behalf, to the addresses in emails (one comma-separated string). Invalid invitees are rejected per address (SELF_REFERRAL, ALREADY_PURCHASED); 422 NO_LEGITIMATE_EMAILS means all were rejected.
Vip tier, 1 operation
list_vip_tiersList vip tiersGETLists the program's configured VIP tiers with each tier's id, name, points multiplier, rewards and entry, retain and regain thresholds.
Use Yotpo Loyalty & Referrals from Claude Code, Cursor or Codex
Connect Yotpo Loyalty & Referrals in LiveContext, create an API key in Settings, then add the LiveContext MCP server to your client. Its Yotpo Loyalty & Referrals operations become tools the client can call, next to every other integration you connected.
claude mcp add --transport http livecontext https://livecontext.ai/mcp --header "X-API-Key: YOUR_API_KEY"[mcp_servers.livecontext]
url = "https://livecontext.ai/mcp"
[mcp_servers.livecontext.http_headers]
"X-API-Key" = "YOUR_API_KEY"{
"mcpServers": {
"livecontext": {
"type": "http",
"url": "https://livecontext.ai/mcp",
"headers": {
"X-API-Key": "YOUR_API_KEY"
}
}
}
}How to connect Yotpo Loyalty & Referrals
- Create your workspace
Sign up free. Nothing to install.
- Connect Yotpo Loyalty & Referrals once
Add your Yotpo Loyalty & Referrals connection in Settings. Every tool from this integration reuses it, and secrets are encrypted at rest and visible only to you.
- Describe the job in chat
The workflow builds itself in front of you and picks the endpoints it needs. Drag the steps yourself on the canvas whenever you would rather be explicit.
Yotpo Loyalty & Referrals integration FAQ
What can you do with the Yotpo Loyalty & Referrals integration?
LiveContext exposes 27 operations on Yotpo Loyalty & Referrals, covering customer anniversary, customer, data and redemption code.
