# patch

## Overview

This endpoint is used for updating metadata on a variable.

## HTTP Request

```http
PATCH /api/v1/tables/:tableReference/variables/:variableName
```

## Path parameters

| Parameter      |                                                                                                                                           |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| tableReference | A qualified reference to the table. See [referencing resources](https://docs.redivis.com/api/referencing-resources) for more information. |
| variableName   | The name of the variable (case insensitive)                                                                                               |

{% hint style="info" %}
This endpoint extends the [general API structure](https://docs.redivis.com/api/rest-api/general-structure)
{% endhint %}

## Request body

Provide a JSON object with the properties you would like to update. All fields are optional. To unset a value, specify `null` for the given property.

| Property name   | Type               | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| --------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **label**       | **string**         | A human-readable label for the variable. Must be less than or equal to 256 characters.                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| **description** | **string**         | A longer description of the variable. Must be less than or equal to 5,000 characters.                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| **valueLabels** | **array\[object]** | <p>A mapping between values in the data and human readable labels. Passed as an array of objects, each with "value" and "label" properties. E.g., <br><code>\[{</code> <br>  <code>"value": "1",</code> <br>  <code>"label": "Yes"</code><br><code>},{</code><br>  <code>"value": "2"</code><br>  <code>"label": "No"</code><br><code>}]</code>. <br><br>The total length of all values + labels cannot exceed 1 million characters.<br><br>Passing an empty array will remove all value labels from the variable.</p> |

## Authorization

Edit access to the corresponding dataset is required. Your access token must have the following scope:

* data.edit

[Learn more about authorization.](https://docs.redivis.com/api/rest-api/authorization)

## Response body

Returns the JSON-encoded "get" representation of a [variable resource](https://docs.redivis.com/api/resource-definitions/variable).