Skip to main content
POST
Create One-Time Window

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

Authorizations

Authorization
string
header
required

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

Path Parameters

team_id
string
required

Body

application/json
name
string
required
kind
enum<string>
required

TimeWindowKind is the role of a one-time window (see OneTimeWindow).

Available options:
TIME_WINDOW_KIND_UNSPECIFIED,
TIME_WINDOW_KIND_HOLIDAY,
TIME_WINDOW_KIND_BLACKOUT,
TIME_WINDOW_KIND_OTHER
startsAt
string<date-time>
required

A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").

Examples:

"2025-01-15T01:30:15.000Z"

"2025-06-01T00:00:00.000Z"

endsAt
string<date-time>
required

A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").

Examples:

"2025-01-15T01:30:15.000Z"

"2025-06-01T00:00:00.000Z"

allDay
boolean

When true, starts_at and ends_at must be midnight UTC boundaries; ends_at is exclusive.

description
string | null
scopedId
string | null

Copy-invariant identity. Omit to have the server mint one.

Response

200 - application/json

Success

data
data · object