Manage > API keys
, then click Create API key
and follow the steps to create a new API key with the permissions you need.
The API token will be displayed after creation; be sure to save it in a secure location as it cannot be seen again.
Bearer
token in the Authorization
header of your request.
*_customers
scopes will not be able to register a customers/update
webhook.
Scope | Description |
---|---|
read_customers | Read-only access to customers, including their points, tiers, rewards and activities. Doesn’t include orders. |
write_customers | Read and write access to customers. Can add and remove customer points, change tiers and trigger customer activities. |
read_unsubscribes | Read-only access to the loyalty email unsubscribes list and unsubscribes webhook |
write_unsubscribes | Read and write access to the loyalty email unsubscribes list. Can add emails to the list. |
read_orders | Read-only access to orders. |
write_orders | Read and write access to orders. Can create, update and cancel orders. |