---
title: "Update dimension"
method: PUT
path: "/instances/{instance_id}/dimensions/{dimension}"
tags: ["Private"]
---

# Update dimension

`PUT /instances/{instance_id}/dimensions/{dimension}`

## Request

- Base URL: `https://api.beta.ons.gov.uk/v1`
- URL: `https://api.beta.ons.gov.uk/v1/instances/{instance_id}/dimensions/{dimension}`
- Auth: API key in header `Authorization`

Update the label and/or description of a dimension within an instance, by providing dimension name and properties to over write

## Path parameters

- `instance_id` string, required
- `dimension` string, required

## Headers

- `If-Match` string

## Request body

- UpdateInstanceDimension: Possible fields to be updated against a dimension for an instance resource
  - `description` string: The dimension description
  - `label` string: A human readable label for dimension

## Response `200`

The instance has been updated

## Other responses

- `400`: Failed to process the request due to invalid request
- `401`: The token provided is unauthorised to carry out this operation
- `403`: The request is forbidden
- `404`: The instance was not found
- `409`: Failed to process the request due to a conflict
- `500`: Failed to process the request due to an internal error

## Changes

- **2025-02-18** `f5f36bf68ba9`: 4 info
  - the endpoint scheme security `Authorization` was added to the API
  - the endpoint scheme security `InternalAPIKey` was removed from the API
  - api tag `Private` added
  - api tag `Private user` removed

[Operation history](https://skmtc.dev/office-of-national-statistics/apis/explore-our-data/changes/instances/:instance_id/dimensions/:dimension/put.md)

---

[API](https://skmtc.dev/office-of-national-statistics/apis/explore-our-data.md) - [All operations](https://skmtc.dev/office-of-national-statistics/apis/explore-our-data/llms.txt) - [OpenAPI document](https://skmtc.dev/office-of-national-statistics/apis/explore-our-data/revisions/c24bb51d5217?raw)