---
title: "Modify a dimension option for an instance"
method: PATCH
path: "/instances/{instance_id}/dimensions/{dimension}/options/{option}"
tags: ["Private"]
---

# Modify a dimension option for an instance

`PATCH /instances/{instance_id}/dimensions/{dimension}/options/{option}`

Modify a dimension option for an instance by setting values for node_id or order

## Path parameters

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

## Headers

- `If-Match` string

## Request body

- object[] — A list of operations to patch a dimension option. Can only handle adding values for /node_id and /order. Each element in the array is processed in sequential order.
  - `op` 'add' — The operation to be made on path. * add - Sets the value for the provided path
  - `path` '/node_id' | '/order' — Path to value that needs to be operated on.
  - `value` string — A value that will be set for the provided path. /node_id accepts string values, and /order accepts integer values.

## Response `200`

The dimension option was modified and the successfully applied patch operations are returned

## 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` — InstanceId does not match any instances
- `409` — Failed to process the request due to a conflict
- `500` — Failed to process the request due to an internal error

---

[API](https://skmtc.net/office-of-national-statistics/apis/dataset-api.md) · [All operations](https://skmtc.net/office-of-national-statistics/apis/dataset-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/office-of-national-statistics/dataset-api/revisions/a2947a13d675/schema)