Edit User On Workspace

Nothing Found

Help Center
API Feature Requests

Nothing Found

Edit User On Workspace

Update a user's name and role.

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

SecurityAuthorization Token

Request

path Parameters

team_id required	number <double> Team ID (Workspace)
user_id required	number <double>

Request Body schema: application/json
required

username required	string
admin required	boolean
custom_role_id required	integer <int32>

Responses

200

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

Request samples

application/json

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

Response samples

application/json

{"member": {"user": {"id": 184,
"username": "User Name",
"email": "user@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"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://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"shared": {"tasks": [ ],
"lists": [ ],
"folders": [ ]
}
}
}

© 2022 ClickUp
Security
Your Privacy
Terms

Edit User On Workspace

path Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required