v1

latestOpenAPI 3.1.02026-07-26620219.6 KB

Record Loyalty Customer Action

post/loyalty/v3/stores/store_id/custom_actions

Path parameters

account_idstring required

Your account's API app key

Query parameters

access_tokenstring

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

Request body

custom_actionobject

typestring required

The type of action. Almost always set this to CustomAction

customer_emailstring required

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

customer_idstring

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

action_namestring required

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

ip_addressstring

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

user_agentstring

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_atstring

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

reward_pointsstring

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

history_titlestring

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

Response

200

object required