Возможность создания email аккаунта на платформе через запрос к API
Правила создания:
- Могут передаваться данные для создания аккаунта: email(обязательное поле), phone(опциональное поле (не записывать если не прошло валидацию)), name(опциональное поле)
- Если загружается только строка с email - создается аккаунт с контактом email и наименованием равным email
- Если строка с email не проходит валидацию - аккаунт не создается.
Response example
{
"status": 0,
"error": {
"fields": {
"data/0/email": "WRONG_EMAIL"
},
"code": "FORMAT_ERROR"
}
}
4. Случай когда уже есть подвязанный email аккаунт с этим же email, и этим же коннекшеном. Тогда нужно игнорировать.
Response example: (аналогичен обычному ответу)
{
"data": {
"count_to_process": 1
},
"status": 1
}
5. При создании аккаунта можно добавить тег
Вставляем в тело запроса: (полностью пример ниже)
"tags": "5d0a4d2cf73822000c44994c"
где, 5d0a4d2cf73822000c44994c - id тега. Его можно скопировать в настройках -> теги-> скопировать id
6. При создании аккаунта обязательно должно быть выбрано email соединение.
"connection_id": "5cfa283a2e9096000b440d51". (полностью пример ниже)
где, 5cfa283a2e9096000b440d51 - id конекшена. Его можно скопировать в настройках -> мессенджеры -> конекшн (к примеру SendGrid) -> скопировать id
POST: https://api.leeloo.ai/api/v2/accounts/email
В Headers:
- В Content type укажите: application/json,
- X-Leeloo-AuthToken - токен компании
В body запроса поместите:
Request example:
{
"data":[{
"email": "revolt@xmpl.net",
"name" : "Robin Hood",
"phone": "+380963333333"
}],
"connection_id": "5cfa283a2e9096000b440d51",
"tags": "5d0a4d2cf73822000c44994c"
}
Response example:
{
"data": {
"count_to_process": 1
},
"status": 1
}
где,
email - email клиента
name - имя клиента
phone - телефон клиента
connection id - id конекшна который создан на платформе (Sendgrid, Mandril)
tags - id тега который будет присвоен пользователю при создании