Adjust a Customer's Point Balance

post

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

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

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200200

422422

423423