Skip to main content
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"
}
'
import requests

url = "https://api.steuerboard.com/v1/workspaces/{id}"

payload = { "name": "Finanzbuchhaltung" }
headers = {
    "x-client-id": "<x-client-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {
    'x-client-id': '<x-client-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({name: 'Finanzbuchhaltung'})
};

fetch('https://api.steuerboard.com/v1/workspaces/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.steuerboard.com/v1/workspaces/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Finanzbuchhaltung'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-client-id: <x-client-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.steuerboard.com/v1/workspaces/{id}"

	payload := strings.NewReader("{\n  \"name\": \"Finanzbuchhaltung\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-client-id", "<x-client-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.steuerboard.com/v1/workspaces/{id}")
  .header("x-client-id", "<x-client-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Finanzbuchhaltung\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.steuerboard.com/v1/workspaces/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-client-id"] = '<x-client-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Finanzbuchhaltung\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "cmf41ajzv003706un4i99q19z",
  "name": "FiBu",
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z",
  "archivedAt": "2021-01-01T00:00:00Z",
  "clientId": "cmf41ajzv003706un4i99q19z"
}
{
  "type": "bad_request",
  "message": "<string>"
}
{
  "status_code": 401,
  "type": "auth_error",
  "code": "unauthorized",
  "message": "<string>"
}
{
  "type": "auth_error",
  "message": "<string>"
}
{
  "status_code": 404,
  "type": "not_found",
  "code": "not_found",
  "message": "<string>"
}
{
  "success": false,
  "error": {
    "name": "ValidationError",
    "issues": [
      {
        "code": "invalid_type",
        "path": [
          "name"
        ],
        "message": "Required"
      }
    ]
  }
}
{
  "status_code": 429,
  "type": "rate_limit",
  "code": "too_many_requests",
  "message": "<string>"
}
This response has no body data.

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"