---
title: "Retracts a dataset after it has been published. Requires a json body with a single field {retraction_reason: string}. The dataset for the given id is modified to include this new retraction_reason field and sets the dataset property sub_status to Retracted. The complete modified dataset is returned. Requires that the dataset being retracted has already been published (dataset.status == Published. Requires a user token with membership in the HuBMAP-Data-Admin group otherwise then a 403 will be returned."
method: PUT
path: "/datasets/{id}/retract"
---

# Retracts a dataset after it has been published. Requires a json body with a single field {retraction_reason: string}. The dataset for the given id is modified to include this new retraction_reason field and sets the dataset property sub_status to Retracted. The complete modified dataset is returned. Requires that the dataset being retracted has already been published (dataset.status == Published. Requires a user token with membership in the HuBMAP-Data-Admin group otherwise then a 403 will be returned.

`PUT /datasets/{id}/retract`

## Path parameters

- `id` string, required

## Request body

- object
  - `retraction_reason` string — Free text describing why the dataset was retracted

## Response `200`

The complete dataset with modified sub_status and retraction_reason

- object

## Other responses

- `400` — Invalid or misformatted entity identifier, the given entity is not a Dataset, is not published or the required retraction_reason was not included in a json body
- `401` — The user's token has expired or the user did not supply a valid token
- `403` — The user is not authorized to query the retract the given dataset. The user must be a member of the HuBMAP-Data-Admin group
- `404` — The target dataset could not be found
- `500` — Internal error

---

[API](https://skmtc.net/hubmapconsortium/apis/hubmap-entity-api.md) · [All operations](https://skmtc.net/hubmapconsortium/apis/hubmap-entity-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hubmapconsortium/hubmap-entity-api/versions/a192f35c6b16/schema)