---
title: "POST /metadata"
method: POST
path: "/metadata"
---

# POST /metadata

`POST /metadata`

## Request

- The document declares no server URL.
- Auth: none declared

## Request body

- Metadata
  - `dataset_id` string, required: The unique dataset identifier for the dataset series.
  - `edition` string, required: The unique edition identifier.
  - `edition_title` string, required: The human readable title of the edition.
  - `quality_designation` 'accredited-official' | 'official' | 'official-in-development': The official statistics quality designation level of this dataset version.
  - `release_date` string, required: The date and time the dataset is to be released
  - `usage_notes` UsageNote[]
    - `title` string, required: The title of the usage note.
    - `note` string, required: The usage note text.
  - `alerts` Alert[]
    - `type` 'alert', required: Whether the alert is a general alert or a correction notice. This enum normally also has the option "correction". As corrections will not be supported in the scope of the current iteration, this enum has been restricted to only "alert". "correction" type alerts will need to be handled manually.
    - `description` string, required: The alert text that is displayed to the user
  - `distributions` Distribution[], required
    - `title` string, required: The title or label of the distribution.
    - `format` 'csv' | 'sdmx' | 'xls' | 'xlsx' | 'csdb', required: File type of the distribution.
    - `file` string, required: The file name of the associated data file. The data file is assumed to be in the zip alongside the metadata file. The file name must meet our URL standard meaning that it can only contain lowercase letters, numbers, dots (`.`) and hyphens (`-`).

## Changes

- **2025-04-25** `f7dad130aed8`: 1 breaking
  - added the new required request property `release_date`
- **2025-04-03** `b37528408dd6`: 1 breaking
  - the request property `edition_title` became required
- **2025-03-20** `aec576172a51`: 7 breaking, 1 info
  - the `alerts/items/description` request property's minLength was increased from `0` to `1`
  - the `dataset_id` request property's minLength was increased from `0` to `1`
  - the `distributions` request property's minLength was increased from `0` to `1`
  - the `distributions/items/title` request property's minLength was increased from `0` to `1`
  - …4 more
- **2025-03-12** `f7b5a3b0605c`: 3 breaking, 4 warning, 3 info
  - added the new required request property `distributions/items/file`
  - added the pattern `^[a-z0-9]+(-[a-z0-9]+)*$` to the request property `dataset_id`
  - added the pattern `^[a-z0-9]+(-[a-z0-9]+)*$` to the request property `edition`
  - the `dataset_id` request property's maxLength was set to `100`
  - …6 more
- **2025-03-12** `52867e71d0a3`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/office-of-national-statistics/apis/dataset-metadata-manifest-schema-definitions/changes/metadata/post.md)

---

[API](https://skmtc.dev/office-of-national-statistics/apis/dataset-metadata-manifest-schema-definitions.md) - [All operations](https://skmtc.dev/office-of-national-statistics/apis/dataset-metadata-manifest-schema-definitions/llms.txt) - [OpenAPI document](https://skmtc.dev/office-of-national-statistics/apis/dataset-metadata-manifest-schema-definitions/revisions/f7dad130aed8?raw)