Archive a deliverable

POST /api/v1/deliverables/{deliverableId}/archive

Retires a deliverable. Its content stays: submissions already reviewed keep the definition that judged them. Once archived, the task can receive a new deliverable.

Authorization

Path parameters

Request headers

Request body

Example

curl -X POST "$COHORTE_API_BASE_URL/api/v1/deliverables/$DELIVERABLE_ID/archive" \
  -H "x-api-key: $COHORTE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{"reason":"Replaced by a recorded demo."}'

Response

• 200 OK — the deliverable is archived. replayed is true when it already was, and nothing was written.
• 400 Bad Request — missing Idempotency-Key, invalid JSON, an invalid date, or a reason over 500 characters.
• 401 Unauthorized — the key is missing, invalid, or no longer attached to a member.
• 403 Forbidden — the bearer is not OWNER or ADMIN of this school.
• 404 Not Found — the deliverable is unknown or belongs to another school.

Response fields

The same fields as Get a deliverable, plus replayed.

Example response

{
  "success": true,
  "data": {
    "id": "e5b2a7c1-0000-4000-8000-000000000000",
    "memberTaskId": "c3f1d2a4-0000-4000-8000-000000000000",
    "title": "Landing page URL",
    "expectations": null,
    "criteria": null,
    "acceptedFormats": [{"kind": "link", "mimeTypes": []}],
    "expectedReviewerRole": "coach",
    "status": "archived",
    "archivedAt": "2026-09-30T08:00:00.000Z",
    "archiveReason": "Replaced by a recorded demo.",
    "createdAt": "2026-09-24T08:00:00.000Z",
    "updatedAt": "2026-09-30T08:00:00.000Z"
  },
  "replayed": false,
  "correlationId": "b0e7f1c2-1d3a-4a52-9f77-52a4b7c3d1e0"
}

Notes

• The archival, its audit entry and the deliverable.archived event are written in one transaction.
• No email or notification is sent.

Related

• Create a deliverable
• Archive a member task