Archive a document

Archive a document. Archiving is reversible with unarchive; nothing is deleted. An archived document is no longer rendered and its key is released, so a new document can be created with the same key. Returns the archived document.

Documents are shared by your sandbox and production environments, so changing one with an API key requires a production API key. A sandbox API key can read documents but gets 403 here.

Documents are opt-in per organization: unless the org_documents feature flag is enabled for your organization this endpoint returns 404.

Path Params
string
required

Must be a UUID. The unique identifier of the document.

Responses

403

The request used a sandbox API key, or the caller is missing the communications:edit permission.

404

No such document, or documents are not enabled for the organization.

409

The document is already archived.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json