CLclickup
Guests

Edit Guest On Workspace

Changed on

Configure options for a guest.

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

put/v2/team/{team_id}/guest/{guest_id}

Request

  • Base URL
    https://api.clickup.com/api
  • URL
    https://api.clickup.com/api/v2/team/{team_id}/guest/{guest_id}
  • Auth
    API key in header Authorization

Path parameters

team_idnumber required
Example:123

Workspace ID

guest_idnumber required
Example:403

Request body

can_see_points_estimatedboolean
can_edit_tagsboolean
can_see_time_spentboolean
can_see_time_estimatedboolean
can_create_viewsboolean
custom_role_idinteger

Example request

{
  "can_see_points_estimated": true,
  "can_edit_tags": true,
  "can_see_time_spent": true,
  "can_see_time_estimated": true,
  "can_create_views": true,
  "custom_role_id": 12345
}

Response

Example response

{
  "guest": {
    "user": {
      "id": 184,
      "username": null,
      "email": "guest@example.com",
      "color": null,
      "profilePicture": null,
      "initials": "G",
      "role": 4,
      "custom_role": {
        "id": 12345,
        "name": "guest 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"
    },
    "can_see_time_spent": true,
    "can_see_time_estimated": true,
    "can_edit_tags": true,
    "can_create_views": true,
    "shared": {
      "tasks": [],
      "lists": [],
      "folders": []
    }
  }
}

Changes

  • a0a72ec97ddbRevision changes
    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from no type to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status