Ви можете оновити будь-який вже існуючий атрибут даних контакту за допомогою цих методів.
➡️ Запит
URL | https://api.helpcrunch.com/v1/customers/<customer_id> |
Методи | PUT / PATCH |
Headers | Authorization: Bearer <your_api_key> |
- PUT - замінює значення для набору полів у тілі запиту. Поля, які не згадуються в тілі, будуть встановлені як null.
- PATCH - лише оновлює значення для набору полів у тілі запиту.
customer_id
- це ID контакту, наданий HelpCrunch. Він необхідний для цього методу і виглядає як комбінація чисел (наприклад, 1568834).
При оновленні контакту ви можете вказати всі наявні поля даних або їх частину в тілі вашого запиту. Ви можете знайти всі доступні поля даних у розділі "Відповідь на успішний запит" нижче.
Приклад тіла запиту
{
"notes": "He has never heard about magic",
"source": null,
"city": "London",
"locale": "en",
"regionCode": "London",
"countryCode": "EN",
"customData": [
{
"property": "Subscription Status",
"value": "Suspended"
},
{
"property": "Number of payments",
"value": 13
}
]
}
Кілька порад
- Усі дати слід передавати у форматі часу UNIX;
- Поле
locale
(локаль) слід передавати як рядок відповідно до стандарту ISO 639-1; Tag
можна додати до контакту за допомогою методу "Додати тег контакту" або видалити за допомогою методу "Прибрати тег у контакту". Тег буде автоматично створено та додано до вашого облікового запису, якщо ви передасте неіснуючий тег. Тегу можна призначити будь-який колір CSS. Якщо ви не вкажете колір, за замовчуванням застосується колір #c377e0.- Щоб очистити значення певного поля, ви повинні передати значення null для нього в тілі запиту.
Щоб створити новий атрибут customData
, перейдіть у Налаштування → Контакти → Власні атрибути та натисніть "Додати новий атрибут". Детальніше у документації "Додайте власний атрибут у контакти".
✅ Відповідь на успішний запит
Якщо ваш запит пройшов успішно, ви отримаєте код успішного статусу 200 OK разом із наведеним нижче тілом відповіді.
{
"id": 7831827,
"name": "Hakim Zarakim",
"email": "hzarakim@example.com",
"userId": "example_22",
"company": "example",
"phone": null,
"firstSeen": 1593547200,
"lastSeen": 1593547200,
"location": {
"regionCode": "London",
"countryCode": "EN",
"city": "London"
},
"device": null,
"unsubscribed": false,
"blocked": false,
"source": null,
"referer": null,
"locale": "en",
"notes": "He has never heard about magic",
"lastPage": null,
"tags": [
{
"name": "Lead",
"color": "#cсс"
},
{
"name": "Paid",
"color": "#c377e0"
}
],
"customData": {
"subscription_status": "Suspended",
"number_of_payments": 13
}
}
🛑 Відповіді з помилками
Ви можете отримати один із наведених нижче кодів статусу помилки та відповіді.
400 Bad Request
{
"errors": [
{
"code": "validation_error",
"message": "email value is invalid"
},
{
"code": "validation_error",
"message": "userId value is invalid"
},
{
"code": "validation_error",
"message": "source value is invalid"
}
]
}
401 Unauthorized
{
"errors": [
{
"code": "invalid_token",
"message": "Invalid token"
}
]
}
404 Not Found
{
"errors": [
{
"code": "entity_not_found",
"message": "Customer not found"
}
]
}
429 Too Many Requests
{
"errors": [
{
"code": "too_many_requests",
"message": "You have exceeded your requests limit"
}
]
}