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

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.

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.

Last updated