TypeScript client
import { OctosparkClient } from '@octospark/sdk'
const client = new OctosparkClient({
token: process.env.OCTOSPARK_TOKEN
})
const response = await client.teams.updateTeam({
teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
body: {},
})import os
from octospark_sdk import OctosparkClient
client = OctosparkClient(token=os.environ["OCTOSPARK_TOKEN"])
response = client.teams.update_team(
teamId=os.environ.get("OCTOSPARK_TEAM_ID", "teamId"),
body={}
)octospark teams update-team \
--request '{"path":{"teamId":"teamId"},"body":{}}'use reqwest::Client;
use std::env;
#[tokio::main]
async fn main() -> Result<(), reqwest::Error> {
let client = Client::new();
let base_url = env::var("OCTOSPARK_API_URL").unwrap_or_else(|_| "https://api.octospark.ai".to_string());
let team_id = env::var("OCTOSPARK_TEAM_ID").unwrap_or_else(|_| "teamId".to_string());
let url = format!("{}/v1/teams/{}", base_url.trim_end_matches('/'), team_id);
let token = env::var("OCTOSPARK_TOKEN").expect("OCTOSPARK_TOKEN");
let mut request = client.patch(url).bearer_auth(token);
request = request.json(&serde_json::json!({}));
let response = request.send().await?;
println!("{}", response.text().await?);
Ok(())
}import 'dart:convert';
import 'dart:io';
import 'package:http/http.dart' as http;
Future<void> main() async {
final baseUrl = Platform.environment['OCTOSPARK_API_URL'] ?? 'https://api.octospark.ai';
final token = Platform.environment['OCTOSPARK_TOKEN'];
final teamId = Platform.environment['OCTOSPARK_TEAM_ID'] ?? 'teamId';
final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId';
final uri = Uri.parse(url);
final headers = {
'Authorization': 'Bearer $token',
'Content-Type': 'application/json',
};
final response = await http.patch(
uri,
headers: headers,
body: jsonEncode({}),
);
print(response.body);
}curl --request PATCH \
--url https://api-staging.octospark.ai/v1/teams/{teamId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Acme Marketing",
"website": "https://acme.com",
"linkTrackingDefault": true,
"timezone": "Europe/London",
"postApprovalMode": "required",
"autoPostEnabled": true,
"reviewBoardVisibleCategories": []
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-staging.octospark.ai/v1/teams/{teamId}",
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' => 'Acme Marketing',
'website' => 'https://acme.com',
'linkTrackingDefault' => true,
'timezone' => 'Europe/London',
'postApprovalMode' => 'required',
'autoPostEnabled' => true,
'reviewBoardVisibleCategories' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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-staging.octospark.ai/v1/teams/{teamId}"
payload := strings.NewReader("{\n \"name\": \"Acme Marketing\",\n \"website\": \"https://acme.com\",\n \"linkTrackingDefault\": true,\n \"timezone\": \"Europe/London\",\n \"postApprovalMode\": \"required\",\n \"autoPostEnabled\": true,\n \"reviewBoardVisibleCategories\": []\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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-staging.octospark.ai/v1/teams/{teamId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Marketing\",\n \"website\": \"https://acme.com\",\n \"linkTrackingDefault\": true,\n \"timezone\": \"Europe/London\",\n \"postApprovalMode\": \"required\",\n \"autoPostEnabled\": true,\n \"reviewBoardVisibleCategories\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.octospark.ai/v1/teams/{teamId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Marketing\",\n \"website\": \"https://acme.com\",\n \"linkTrackingDefault\": true,\n \"timezone\": \"Europe/London\",\n \"postApprovalMode\": \"required\",\n \"autoPostEnabled\": true,\n \"reviewBoardVisibleCategories\": []\n}"
response = http.request(request)
puts response.read_body$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api-staging.octospark.ai/v1/teams/{teamId}' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"name": "Acme Marketing",
"website": "https://acme.com",
"linkTrackingDefault": true,
"timezone": "Europe/London",
"postApprovalMode": "required",
"autoPostEnabled": true,
"reviewBoardVisibleCategories": []
}'import Foundation
let parameters = [
"name": "Acme Marketing",
"website": "https://acme.com",
"linkTrackingDefault": true,
"timezone": "Europe/London",
"postApprovalMode": "required",
"autoPostEnabled": true,
"reviewBoardVisibleCategories": []
] as [String : Any?]
let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])
let url = URL(string: "https://api-staging.octospark.ai/v1/teams/{teamId}")!
var request = URLRequest(url: url)
request.httpMethod = "PATCH"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
]
request.httpBody = postData
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))using RestSharp;
var options = new RestClientOptions("https://api-staging.octospark.ai/v1/teams/{teamId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"name\": \"Acme Marketing\",\n \"website\": \"https://acme.com\",\n \"linkTrackingDefault\": true,\n \"timezone\": \"Europe/London\",\n \"postApprovalMode\": \"required\",\n \"autoPostEnabled\": true,\n \"reviewBoardVisibleCategories\": []\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
using RestSharp;
var options = new RestClientOptions("https://api-staging.octospark.ai/v1/teams/{teamId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"name\": \"Acme Marketing\",\n \"website\": \"https://acme.com\",\n \"linkTrackingDefault\": true,\n \"timezone\": \"Europe/London\",\n \"postApprovalMode\": \"required\",\n \"autoPostEnabled\": true,\n \"reviewBoardVisibleCategories\": []\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-staging.octospark.ai/v1/teams/{teamId}");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"name\": \"Acme Marketing\",\n \"website\": \"https://acme.com\",\n \"linkTrackingDefault\": true,\n \"timezone\": \"Europe/London\",\n \"postApprovalMode\": \"required\",\n \"autoPostEnabled\": true,\n \"reviewBoardVisibleCategories\": []\n}");
CURLcode ret = curl_easy_perform(hnd);CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-staging.octospark.ai/v1/teams/{teamId}");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"name\": \"Acme Marketing\",\n \"website\": \"https://acme.com\",\n \"linkTrackingDefault\": true,\n \"timezone\": \"Europe/London\",\n \"postApprovalMode\": \"required\",\n \"autoPostEnabled\": true,\n \"reviewBoardVisibleCategories\": []\n}");
CURLcode ret = curl_easy_perform(hnd);val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"name\": \"Acme Marketing\",\n \"website\": \"https://acme.com\",\n \"linkTrackingDefault\": true,\n \"timezone\": \"Europe/London\",\n \"postApprovalMode\": \"required\",\n \"autoPostEnabled\": true,\n \"reviewBoardVisibleCategories\": []\n}")
val request = Request.Builder()
.url("https://api-staging.octospark.ai/v1/teams/{teamId}")
.patch(body)
.addHeader("Authorization", "Bearer <token>")
.addHeader("Content-Type", "application/json")
.build()
val response = client.newCall(request).execute(){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"website": "<string>",
"linkTrackingDefault": true,
"timezone": "<string>",
"postApprovalMode": "off",
"autoPostEnabled": true,
"reviewBoardVisibleCategories": [
"not_started"
],
"createdAt": "<string>",
"updatedAt": "<string>"
}{
"issues": [
{
"_tag": "Pointer",
"path": [
"<string>"
],
"message": "<string>"
}
],
"message": "<string>",
"_tag": "HttpApiDecodeError"
}{
"message": "<string>",
"_tag": "Unauthorized"
}{
"message": "<string>",
"_tag": "PaymentRequired"
}{
"message": "<string>",
"_tag": "Forbidden"
}{
"message": "<string>",
"_tag": "NotFound"
}{
"message": "<string>",
"_tag": "Conflict",
"code": "<string>",
"currentRevision": 123
}{
"message": "<string>",
"code": "<string>",
"_tag": "UnprocessableEntity"
}{
"message": "<string>",
"_tag": "TooManyRequests",
"code": "<string>",
"retryAfterSeconds": 123
}{
"message": "<string>",
"_tag": "InternalError"
}Teams
Update team
Update a team’s settings, such as its name. Membership changes go through the team member endpoints, not this one.
PATCH
/
v1
/
teams
/
{teamId}
TypeScript client
import { OctosparkClient } from '@octospark/sdk'
const client = new OctosparkClient({
token: process.env.OCTOSPARK_TOKEN
})
const response = await client.teams.updateTeam({
teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
body: {},
})import os
from octospark_sdk import OctosparkClient
client = OctosparkClient(token=os.environ["OCTOSPARK_TOKEN"])
response = client.teams.update_team(
teamId=os.environ.get("OCTOSPARK_TEAM_ID", "teamId"),
body={}
)octospark teams update-team \
--request '{"path":{"teamId":"teamId"},"body":{}}'use reqwest::Client;
use std::env;
#[tokio::main]
async fn main() -> Result<(), reqwest::Error> {
let client = Client::new();
let base_url = env::var("OCTOSPARK_API_URL").unwrap_or_else(|_| "https://api.octospark.ai".to_string());
let team_id = env::var("OCTOSPARK_TEAM_ID").unwrap_or_else(|_| "teamId".to_string());
let url = format!("{}/v1/teams/{}", base_url.trim_end_matches('/'), team_id);
let token = env::var("OCTOSPARK_TOKEN").expect("OCTOSPARK_TOKEN");
let mut request = client.patch(url).bearer_auth(token);
request = request.json(&serde_json::json!({}));
let response = request.send().await?;
println!("{}", response.text().await?);
Ok(())
}import 'dart:convert';
import 'dart:io';
import 'package:http/http.dart' as http;
Future<void> main() async {
final baseUrl = Platform.environment['OCTOSPARK_API_URL'] ?? 'https://api.octospark.ai';
final token = Platform.environment['OCTOSPARK_TOKEN'];
final teamId = Platform.environment['OCTOSPARK_TEAM_ID'] ?? 'teamId';
final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/teams/$teamId';
final uri = Uri.parse(url);
final headers = {
'Authorization': 'Bearer $token',
'Content-Type': 'application/json',
};
final response = await http.patch(
uri,
headers: headers,
body: jsonEncode({}),
);
print(response.body);
}curl --request PATCH \
--url https://api-staging.octospark.ai/v1/teams/{teamId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Acme Marketing",
"website": "https://acme.com",
"linkTrackingDefault": true,
"timezone": "Europe/London",
"postApprovalMode": "required",
"autoPostEnabled": true,
"reviewBoardVisibleCategories": []
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-staging.octospark.ai/v1/teams/{teamId}",
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' => 'Acme Marketing',
'website' => 'https://acme.com',
'linkTrackingDefault' => true,
'timezone' => 'Europe/London',
'postApprovalMode' => 'required',
'autoPostEnabled' => true,
'reviewBoardVisibleCategories' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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-staging.octospark.ai/v1/teams/{teamId}"
payload := strings.NewReader("{\n \"name\": \"Acme Marketing\",\n \"website\": \"https://acme.com\",\n \"linkTrackingDefault\": true,\n \"timezone\": \"Europe/London\",\n \"postApprovalMode\": \"required\",\n \"autoPostEnabled\": true,\n \"reviewBoardVisibleCategories\": []\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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-staging.octospark.ai/v1/teams/{teamId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Marketing\",\n \"website\": \"https://acme.com\",\n \"linkTrackingDefault\": true,\n \"timezone\": \"Europe/London\",\n \"postApprovalMode\": \"required\",\n \"autoPostEnabled\": true,\n \"reviewBoardVisibleCategories\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.octospark.ai/v1/teams/{teamId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Marketing\",\n \"website\": \"https://acme.com\",\n \"linkTrackingDefault\": true,\n \"timezone\": \"Europe/London\",\n \"postApprovalMode\": \"required\",\n \"autoPostEnabled\": true,\n \"reviewBoardVisibleCategories\": []\n}"
response = http.request(request)
puts response.read_body$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api-staging.octospark.ai/v1/teams/{teamId}' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"name": "Acme Marketing",
"website": "https://acme.com",
"linkTrackingDefault": true,
"timezone": "Europe/London",
"postApprovalMode": "required",
"autoPostEnabled": true,
"reviewBoardVisibleCategories": []
}'import Foundation
let parameters = [
"name": "Acme Marketing",
"website": "https://acme.com",
"linkTrackingDefault": true,
"timezone": "Europe/London",
"postApprovalMode": "required",
"autoPostEnabled": true,
"reviewBoardVisibleCategories": []
] as [String : Any?]
let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])
let url = URL(string: "https://api-staging.octospark.ai/v1/teams/{teamId}")!
var request = URLRequest(url: url)
request.httpMethod = "PATCH"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
]
request.httpBody = postData
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))using RestSharp;
var options = new RestClientOptions("https://api-staging.octospark.ai/v1/teams/{teamId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"name\": \"Acme Marketing\",\n \"website\": \"https://acme.com\",\n \"linkTrackingDefault\": true,\n \"timezone\": \"Europe/London\",\n \"postApprovalMode\": \"required\",\n \"autoPostEnabled\": true,\n \"reviewBoardVisibleCategories\": []\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
using RestSharp;
var options = new RestClientOptions("https://api-staging.octospark.ai/v1/teams/{teamId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"name\": \"Acme Marketing\",\n \"website\": \"https://acme.com\",\n \"linkTrackingDefault\": true,\n \"timezone\": \"Europe/London\",\n \"postApprovalMode\": \"required\",\n \"autoPostEnabled\": true,\n \"reviewBoardVisibleCategories\": []\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-staging.octospark.ai/v1/teams/{teamId}");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"name\": \"Acme Marketing\",\n \"website\": \"https://acme.com\",\n \"linkTrackingDefault\": true,\n \"timezone\": \"Europe/London\",\n \"postApprovalMode\": \"required\",\n \"autoPostEnabled\": true,\n \"reviewBoardVisibleCategories\": []\n}");
CURLcode ret = curl_easy_perform(hnd);CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-staging.octospark.ai/v1/teams/{teamId}");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"name\": \"Acme Marketing\",\n \"website\": \"https://acme.com\",\n \"linkTrackingDefault\": true,\n \"timezone\": \"Europe/London\",\n \"postApprovalMode\": \"required\",\n \"autoPostEnabled\": true,\n \"reviewBoardVisibleCategories\": []\n}");
CURLcode ret = curl_easy_perform(hnd);val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"name\": \"Acme Marketing\",\n \"website\": \"https://acme.com\",\n \"linkTrackingDefault\": true,\n \"timezone\": \"Europe/London\",\n \"postApprovalMode\": \"required\",\n \"autoPostEnabled\": true,\n \"reviewBoardVisibleCategories\": []\n}")
val request = Request.Builder()
.url("https://api-staging.octospark.ai/v1/teams/{teamId}")
.patch(body)
.addHeader("Authorization", "Bearer <token>")
.addHeader("Content-Type", "application/json")
.build()
val response = client.newCall(request).execute(){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"website": "<string>",
"linkTrackingDefault": true,
"timezone": "<string>",
"postApprovalMode": "off",
"autoPostEnabled": true,
"reviewBoardVisibleCategories": [
"not_started"
],
"createdAt": "<string>",
"updatedAt": "<string>"
}{
"issues": [
{
"_tag": "Pointer",
"path": [
"<string>"
],
"message": "<string>"
}
],
"message": "<string>",
"_tag": "HttpApiDecodeError"
}{
"message": "<string>",
"_tag": "Unauthorized"
}{
"message": "<string>",
"_tag": "PaymentRequired"
}{
"message": "<string>",
"_tag": "Forbidden"
}{
"message": "<string>",
"_tag": "NotFound"
}{
"message": "<string>",
"_tag": "Conflict",
"code": "<string>",
"currentRevision": 123
}{
"message": "<string>",
"code": "<string>",
"_tag": "UnprocessableEntity"
}{
"message": "<string>",
"_tag": "TooManyRequests",
"code": "<string>",
"retryAfterSeconds": 123
}{
"message": "<string>",
"_tag": "InternalError"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.
Body
application/json
New team (workspace) display name, 2 to 64 characters.
Required string length:
2 - 64Example:
"Acme Marketing"
Brand website URL used for enrichment and display; null clears it.
Example:
"https://acme.com"
Default link-tracking toggle for new posts in this workspace; null resets to the plan default.
IANA timezone name (e.g. Europe/London) used to resolve this workspace's scheduling-slot wall-clock times to UTC instants; null clears it. Validated against the runtime's supported timezone list; an unsupported name is rejected with 400.
Example:
"Europe/London"
Client approval workflow mode: off hides review features and blocks new submit-for-review calls, optional (the default; null resets to it) enables the workflow as an advisory signal, required additionally blocks scheduling/publishing until the current content version is approved.
Available options:
off, optional, required Example:
"required"
Whether eligible content workflow statuses can trigger automatic publishing.
Workflow categories the client review-board link surfaces (any subset of not_started, active, in_review, completed, closed). Default is [in_review, completed] - submitted + approved posts.
Available options:
not_started, active, in_review, completed, closed Response
Success
a Universally Unique Identifier
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$a Universally Unique Identifier
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Available options:
off, optional, required Available options:
not_started, active, in_review, completed, closed