Availability commands: set
The Availability Verbs set as CLI commands, with inputs, result, refusals and an example.
Reference for Availability, one group of Availability commands.
Availability.set
Set records the weekly hours a Worker can be booked in and the calendars whose busy times it subtracts. Verb page.
npx startup-builder do Availability.set --json '<input>' [--try | --send | --do]Emits Availability.set.
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. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
availability | Availability | required | The Availability, replacing the Worker’s last one. |
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. |
Example
npx startup-builder do Availability.set --json '{"worker": "worker_whZFpOKWIV", "hours": {"tue": ["09: 00-12: 00"], "thu": ["13: 00-17: 00"]}, "timezone": "America/ Chicago"}'