Skip to content
My Docs

Updates an existing workspace

PUT
/api/v1/Workspaces/{workspaceId}

Required permissions:

  • Workspace Owner access level, or
  • Admin access

Authorizations

Parameters

Path Parameters

workspaceId
required
string format: uuid

The unique identifier of the workspace to update

Request Body

Updated workspace details

object
name
required
string
>= 3 characters <= 20 characters

Responses

200

Workspace successfully updated

object
id
string format: uuid
name
string
nullable
ownerId
string format: uuid
createdDate
string format: date-time
projects
Array<object>
nullable
object
id
string format: uuid
workspaceId
string format: uuid
name
string
nullable
description
string
nullable
startDate
string format: date-time
nullable
endDate
string format: date-time
nullable
status
integer format: int32
createdDate
string format: date-time
members
Array<object>
nullable
object
id
string format: uuid
projectId
string format: uuid
workspaceMemberId
string format: uuid
accessLevel
integer format: int32
createdDate
string format: date-time
workspaceMember
object
id
string format: uuid
workspaceId
string format: uuid
userId
string format: uuid
accessLevel
integer format: int32
createdDate
string format: date-time
lists
Array<object>
nullable
object
id
string format: uuid
projectId
string format: uuid
name
string
nullable
position
integer format: int32
createdDate
string format: date-time
tasks
Array<object>
nullable
object
id
string format: uuid
projectId
string format: uuid
listId
string format: uuid
name
string
nullable
description
string
nullable
priority
integer format: int32
status
integer format: int32
deadline
string format: date-time
nullable
createdDate
string format: date-time
assignees
Array<object>
nullable
object
id
string format: uuid
taskId
string format: uuid
userId
string format: uuid
assignedDate
string format: date-time
user
object
id
string format: uuid
username
string
nullable
name
string
nullable
email
string
nullable
createdDate
string format: date-time
accessLevel
integer format: int32
comments
Array<object>
nullable
object
id
string format: uuid
taskId
string format: uuid
userId
string format: uuid
content
required
string
nullable
createdDate
string format: date-time
user
object
id
string format: uuid
username
string
nullable
name
string
nullable
email
string
nullable
createdDate
string format: date-time
accessLevel
integer format: int32
list
object recursive
project
object recursive
members
Array<object>
nullable
object
id
string format: uuid
workspaceId
string format: uuid
userId
string format: uuid
accessLevel
integer format: int32
createdDate
string format: date-time

400

Invalid update data or user ID is null

403

Insufficient permissions to update workspace

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties

404

Workspace not found

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties