v1

latestOpenAPI 3.0.02026-08-04350108.2 KB
documents

Update document properties

Update document properties including status, name, instructions, and layout association.

Use this endpoint to:

  • Update the document name
  • Update instructions
  • Change the document status (completed, draft, published, archived)
  • Associate the document with a layout (e.g., after saving a new layout from a custom document)

At least one parameter (name, instructions, status, or layout_uuid) must be provided.

put/documents/{uuid}

Path parameters

uuidstring required

<tenant_uuid>_<document_uuid>

Request body

namestring

Document name

instructionsstring

Instructions content for the document. Changing this triggers content regeneration.

statusstring

Document status: 'completed', 'draft', 'published', or 'archived'.

content_typestring

Document type: 'document' or 'layout'

layout_uuidstring

Simple UUID of the layout to associate with this document