PATCH
/
workspaces
/
{id}
Update a workspace
curl --request PATCH \
  --url https://api.steuerboard.com/v1/workspaces/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <x-client-id>' \
  --data '{
  "name": "Finanzbuchhaltung"
}'
{
  "id": "cmf41ajzv003706un4i99q19z",
  "name": "FiBu",
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z",
  "archivedAt": "2021-01-01T00:00:00Z",
  "clientId": "cmf41ajzv003706un4i99q19z"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication

Headers

​
x-client-id
string<cuid>
required

The ID of the client

Example:

"cmf41ajzv003706un4i99q19z"

Path Parameters

​
id
string<cuid>
required

The ID of the item

Example:

"cmf41ajzv003706un4i99q19z"

Body

application/json

Workspace update

​
name
string
required

The new name of the workspace

Example:

"Finanzbuchhaltung"

Response

Workspace updated successfully

​
id
string<cuid>
required

The ID of the workspace

Example:

"cmf41ajzv003706un4i99q19z"

​
name
string
required

The name of the workspace

Example:

"FiBu"

​
createdAt
string<date-time>
required

The date and time of the creation for the workspace. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

Example:

"2021-01-01T00:00:00Z"

​
updatedAt
string<date-time>
required

The date and time of the last update for the workspace. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

Example:

"2021-01-01T00:00:00Z"

​
archivedAt
string<date-time> | null
required

The date and time the workspace was archived. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

Example:

"2021-01-01T00:00:00Z"

​
clientId
string<cuid>
required

The ID of the client

Example:

"cmf41ajzv003706un4i99q19z"