> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arzguard.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Изменить свой профиль

> Обновляет доступные настройки профиля текущего пользователя.

Обновляет доступные настройки профиля текущего пользователя.

Передавайте только изменяемые настройки. Проверяются права редактировать профиль, подпись и пользовательский статус. Изменение даты рождения этим методом в установленной реализации не предусмотрено. ID пользователя выбирается контекстом API, а не параметром тела.

## Доступ

Передавайте `XF-Api-Key` в заголовке каждого запроса. [Типы ключей и выбор пользователя](/guard-forum/authentication).

Требуемые scopes: `user:write`. Все перечисленные разрешения нужны одновременно.

Нужен контекст зарегистрированного пользователя. Для Super key укажите `XF-Api-User`; доступ к объектам и действиям проверяется отдельно от scopes.

## Параметры

**XF-Api-Key** `string` *required*

Секретный API-ключ. В примерах ключ берётся из серверной переменной `$FORUM_API_KEY`.

Тело запроса: `application/x-www-form-urlencoded`. Вложенные значения передавайте в форме с квадратными скобками в имени поля.

**option\[creation\_watch\_state]** `string`

Настройка автоматического отслеживания создаваемых тем.

**option\[interaction\_watch\_state]** `string`

Настройка отслеживания тем, в которых пользователь участвует.

**option\[content\_show\_signature]** `boolean`

Показывать подписи под сообщениями при просмотре форума.

**option\[email\_on\_conversation]** `boolean`

Получать уведомления о личных переписках по email.

**option\[push\_on\_conversation]** `boolean`

Получать push-уведомления о личных переписках.

**option\[receive\_admin\_email]** `boolean`

Разрешить письма от администрации форума.

**option\[show\_dob\_year]** `boolean`

Показывать год рождения в профиле.

**option\[show\_dob\_date]** `boolean`

Показывать день и месяц рождения в профиле.

**profile\[location]** `string`

Местоположение, указанное в профиле.

**profile\[website]** `string`

Адрес сайта в профиле.

**profile\[about]** `string`

Текст раздела «О себе».

**profile\[signature]** `string`

Подпись под сообщениями. Применяется с учётом права редактировать подпись и её ограничений.

**privacy\[allow\_view\_profile]** `string`

Настройка того, кто может просматривать профиль.

**privacy\[allow\_post\_profile]** `string`

Настройка того, кто может писать в профиле.

**privacy\[allow\_receive\_news\_feed]** `string`

Настройка доступности активности пользователя в ленте.

**privacy\[allow\_send\_personal\_conversation]** `string`

Настройка того, кто может начинать с пользователем личную переписку.

**privacy\[allow\_view\_identities]** `string`

Настройка видимости контактных данных и внешних аккаунтов.

**visible** `boolean`

Показывать пользователя в списках присутствующих.

**activity\_visible** `boolean`

Показывать текущую активность пользователя.

**timezone** `string`

Часовой пояс в формате идентификатора, например `Europe/Moscow`.

**custom\_title** `string`

Пользовательский статус под именем. Применяется только при наличии права изменять его.

**custom\_fields\[\<name>]** `string`

Значение дополнительного поля профиля. Вместо `<name>` передайте существующий идентификатор поля.

## Ответ

HTTP `200`, JSON. [Схемы объектов и условные поля](/guard-forum/models).

**success** `true`

Результат выполнения операции.

Ошибки возвращаются в общей структуре `errors`. Обрабатывайте поле `code`; текст `message` может меняться или переводиться. [Формат ошибок](/guard-forum/requests-and-errors).

```bash cURL theme={null}
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]=Пример описания'
```

```json 200 · условный пример theme={null}
{
  "success": true
}
```

Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.