Edit Guest On Workspace

Rename and configure options for a guest.

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)

guest_id
required
number <double>
Request Body schema: application/json
required
username
required
string
can_edit_tags
required
boolean
can_see_time_spent
required
boolean
can_see_time_estimated
required
boolean
can_create_views
required
boolean
custom_role_id
required
integer <int32>
Responses
200
put/v2/team/{team_id}/guest/{guest_id}
Request samples
application/json
{
  • "username": "Guest User",
  • "can_edit_tags": true,
  • "can_see_time_spent": true,
  • "can_see_time_estimated": true,
  • "can_create_views": true,
  • "custom_role_id": 12345
}
Response samples
application/json
{
  • "guest": {
    }
}