/documents/{id}Write operationArchive a document
Requires the latest strong resource ETag. The cell-local App re-authenticates and atomically applies the tenant-bound revision before returning a fresh ETag.
documents:writePrepare this request
The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.
Path parameters
1idrequiredStable identifier of the resource in the authenticated workspace.
Headers
1If-MatchrequiredExactly one latest strong document ETag. Wildcards, weak validators, and lists are rejected.
Responses
11200The request to archive a document succeeded. The response contains the canonical public result and request metadata.application/json
application/jsonPublic API representation of document.
The attributes associated with this document.
archivedrequiredWhether this resource is archived.
contentThe content associated with this document attributes.
createdAtrequiredTimestamp at which the resource was created.
createdByrequiredIdentifier of the user or principal that created the resource.
namerequiredHuman-readable name of the resource.
updatedAtrequiredTimestamp of the most recent successful update.
updatedByrequiredIdentifier of the user or principal that most recently updated the resource.
idrequiredStable TeamGrid identifier for this resource.
typerequiredCanonical type discriminator for this resource.
Public API representation of meta.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
400The request is invalid.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
401The bearer credential is missing, invalid, expired, or revoked.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
403The credential has insufficient scope.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
404The tenant-scoped resource does not exist.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
409The request conflicts with the current resource state.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
412The resource changed since the supplied revision.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
428A strong If-Match revision is required.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
429The credential or source exceeded its rate limit.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
502The cell-local application returned an invalid response.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
503A required cell-local dependency is unavailable.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
Thank you. The rating contains no account or customer data.