Skip to content

by startups.studio

by Startups.Studio

Growth Availability

Availability.set

POST /{namespace}/availabilities/set

Set records the weekly hours a Worker can be booked in and the calendars whose busy times it subtracts.

Noun: Availability
Mode: do
Event: Availability.set

You, to your agent

Set the latest availability with a worker.

curl -X POST https://api.sb/leaseline.app/availabilities/set \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"worker":"worker_whZFpOKWIV","hours":{"tue":["09:00-12:00"],"thu":["13:00-17:00"]},"timezone":"America/Chicago"}'

import { $ } from 'startup-builder'

const availability = await $.Availability.set({ worker: 'worker_whZFpOKWIV', hours: { tue: ['09:00-12:00'], thu: ['13:00-17:00'] }, timezone: 'America/Chicago' })

npx startup-builder do Availability.set --json '{"worker":"worker_whZFpOKWIV","hours":{"tue":["09:00-12:00"],"thu":["13:00-17:00"]},"timezone":"America/Chicago"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Availability.set({ worker: 'worker_whZFpOKWIV', hours: { tue: ['09:00-12:00'], thu: ['13:00-17:00'] }, timezone: 'America/Chicago' })"
  }
}

Inputs

Input	Type	Required	Description
`worker`	Worker	required	Who is booked.
`hours`	`json`	required	Open hours by weekday.
`timezone`	`string`	required	An IANA time zone.
`calendars`	`string[]`		Connected calendars to subtract busy times from.

Outputs

Output	Type	Required	Description
`availability`	Availability	required	The Availability, replacing the Worker’s last one.

Effects

Fact	Value
Action class	None: it runs within its seat's Limits
Door	Two-way: it runs at once
Modes	`try` previews it and stores nothing; `send` returns a pending Action; `do` (default) waits for the result
Idempotent	With a key: a repeat with the same `Idempotency-Key` returns the first Action, and a repeat without one runs again
Undo	Action.undo reverses it
Emits	`Availability.set`
Performed by	The Customer Lead

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Availability.list

Previous

Availability.update

Next