User

Give manager role to a user

Changed on
post/v1/workspaces/{workspaceId}/users/{userId}/roles

Request

  • Base URL: https://api.clockify.me/api
  • URL: https://api.clockify.me/api/v1/workspaces/{workspaceId}/users/{userId}/roles
  • Auth: one of:
    • API key in header x-api-key
    • API key in header x-addon-token

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303
userIdstring required

Represents a user identifier across the system.

Example:5a0ab5acb07987125438b60f

Request body

entityIdstring required

Represents an entity identifier across the system.

role'WORKSPACE_ADMIN' | 'TEAM_MANAGER' | 'PROJECT_MANAGER' required

Represents a valid role.

sourceType'USER_GROUP'

Optional field used to indicate that the target of the operation is a user group, in which case the value USER_GROUP should be used, alongside a valid user group ID for the entityId field. If omitted, a user ID should be used for the entityId field.

Example request

{
  "entityId": "60f924bafdaf031696ec6218",
  "role": "TEAM_MANAGER",
  "sourceType": "USER_GROUP"
}

Response

Created

userIdstring

Represents workspace identifier across the system.

workspaceIdstring

Represents workspace identifier across the system.

Example response

[
  {
    "role": {
      "id": "60f91b3ffdaf031696ec61a8",
      "name": "Administrator",
      "source": {
        "id": "5b715612b079875110791234",
        "type": "USER_GROUP"
      }
    },
    "userId": "5a0ab5acb07987125438b60f",
    "workspaceId": "64a687e29ae1f428e7ebe303"
  }
]

Changes

  • a5b636acbcd8Revision changes
    • info

      the request property default value was added

    • info

      the request property default value was added

    • info

      the request property default value was added

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status