curl --request POST 'https://forum.arzguard.com/api/me/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'profile[about]=Пример описания'
{
"success": true
}
Текущий пользователь
Изменить свой профиль
Обновляет доступные настройки профиля текущего пользователя.
POST
/
api
/
me
/
curl --request POST 'https://forum.arzguard.com/api/me/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'profile[about]=Пример описания'
{
"success": true
}
Обновляет доступные настройки профиля текущего пользователя.
Передавайте только изменяемые настройки. Проверяются права редактировать профиль, подпись и пользовательский статус. Изменение даты рождения этим методом в установленной реализации не предусмотрено. ID пользователя выбирается контекстом API, а не параметром тела.
Тело запроса:
Ошибки возвращаются в общей структуре
Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.
Доступ
ПередавайтеXF-Api-Key в заголовке каждого запроса. Типы ключей и выбор пользователя.
Требуемые scopes: user:write. Все перечисленные разрешения нужны одновременно.
Нужен контекст зарегистрированного пользователя. Для Super key укажите XF-Api-User; доступ к объектам и действиям проверяется отдельно от scopes.
Параметры
string
required
Секретный API-ключ. В примерах ключ берётся из серверной переменной
$FORUM_API_KEY.application/x-www-form-urlencoded. Вложенные значения передавайте в форме с квадратными скобками в имени поля.
string
Настройка автоматического отслеживания создаваемых тем.
string
Настройка отслеживания тем, в которых пользователь участвует.
boolean
Показывать подписи под сообщениями при просмотре форума.
boolean
Получать уведомления о личных переписках по email.
boolean
Получать push-уведомления о личных переписках.
boolean
Разрешить письма от администрации форума.
boolean
Показывать год рождения в профиле.
boolean
Показывать день и месяц рождения в профиле.
string
Местоположение, указанное в профиле.
string
Адрес сайта в профиле.
string
Текст раздела «О себе».
string
Подпись под сообщениями. Применяется с учётом права редактировать подпись и её ограничений.
string
Настройка того, кто может просматривать профиль.
string
Настройка того, кто может писать в профиле.
string
Настройка доступности активности пользователя в ленте.
string
Настройка того, кто может начинать с пользователем личную переписку.
string
Настройка видимости контактных данных и внешних аккаунтов.
boolean
Показывать пользователя в списках присутствующих.
boolean
Показывать текущую активность пользователя.
string
Часовой пояс в формате идентификатора, например
Europe/Moscow.string
Пользовательский статус под именем. Применяется только при наличии права изменять его.
string
Значение дополнительного поля профиля. Вместо
<name> передайте существующий идентификатор поля.Ответ
HTTP200, JSON. Схемы объектов и условные поля.
true
Результат выполнения операции.
errors. Обрабатывайте поле code; текст message может меняться или переводиться. Формат ошибок.
curl --request POST 'https://forum.arzguard.com/api/me/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'profile[about]=Пример описания'
{
"success": true
}