Adjust Loyalty Customer Points

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Adjustment use cases

When adjusting a customer's points, you can provide a positive or negative value depending on the reason for the adjustment.

Below is an overview of common adjustment reasons. You can provide different parameters, depending on the reason for the adjustment.

It's important to note that certain adjustments will only affect the customer's current point balance, while others will also affect their lifetime or total points earned.

Adjustment reasonDescriptionpoint_adjustment_amountapply_adjustment_to_points_earned
Reward customerReward a customer with pointsPositive integerTRUE
Refund points deducted by redemption/expirationReimburse a customer if they lost points due to a refund or points expirationPositive integerFALSE
Redeem points for a discountUse a customer's points in order to redeem a discount on their behalfNegative integerFALSE
Remove earned pointsDeduct points that were not supposed to be earned, for example - points earned for a purchase that was later refunded or cancelledNegative integerTRUE
Expire pointsBypass the point expiration date set in your Loyalty & Referrals admin and expire them immediatelyNegative integerFALSE
👍

How to use this endpoint

Requests for this endpoint are limited to 100 requests/minute, per app key.

Path Params
string
required

Your account's API app key

Query Params
string

Your Yotpo access token. Click here to learn how to generate one

Body Params
string
required

The customer's email address. Required if no customer_id is passed.

string
required

Use this to override the normal description shown to the user in their history. Will default to the campaign settings otherwise.

int32
required

The amount of points you wish to add or remove. You can also provide a negative points value.

string

Choose whether the adjustment is visible to the customer on-site.

boolean

Choose if this should also apply to the customer's total points earned value.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json