Skip to content

by Startups.Studio

Core grammar Document

Document.update

PATCH /{namespace}/documents/{id}

Changes the given properties of a Document.

Noun: Document
Mode: do
Event: Document.updated

You, to your agent

Change the latest document.

curl -X PATCH https://api.sb/quietcopy.com/documents/document_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"form":"document"}'

import { $ } from 'startup-builder'

const document = await $.Document.update({ id: 'document_1', form: 'document' })

npx startup-builder do Document.update --json '{"id":"document_1","form":"document"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Document.update({ id: 'document_1', form: 'document' })"
  }
}

Update changes the given properties of a Document. It is inherited: every Noun has get, list, create, update and delete.

Inputs

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

Outputs

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

Effects

Emits Document.updated.
Two-way: try, 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.	Document.update

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
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`.

Document.render

Previous Page

Entry

Next Page