POST
/
v1
/
teams
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.teams.createTeam({
  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.

Body

application/json
organizationId
string<uuid>
required

UUID of the organization the team (workspace) belongs to.

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}$
Example:

"5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e"

name
string
required

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"

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
timezone
string | null
required
createdAt
string
required
updatedAt
string
required