Skip to content

by startups.studio

by Startups.Studio

Meeting.cancel

POST /{namespace}/meetings/{meeting}/cancel

Cancel ends a scheduled Meeting before it starts, frees its time, and applies the refund rule of any Offer it was paid through.

Noun: Meeting
Mode: do
Event: Meeting.canceled

You, to your agent

Cancel the latest meeting.

curl -X POST https://api.sb/leaseline.app/meetings/meeting_TyEQGjh9uX/cancel \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const meeting = await $.Meeting.cancel({ meeting: 'meeting_TyEQGjh9uX' })

npx startup-builder do Meeting.cancel --json '{"meeting":"meeting_TyEQGjh9uX"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Meeting.cancel({ meeting: 'meeting_TyEQGjh9uX' })"
  }
}

Inputs

Input	Type	Required	Description
`meeting`	Meeting	required	The Meeting to cancel.
`reason`	`string`		Why, as the attendees read it.

Outputs

Output	Type	Required	Description
`meeting`	Meeting	required	The canceled Meeting.

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	`Meeting.canceled`
Performed by	The Customer Lead

Frees the time in the host’s Availability.
A paid Meeting refunds as its Offer’s terms state, through Order.refund.

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

Meeting.book

Previous

Meeting.create

Next