Skip to content
/
Archive a List

Archive a List

Request

Archive a List, which is how a List is deleted. It leaves every list view; the app can restore it. Use this when someone asks to delete or archive a List. Archiving is how a List is deleted; the owner may restore it in the app. Only the owner may archive (403 owner_only).

Security
bearerKey
Path
idstringrequired
Headers
Idempotency-Keystring, [ 1 .. 128 ] characters

1 to 128 characters. A retry with the same key and body returns the first result; the same key with another body is 409.

Bodyapplication/json
object
curl -i -X POST \
  'https://docs.societyhealth.co/_mock/docs/openapi/api/v1/lists/{id}/archive' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Done.

Bodyapplication/json
okanyrequired
Value:true
dataobject(PublicList)required
Response
{
  "ok": true,
  "data": {
    "id": "Lst8kQ2mZp4xV7nR1tYw",
    "url": "https://hrcledger.com/lists/items/Lst8kQ2mZp4xV7nR1tYw",
    "name": "Virginia systems",
    "purpose": "general",
    "archived": true,
    "revisionNo": 2,
    "updatedAt": "2026-10-16T14:02:11.000Z"
  }
}