---
title: "Partially update a dimension"
method: PATCH
path: "/projects/{project_id}/dimensions/{dimension_id}/"
tags: ["Dimensions"]
---

# Partially update a dimension

`PATCH /projects/{project_id}/dimensions/{dimension_id}/`

## Request

- Base URL: `https://api.parsewise.ai/api/v1`
- URL: `https://api.parsewise.ai/api/v1/projects/{project_id}/dimensions/{dimension_id}/`
- Auth: API key in header `X-API-Key`

Update one or more fields on an existing dimension (supply only the fields you want to change). Renaming is subject to the same name-collision rules as create. Returns the updated dimension.

## Path parameters

- `dimension_id` string, uuid, required
- `project_id` string, uuid, required

## Request body

- PatchedV1DimensionRequest: A dimension is a project-scoped attribute that an agent extracts a value for on each document (e.g. ``Year``, ``Region``). Dimensions are referenced by ID when attaching them to agents and when reading extraction results.
  - `name` string: Human-readable name of the dimension. Must be unique within the project. Cannot match the reserved system dimension name "Document" or any of the project's tag keys.
  - `description` string: Optional free-form description of what this dimension captures.
  - `example_values` string: Optional comma-separated list of example values to help guide extraction.
  - `value_type` 'string' | 'number': * `string` - String * `number` - Number

## Response `200`

- V1Dimension: A dimension is a project-scoped attribute that an agent extracts a value for on each document (e.g. ``Year``, ``Region``). Dimensions are referenced by ID when attaching them to agents and when reading extraction results.
  - `id` string, uuid, required: Stable identifier for the dimension (UUID).
  - `project_id` string, uuid, required: Identifier of the project this dimension belongs to.
  - `name` string, required: Human-readable name of the dimension. Must be unique within the project. Cannot match the reserved system dimension name "Document" or any of the project's tag keys.
  - `description` string: Optional free-form description of what this dimension captures.
  - `example_values` string: Optional comma-separated list of example values to help guide extraction.
  - `value_type` 'string' | 'number': * `string` - String * `number` - Number
  - `source` 'CUSTOM' | 'DOCUMENT' | 'TAG', required: * `CUSTOM` - CUSTOM * `DOCUMENT` - DOCUMENT * `TAG` - TAG
  - `source_agent_id` string, uuid, nullable, required: ID of the list agent that supplies this dimension's allowed values, or null when the values are set manually. Agents using the dimension wait for this agent to finish and only record values from its resolved list.
  - `auto_attach_to_new_agents` boolean, required: Whether this dimension is automatically attached to newly created agents.
  - `created_at` string, date-time, required: Timestamp the dimension was created.

---

[API](https://skmtc.dev/parsewise/apis/parsewise-api.md) - [All operations](https://skmtc.dev/parsewise/apis/parsewise-api/llms.txt) - [OpenAPI document](https://skmtc.dev/parsewise/apis/parsewise-api/revisions/5db46512debf?raw)