custom
rule for an enrolled
customer.
This can be called once a customer has completed the relevant activity on your
store to award them with points or a reward based on the custom rule’s
configured settings.
For example, if you have a custom rule for encourage providing feedback on your
store, you could call this endpoint once the customer has provided feedback.
If the customer is able to complete the rule, a success response will be
returned. This response will include a list of actions
which will indicate any
points or rewards that were awarded based on the rule’s configuration.
If the customer is not able to complete the rule, a 422
response will be
returned instead. For example, if the customer has already completed the rule
an allowed number of times, or the rule isn’t enabled for the customer.Authorizations
An API key linked to a Program in LoyaltyLion, with a set of permissions (scopes). API keys can be created manually, or acquired through an OAuth2 flow. The API key should be provided as a Bearer
token in the Authorization
header
Path Parameters
Your LoyaltyLion Site ID
Query Parameters
The sales channel from which this request is made. Must be provided as this query parameter, or the X-LoyaltyLion-Channel
header
web
, pos
, mobile
Body
Body
The LoyaltyLion ID of the rule to complete
Response
200
A list of actions that resulted from the rule's completion, such as points or rewards being awarded
The customer object, updated as of the rule action, i.e. their history, points, and rewards will include any new actions as a result of completing the rule. This customer will always have state
set to enrolled
, as only enrolled customers can complete rules