Update an existing table

PATCH {{baseUrl}}/cms/v3/hubdb/tables/:tableIdOrName/draft?includeForeignIds=<boolean>&archived=<boolean>&isGetLocalizedSchema=<boolean>

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 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.

Request Params

KeyDatatypeRequiredDescription
includeForeignIdsstringSet this to true to populate foreign ID values in the result.
archivedstringSpecifies whether to return archived tables. Defaults to false.
isGetLocalizedSchemastring

Request Body

{"label"=>"<string>", "name"=>"<string>", "useForPages"=>"<boolean>", "allowPublicApiAccess"=>"<boolean>", "allowChildTables"=>"<boolean>", "enableChildTablePages"=>"<boolean>", "columns"=>[{"id"=>"<integer>", "label"=>"<string>", "name"=>"<string>", "options"=>[{"id"=>"<string>", "name"=>"<string>", "order"=>"<integer>", "type"=>"<string>", "label"=>"<string>", "createdAt"=>"<dateTime>", "updatedAt"=>"<dateTime>"}, {"id"=>"<string>", "name"=>"<string>", "order"=>"<integer>", "type"=>"<string>", "label"=>"<string>", "createdAt"=>"<dateTime>", "updatedAt"=>"<dateTime>"}], "type"=>"NUMBER", "foreignTableId"=>"<long>", "foreignColumnId"=>"<integer>"}, {"id"=>"<integer>", "label"=>"<string>", "name"=>"<string>", "options"=>[{"id"=>"<string>", "name"=>"<string>", "order"=>"<integer>", "type"=>"<string>", "label"=>"<string>", "createdAt"=>"<dateTime>", "updatedAt"=>"<dateTime>"}, {"id"=>"<string>", "name"=>"<string>", "order"=>"<integer>", "type"=>"<string>", "label"=>"<string>", "createdAt"=>"<dateTime>", "updatedAt"=>"<dateTime>"}], "type"=>"NULL", "foreignTableId"=>"<long>", "foreignColumnId"=>"<integer>"}], "dynamicMetaTags"=>{"dolore487"=>"<integer>", "voluptate_0"=>"<integer>"}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;label&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;columns&quot;:[{&quot;label&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;DATE&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;deleted&quot;:&quot;\u003cboolean\u003e&quot;,&quot;options&quot;:[{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;order&quot;:&quot;\u003cinteger\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;label&quot;:&quot;\u003cstring\u003e&quot;,&quot;createdAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updatedAt&quot;:&quot;\u003cdateTime\u003e&quot;},{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;order&quot;:&quot;\u003cinteger\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;label&quot;:&quot;\u003cstring\u003e&quot;,&quot;createdAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updatedAt&quot;:&quot;\u003cdateTime\u003e&quot;}],&quot;width&quot;:&quot;\u003cinteger\u003e&quot;,&quot;foreignTableId&quot;:&quot;\u003clong\u003e&quot;,&quot;foreignColumnId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;foreignIds&quot;:[{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;},{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;}],&quot;foreignIdsByName&quot;:{&quot;irure1&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;},&quot;laboris0&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;}},&quot;foreignIdsById&quot;:{&quot;sint5&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;},&quot;sed0&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;},&quot;et_1&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;}},&quot;optionCount&quot;:&quot;\u003cinteger\u003e&quot;},{&quot;label&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;URL&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;deleted&quot;:&quot;\u003cboolean\u003e&quot;,&quot;options&quot;:[{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;order&quot;:&quot;\u003cinteger\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;label&quot;:&quot;\u003cstring\u003e&quot;,&quot;createdAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updatedAt&quot;:&quot;\u003cdateTime\u003e&quot;},{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;order&quot;:&quot;\u003cinteger\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;label&quot;:&quot;\u003cstring\u003e&quot;,&quot;createdAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updatedAt&quot;:&quot;\u003cdateTime\u003e&quot;}],&quot;width&quot;:&quot;\u003cinteger\u003e&quot;,&quot;foreignTableId&quot;:&quot;\u003clong\u003e&quot;,&quot;foreignColumnId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;foreignIds&quot;:[{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;},{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;}],&quot;foreignIdsByName&quot;:{&quot;non_d&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;},&quot;magna___6&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;}},&quot;foreignIdsById&quot;:{&quot;fugiat0&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;}},&quot;optionCount&quot;:&quot;\u003cinteger\u003e&quot;}],&quot;published&quot;:&quot;\u003cboolean\u003e&quot;,&quot;deleted&quot;:&quot;\u003cboolean\u003e&quot;,&quot;columnCount&quot;:&quot;\u003cinteger\u003e&quot;,&quot;rowCount&quot;:&quot;\u003cinteger\u003e&quot;,&quot;createdBy&quot;:{&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;firstName&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;lastName&quot;:&quot;\u003cstring\u003e&quot;},&quot;updatedBy&quot;:{&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;firstName&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;lastName&quot;:&quot;\u003cstring\u003e&quot;},&quot;useForPages&quot;:&quot;\u003cboolean\u003e&quot;,&quot;allowChildTables&quot;:&quot;\u003cboolean\u003e&quot;,&quot;enableChildTablePages&quot;:&quot;\u003cboolean\u003e&quot;,&quot;isOrderedManually&quot;:&quot;\u003cboolean\u003e&quot;,&quot;dynamicMetaTags&quot;:{&quot;est6c3&quot;:&quot;\u003cinteger\u003e&quot;},&quot;allowPublicApiAccess&quot;:&quot;\u003cboolean\u003e&quot;,&quot;createdAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;publishedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updatedAt&quot;:&quot;\u003cdateTime\u003e&quot;}