XExenforo-ltd
Me

Update information about the current user

Changed on

Update information about the current user.

post/me/

Request

  • Base URL
    https://example.com/api
  • Auth
    • OAuth 2
      Authorization codehttps://example.com/oauth2/authorize
      Token URLhttps://example.com/api/oauth2/token
      Scopesuser:write
    • or API key in header XF-Api-Key
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

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
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

    • info

      api operation id post_me_ removed and replaced with postMe

    • 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

      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 postMe removed and replaced with post_me_

    • 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