Sign in
Users

Edit User On Workspace

Update a user's name and role.

Note: This endpoint is only available to Workspaces on our Enterprise Plan.

put/v2/team/{team_id}/user/{user_id}

Path parameters

team_idnumber required
Example:123

Workspace ID

user_idnumber required
Example:403

Request body

usernamestring required
adminboolean required
custom_role_idinteger required

Example request

{
  "username": "User Name",
  "admin": false,
  "custom_role_id": 998877
}

Response

memberMember required— unresolved $ref

Example response

{
  "member": {
    "user": {
      "id": 184,
      "username": "User Name",
      "email": "user@example.com",
      "color": null,
      "profilePicture": null,
      "initials": "UN",
      "role": 3,
      "custom_role": {
        "id": 998877,
        "name": "member custom"
      },
      "last_active": null,
      "date_joined": null,
      "date_invited": "1583358383412"
    },
    "invited_by": {
      "id": 183,
      "color": "#827718",
      "username": "Jerry",
      "email": "jerry@example.com",
      "initials": "J",
      "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
    },
    "shared": {
      "tasks": [],
      "lists": [],
      "folders": []
    }
  }
}

Changes