Sign in
User / team / organization / usage

Changed on

Update current user infos

patch/me/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Request body

usernamestring

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

first_namestring
last_namestring
emailstring email
is_superuserboolean

Designates that this user has all permissions without explicitly assigning them.

server_timestring date-time
date_joinedstring date-time
projects_urlstring uri
gravatarstring uri
last_loginstring date-time nullable
current_passwordstring
new_passwordstring
git_revstring
validated_passwordboolean
accepted_tosboolean

Verifies user acceptance of terms of service (tos) by checking that the tos endpoint was called and stored the current time in the private_data property

extra_details__uidstring

Example request

{
  "projects_url": "https://kf.kobotoolbox.org/bob",
  "gravatar": "https://www.gravatar.com/avatar/5a9aec55090975e64e0f6b0a29110a5f?s=40",
  "organization": {
    "url": "https://kf.kobotoolbox.org/api/v2/organizations/orgzeph7Ub8tVmJ82JBbH96n/"
  }
}

Response

usernamestring required
first_namestring required
last_namestring required
emailstring email required
server_timestring date-time required
date_joinedstring date-time required
projects_urlstring uri required
gravatarstring uri required
last_loginstring date-time nullable required
validated_passwordboolean required
accepted_tosboolean required
extra_details__uidstring required

Example response

{
  "projects_url": "https://kf.kobotoolbox.org/bob",
  "gravatar": "https://www.gravatar.com/avatar/5a9aec55090975e64e0f6b0a29110a5f?s=40",
  "organization": {
    "url": "https://kf.kobotoolbox.org/api/v2/organizations/orgzeph7Ub8tVmJ82JBbH96n/"
  }
}

Changes

  • v255ed00f628b8Revision changes
    • breaking

      the / request property type changed from string to boolean (media type: application/json)

    • breaking

      the / request property type changed from string to boolean (media type: application/x-www-form-urlencoded)

    • breaking

      the / request property type changed from string to boolean (media type: multipart/form-data)

    • breaking

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

    • info

      added the new optional request property / (media type: application/json)

    • info

      added the new optional request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property / (media type: multipart/form-data)

    • info

      added the optional property / to the response with the status

  • v2f55f5ce273d3Revision changes
    • breaking

      the request property became not nullable (media type: application/json)

    • breaking

      the request property became not nullable (media type: application/x-www-form-urlencoded)

    • breaking

      the request property became not nullable (media type: multipart/form-data)