Skip to content

by Startups.Studio

Growth Gathering

Gathering.register

POST /{namespace}/gatherings/{gathering}/register

Register gives a Contact a place at a Gathering, or a waitlist place when the Gathering is full.

Noun: Gathering
Mode: do
Event: Gathering.registered

You, to your agent

Register the latest gathering with a contact.

curl -X POST https://api.sb/kilnbakery.com/gatherings/gathering_1/register \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"contact":"contact_1"}'

import { $ } from 'startup-builder'

const { registration, gathering } = await $.Gathering.register({ gathering: 'gathering_1', contact: 'contact_1' })

npx startup-builder do Gathering.register --json '{"gathering":"gathering_1","contact":"contact_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Gathering.register({ gathering: 'gathering_1', contact: 'contact_1' })"
  }
}

Inputs

Input	Type	Required	Description
`gathering`	Gathering	required	The Gathering.
`contact`	Contact	required	Who takes the place.

Outputs

Output	Type	Required	Description
`registration`	Registration	required	The Registration, `registered` or `waitlisted`.
`gathering`	Gathering	required	The Gathering with its registered count.

Effects

Emits Gathering.registered.
Performed by the Marketing Lead.
Two-way: it runs at once, in the try, send and do modes.
Makes the Contact a Lead when it has no open Lead, with the Gathering’s Acquisition.

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

When it waits

Gate	Default
Decision class	Medium: two-way, visible
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
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.list

Previous Page

Gathering.update

Next Page