Archive document

POST/api/v1/documents/{ref}/archive

This endpoint isn’t available for live testing.

curl -X POST 'https://app.quote.cloud/api/v1/documents/{ref}/archive?client_id=<your client id>' \
  -H 'Authorization: Bearer <your token>'

<your token> and <your client id> are placeholders. Get your own

Inputs

refrequiredThe document’s number, shown as #1234 in the ID column of your documents list and beside the title in the editor. Enter it without the #. In API responses it’s displayId.

client_idrequiredYou don’t need to enter this here. In your own code, use the Client ID from your OAuth client. How to get one

Not sure what to enter? Here’s where to find IDs

Example response

{
  "data": {
    "id": "string",
    "documentRef": "string",
    "affectedVersionCount": 0,
    "archived": true
  }
}

The spec has no example, so this 200 response is generated from the schema. Values are placeholders.

Archive a document and its revision family

Permission

An OAuth access token with this scope. How to get a token

documents:archive

Archive and restore documents.

Parameters

Not sure what to enter? Here’s where to find IDs.

refpath · stringrequired

The document’s number, shown as #1234 in the ID column of your documents list and beside the title in the editor. Enter it without the #. In API responses it’s displayId.Matches ^\d+$.

client_idquery · stringrequired

The Client ID of your OAuth client. It’s public, and goes on every request alongside your access token. Find it in QuoteCloud under Settings → API dashboard → Manage Integrations → OAuth Clients.Length at least 1.

Responses

200Document family archived.

dataobjectrequired

Fields

idstringrequired

documentRefstringrequired

affectedVersionCountintegerrequired

archivedbooleanrequired

401Missing or invalid bearer token or client ID.

errorstringrequired

error_descriptionstring

403Insufficient scope, missing add-on, usage limit, or permission denial.

Exactly one of these:

OAuthError

errorstringrequired

error_descriptionstring

ApiErrorEnvelope

dataobjectrequired

Fields

statusstringrequired

Always error.

messagestringrequired

codestring

documentRefstring

assetGenerationIdstring

errorsarray of object

Item fields

fieldstringrequired

messagestringrequired

404Requested resource was not found in the token's company.

dataobjectrequired

Fields

statusstringrequired

Always error.

messagestringrequired

codestring

documentRefstring

assetGenerationIdstring

errorsarray of object

Item fields

fieldstringrequired

messagestringrequired

409Request conflicts with resource state or an idempotent request.

dataobjectrequired

Fields

statusstringrequired

Always error.

messagestringrequired

codestring

documentRefstring

assetGenerationIdstring

errorsarray of object

Item fields

fieldstringrequired

messagestringrequired

Rate limit

120 requests a minute per company, shared across REST, Zapier and MCP. On a 429, wait for Retry-After.