Updates a Tulip Table's metadata and schema. If the update is successful, the Table's updatedAt will be set to the current time and updatedBy will be set to your user id.
Requires the tables:write API key scope.
Access to the Tulip API requires the use of HTTP Basic Authentication using the credentials of an active Tulip API Token. All requests require the Authorization HTTP header with the Basic scheme to provide API credentials unless otherwise noted.
API tokens can be configured with a set of scopes which determine what parts of the API that specific token has access to. Security best practices dictate that API credentials be given the minimum set of capabilities required to fulfill their intended purpose. For example, an API token created for use in an integration that is only designed to use the Tables API should probably only be given the tables:read and tables:write scopes. In this way you can minimize risk in the event that API credentials are compromised. API endpoints will document what API token scopes are required to access that endpoint in their descriptions. If a request is made to an endpoint with an API token which does not have the required scopes, the response will be an authorization error.
The id of a Tulip Table.
The spec for updating a Tulip Table. The spec must include all existing columns of the Table, including the id column. The data type of existing columns cannot be changed. If you wish to change a column's type, hide the existing column and make a new column with the desired type.
The display label for this Table.
A long-form description for this Table.
Whether the Table should be hidden from the Tulip Tables UI. If not specified, the Table's deleted status is unchanged.
The updated columns of the Table. All existing columns must be mentioned, including the id column.
The name of the column. Must start with a letter and contain only letters, numbers, and underscores. Must be unique to this Table.
The display label for this column.
A long-form description for this column.
The type of a value in Tulip.
Whether the column should be hidden in the Tulip Tables UI. The id column cannot be hidden.
Whether the values in the column must be unique. This property cannot be changed on existing columns.
The Tulip Table was updated successfully. The details of the updated Table are returned in the response.
The display label for this Table.
A long-form description for this Table.
The internal id of this column.
The display label for this column.
A long-form description for this column.
The type of a value in Tulip.
Whether this column is hidden from the UI or not.
Whether values in this column are required to be unique or not.
The request was malformed. This could mean that headers, query parameters, or the request body was unable to be parsed or had unexpected values.
The request was made unauthorized. HTTP Basic Authorization using a Tulip API Key is required for use of the API.
The provided authentication info was rejected. The response will provide additional details.
The requested database entry was not found.
The request was malformed. This could mean that headers, query parameters, or the request body was unable to be parsed or had unexpected values.
The server encountered an unexpected error.