Update workspace
curl --request PATCH \
--url https://{defaultHost}/v1/workspaces/{id} \
--header 'X-Authorization: <api-key>'import requests
url = "https://{defaultHost}/v1/workspaces/{id}"
headers = {"X-Authorization": "<api-key>"}
response = requests.patch(url, headers=headers)
print(response.text)const options = {method: 'PATCH', headers: {'X-Authorization': '<api-key>'}};
fetch('https://{defaultHost}/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://{defaultHost}/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_HTTPHEADER => [
"X-Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{defaultHost}/v1/workspaces/{id}"
req, _ := http.NewRequest("PATCH", url, nil)
req.Header.Add("X-Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://{defaultHost}/v1/workspaces/{id}")
.header("X-Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{defaultHost}/v1/workspaces/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"workspace": {
"id": "ws_123",
"name": "Acme Corp",
"personal": false,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_pro": false,
"public_signup": false,
"user_info_requirement": "email",
"slug": "acme-corp",
"membership": {
"role": "owner",
"created_at": "2023-11-07T05:31:56Z"
},
"settings": {
"onboarding": {
"fullName": true,
"companyName": false
}
},
"logo_url": "https://example.com/logo.png"
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Workspaces
Update workspace
Update workspace details. Requires member access.
PATCH
/
v1
/
workspaces
/
{id}
Update workspace
curl --request PATCH \
--url https://{defaultHost}/v1/workspaces/{id} \
--header 'X-Authorization: <api-key>'import requests
url = "https://{defaultHost}/v1/workspaces/{id}"
headers = {"X-Authorization": "<api-key>"}
response = requests.patch(url, headers=headers)
print(response.text)const options = {method: 'PATCH', headers: {'X-Authorization': '<api-key>'}};
fetch('https://{defaultHost}/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://{defaultHost}/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_HTTPHEADER => [
"X-Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{defaultHost}/v1/workspaces/{id}"
req, _ := http.NewRequest("PATCH", url, nil)
req.Header.Add("X-Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://{defaultHost}/v1/workspaces/{id}")
.header("X-Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{defaultHost}/v1/workspaces/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"workspace": {
"id": "ws_123",
"name": "Acme Corp",
"personal": false,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_pro": false,
"public_signup": false,
"user_info_requirement": "email",
"slug": "acme-corp",
"membership": {
"role": "owner",
"created_at": "2023-11-07T05:31:56Z"
},
"settings": {
"onboarding": {
"fullName": true,
"companyName": false
}
},
"logo_url": "https://example.com/logo.png"
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Was this page helpful?
⌘I