Skip to main content
POST
/
v1
/
cases
/
{id}
curl --request POST \
  --url https://connect.penbox.io/v1/cases/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "archived": true }'
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "Onboarding - Acme Corp",
  "status": "in_progress",
  "archived_at": "2026-06-30T10:00:00.000Z"
}
Archive or unarchive a case. Set archived to true to archive the case, or false to restore (unarchive) it.
Templates cannot be archived. Calling this endpoint on a case template returns a 400 error.

Path Parameters

id
string
required
The UUID of the case to archive or unarchive.

Body

archived
boolean
required
Set to true to archive the case, or false to unarchive (restore) it.

Response

Returns the updated case, including its steps and schema. The archived_at timestamp is set when the case is archived, and null when it is restored.
id
string
The case UUID.
archived_at
string | null
ISO 8601 timestamp set when the case was archived, or null if the case is not archived.
curl --request POST \
  --url https://connect.penbox.io/v1/cases/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "archived": true }'
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "Onboarding - Acme Corp",
  "status": "in_progress",
  "archived_at": "2026-06-30T10:00:00.000Z"
}