This guide explains how you can use API integration to connect your existing system—such as a CRM, loyalty program, or online store—to Heyloyalty. This allows you to create, edit, and delete members, as well as retrieve data from Heyloyalty.
Access to API Documentation
To get started with the integration, your developer needs access to Heyloyalty’s API documentation. Visit our API documentation here.
Managing Contacts via the API
With the API, you can manage contacts individually. Use API calls to create, edit, or delete individual members; see the documentation here.
Handling Contact Information
Gender
The API requires a specific notation for gender:
- 1 = Male / Man
- 2 = Female / Woman
- Tom = Not specified
Country
When you add a contact’s country via the API, you must use Heyloyalty country codes instead of standard country abbreviations.
Get a List of Country Codes:
- Make the following API call:
loyalty/v1/lists/{list_id} - This returns a list of Heyloyalty country codes.