Skip to content

by startups.studio

by Startups.Studio

Growth Availability

Availability.update

PATCH /{namespace}/availabilities/{id}

Changes the given properties of an Availability.

Noun: Availability
Mode: do
Event: Availability.updated

You, to your agent

Change the latest availability.

curl -X PATCH https://api.sb/leaseline.app/availabilities/availability_8Zj0a7vvRl \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"worker":"worker_whZFpOKWIV"}'

import { $ } from 'startup-builder'

const availability = await $.Availability.update({ id: 'availability_8Zj0a7vvRl', worker: 'worker_whZFpOKWIV' })

npx startup-builder do Availability.update --json '{"id":"availability_8Zj0a7vvRl","worker":"worker_whZFpOKWIV"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Availability.update({ id: 'availability_8Zj0a7vvRl', worker: 'worker_whZFpOKWIV' })"
  }
}

Update changes the given properties of an Availability. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Availability.
`worker`	Worker		Who is booked: a Human, or an Agent that takes calls.
`hours`	`json`		Open hours by weekday, in its time zone.
`timezone`	`string`		An IANA time zone.
`calendars`	`string[]`		Connected calendars whose busy times it subtracts.
`buffer`	`integer`		Minutes kept free before and after each Meeting.
`notice`	`integer`		The fewest hours ahead a Meeting can be booked.

Outputs

Output	Type	Required	Description
`availability`	Availability	required	The Availability.

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.updated`

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.set

Previous

Campaign

Next