XExenforo-ltd
Users

Update an existing user

Changed on

Update an existing user.

post/users/{id}/

Request

Request body 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
option[push_on_conversation]boolean
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
visibleboolean
activity_visibleboolean
timezonestring
custom_titlestring
option[is_discouraged]boolean
usernamestring
emailstring
user_group_idinteger
secondary_group_idsinteger[]
user_statestring
is_staffboolean
message_countinteger
reaction_scoreinteger
trophy_pointsinteger
username_change_visibleboolean

If true and the username is changed, the change will be visible (shown in the public list of previous usernames).

passwordstring
dob[day]integer
dob[month]integer
dob[year]integer
custom_fields[<name>]string

Response

OK

successboolean

Changes

  • e271d0e41f6dRevision changes
    • breaking

      removed the media type application/json from the request body

    • breaking

      the response's property type changed from string to boolean for status

    • warning

      deleted the path request parameter id

    • info

      api operation id post_users_id_ removed and replaced with postUsersId

    • info

      the endpoint scheme security XF-Api-Key was added to the API

    • info

      the endpoint scheme security XF-OAuth2 was added to the API

    • info

      added the new optional header request parameter XF-Api-User to all path's operations

    • info

      added the new optional query request parameter api_bypass_permissions to all path's operations

  • fc0a40f3b859Revision changes
    • breaking

      added the new path request parameter id

    • breaking

      the response's property type changed from boolean to string for status

    • warning

      the optional response header XF-Latest-Api-Version removed for the status 200

    • warning

      the optional response header XF-Request-User removed for the status 200

    • warning

      the optional response header XF-Request-User-Extras removed for the status 200

    • warning

      the optional response header XF-Used-Api-Version removed for the status 200

    • info

      api operation id postUsersId removed and replaced with post_users_id_

    • info

      the endpoint scheme security XF-Api-Key was removed from the API

    • info

      the endpoint scheme security XF-OAuth2 was removed from the API

    • info

      added the media type application/json to the request body