Skip to main content
PATCH
/
api
/
v1
/
workspaces
/
{workspace_id}
Update Workspace Name
curl --request PATCH \
  --url https://api.example.com/api/v1/workspaces/{workspace_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "name": "<string>",
  "memberships": [
    {
      "userId": "<string>",
      "workspaceId": "<string>",
      "privileges": [
        "ROLE_WORKSPACE_OWNER"
      ],
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspace_id
string<uuid4>
required

Query Parameters

expand
string | null
Allowed value: "workspaceMemberships"

Body

application/json
name
string
required
Required string length: 1 - 128

Response

Successful Response

name
string
required
memberships
WorkspaceMembershipDto · object[] | null
required
id
string<uuid4>
createdAt
string<date-time>
updatedAt
string<date-time>