Create and edit documents

Use the createDocument, updateDocument, and deleteDocument mutations to manage the lifecycle of a rich-text document — a collaboratively-edited page that lives inside a workspace. Workspaces are Project objects in the API, and each document is a Document. The same Document row powers both regular documents and Wiki pages: set wiki: true on create to make it a Wiki page.

Use content to read or write the document body as HTML. Blue converts it to the same collaborative state used by the editor. The raw collaboration state is internal and is not part of the public API.

This page covers rich-text documents only. The separate Portable Document subsystem (PDF templates for printing record data) is documented under Build Portable Document templates.

Request

Create a document in a workspace. projectId is the only required field; everything else is optional.

mutation CreateDocument {
  createDocument(
    input: {
      projectId: "project_123"
      title: "Onboarding runbook"
      content: "<h1>Onboarding runbook</h1><p>Step 1…</p>"
    }
  ) {
    id
    title
    wiki
    createdAt
  }
}

To create a Wiki page instead, set wiki: true:

mutation CreateWikiPage {
  createDocument(input: { projectId: "project_123", title: "Team handbook", wiki: true }) {
    id
    title
    wiki
  }
}

Parameters

CreateDocumentInput

Parameter	Type	Required	Description
`projectId`	`String!`	Yes	ID or slug of the workspace (`Project`) the document belongs to.
`title`	`String`	No	Document title. Defaults to an empty string if omitted.
`content`	`String`	No	Document body as HTML. Defaults to an empty document if omitted.
`wiki`	`Boolean`	No	When `true`, the document is a Wiki page instead of a regular document. The workspace must have the corresponding feature enabled (see Permissions).

Response

{
  "data": {
    "createDocument": {
      "id": "clm4n8qwx000008l0g4oxdqn7",
      "title": "Onboarding runbook",
      "wiki": null,
      "createdAt": "2026-05-29T10:12:04.000Z"
    }
  }
}

Document

The fields available on the returned Document type.

Field	Type	Description
`id`	`ID!`	Unique document identifier.
`uid`	`String!`	Short stable identifier used in URLs.
`title`	`String!`	Document title.
`content`	`String`	Document body as HTML.
`wiki`	`Boolean`	`true` if this is a Wiki page; otherwise `null`/`false`.
`project`	`Project!`	The workspace the document belongs to.
`createdBy`	`User!`	The user who created the document.
`createdAt`	`DateTime!`	When the document was created.
`updatedAt`	`DateTime!`	When the document was last modified.

Update a document

Use updateDocument to change a document’s fields. Only id is required — include just the fields you want to change. A title-only edit passes through without touching content.

mutation UpdateDocument {
  updateDocument(
    input: {
      id: "document_123"
      title: "Onboarding runbook (v2)"
      content: "<h1>Onboarding runbook</h1><p>Updated.</p>"
    }
  ) {
    id
    title
    updatedAt
  }
}

UpdateDocumentInput

Parameter	Type	Required	Description
`id`	`ID!`	Yes	ID of the document to update.
`title`	`String`	No	New title.
`content`	`String`	No	New HTML body. An explicit empty string clears the body. If omitted, the existing body is unchanged.
`wiki`	`Boolean`	No	Flip the document between document and Wiki page. The caller must have permission for both the current and the resulting type.

Delete a document

Use deleteDocument to delete a document by ID. It returns Boolean — true on success — so it takes no sub-selection. The deleted document is moved to trash, not hard-deleted.

mutation DeleteDocument {
  deleteDocument(id: "document_123")
}

{ "data": { "deleteDocument": true } }

Errors

Code	Operation	When
`PROJECT_NOT_FOUND`	`createDocument`	No workspace matches `projectId`.
`DOCUMENT_NOT_FOUND`	`updateDocument`, `deleteDocument`	No document matches `id`.
`FORBIDDEN`	all	The caller is not an ADMIN/OWNER/MEMBER on the workspace, or their role cannot use the docs or wiki feature.
`RATE_LIMITED`	`createDocument`	More than 5 `createDocument` calls in the 60-second window for the same user (default limit).
`UNAUTHENTICATED`	all	The request carries no valid credentials.

Permissions

createDocument requires the caller to be an ADMIN, OWNER, or MEMBER on the workspace, and the workspace must have the relevant feature enabled for that role: the docs feature for a regular document, or the wiki feature when wiki: true. It is rate-limited to a default of 5 requests per 60 seconds per user.
updateDocument and deleteDocument require the caller to have permission for the document’s type (docs for documents, wiki for Wiki pages). For an update that flips wiki, the caller needs permission for both the current and the resulting type. deleteDocument also succeeds for the document’s original creator.

Query and subscribe to documents — fetch a document, list a workspace’s documents, and stream real-time changes.
Build Portable Document templates — the separate PDF-template subsystem.
Documents overview — how rich-text Documents and Portable Documents differ.