v1

latestOpenAPI 3.1.02026-07-26620219.6 KB

Adjust Loyalty Customer Points

post/loyalty/v3/stores/:store_id/points/adjust

account_idstring required

Your account's API app key

access_tokenstring

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

customer_emailstring required

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

history_titlestring required

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

point_adjustment_amountinteger required

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

visible_to_customerstring

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

apply_adjustment_to_points_earnedboolean

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

200

object required