---
title: "Request an update to the schema definition of a entity"
method: PATCH
path: "/v1/entities/{name}"
tags: ["entities"]
---

# Request an update to the schema definition of a entity

`PATCH /v1/entities/{name}`

Request updates to the definition of an existing data set (as a partial update).

A request can only be raised for one property of the entity's schema definition at a time.

In a future version of the API, the response will include a link to the resulting `request` resource (but this isn't implemented yet).

## Path parameters

- `name` string, required

## Query parameters

- `field` string, required
- `property` string, required
- `newValue` string, required

## Response `202`

Accepted

- RequestAccepted
  - `status` string
  - `code` integer
  - `type` string
  - `detail` string

## Other responses

- `400` — Bad request
- `401` — The user is not authorized to perform this request
- `404` — Not Found

---

[API](https://skmtc.dev/home-office/apis/reference-data-service-api.md) · [All operations](https://skmtc.dev/home-office/apis/reference-data-service-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/home-office/reference-data-service-api/revisions/97df0cb8be1b/schema)