Record Loyalty Customer Action

post

https://developers.yotpo.com/loyalty/v3/stores/store_id/custom_actions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This endpoint records an action performed by a customer. It will apply the action to all active custom action earning rules and award the necessary points and/or discounts.

📘
Please note:

The "created at" parameter will be used in the Get Customer Details call with the "withhistory" parameter.

Path Params

account_id

string

required

Your account's API app key

Query Params

access_token

string

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

Body Params

type

string

required

The type of action. Almost always set this to CustomAction

customer_email

string

required

The email address used to identify the customer who performed the action.

customer_id

string

The unique identifier of the customer who performed the action in your system. Required if no customer_email is passed.

action_name

string

required

The name of the action that was performed. This must match the name set for one of your custom action earning rules.

ip_address

string

The ip address of the user when the action was performed. This is required if this action completes a referral program requirement.

user_agent

string

The browser user agent of the user when the action was performed. This is strongly recommended if this action completes a referral program requirements.

created_at

string

The time the action was performed. This will default to the current time. Use this if you need to back date an action.

reward_points

string

Use this to override the normal amount of points awarded for performing the action. Will default to the earning rule settings otherwise.

history_title

string

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

Responses

Please note:

200200

400400