Створити контакт

Додайте один контакт до HelpCrunch
Написано Микола
Оновлено 2 місяці тому

За допомогою цього методу ви можете створити один контакт. Щоб створити чат від імені цього контакту, скористайтеся методом "Створити чат".

➡️ Запит

URL https://api.helpcrunch.com/v1/customers
Метод POST
Headers Authorization: Bearer <your_api_key>

Під час створення контакту ви можете вказати всі наявні поля даних або їх частину в тілі вашого запиту POST. Ви можете знайти всі доступні поля даних у розділі "Відповідь на успішний запит" нижче.

Для цього методу немає обов’язкових полів, однак ми не рекомендуємо створювати контакти без указаних даних. Ім’я, адреса електронної пошти та ID користувача – це поля, які бажано надсилати завжди.
Коли ви створюєте контакт, HelpCrunch автоматично створює для нього внутрішній ID контакту. userId не є внутрішнім ID контакту в HelpCrunch, ви можете передати туди свій власний ID контакту (наприклад, зі своєї CRM). 

Тіло запиту

{
    "name": "Hakim Zarakim",
    "email": "hzarakim@example.com",
    "userId": "example_22",
    "company": "example",
    "source": "https://google.com",
    "locale": "en",
    "firstSeen": 1593547200,
    "notes": "Hakim Zarakim could be a soccer player, but preferred to develop his magic skills instead.",
    "customData": [
        {
            "property": "Subscription status",
            "value": "Active"
        },
        {
            "property": "Number of payments",
            "value": 15
        }
    ],
    "tags": [
        {
            "name": "Lead",
            "color": "#ccc"
        },
        {
            "name": "Paid"
        }
    ]
}

Кілька порад

  • Усі дати слід передавати у форматі часу UNIX;
  • Поле locale (локаль) слід передавати як рядок відповідно до стандарту ISO 639-1;
  • Тег буде автоматично створено та додано до вашого облікового запису, якщо ви передасте неіснуючий тег. Тегу можна призначити будь-який колір CSS. Якщо ви не вкажете колір, за замовчуванням застосується колір #c377e0.

Щоб створити новий атрибут customData, перейдіть у Налаштування → Контакти → Власні атрибути та натисніть "Додати новий атрибут".

✅ Відповідь на успішний запит

Якщо ваш запит пройшов успішно, ви отримаєте код успішного статусу 201 Created разом із наведеним нижче тілом відповіді.

{
    "id": 7831827,
    "name": "Hakim Zarakim",
    "email": "hzarakim@example.com",
    "userId": "example_22",
    "company": "example",
    "phone": null,
    "firstSeen": 1593547200,
    "lastSeen": 1593547200,
    "location": {
        "regionCode": null,
        "countryCode": null,
        "city": null
    },
    "device": null,
    "unsubscribed": false,
    "blocked": false,
    "source": "https://google.com",
    "referer": null,
    "locale": "en",
    "notes": "Hakim Zarakim could be a soccer player, but preferred to develop his magic skills instead.",
    "lastPage": null,
    "tags": [
        {
            "name": "Lead",
            "color": "#cсс"
        },
        {
            "name": "Paid",
            "color": "#c377e0"
        }
    ],
    "customData": {
            "subscription_status": "Active",
            "number_of_payments": 15
        }
}

🛑 Відповіді з помилками

Ви можете отримати один із наведених нижче кодів статусу помилки та відповіді.

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"
        }
    ]
}

429 Too Many Requests

{
    "errors": [
        {
            "code": "too_many_requests",
            "message": "You have exceeded your requests limit"
        }
    ]
}
Чи була наша стаття корисною?