Collection routes: update, delete

Reference for Collection, one group of Collection routes.

Collection.update

Changes the given properties of a Collection. Verb page.

Text

PATCH /{namespace}/collections/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Collection.
`type`	list of Noun		The Nouns this Thing is an instance of.
`outside`	`json`		The ids this Thing has in outside tools, one per Integration, so a re-run matches instead of duplicating.
`query`	`json`		The saved query that defines a dynamic Collection.

Returns

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

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.

Example

Terminal

curl -X PATCH https://api.sb/leaseline.app/collections/collection_txTK8QorKn \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":{}}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "collection": {
    "$id": "https://api.sb/leaseline.app/collections/collection_txTK8QorKn",
    "$type": "Collection",
    "id": "Example id",
    "type": [
      "noun_v0akLUrXCN"
    ],
    "query": {}
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Collection.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Collection.delete

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