Skip to content
Snippets Groups Projects
Unverified Commit ab3e19d8 authored by Paul Tötterman's avatar Paul Tötterman Committed by GitHub
Browse files

Improve API doc readability (#7527)

parent 250f3eb9
No related branches found
No related tags found
No related merge requests found
...@@ -33,21 +33,22 @@ with a body of: ...@@ -33,21 +33,22 @@ with a body of:
including an ``access_token`` of a server admin. including an ``access_token`` of a server admin.
The parameter ``displayname`` is optional and defaults to the value of Parameters:
``user_id``.
The parameter ``threepids`` is optional and allows setting the third-party IDs - ``password``, optional. If provided, the user's password is updated and all
(email, msisdn) belonging to a user. devices are logged out.
- ``displayname``, optional, defaults to the value of ``user_id``.
The parameter ``avatar_url`` is optional. Must be a [MXC - ``threepids``, optional, allows setting the third-party IDs (email, msisdn)
URI](https://matrix.org/docs/spec/client_server/r0.6.0#matrix-content-mxc-uris). belonging to a user.
The parameter ``admin`` is optional and defaults to ``false``. - ``avatar_url``, optional, must be a
`MXC URI <https://matrix.org/docs/spec/client_server/r0.6.0#matrix-content-mxc-uris>`_.
The parameter ``deactivated`` is optional and defaults to ``false``. - ``admin``, optional, defaults to ``false``.
The parameter ``password`` is optional. If provided, the user's password is - ``deactivated``, optional, defaults to ``false``.
updated and all devices are logged out.
If the user already exists then optional parameters default to the current value. If the user already exists then optional parameters default to the current value.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment