Update a deliverable

PUT /api/v1/deliverables/{deliverableId}

Replaces the definition of a deliverable.

This is a full replacement, not a partial update. Send every field you want to keep: an omitted expectations or criteria is erased.

Authorization

Role in the organization	This endpoint
`OWNER`	Allowed
`ADMIN`	Allowed
`MEMBER`	Refused — `403`

Requirement	Rule for this endpoint
Business role	None
Resource scope	Deliverable of the school attached to the API key
Participation	None
Resource state	An archived deliverable, or one whose task is archived, answers `403`

Path parameters

Parameter	Type	Required	Description
`deliverableId`	UUID	yes	Deliverable visible from the key's school

Request headers

Header	Required	Description
`x-api-key`	yes	API key created for this school
`Idempotency-Key`	yes	Stable key for this change
`X-Correlation-Id`	no	Caller correlation id, returned or generated

Request body

Field	Type	Required	Nullable	Description
`title`	string	yes	no	3 to 100 characters
`acceptedFormats`	array	yes	no	At least one entry, each `kind` at most once
`acceptedFormats[].kind`	string	yes	no	`file` or `link`
`acceptedFormats[].mimeTypes`	array of string	no	no	For a `file`: up to 20 types such as `application/pdf`. A `link` accepts none
`expectedReviewerRole`	string	yes	no	`program_director`, `coach` or `reviewer`
`expectations`	string	no	yes	What the member must produce, up to 2000 characters
`criteria`	string	no	yes	How it is judged, up to 2000 characters

Example

bash

curl -X PUT "$COHORTE_API_BASE_URL/api/v1/deliverables/$DELIVERABLE_ID" \
  -H "x-api-key: $COHORTE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{"title":"Landing page URL","acceptedFormats":[{"kind":"link"},{"kind":"file","mimeTypes":["application/pdf"]}],"expectedReviewerRole":"coach"}'

Response

200 OK — the deliverable, as it now stands. replayed is true when the same Idempotency-Key replayed an earlier change.
400 Bad Request — missing Idempotency-Key, invalid JSON, a missing required field, or invalid formats.
401 Unauthorized — the key is missing, invalid, or no longer attached to a member.
403 Forbidden — the bearer is not OWNER or ADMIN, or the deliverable or its task is archived.
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

json

{
  "success": true,
  "data": {
    "id": "e5b2a7c1-0000-4000-8000-000000000000",
    "memberTaskId": "c3f1d2a4-0000-4000-8000-000000000000",
    "title": "Landing page URL",
    "expectations": "The public URL of your landing page.",
    "criteria": "The page states the offer, the price and one call to action.",
    "acceptedFormats": [{"kind": "link", "mimeTypes": []}],
    "expectedReviewerRole": "coach",
    "status": "active",
    "archivedAt": null,
    "archiveReason": null,
    "createdAt": "2026-09-24T08:00:00.000Z",
    "updatedAt": "2026-09-24T08:00:00.000Z"
  },
  "correlationId": "b0e7f1c2-1d3a-4a52-9f77-52a4b7c3d1e0"
}

Notes

The change, its audit entry and the deliverable.updated event — carrying the definition before and after — are written in one transaction.
Submissions already handed in are not re-checked against the new formats.
No email or notification is sent.

PUT /api/v1/deliverables/{deliverableId}

Replaces the definition of a deliverable.

This is a full replacement, not a partial update. Send every field you want to keep: an omitted expectations or criteria is erased.

Authorization

Role in the organization	This endpoint
`OWNER`	Allowed
`ADMIN`	Allowed
`MEMBER`	Refused — `403`

Requirement	Rule for this endpoint
Business role	None
Resource scope	Deliverable of the school attached to the API key
Participation	None
Resource state	An archived deliverable, or one whose task is archived, answers `403`

Path parameters

Parameter	Type	Required	Description
`deliverableId`	UUID	yes	Deliverable visible from the key's school

Request headers

Header	Required	Description
`x-api-key`	yes	API key created for this school
`Idempotency-Key`	yes	Stable key for this change
`X-Correlation-Id`	no	Caller correlation id, returned or generated

Request body

Field	Type	Required	Nullable	Description
`title`	string	yes	no	3 to 100 characters
`acceptedFormats`	array	yes	no	At least one entry, each `kind` at most once
`acceptedFormats[].kind`	string	yes	no	`file` or `link`
`acceptedFormats[].mimeTypes`	array of string	no	no	For a `file`: up to 20 types such as `application/pdf`. A `link` accepts none
`expectedReviewerRole`	string	yes	no	`program_director`, `coach` or `reviewer`
`expectations`	string	no	yes	What the member must produce, up to 2000 characters
`criteria`	string	no	yes	How it is judged, up to 2000 characters

Example

bash

curl -X PUT "$COHORTE_API_BASE_URL/api/v1/deliverables/$DELIVERABLE_ID" \
  -H "x-api-key: $COHORTE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{"title":"Landing page URL","acceptedFormats":[{"kind":"link"},{"kind":"file","mimeTypes":["application/pdf"]}],"expectedReviewerRole":"coach"}'

Response

200 OK — the deliverable, as it now stands. replayed is true when the same Idempotency-Key replayed an earlier change.
400 Bad Request — missing Idempotency-Key, invalid JSON, a missing required field, or invalid formats.
401 Unauthorized — the key is missing, invalid, or no longer attached to a member.
403 Forbidden — the bearer is not OWNER or ADMIN, or the deliverable or its task is archived.
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

json

{
  "success": true,
  "data": {
    "id": "e5b2a7c1-0000-4000-8000-000000000000",
    "memberTaskId": "c3f1d2a4-0000-4000-8000-000000000000",
    "title": "Landing page URL",
    "expectations": "The public URL of your landing page.",
    "criteria": "The page states the offer, the price and one call to action.",
    "acceptedFormats": [{"kind": "link", "mimeTypes": []}],
    "expectedReviewerRole": "coach",
    "status": "active",
    "archivedAt": null,
    "archiveReason": null,
    "createdAt": "2026-09-24T08:00:00.000Z",
    "updatedAt": "2026-09-24T08:00:00.000Z"
  },
  "correlationId": "b0e7f1c2-1d3a-4a52-9f77-52a4b7c3d1e0"
}

Notes

The change, its audit entry and the deliverable.updated event — carrying the definition before and after — are written in one transaction.
Submissions already handed in are not re-checked against the new formats.
No email or notification is sent.

Update a deliverable

Update a deliverable

Authorization

Path parameters

Request headers

Request body

Example

Response

Response fields

Example response

Notes

Related

Authorization

Path parameters

Request headers

Request body

Example

Response

Response fields

Example response

Notes

Related