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: {},
})
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "website": "<string>",
  "linkTrackingDefault": true,
  "timezone": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

Body

application/json
​
name
string

New team (workspace) display name, 2 to 64 characters.

Required string length: 2 - 64
Example:

"Acme Marketing"

​
website
string | null

Brand website URL used for enrichment and display; null clears it.

Example:

"https://acme.com"

​
linkTrackingDefault
boolean | null

Default link-tracking toggle for new posts in this workspace; null resets to the plan default.

​
timezone
string | null

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"

Response

Success

​
id
string<uuid>
required

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}$
​
organizationId
string<uuid>
required

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}$
​
name
string
required
​
website
string | null
required
​
linkTrackingDefault
boolean | null
required
​
timezone
string | null
required
​
createdAt
string
required
​
updatedAt
string
required