Установка аватара
Метод и конечная точка
POST /users.setAvatar
Описание
Устанавливает аватар пользователя. Изображение может быть передано как URL или загружено в виде файла.
Параметры
Перечень параметров представлен в таблице.
| Название | Обязательный | Тип данных | Описание |
|---|---|---|---|
| avatarUrl | нет* | string | URL изображения аватара |
| file | нет* | file | Файл изображения для загрузки |
* Должен быть указан один из параметров: avatarUrl или file.
Запрос (через URL)
curl -X 'POST' \
'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/users.setAvatar' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-User-Id: <USER_ID>' \
-H 'x-auth-token: <AUTH_TOKEN>' \
-d '{ \
"avatarUrl": "<AVATAR_URL>"
}'
Где:
<ENV>— окружение, на котором выполняется запрос;<DEFAULT_DOMAIN>— домен сервера Squadus;<USER_ID>— идентификатор пользователя, от имени которого выполняется запрос;<AUTH_TOKEN>— токен аутентификации пользователя;<AVATAR_URL>— URL изображения для аватара.
Ответ
200 — Basic API response with success status — Аватар установлен. Пример вывода:
{
"success": true
}