Your account's API app key

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

The type of action. Almost always set this to CustomAction

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

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

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

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

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

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

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

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