---
title: "Update the state of an in-progress dataset"
method: PATCH
path: "/datasets/{doi}"
tags: ["datasets"]
---

# Update the state of an in-progress dataset

`PATCH /datasets/{doi}`

Sending a JSON patch request whose JSON body looks like **[ { 'op': 'replace', 'path': '/versionStatus', 'value': 'submitted' } ]**. (This is the most common command, attempting to change the versionStatus to 'submitted'.) Other options are available that are useful for integration with manuscript processing systems. See the [embedded Dryad documentation](https://github.com/datadryad/dryad-app/blob/main/documentation/apis/embedded_submission.md) for details. Set http header **'Content-Type: application/json-patch+json'** when making the request instead of a standard json content-type.

## Path parameters

- `doi` string, required

## Request body

- DatasetSubmission[]
  - `op` 'replace'
  - `path` '/versionStatus' | '/curationStatus' | 'publicationISSN'
  - `value` union
    - 'in_progress' | 'processing' | 'submitted'
    - 'queued' | 'submitted' | 'peer_review' | 'curation' | 'action_required' | 'withdrawn'
    - string

## Response `202`

Submission taking place, watch the dataset versionStatus for changes.

- Dataset
  - `identifier` string
  - `id` integer
  - `storageSize` integer
  - `relatedPublicationISSN` string
  - `_links` object
    - `self` HalLink
      - `href` string, uri, required
    - `stash:dataset` HalLink
      - `href` string, uri, required
    - `stash:files` HalLink
      - `href` string, uri, required
    - `stash:download` HalLink
      - `href` string, uri, required
    - `curies` HalCurie[]
      - `name` string, required
      - `href` string, uri, required
      - `templated` boolean, required
    - `stash:versions` HalLink
      - `href` string, uri, required
    - `stash:version` HalLink
      - `href` string, uri, required
  - `title` string, required
  - `authors` Author[], required
    - `firstName` string
    - `lastName` string
    - `email` string
    - `affiliation` string
    - `affiliationROR` string — Preferred identifier for the author affiliation.
    - `affiliations` unknown[]
      - unknown
    - `affiliationISNI` string
    - `orcid` string
    - `order` integer
  - `abstract` string, required — An abstract introducing the dataset.
  - `funders` Funder[]
    - `organization` string
    - `identifier` string — The organization identifier, for example a ROR ID.
    - `identifierType` string — Type of identifier — ror, isni, grid, crossref_funder_id or other.
    - `awardNumber` string
    - `awardDescription` string — Usually used for the program or the division of the award.
    - `order` integer
  - `keywords` string[]
  - `fieldOfScience` string — A term from the FOS (Fields of Science and Technology) controlled vocabulary. The main category of the dataset.
  - `hsiStatement` string — A statement explaining the de-identification of any human subject data in the dataset.
  - `methods` string — The methods by which the data was produced. Not required for publication.
  - `usageNotes` string — Usage notes for the dataset (Deprecated; It is preferred for this content to appear in the README file for the dataset). If the dataset has been retracted, the retraction statement will appear here.
  - `locations` Geolocation[]
    - `place` string — A place name.
    - `box` GeolocationBox
      - `swLongitude` number — The longitude of the southwest corner of the box.
      - `swLatitude` number — The latitude of the southwest corner of the box.
      - `neLongitude` number — The longitude of the northeast corner of the box.
      - `neLatitude` number — The latitude of the northeast corner of the box.
    - `point` GeolocationPoint
      - `latitude` number — The latitude of the point.
      - `longitude` number — The longitude of the point.
  - `relatedWorks` RelatedWork[]
    - `relationship` 'article' | 'dataset' | 'preprint' | 'software' | 'supplemental_information' | 'primary_article' | 'data_management_plan', string
    - `identifierType` string
    - `identifier` string
  - `versionNumber` integer
  - `versionStatus` 'in_progress' | 'processing' | 'submitted' — Internal processing status of files.
  - `curationStatus` 'In progress' | 'Processing' | 'Queued for curation' | 'Private for Peer Review' | 'Awaiting payment' | 'Curation' | 'Action required' | 'Withdrawn' | 'Embargoed' | 'Published' — Status of the submission in the curation workflow.
  - `versionChanges` 'files_changed' | 'metadata_changed'
  - `publicationDate` string
  - `lastModificationDate` string
  - `visibility` string — Whether or not this version is publicly visible.
  - `metrics` object
    - `views` integer
    - `downloads` integer
    - `citations` integer
  - `license` string — The license of the dataset

## Other responses

- `400`
- `401`
- `403`
- `406`

---

[API](https://skmtc.net/datadryad/apis/dryad-api.md) · [All operations](https://skmtc.net/datadryad/apis/dryad-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/datadryad/dryad-api/revisions/5e35babfb8d2/schema)