Skip to content

Gathering routes: update, delete

The Gathering Verbs update, delete as api.sb routes, with inputs, result, refusals and an example.

Reference for Gathering, one group of Gathering routes.

Gathering.update

Changes the given properties of a Gathering. Verb page.

Text
PATCH /{namespace}/gatherings/{id}

Path: id. Body, as JSON: the other inputs. Emits Gathering.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Gathering.
titlestringWhat the Gathering is called on its Page and invitations.
atdatetimeWhen it starts.
capacityintegerThe most Registrations it admits before new ones join the waitlist.
recordingurlWhere the replay lives once it ends.

Returns

OutputTypeRequiredDescription
gatheringGatheringrequiredThe Gathering.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X PATCH https://api.sb/leaseline.app/gatherings/gathering_ACB9Q1atRR \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Leaseline Pro"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "gathering": {
    "$id": "https://api.sb/leaseline.app/gatherings/gathering_ACB9Q1atRR",
    "$type": "Gathering",
    "title": "Leaseline Pro",
    "at": "2026-10-22T12:00:00Z"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Gathering.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Gathering.delete

Deletes a Gathering: a soft delete that keeps its history, undone by Thing.restore. Verb page.

Text
DELETE /{namespace}/gatherings/{id}

Path: id. Emits Gathering.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Gathering.

Returns

OutputTypeRequiredDescription
gatheringGatheringrequiredThe Gathering.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X DELETE https://api.sb/leaseline.app/gatherings/gathering_ACB9Q1atRR \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "gathering": {
    "$id": "https://api.sb/leaseline.app/gatherings/gathering_ACB9Q1atRR",
    "$type": "Gathering",
    "title": "Leaseline Pro",
    "at": "2026-10-22T12:00:00Z"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Gathering.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}