Document routes: update, delete

Reference for Document, one group of Document routes.

Document.update

Changes the given properties of a Document. Verb page.

Text

PATCH /{namespace}/documents/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Document.
`form`	`string`		One of `document`, `deck`, or `sheet`.

Returns

Output	Type	Required	Description
`document`	Document	required	The Document.

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/documents/document_af2wijcmRy \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"form":"document"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "document": {
    "$id": "https://api.sb/leaseline.app/documents/document_af2wijcmRy",
    "$type": "Document",
    "form": "document"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Document.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Document.delete

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