{"id":5123,"date":"2026-07-14T14:29:05","date_gmt":"2026-07-14T12:29:05","guid":{"rendered":"https:\/\/guides.heyloyalty.com\/help\/api-integrate-your-own-system-with-the-heyloyalty-api\/"},"modified":"2026-07-14T14:29:41","modified_gmt":"2026-07-14T12:29:41","slug":"api-integrate-your-own-system-with-the-heyloyalty-api","status":"publish","type":"ht_kb","link":"https:\/\/guides.heyloyalty.com\/en\/help\/api-integrate-your-own-system-with-the-heyloyalty-api\/","title":{"rendered":"API &#8211; Integrate your own system with the Heyloyalty API"},"content":{"rendered":"<div class=\"wp-block-post-date__modified-date wp-block-post-date\"><time datetime=\"2026-07-14T14:29:41+02:00\">14. July 2026<\/time><\/div>\n<p class=\"wp-block-paragraph\">This guide explains how you can use API integration to connect your existing system\u2014such as a CRM, loyalty program, or online store\u2014to Heyloyalty. This allows you to create, edit, and delete members, as well as retrieve data from Heyloyalty. <\/p>\n\n<h2 class=\"wp-block-heading\">Access to API Documentation<\/h2>\n\n<p class=\"wp-block-paragraph\">To get started with the integration, your developer needs access to Heyloyalty&#8217;s API documentation. Visit our<a href=\"https:\/\/documentation.heyloyalty.com\/\" data-type=\"link\" data-id=\"https:\/\/documentation.heyloyalty.com\/\" target=\"_blank\" rel=\"noreferrer noopener\"> <strong>API documentation here.<\/strong><\/a>  <\/p>\n\n<p class=\"wp-block-paragraph\"><\/p>\n\n<h2 class=\"wp-block-heading\">Managing Contacts via the API<\/h2>\n\n<p class=\"wp-block-paragraph\">With the API, you can manage contacts individually. Use API calls to create, edit, or delete individual members; <a href=\"https:\/\/documentation.heyloyalty.com\/#tag\/Contacts\" data-type=\"link\" data-id=\"https:\/\/documentation.heyloyalty.com\/#tag\/Contacts\" target=\"_blank\" rel=\"noreferrer noopener\">see the documentation here.<\/a> <\/p>\n\n<ol class=\"wp-block-list\"><\/ol>\n\n<h3 class=\"wp-block-heading\">Handling Contact Information<\/h3>\n\n<p class=\"wp-block-paragraph\"><strong><mark style=\"background-color:rgba(0, 0, 0, 0);color:#fc8d46\" class=\"has-inline-color\">Gender<\/mark><\/strong><\/p>\n\n<p class=\"wp-block-paragraph\">The API requires a specific notation for gender:<\/p>\n\n<ul class=\"wp-block-list\">\n<li><strong>1<\/strong> = Male \/ Man<\/li>\n\n\n\n<li><strong>2<\/strong> = Female \/ Woman<\/li>\n\n\n\n<li><strong>Tom<\/strong> = Not specified<\/li>\n<\/ul>\n\n<p class=\"wp-block-paragraph\"><strong><mark style=\"background-color:rgba(0, 0, 0, 0);color:#fc8d46\" class=\"has-inline-color\">Country<\/mark><\/strong><\/p>\n\n<p class=\"wp-block-paragraph\">When you add a contact&#8217;s country via the API, you must use Heyloyalty country codes instead of standard country abbreviations.<\/p>\n\n<p class=\"wp-block-paragraph\"><\/p><p><strong>Get a List of Country Codes:<\/strong><\/p>\n\n<ul class=\"wp-block-list\">\n<li>Make the following API call:  <code>loyalty\/v1\/lists\/{list_id}<\/code><\/li>\n\n\n\n<li>This returns a list of Heyloyalty country codes.<\/li>\n<\/ul>\n\n<ol class=\"wp-block-list\"><\/ol>\n","protected":false},"excerpt":{"rendered":"<p>This guide explains how you can use API integration to connect your existing system\u2014such as a CRM, loyalty program, or online store\u2014to 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&#8230;<\/p>\n","protected":false},"author":7,"comment_status":"closed","ping_status":"closed","template":"","format":"standard","meta":{"footnotes":""},"ht-kb-category":[73],"ht-kb-tag":[],"class_list":["post-5123","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-integrations-and-api"],"_links":{"self":[{"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/ht-kb\/5123","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/users\/7"}],"replies":[{"embeddable":true,"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/comments?post=5123"}],"version-history":[{"count":1,"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/ht-kb\/5123\/revisions"}],"predecessor-version":[{"id":5124,"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/ht-kb\/5123\/revisions\/5124"}],"wp:attachment":[{"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/media?parent=5123"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/ht-kb-category?post=5123"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/ht-kb-tag?post=5123"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}