patch

Overview

This endpoint is used for updating metadata on a variable.

HTTP Request

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

Note that you can only update metadata on a variable belonging to a table. You cannot edit metadata associated with a variable belonging to an upload (though this upload variable will always be represented by a corresponding table variable).

Path parameters

Parameter
tableReference	A qualified reference to the table. See referencing resources for more information.
variableName	The name of the variable (case insensitive)

This endpoint extends the general API structure

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]	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., [{ "value": "1", "label": "Yes" },{ "value": "2" "label": "No" }]. The total length of all values + labels cannot exceed 1 million characters. Passing an empty array will remove all value labels from the variable.

Authorization

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

• data.edit

Learn more about authorization.

Response body

Returns the JSON-encoded "get" representation of a table resource.