PUT
/
teams
/
{team_slug}
/
workspaces
/
{workspace_slug}
curl --request PUT \
  --url https://api.orgnise.in/teams/{team_slug}/workspaces/{workspace_slug} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Engineering Workspace",
  "description": "A workspace for the engineering team.",
  "visibility": "public",
  "defaultAccess": "full"
}'
{
  "_id": "<string>",
  "name": "<string>",
  "description": "",
  "defaultAccess": "full",
  "meta": {
    "title": "<string>",
    "description": "<string>",
    "slug": "<string>"
  },
  "Visibility": "<any>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
team_slug
string
required

The slug of the team.

​
workspace_slug
string
required

The slug of the workspace.

Body

application/json

Update a workspace. Workspaces are collections of projects and tasks. Workspaces can be private or public. Private workspaces are only visible to members of the workspace.

​
name
string

The name of the workspace.

Required string length: 1 - 32
​
description
string

The description of the workspace.

Maximum length: 120
​
slug
string

The slug of the workspace.

Required string length: 3 - 48
​
visibility
any

The visibility of the workspace. Private workspaces are only visible to members of the workspace.

​
defaultAccess
enum<string>
default:full

The default access level of the workspace. Full access allows members to perform all actions in the workspace. Read access allows members to view the workspace but not make changes.

Available options:
full,
read-only
Example:

"full"

Response

200
application/json
The updated workspace

A workspace is a collection of projects and tasks. Workspaces can be private or public. Private workspaces are only visible to members of the workspace.

​
_id
string
required

The unique ID of the workspace.

​
name
string
required

The name of the workspace.

​
description
string
default:
required

The description of the workspace.

Maximum length: 120
​
defaultAccess
enum<string>
default:full
required

The default access level of the workspace. Full access allows members to perform all actions in the workspace. Read access allows members to view the workspace but not make changes.

Available options:
full,
read-only
Example:

"full"

​
meta
object
required

The meta of the workspace.

​
Visibility
any
required

The visibility of the workspace. Private workspaces are only visible to members of the workspace.

​
createdAt
string
required

The date and time when the workspace was created.

​
updatedAt
string
required

The date and time when the workspace was last updated.

Was this page helpful?

Suggest edits
Retrieve a workspaceDelete a workspace