Skip to content

by Startups.Studio

Core grammar Thing Collection

Collection.delete

DELETE /{namespace}/collections/{id}

Deletes a Collection; its history is kept.

Noun: Collection
Mode: do
Event: Collection.deleted

You, to your agent

Remove the latest collection.

curl -X DELETE https://api.sb/ledgerlark.com/collections/collection_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const collection = await $.Collection.delete({ id: 'collection_1' })

npx startup-builder do Collection.delete --json '{"id":"collection_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Collection.delete({ id: 'collection_1' })"
  }
}

Delete removes a Collection; its history is kept. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Collection.

Outputs

Output	Type	Required	Description
`collection`	Collection	required	The Collection.

Effects

Emits Collection.deleted.
One-way: 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.	Collection.delete

When it waits

Gate	Default
Decision class	Medium: one-way, bounded
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`.

Collection.create

Previous Page

Collection.export

Next Page