Клиенты

Получить данные для одного клиента

GET /v1.3/customers/<id>

  • id - идентификатор клиента

После успешного выполнения возвращается объект, описывающий клиента.

id integer Идентификатор клиента
login string Логин клиента в мессенджере или название аккаунта в социальной сети
name string Имя клиента в Umnico
avatar string Аватар аккаунта в мессенджере или социальной сети
email string Email клиента
phone string Номер телефона
address string Адрес
profiles массив объектов Профили клиента
  • id
integer Идентификатор профиля
  • login
string Логин клиента в мессенджере или название аккаунта в социальной сети
  • type
string Тип профиля (равнозначен типу интеграции, в которую написал клиент)
  • socialId
string Идентификатор клиента в мессенджере или социальной сети
  • profileUrl
string Ссылка на профиль

Пример:

GET https://api.umnico.com/v1.3/customers/78

Response:

{
    "id": 78,
    "login": "Important Client",
    "name": "Important Client",
    "avatar": "https://sun9-8.userapi.com/c9аав2bb34.jpg",
    "email": null,
    "phone": null,
    "address": null,
    "profiles": [
        {
            "id": 45,
            "login": "Important Client",
            "type": "vk_group",
            "socialId": "1111111",
            "profileUrl": "https://vk.com/id0"
        }
    ]
}

Изменить данные клиента

PUT /v1.3/customers/<id>

  • id - идентификатор клиента

В тело запроса добавляются поля, которые нужно изменить.

  • name - имя клиента в Umnico
  • phone - номер телефона
  • email - email клиента
  • address - адрес клиента

После успешного выполнения возвращается объект, описывающий клиента (см. выше).


Пример:

PUT https://api.umnico.com/v1.3/customers/78

Body:

{
   "phone": "78965432211",
   "email": "some@email.com"
}

Response:

{
    "id": 78,
    "login": "Important Client",
    "name": "Important Client",
    "avatar": "https://sun9-8.userapi.com/c9аав2bb34.jpg",
    "email": "some@email.com",
    "phone": "78965432211",
    "address": null,
    "profiles": [
        {
            "id": 45,
            "login": "Important Client",
            "type": "vk_group",
            "socialId": "1111111",
            "profileUrl": "https://vk.com/id0"
        }
    ]
}

Обновить аватар клиента

POST /v1.3/customers/<id>/update

  • id - идентификатор клиента

После успешного выполнения возвращается объект, описывающий клиента (см. выше).


Пример:

PUT https://api.umnico.com/v1.3/customers/78/update

Response:

{
    "id": 78,
    "login": "Important Client",
    "name": "Important Client",
    "avatar": "https://sun9-8.userapi.com/23sddf34.jpg",
    "email": "some@email.com",
    "phone": "78965432211",
    "address": null,
    "profiles": [
        {
            "id": 45,
            "login": "Important Client",
            "type": "vk_group",
            "socialId": "1111111",
            "profileUrl": "https://vk.com/id0"
        }
    ]
}