Skip to content

by Startups.Studio

Growth Gathering

Gathering.update

PATCH /{namespace}/gatherings/{id}

Changes the given properties of a Gathering.

Noun: Gathering
Mode: do
Event: Gathering.updated

You, to your agent

Change the latest gathering.

curl -X PATCH https://api.sb/kilnbakery.com/gatherings/gathering_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Saturday sourdough"}'

import { $ } from 'startup-builder'

const gathering = await $.Gathering.update({ id: 'gathering_1', title: 'Saturday sourdough' })

npx startup-builder do Gathering.update --json '{"id":"gathering_1","title":"Saturday sourdough"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Gathering.update({ id: 'gathering_1', title: 'Saturday sourdough' })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Gathering.
`title`	`string`		What the Gathering is called on its Page and invitations.
`at`	`datetime`		When it starts.
`capacity`	`integer`		The most Registrations it admits before new ones join the waitlist.
`recording`	`url`		Where the replay lives once it ends.

Outputs

Output	Type	Required	Description
`gathering`	Gathering	required	The Gathering.

Effects

Emits Gathering.updated.
Two-way: try, send, do.

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.	Gathering.update

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

Gathering.register

Previous Page

Goal

Next Page