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 → Archive an organization document

AI-generated

Summary

Archive an organization document by specifying its client document ID, sending a POST request to the corresponding NinjaOne API endpoint to mark the document as archived.

Inputs

  • Client Document Id (required) — The numeric identifier of the client document to archive.
  • Custom Body — Optional JSON object to include in the request body, merged with standard parameters if any.
  • Custom Headers — Optional additional HTTP headers to include in the API request.
  • Query Filters — Optional query-string parameters to filter or modify the API request.
  • Batching — Optional batching configuration to send requests in groups with delay intervals.
  • Debug — Enable to include detailed request data (URL, headers, body) in the node output for troubleshooting.
  • Pagination — Pagination settings, generally unused for this single document archive operation.
  • Timeout (ms) — Maximum time to wait for the server response before aborting the request, defaulting to 5 minutes.

Output shape

a JSON object representing the API response confirming the archiving of the organization document

The response includes the standard API reply to the POST /v2/organization/document/{clientDocumentId}/archive endpoint. Enabling debug mode adds detailed request info under a debug field. Batch execution and query filters are supported but typically irrelevant for this single-item archive operation.

Examples

Example 1: Archive specific document by Client Document Id

Provide the Client Document Id of the document to archive and optionally customize headers or body if needed.

Links

Discussion