Adjust a Customer's Point Balance

post

https://loyalty.yotpo.com/api/v2/points/adjust

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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 reasons	Description	point_adjustment_amount	apply_adjustment_to_points_earned
Reward customer	Reward a customer with points.	Positive integer	TRUE
Refund points deducted by redemption/expiration	Reimburse a customer if they lost points due to a refund or points expiration.	Positive integer	FALSE
Redeem points for a discount	Use a customer's points in order to redeem a discount on their behalf.	Negative integer	FALSE
Remove earned points	Deduct points that were not supposed to be earned, for example - points earned for a purchase that was later refunded or cancelled.	Negative integer	TRUE
Expire points	Bypass the point expiration date set in your Loyalty & Referrals admin and expire them immediately.	Negative integer	FALSE

Body Params

customer_email

string

required

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

customer_id

string

The identifier used to uniquely identify the customer in your system. Required if implementing a generic e-commerce integration.

point_adjustment_amount

int32

required

The amount of points you wish to add or remove. Use a positive integer to add points (e.g., reward customer, refund points) or a negative integer to remove points (e.g., redeem for discount, remove earned points, expire points).

apply_adjustment_to_points_earned

boolean

Choose if this should also apply to the customer's total points earned value. Set to true when rewarding a customer or removing earned points. Set to false when refunding points deducted by redemption/expiration, redeeming points for a discount, or expiring points.

history_title

string

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

visible_to_customer

boolean

Defaults to true

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

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Adjustment use cases

200200

422422

423423