Skip to main content

Archive a document

Moves a document to archive. Can be restored later.

Parameters​

No parameters.

Returns​

Returns the archived document object.

post
/api/documents/{id}/archive
curl -X POST https://{workspace}.documocu.com/api/documents/{id}/archive \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {API_KEY}'
Response
{
  "activity": null,
  "allow_download": false,
  "allow_forwarding": true,
  "archived_at": "2024-03-15T10:47:02+00:00",
  "author": "u_zxlr80cwmrshq0uk0bk7nnik",
  "completed_at": null,
  "cover_page": null,
  "created_at": "2024-05-14T05:36:50+00:00",
  "currency": "USD",
  "declined_at": null,
  "deleted_at": null,
  "expiration_date": null,
  "expiration_date_in_days": null,
  "expiration_warning": false,
  "expired_at": null,
  "id": "doc_96kjrc28vp1xdjestep1fu25",
  "modifier": "u_by5010epw5yhbrnb73hgxbjc",
  "name": "Veniam rerum earum debitis et quia et.",
  "page_orientation": "portrait",
  "page_size": "a4",
  "recipient_language": "en_US",
  "recipients": null,
  "recurring_reminder_frequency": null,
  "recurring_reminder_period_unit": null,
  "reminder_days": null,
  "sent_at": null,
  "sent_via": null,
  "status": "draft",
  "type": "regular",
  "updated_at": "2024-05-14T05:36:50+00:00",
  "value": 0,
  "viewed_at": null
}