Категории

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

POST https://api.usedesk.ru/update/client

Внимание. Если вы используете коробочную версию Юздеска на собственном сервере, URL методов у вас будет отличаться. Уточните URL для работы с API у поддержки — support@usedesk.ru.

Метод изменяет информацию о клиенте.

* — обязательные поля

Параметр Значение
api_token* Токен API канала
client_id* id клиента
name Новое имя клиента
emails

Массив с почтовыми адресами

Система добавит адреса к уже существующим

messengers

Массив с данными мессенджеров, которые можно обновить или добавить в карточку клиента

Содержит параметры:

  • id — id мессенджера (необязательный)
    Если указан, то произойдет изменение существующего мессенджера;
    • Строка, 64 символа. Если передается пустое значение и задан id параметр, то мессенджер будет удалён
  • identity — никнейм, номер телефона, другие идентификаторы, которые отображаются в карточке клиента (обязательный).
  • type — тип мессенджера (обязательный)
    Возможные значения:
    • telegram,
    • whatsapp,
    • viber,
    • skype,
    • gtalk,
    • imessage,
    • other
  • uid — id пользователя в мессенджере (необязательный)
note Текст заметки
is_new_note

Флаг новой заметки

Если установлен параметр false или он отсутствует, то текст заметки добавляется к существующему

phone

Телефон пользователя

Система добавит телефон к уже существующим

sites

Массив с сайтами клиента

Содержит параметры:

  • id — id сайта (необязательный)
    Если указан, то произойдет изменение существующего сайта
    Если указан несуществующий id, то обновления не произойдет
  • url — ссылка на сайт клиента (обязательный). Если передаётся пустое значение и задан id параметр, то сайт будет удалён
avatar

Файл с изображением

multipart/form-data

status_vip

Статус клиента vip-клиента

Допустимые значения:

  • true;
  • false

Не может использоваться одновременно с параметром status_spam

status_spam

Статус клиента-спамера

Допустимые значения:

  • true;
  • false

Не может использоваться одновременно с параметром status_vip

position Должность клиента
merge_id Идентификатор клиента, с которым будет объединён пользователь с идентификатором client_id
client_country Страна клиента
client_city Город клиента
client_address Адрес клиента
new_address

Флаг нового адреса

Передаётся, если требуется создать дополнительный адрес

phone_type

Тип телефона при сохранении

Возможные значения:

  • home;
  • mobile;
  • stationary;
  • fax;
  • other

Важно: параметр status устарел — вместо него появились параметры status_spam и status_vip.

Пример запроса на PHP
$data = array(
    'api_token'=> 'e1cbe1c1c9d910ef2ae975215644cb53dd555de4',
    'client_id'=>1234,
    'name' =>'Jon',
    'emails'=>['test@gmail.com'],
    'messengers'=>[
        {
            'id'=>'123456',
            'identity'=>'test',
            'type'=>'telegram',
            'uid'=>'1234'
        },
        {
            'id'=>'56789',
            'identity'=>'test2',
            'type'=>'whatsapp'
        }
    ]
);
$mch_api = curl_init();
curl_setopt($mch_api, CURLOPT_URL, 'https://api.usedesk.ru/update/client');
curl_setopt($mch_api, CURLOPT_RETURNTRANSFER, true);
curl_setopt($mch_api, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($mch_api, CURLOPT_TIMEOUT, 10);
curl_setopt($mch_api, CURLOPT_POST, true);
curl_setopt($mch_api, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($mch_api, CURLOPT_POSTFIELDS, $data);
$result = curl_exec($mch_api);
return $result;

Пример ответа от сервера 
{
    "client_id": 1234,
    "status": true
}

Параметры ответа от сервера

Параметр Описание
client_id ID клиента
status Статус выполнения запроса