Create a points event for a customer

post

https://developer-api.rivo.io/merchant_api/v1/points_events

Create a points event to adjust a customers points balance.

Form Data

customer_identifier

string

required

Shopify Customer ID or Email

source

string

enum

required

Source associated with the points event. Choose manual by default.

points_amount

int32

Number of points. Use positive numbers to add points and negative numbers to subtract points. Required when source is manual.

credits_amount

float

Number of credits. Use positive numbers to add credits and negative numbers to subtract credits. Required when source is manual.

skip_email

boolean

If an email was supposed to be sent for earning points - we'll skip it if you pass this as true.

internal_note

string

Internal facing note on why the points were granted. Customers WONT see this.

external_note

string

External facing note on why the points were granted. Customers WILL see this.

applied_at

date-time

Time the event took place. Defaults to the current time if left blank

custom_action_name

string

Required when creating a points event for a custom action or visit URL. Pass the Custom Action Name you created in the app here, or provide the URL for the visit url.

Headers

Authorization

string

required

Merchant Auth Token

Response

201

Create a points event to adjust a customers points balance.

Language

Response

Click Try It! to start a request and see the response here!