updated
property
will be false
. Otherwise, they will be subscribed and the updated
property
will be true
.
In case it’s not possible to subscribe the customer, a 422
response will be
returned with a code
property indicating the reason.
If there are relevant rules applicable to the customer, such as a
newsletter_signup
rule, they will be triggered (unless they have already been
completed before), and any related actions will be included in the
actions
property in the response, such as points or rewards that were awarded.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
Your LoyaltyLion Site ID
The ID of the customer in your platform or ecommerce store.
For Shopify stores, you can pass either a GID or a regular numeric ID. If you do pass a GID you must encode it as a URL parameter, e.g. gid%3A%2F%2Fshopify%2FCustomer%2F1001
This must be a customer whose state is enrolled
1
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
200
The response is of type object
.