{"id":755,"date":"2025-08-11T14:31:29","date_gmt":"2025-08-11T14:31:29","guid":{"rendered":"https:\/\/rs.quarticon.com\/qon-api-contact-synchronisation-en\/"},"modified":"2025-08-12T15:38:16","modified_gmt":"2025-08-12T15:38:16","slug":"qon-api-contact-synchronisation-en","status":"publish","type":"post","link":"https:\/\/help.quarticon.com\/pl\/qon-api-contact-synchronisation-en\/","title":{"rendered":"QON API contact synchronisation (EN)"},"content":{"rendered":"<article class='jsx-ef86202475c6562f '>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p><b>Authentication<\/b><\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>All requests to the API are authenticated by providing your API key. The API key should be provided as an HTTP header named Api-Token.<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-code'>\n<pre>Header<br>curl -H 'Api-Token: YOUR_TOKEN' https:\/\/account.api-us1.com\/api\/3\/<\/pre>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Your API key can be found in your account on the <b>Settings <\/b>page under the <b>Developer <\/b>tab. Each user in your Quarticon CDXP account has their own unique API key.<\/p>\n<\/div>\n<div class='intercom-interblocks-table'>\n<table>\n<tbody>\n<tr>\n<td>\n<div class='intercom-interblocks-subheading intercom-interblocks-align-left'>\n<h3 id='h_c1f34dff01'>Remember to keep your API key secret. Do not share it and take care not to expose it publicly in client-side code.<\/h3>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p><b>Base URL<\/b><\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>The API is accessed using a base URL that is specific to your account. In the examples provided in this documentation, we use the URL youraccountname.api-us1.com as a stand-in for your real account API URL. Your API URL can be found in your account on the <b>My Settings<\/b> page under the <b>Developer <\/b>tab. In addition, URL paths should begin with <i>\/api\/3<\/i> to specify version 3 of the API. Generally, the URL will be in the form:<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p><i>https:\/\/{account}.api-us1.com\/api\/3\/{endpoint}<\/i><\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>You have to log in into your account on Quarticon CDXP, go to the page <b>Settings<\/b> \u2192 <b>Developer <\/b>and insert data appropriately:<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-image intercom-interblocks-align-left'><a href='https:\/\/cdn.quartic.com.pl\/howtoimg\/i\/o\/548813833\/f05778c5d6110a5662c463b3\/P3Ia1hZnE5Xywr3JS1LsOA1kwmVU0GNVCEwr_cFiQVv7YUXdKof2dje1laLt_BnEXBkkRfCuYF1MHO7prrJz6wZshex5U9q9ciChqnJgOUPN56sWhV2WqUADZTW5bNs_Mwuhukgo4jDCFclobQ' target='_blank' rel='noreferrer nofollow noopener'><img src='https:\/\/cdn.quartic.com.pl\/howtoimg\/i\/o\/548813833\/f05778c5d6110a5662c463b3\/P3Ia1hZnE5Xywr3JS1LsOA1kwmVU0GNVCEwr_cFiQVv7YUXdKof2dje1laLt_BnEXBkkRfCuYF1MHO7prrJz6wZshex5U9q9ciChqnJgOUPN56sWhV2WqUADZTW5bNs_Mwuhukgo4jDCFclobQ'><\/a><\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>All API calls should be made over HTTPS.<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p><b>Rate Limits<\/b><\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Our API has a rate limit of 5 requests per second per account.<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-subheading intercom-interblocks-align-left'>\n<h3 id='h_294a3aef42'><b>Property<\/b><\/h3>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>The data type of the value stored in the field. Valid types are currency, date, datetime, number, text, and textarea.<\/p>\n<\/div>\n<div class='intercom-interblocks-table'>\n<table>\n<tbody>\n<tr>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p><b>Type Name<\/b><\/p>\n<\/div>\n<\/td>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p><b>Description<\/b><\/p>\n<\/div>\n<\/td>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p><b>Notes<\/b><\/p>\n<\/div>\n<\/td>\n<\/tr>\n<tr>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>text<\/p>\n<\/div>\n<\/td>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>A short text field<\/p>\n<\/div>\n<\/td>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Limited to 65,535. Longer strings will not be saved.<\/p>\n<\/div>\n<\/td>\n<\/tr>\n<tr>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>textarea<\/p>\n<\/div>\n<\/td>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>A text field of any length<\/p>\n<\/div>\n<\/td>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<\/td>\n<\/tr>\n<tr>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>number<\/p>\n<\/div>\n<\/td>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>An integer or decimal number<\/p>\n<\/div>\n<\/td>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Number of decimals saved can be defined with the additional scale field. Scale can be set to 0 to denote integer values \u2013 this is the default.<\/p>\n<\/div>\n<\/td>\n<\/tr>\n<tr>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>datetime<\/p>\n<\/div>\n<\/td>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>A valid <a href='https:\/\/en.wikipedia.org\/wiki\/ISO_8601' rel='nofollow noopener noreferrer' target='_blank'>ISO8601<\/a> date time string (e.g. 2021-08-13T17:51:44+00:00)<\/p>\n<\/div>\n<\/td>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<\/td>\n<\/tr>\n<tr>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>date<\/p>\n<\/div>\n<\/td>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>A date string in the format YYYY-MM-DD (e.g. 2011-12-23)<\/p>\n<\/div>\n<\/td>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<\/td>\n<\/tr>\n<tr>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>dropdown<\/p>\n<\/div>\n<\/td>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>A field to capture a single value from a predefined list of options.<\/p>\n<\/div>\n<\/td>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Options need to be defined in the additional options field.<\/p>\n<\/div>\n<\/td>\n<\/tr>\n<tr>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>multiselect<\/p>\n<\/div>\n<\/td>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>A field to capture multiple values from a predefined list of options.<\/p>\n<\/div>\n<\/td>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Options need to be defined in the additional options field.<\/p>\n<\/div>\n<\/td>\n<\/tr>\n<tr>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>currency<\/p>\n<\/div>\n<\/td>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>A value containing numbers representing a currency value.<\/p>\n<\/div>\n<\/td>\n<td>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>The value is a three-character <a href='https:\/\/en.wikipedia.org\/wiki\/ISO_4217' rel='nofollow noopener noreferrer' target='_blank'>ISO 4217<\/a> currency code. The value defaults to 'USD&#8217;.<\/p>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<div class='intercom-interblocks-heading intercom-interblocks-align-left'>\n<h2 id='h_6f1b507bd4'>How to synchronise contact database?<\/h2>\n<\/div>\n<div class='intercom-interblocks-subheading intercom-interblocks-align-left'>\n<h3 id='h_12b554e4eb'><b>1. Create a contact<\/b><\/h3>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Here are the list of standard fields:<\/p>\n<\/div>\n<div class='intercom-interblocks-unordered-nested-list'>\n<ul>\n<li>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p><b>email string (required)<\/b><\/p>\n<\/div>\n<\/li>\n<\/ul>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>E-mail address of the new contact. Example: &#8217;<a href='mailto:test@example.com' rel='nofollow noopener noreferrer' target='_blank'>test@example.com<\/a>&#8217;<\/p>\n<\/div>\n<div class='intercom-interblocks-unordered-nested-list'>\n<ul>\n<li>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p><b>firstName string<\/b><\/p>\n<\/div>\n<\/li>\n<\/ul>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>First name of the new contact.<\/p>\n<\/div>\n<div class='intercom-interblocks-unordered-nested-list'>\n<ul>\n<li>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p><b>lastName string<\/b><\/p>\n<\/div>\n<\/li>\n<\/ul>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Last name of the new contact.<\/p>\n<\/div>\n<div class='intercom-interblocks-unordered-nested-list'>\n<ul>\n<li>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p><b>phone string<\/b><\/p>\n<\/div>\n<\/li>\n<\/ul>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Phone number of the contact.<\/p>\n<\/div>\n<div class='intercom-interblocks-unordered-nested-list'>\n<ul>\n<li>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p><b>fieldValues array<\/b><\/p>\n<\/div>\n<\/li>\n<\/ul>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Contact&#8217;s custom field values [{field id, value}]<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-code'>\n<pre>curl -X POST https:\/\/domena_klienta_api\/api\/3\/contact\/sync <br>-H 'Api-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' <br>-d '{<br> 'contact': {<br> 'email': 'johndoe@example.com',<br> 'firstName': 'John',<br> 'lastName': 'Doe',<br> 'phone': '7223224221',<br> 'fieldValues':[<br> {<br> 'field':'1',<br> 'value':'Contact Street'<br> },<br> {<br> 'field':'2',<br> 'value':'Contact zip Code'<br> },<br> {<br> 'field':'3',<br> 'value':'Contact City'<br> },<br> {<br> 'field':'7',<br> 'value':'Male'<br> }<br> ]<br><br>}}'<\/pre>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-subheading intercom-interblocks-align-left'>\n<h3 id='h_852e33d07d'>2. <b>List all custom fields<\/b> <\/h3>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>IDs of custom fields are provided in a separate xls document by Quarticon Team. However you can generate the field.id by executing the following request:<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-code'>\n<pre>curl --request GET <br> --url 'https:\/\/youraccountname.api-us1.com\/api\/3\/fields?limit=100' <br> --header 'Accept: application\/json' <br> --header 'api-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'<\/pre>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>In the response you will find a Field id in <b>Fields.ID.<\/b><\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-subheading intercom-interblocks-align-left'>\n<h3 id='h_f1e6bee0d5'>3. <b>Update a contact<\/b> <\/h3>\n<\/div>\n<div class='intercom-interblocks-code'>\n<pre>curl -X PUT https:\/\/domena_klienta_api\/api\/3\/contact\/sync <br>-H 'Api-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' <br>-d '{<br> 'contact': {<br> 'email': 'johndoe@example.com',<br> 'firstName': 'John',<br> 'lastName': 'Doe',<br> 'phone': '7223224221',<br> 'fieldValues':[<br> {<br> 'field':'1',<br> 'value':'Contact Street'<br> },<br> {<br> 'field':'2',<br> 'value':'Contact zip Code'<br> },<br> {<br> 'field':'3',<br> 'value':'Contact City'<br> },<br> {<br> 'field':'7',<br> 'value':'Male'<br> }<br> ]<br><br>}}'<\/pre>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-subheading intercom-interblocks-align-left'>\n<h3 id='h_0a23524f8f'><b>4. Assigning a contact to the Account or LIST (Consent)<\/b><\/h3>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Quarticon configures the accounts and lists in Quarticon CDXP panel. <\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>For assigning a contact to the account or list you need to get the Contact.ID. <\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Please execute the following request to get the Contact.ID based on e-mail address.<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-code'>\n<pre>curl https:\/\/domena_klienta_api\/api\/3\/contacts?email=second@somewhere.com<br> -H 'Accept: application\/json,<br> Api-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ' <\/pre>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-subheading intercom-interblocks-align-left'>\n<h3 id='h_3bce64e9f2'><b>4.1. Assigning to the account<\/b><\/h3>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>IDs of accounts (there should be separated account per each shop or domain) are provided in a separate document by Quarticon Team. <\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-image intercom-interblocks-align-left'><a href='https:\/\/cdn.quartic.com.pl\/howtoimg\/i\/o\/548813838\/bf4088b54c80263539f7a138\/N1DuhhXCh9riFu2i20tfEkcCBDU6IPX4YEndMBx2ZVyWFloSHfsQe8tNc0Y52kjKszpQaUF9wRRVjGB7mqMvm6zU2ikSLeo_eZgtMmQpmTMC4KWEDqnqR8Q-Mk37Xt1HL-koHMIWjSJg476usmY' target='_blank' rel='noreferrer nofollow noopener'><img src='https:\/\/cdn.quartic.com.pl\/howtoimg\/i\/o\/548813838\/bf4088b54c80263539f7a138\/N1DuhhXCh9riFu2i20tfEkcCBDU6IPX4YEndMBx2ZVyWFloSHfsQe8tNc0Y52kjKszpQaUF9wRRVjGB7mqMvm6zU2ikSLeo_eZgtMmQpmTMC4KWEDqnqR8Q-Mk37Xt1HL-koHMIWjSJg476usmY'><\/a><\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Please execute the following request due to assigning the contact to the account:<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-code'>\n<pre>curl -X POST https:\/\/domena_klienta_api\/api\/3\/accountContacts <br>-H 'Api-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' <br>-d '{<br>'accountContact': {<br>'contact': contact.id,<br>'account': 1<br>}<br>}'<\/pre>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-subheading intercom-interblocks-align-left'>\n<h3 id='h_4c1798a412'><b>4.2 Consents; Subscribing to the lists<\/b><\/h3>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>IDs of lists are provided in a separate document by Quarticon Team:<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-image intercom-interblocks-align-left'><a href='https:\/\/cdn.quartic.com.pl\/howtoimg\/i\/o\/548813842\/5d1e0ce8a6baa92e9d396b51\/N8PWMaF1_ZJazk2Pn0B3AS3eYiSICWHHzbrt-1j90JQoNBsRIAD8VAN07WEgSfOQz5tklDlZINPh9fZnWtRbGwsn5F5cCzEsO3yLCZOvssgaLSnZvyzj-KSj-JGcoDoT8s1V-QnysIaA5qUNHQ0' target='_blank' rel='noreferrer nofollow noopener'><img src='https:\/\/cdn.quartic.com.pl\/howtoimg\/i\/o\/548813842\/5d1e0ce8a6baa92e9d396b51\/N8PWMaF1_ZJazk2Pn0B3AS3eYiSICWHHzbrt-1j90JQoNBsRIAD8VAN07WEgSfOQz5tklDlZINPh9fZnWtRbGwsn5F5cCzEsO3yLCZOvssgaLSnZvyzj-KSj-JGcoDoT8s1V-QnysIaA5qUNHQ0'><\/a><\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Please execute the following request due to assigning the contact to the proper list:<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p><b>Consent to market communication<\/b><\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-code'>\n<pre>Status = 0 Uncofirmed, <br>Status = 1 Subscribed, <br>Status = 2 Unsubscribed, <br><br>curl -X POST https:\/\/domena_klienta_api\/api\/3\/contactLists<br>-H 'Api-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' <br>-d '{<br> 'contactList': {<br> 'list': 1,<br> 'contact': contact.id,<br> 'status': 1<br> }<br>}'<\/pre>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-subheading intercom-interblocks-align-left'>\n<h3 id='h_698cd490e4'><b>5. Deleting<\/b><\/h3>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Please execute the following request due to delete the contact from the the system:<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-code'>\n<pre>curl --request DELETE <br> --url https:\/\/youraccountname.api-us1.com\/api\/3\/contacts\/contact.id <br> --header 'Accept: application\/json' <br> --header 'api-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'<\/pre>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p><b>Webhook \u2013 Quarticon CDXP notifies about contact data change or events<\/b><\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Webhooks provide the ability to receive real-time data updates about your contact.<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Choose to receive data based on certain actions (subscribes, unsubscribes, update, etc.) and have all applicable data sent to a URL of your choice. You can then use your own custom script to read, save, and do whatever you want with that data. This is a powerful option that allows you to keep all of your data in sync and opens up the possibility of all sorts of integration options.<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>With every webhook you create you can choose when it should actually fire. Perhaps you only want to receive data when a contact is added from the API. You can simply specify subscribe as the event and api as the source when you create your webhook. You can specify multiple events and sources for each webhook if you wish. All event and source options are listed below.<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>We strive to have \u201cat least one\u201d webhook event delivered. There are times that you could receive a webhook event more than once, so it\u2019s important to create an idempotent system.<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p><b>Adding Webhook from Quarticon CDXP panel <\/b><\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Webhooks are automated messages sent from the system when something happens. There should be at least one webhook configured for the event \u201cUnsubscription\u201d.<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>To set up webhook please login to the Quarticon CDXP panel and click:<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p><b>Settings<\/b> -&gt;<b>Developer<\/b>.<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Then click in right corner at the top <b>Manage Webhooks<\/b>.<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-image intercom-interblocks-align-left'><a href='https:\/\/cdn.quartic.com.pl\/howtoimg\/i\/o\/548813848\/eaf690cf1d6e370ae7b4ab30\/W7MZJpg36sPyAzhqcK42300S5xaTGk4vmPR_0AezlAJLutOeCTGn0SO2r2Z-6954k4PGnbTnFdmq_FIxq1bD87v8LPeR-iADi04169Zw3BIbXFMrLUelJkpwYVFBR2CEv8alPd-1wfbT8eEl0Q' target='_blank' rel='noreferrer nofollow noopener'><img src='https:\/\/cdn.quartic.com.pl\/howtoimg\/i\/o\/548813848\/eaf690cf1d6e370ae7b4ab30\/W7MZJpg36sPyAzhqcK42300S5xaTGk4vmPR_0AezlAJLutOeCTGn0SO2r2Z-6954k4PGnbTnFdmq_FIxq1bD87v8LPeR-iADi04169Zw3BIbXFMrLUelJkpwYVFBR2CEv8alPd-1wfbT8eEl0Q'><\/a><\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Here you can find all previously configured webhooks.<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Click <b>Add <\/b>for adding a new one.<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-image intercom-interblocks-align-left'><a href='https:\/\/cdn.quartic.com.pl\/howtoimg\/i\/o\/548813852\/d21001b24763ab8b00ec5aa6\/Tw4J8pjMkVh5ejdP6Ahwh-D3aMTzQzXYjSFLq9ZfLl7Jo87bDzhgAboY7UPlmcX6S59ykFvM6XiWJeXM9_Cn8_nNhAnqofxHf9mU7Rx36YLtGPt6-jLCkjUneQG6xVHWeIq1_1b26iOQ8x1dKg' target='_blank' rel='noreferrer nofollow noopener'><img src='https:\/\/cdn.quartic.com.pl\/howtoimg\/i\/o\/548813852\/d21001b24763ab8b00ec5aa6\/Tw4J8pjMkVh5ejdP6Ahwh-D3aMTzQzXYjSFLq9ZfLl7Jo87bDzhgAboY7UPlmcX6S59ykFvM6XiWJeXM9_Cn8_nNhAnqofxHf9mU7Rx36YLtGPt6-jLCkjUneQG6xVHWeIq1_1b26iOQ8x1dKg'><\/a><\/div>\n<div class='intercom-interblocks-unordered-nested-list'>\n<ul>\n<li>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Every webhook has to be connected with lists \u2013 it is possible to choose one list or all lists. The exception is a webhook with creation of a new list;<\/p>\n<\/div>\n<\/li>\n<li>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Name \u2013 name of webhook;<\/p>\n<\/div>\n<\/li>\n<li>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>URL \u2013 the address, where webhook is to be sent;<\/p>\n<\/div>\n<\/li>\n<li>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Type \u2013 the events which call out the webhook.<\/p>\n<\/div>\n<\/li>\n<\/ul>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>Key events are highlighted with yellow colour:<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-image intercom-interblocks-align-left'><a href='https:\/\/cdn.quartic.com.pl\/howtoimg\/i\/o\/548812279\/93c6c3b1ef83cf6ee07a3ed4\/image.png' target='_blank' rel='noreferrer nofollow noopener'><img src='https:\/\/cdn.quartic.com.pl\/howtoimg\/i\/o\/548812279\/93c6c3b1ef83cf6ee07a3ed4\/image.png' width='455' height='693'><\/a><\/div>\n<div class='intercom-interblocks-image intercom-interblocks-align-left'><a href='https:\/\/cdn.quartic.com.pl\/howtoimg\/i\/o\/548812438\/dfc50c583c9ef5eba7e1aa33\/image.png' target='_blank' rel='noreferrer nofollow noopener'><img src='https:\/\/cdn.quartic.com.pl\/howtoimg\/i\/o\/548812438\/dfc50c583c9ef5eba7e1aa33\/image.png' width='409' height='172'><\/a><\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p><b>Webhook can be configured with API:<\/b><\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>WEBHOOK OBJECT<\/p>\n<\/div>\n<div class='intercom-interblocks-unordered-nested-list'>\n<ul>\n<li>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>name string required<\/p>\n<\/div>\n<\/li>\n<\/ul>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>A name (or label) to give this webhook.<\/p>\n<\/div>\n<div class='intercom-interblocks-unordered-nested-list'>\n<ul>\n<li>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>url string required<\/p>\n<\/div>\n<\/li>\n<\/ul>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>The URL where the webhook will send the POST request when the event occurs.<\/p>\n<\/div>\n<div class='intercom-interblocks-unordered-nested-list'>\n<ul>\n<li>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>events array of strings required<\/p>\n<\/div>\n<\/li>\n<\/ul>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>The event(s) that will trigger the webhook to fire.<\/p>\n<\/div>\n<div class='intercom-interblocks-unordered-nested-list'>\n<ul>\n<li>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>sources array of strings required<\/p>\n<\/div>\n<\/li>\n<\/ul>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>The source(s) causing an event to occur.<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>The example of webhook request is below:<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-code'>\n<pre>{<br>'contact':{<br> 'customer_acct_name' : '',<br> 'email': 'jan@testowy.pl',<br> 'first_name': 'jan',<br> 'id': 4,<br> 'ip': '0.0.0.0',<br> 'last_name':'test',<br> 'orgname': '',<br> 'phone':'+48555555555',<br> 'tags':''<br>},<br>'list':[<br> {<br> 'id': 0,<br> 'name': 'Lista testowa'<br> }<br>],<br>'tags':'',<br>'customer_acct_id': 0,<br>'customer_acct_name':'',<br>'date_time': '2022-07-18T05:59:35-05:00',<br>'initiated_by':'contact',<br>'initiated_from':'public',<br>'orgname':'',<br>'type': 'unsubscribe'<br>}<\/pre>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p><b>Please find more here:<\/b><\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p><a href='https:\/\/docs.quarticon.com\/contactSynchronisationApi\/' rel='nofollow noopener noreferrer' target='_blank'>https:\/\/docs.quarticon.com\/contactSynchronisationApi\/<\/a><\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<p>You can read more about webhooks <a href='https:\/\/howto.quarticon.com\/en\/articles\/6799943-webhooks'>here<\/a>.<\/p>\n<\/div>\n<div class='intercom-interblocks-paragraph no-margin intercom-interblocks-align-left'>\n<\/div>\n<\/article>\n","protected":false},"excerpt":{"rendered":"<p>Authentication All requests to the API are authenticated by providing your API key. The API key should be provided as an HTTP header named Api-Token. Headercur<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[4],"tags":[],"class_list":["post-755","post","type-post","status-publish","format-standard","hentry","category-cdxp"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/help.quarticon.com\/pl\/wp-json\/wp\/v2\/posts\/755","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.quarticon.com\/pl\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/help.quarticon.com\/pl\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/help.quarticon.com\/pl\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/help.quarticon.com\/pl\/wp-json\/wp\/v2\/comments?post=755"}],"version-history":[{"count":5,"href":"https:\/\/help.quarticon.com\/pl\/wp-json\/wp\/v2\/posts\/755\/revisions"}],"predecessor-version":[{"id":2021,"href":"https:\/\/help.quarticon.com\/pl\/wp-json\/wp\/v2\/posts\/755\/revisions\/2021"}],"wp:attachment":[{"href":"https:\/\/help.quarticon.com\/pl\/wp-json\/wp\/v2\/media?parent=755"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/help.quarticon.com\/pl\/wp-json\/wp\/v2\/categories?post=755"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/help.quarticon.com\/pl\/wp-json\/wp\/v2\/tags?post=755"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}