Users

Edit User

Required scopes: user (Read and Write).

patch/users/{userId}

Request

Path parameters

userIdinteger required

User Identifier. Get via List Users

Request body

valuestring required
op'replace' required

Patch operation to perform

path'/firstName' | '/lastName' | '/timezone' | '/status' | '/adminAccess' | '/avatarStorageId' json-pointer required

A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>

Example request

[
  {
    "value": "Smith",
    "path": "/lastName"
  }
]

Response

User was successfully updated

Example response

{
  "data": {
    "id": 12,
    "username": "john_smith",
    "firstName": "John",
    "lastName": "Smith",
    "fields": {
      "some-field-1": "some value 1",
      "some-field-2": 12,
      "some-field-3": true,
      "some-field-4": [
        "en",
        "ja"
      ]
    },
    "isAdmin": true,
    "status": "active",
    "createdAt": "2019-07-11T07:40:22+00:00",
    "lastSeen": "2019-10-23T11:44:02+00:00",
    "email": "jsmith@example.com",
    "twoFactor": "enabled",
    "timezone": "Europe/Kyiv",
    "joinDetails": {
      "type": "privateInvitation",
      "invitedBy": {
        "id": 19,
        "username": "john_doe",
        "fullName": "John Smith"
      }
    },
    "deviceVerification": "enabled",
    "loginMethods": [
      "crowdin"
    ],
    "mfaMethods": [
      "authenticatorApp"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.