NinjaOne icon

NinjaOne

Ninja One Public API documentation. <br><br>See also: <br> <a href="https://resources.ninjarmm.com/API/Ninja+RMM+Public+API+v2.0.5+Device+Filter+Syntax.pdf">Device Filter syntax</a><br><a href="https://app.ninjarmm.com/apidocs-beta/core-resources/articles/webhooks/overview">Webhooks</a>

Actions309

OrganizationDocuments → Update organization document

AI-generated

Summary

Update an existing organization document by specifying the organization and document IDs along with optional fields to modify its name, description, or other JSON-structured fields.

Inputs

  • Organization Id (required) — Numeric identifier for the target organization.
  • Client Document Id (required) — Numeric identifier of the document within the organization to update.
  • Additional Fields — Optional metadata to update including Document Name (string), Document Description (string), and Fields (JSON object) to modify document details.
  • Options — Optional settings including custom JSON body (merged with other fields but taking priority), custom HTTP headers, query string filters, batching controls, debug output enabling, pagination configuration, and request timeout.

Output shape

a single JSON object representing the updated organization document as returned by the API, including any updated fields and metadata.

Includes optional debug information with request details if enabled. Supports batching for multiple updates in one operation, although each request is made individually per input item with possible intervals between batches.

Examples

Example 1: Update a document's name and description

Set Organization Id and Client Document Id, fill 'Document Name' and 'Document Description' in Additional Fields, execute to update the document metadata.

Links

Discussion