Skip to main content

Archive a doc

Moves a doc to archive. Can be restored later.

Parameters​

No parameters.

Returns​

Returns the archived doc object.

post
/api/docs/{id}/archive
curl -X POST https://{workspace}.kitchen.co/api/docs/{id}/archive \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Bearer {API_KEY}'
Response
{
  "archived_at": "2024-03-15T10:47:02+00:00",
  "body": [
    "The doc body"
  ],
  "clients_can_edit": false,
  "created_at": "2024-03-12T10:11:23+00:00",
  "id": "doc_36e7eeabce00ecd1f5e9387a",
  "title": "The doc title",
  "updated_at": "2024-03-15T10:47:02+00:00",
  "visibility": "internal"
}