awork icon

awork

Automate your workflows with the awork API

Actions110

Document → Update Document

AI-generated

Summary

Update a document in a specified workspace by its Document ID, modifying one or more of its attributes such as name, emoji, project association, privacy settings, parent document, order, and workspace access level.

Inputs

  • Document ID (required) — The unique identifier of the document to update.
  • Update Fields — One or more document properties to update, including Document Space ID, Emoji icon, whether hidden for Connect users, name, order in document list, Parent Document ID, privacy status, associated Project ID, referenced Task ID, and workspace access level granted to users.

Output shape

A single updated document object containing the new state of the updated document fields.

The operation returns the updated document details upon success. If update fields are omitted, no changes are made. Errors occur if the Document ID is invalid or the update fails.

Examples

Example 1: Rename a document and set it to private

Provide the Document ID and set the Update Fields 'Name' to the new name and 'Private' to true.

Links

Discussion