Customers API дозволяє отримувати, знаходити, створювати, оновлювати, позначати тегами контакти або знімати теги, а також видаляти свої контакти. За потреби ви також можете передати контакту подію активності. Таким чином, ви зможете повністю контролювати свої контакти в HelpCrunch.
Нижче приклад відповіді для більшості методів Customer API:
{
"id": 542335,
"name": "John Doe",
"email": "john.doe@example.com",
"userId": "user_1234567890",
"company": "Example Inc.",
"phone": "+10233456781",
"firstSeen": "1603885746",
"lastSeen": "1603885746",
"location": {
"regionCode": "Kyyivs'ka Oblast",
"countryCode": "UA",
"city": "Kyiv"
},
"device": {
"id": 542335,
"ip": "192.168.1.1",
"timezone": "Europe/Kiev",
"platform": "desktop",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.111 Safari/537.36"
},
"unsubscribed": false,
"blocked": false,
"source": "https://example.com",
"referer": "https://example.com",
"lastPage": "https://example.com",
"locale": "uk",
"notes": "Lorem ipsum",
"tags": [
{
"name": "vip",
"color": "#ff0000"
}
],
"customData": {
"subscription_status": "active",
"number_of_payments": 15,
"last_paid_amount": 15.99,
"last_payment_date": 1603885746,
"last_invoice_url": "https://example.com/invoice.html",
"last_payment_was_successful": true
}
}Нижче ви можете знайти детальну інформацію про кожне з полів Customer Object.
| Поле | Тип | Опис |
| id | Integer | Унікальний ID контакту, наданий HelpCrunch |
| name | String|Null | Ім'я контакту |
| String|Null | Електронна адреса контакту | |
| userId | String|Null |
Власний унікальний ID контакту, який ви можете передати в HelpCrunch за допомогою режиму автентифікації користувача |
| company | String|Null | Компанія контакту |
| phone | String|Null | Номер телефону контакту |
| firstSeen | String (UNIX timestamp)|Null | Дата та час першого візиту контакту |
| lastSeen | String (UNIX timestamp)|Null | Дата та час останнього візиту контакту |
| location | Object | Об'єкт геолокації контакту. Містить рядки regionCode, countryCode та city. |
| device | Object|Null | Об'єкт пристрою контакту. Містить унікальний id, ip address, timezone, platform ("desktop" чи "mobile") та userAgent. |
| unsubscribed | Boolean | Статус підписки електронної пошти контакту. True - відписаний. False - підписаний. |
| blocked | Boolean | Заблоковані контакти взагалі не бачать віджет HelpCrunch. True - заблокований. False - розблокований. |
| source | String|Null | URL-адреса, з якої контакт перейшов на ваш сайт |
| referer | String|Null | Рядок HTTP Referrer |
| locale | String|Null | Локаль контакту, яка визначає мову і регіон контакту |
| notes | String|Null | Примітки щодо контакту. Доступні в профілі контакту |
| lastPage | String|Null | Остання сторінка, на якій був контакт |
| tags | Array of object | Назва та колір тегу контакту. Колір за замовчуванням - #c377e0. |
| customData | Array |
Ваші власні дані, представлені у вигляді масиву. Кожен атрибут складається з назви (обов’язкова) і значення (обов’язкове). |
