Sign in

v3

latestOpenAPI 3.0.12026-07-133132111.2 KB
Tables

Update an existing table

Update an existing HubDB table. You can use this endpoint to add or remove columns to the table as well as restore an archived table. Tables updated using the endpoint will only modify the draft verion of the table. Use the /publish endpoint to push all the changes to the published version. To restore a table, include the query parameter archived=true and "archived": false in the json body. Note: You need to include all the columns in the input when you are adding/removing/updating a column. If you do not include an already existing column in the request, it will be deleted.

patch/cms/hubdb/2026-03/tables/{tableIdOrName}/draft

Path parameters

tableIdOrNamestring required

The ID or name of the table to update.

Query parameters

archivedboolean

Specifies whether to return archived tables. Defaults to false.

includeForeignIdsboolean

Set this to true to populate foreign ID values in the result.

isGetLocalizedSchemaboolean

Indicates whether to retrieve the localized schema for the table.

Request body

allowChildTablesboolean required

Specifies whether child tables can be created

allowPublicApiAccessboolean required

Specifies whether the table can be read by public without authorization

dynamicMetaTagsobject required

Specifies the key value pairs of the metadata fields with the associated column IDs.

enableChildTablePagesboolean required

Specifies creation of multi-level dynamic pages using child tables

labelstring required

Label of the table

namestring required

Name of the table

useForPagesboolean required

Specifies whether the table can be used for creation of dynamic pages

Response

successful operation

allowChildTablesboolean required

Specifies whether child tables can be created

allowPublicApiAccessboolean required

Specifies whether the table can be read by public without authorization

columnCountinteger required

Number of columns including deleted

createdAtstring date-time required

Timestamp at which the table is created

deletedboolean required

Specifies whether the table is marked as deleted.

deletedAtstring date-time required

The timestamp indicating when the table was deleted.

dynamicMetaTagsobject required

Specifies the key value pairs of the metadata fields with the associated column IDs.

enableChildTablePagesboolean required

Specifies creation of multi-level dynamic pages using child tables

idstring required

Id of the table

isOrderedManuallyboolean

Indicates whether the table rows are ordered manually.

labelstring required

Label of the table

namestring required

Name of the table

publishedboolean required

Indicates whether the table is currently published.

publishedAtstring date-time required

Timestamp at which the table is published recently

rowCountinteger required

Number of rows in the table

updatedAtstring date-time required

Timestamp at which the table is updated recently

useForPagesboolean required

Specifies whether the table can be used for creation of dynamic pages