POST
/
v1
/
teams
/
{teamId}
/
scheduling-slots
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

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

const response = await client.schedulingSlots.createSchedulingSlot({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  body: {},
})
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "hour": 11,
  "minute": 29,
  "label": "<string>",
  "daysOfWeek": [
    3
  ],
  "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
hour
integer
required

a number between 0 and 23

Required range: 0 <= x <= 23
minute
integer
required

a number between 0 and 59

Required range: 0 <= x <= 59
label
string | null

Optional human-friendly name for this slot (for example "Morning" or "Lunch"), shown in the composer and calendar. Omit it or send null to leave the slot unlabelled.

daysOfWeek
integer[]

Days of the week this slot fires on, as integers where 0 is Sunday through 6 is Saturday. Omit to default to all seven days.

Minimum array length: 1

a number between 0 and 6

Required range: 0 <= x <= 6

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}$
teamId
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}$
hour
integer
required

a number between 0 and 23

Required range: 0 <= x <= 23
minute
integer
required

a number between 0 and 59

Required range: 0 <= x <= 59
label
string | null
required
daysOfWeek
integer[]
required

an array of at least 1 item(s)

Minimum array length: 1

a number between 0 and 6

Required range: 0 <= x <= 6
createdAt
string
required
updatedAt
string
required