Record a Customer Action

post

https://loyalty.yotpo.com/api/v2/actions

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

Body Params

type

string

required

Defaults to CustomAction

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. Required if no customer_id is passed.

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 Campaigns.

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

int32

Use this to override the normal amount of points awarded for performing the action. Will default to the rules of the campaign otherwise.

history_title

string

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

Responses

Language

Credentials

Response

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

application/json

200200

400400

423423