Update an existing table

curl --request PATCH \
  --url https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/draft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowChildTables": true,
  "allowPublicApiAccess": true,
  "columns": [
    {
      "id": 123,
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "createdAt": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "label": "<string>",
          "name": "<string>",
          "order": 123,
          "type": "<string>",
          "updatedAt": "2023-11-07T05:31:56Z",
          "createdBy": {
            "email": "<string>",
            "firstName": "<string>",
            "id": "<string>",
            "lastName": "<string>"
          },
          "createdByUserId": 123,
          "updatedBy": {
            "email": "<string>",
            "firstName": "<string>",
            "id": "<string>",
            "lastName": "<string>"
          },
          "updatedByUserId": 123
        }
      ],
      "type": "BOOLEAN",
      "foreignColumnId": 123,
      "foreignTableId": 123,
      "maxNumberOfCharacters": 123,
      "maxNumberOfOptions": 123
    }
  ],
  "dynamicMetaTags": {},
  "enableChildTablePages": true,
  "label": "<string>",
  "name": "<string>",
  "useForPages": true
}
'

{
  "allowChildTables": true,
  "allowPublicApiAccess": true,
  "columnCount": 123,
  "columns": "{name: \"column1\"",
  "createdAt": "2023-11-07T05:31:56Z",
  "deleted": true,
  "deletedAt": "2023-11-07T05:31:56Z",
  "dynamicMetaTags": {},
  "enableChildTablePages": true,
  "id": "<string>",
  "label": "<string>",
  "name": "<string>",
  "published": true,
  "publishedAt": "2023-11-07T05:31:56Z",
  "rowCount": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "useForPages": true,
  "createdBy": {
    "email": "<string>",
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>"
  },
  "isOrderedManually": true,
  "updatedBy": {
    "email": "<string>",
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>"
  }
}

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

tables

{tableIdOrName}

draft

Update an existing table

curl --request PATCH \
  --url https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/draft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowChildTables": true,
  "allowPublicApiAccess": true,
  "columns": [
    {
      "id": 123,
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "createdAt": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "label": "<string>",
          "name": "<string>",
          "order": 123,
          "type": "<string>",
          "updatedAt": "2023-11-07T05:31:56Z",
          "createdBy": {
            "email": "<string>",
            "firstName": "<string>",
            "id": "<string>",
            "lastName": "<string>"
          },
          "createdByUserId": 123,
          "updatedBy": {
            "email": "<string>",
            "firstName": "<string>",
            "id": "<string>",
            "lastName": "<string>"
          },
          "updatedByUserId": 123
        }
      ],
      "type": "BOOLEAN",
      "foreignColumnId": 123,
      "foreignTableId": 123,
      "maxNumberOfCharacters": 123,
      "maxNumberOfOptions": 123
    }
  ],
  "dynamicMetaTags": {},
  "enableChildTablePages": true,
  "label": "<string>",
  "name": "<string>",
  "useForPages": true
}
'

{
  "allowChildTables": true,
  "allowPublicApiAccess": true,
  "columnCount": 123,
  "columns": "{name: \"column1\"",
  "createdAt": "2023-11-07T05:31:56Z",
  "deleted": true,
  "deletedAt": "2023-11-07T05:31:56Z",
  "dynamicMetaTags": {},
  "enableChildTablePages": true,
  "id": "<string>",
  "label": "<string>",
  "name": "<string>",
  "published": true,
  "publishedAt": "2023-11-07T05:31:56Z",
  "rowCount": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "useForPages": true,
  "createdBy": {
    "email": "<string>",
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>"
  },
  "isOrderedManually": true,
  "updatedBy": {
    "email": "<string>",
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>"
  }
}

Supported products

Requires one of the following products or higher.

Marketing Hub -Professional

Sales Hub -Free

Service Hub -Free

Content Hub -Professional

Data Hub -Free

Required Scopes

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

tableIdOrName

string

required

The ID or name of the table to update.

Query Parameters

archived

boolean

Specifies whether to return archived tables. Defaults to false.

includeForeignIds

boolean

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

isGetLocalizedSchema

boolean

Indicates whether to retrieve the localized schema for the table.

Body

application/json

allowChildTables

boolean

required

Specifies whether child tables can be created

allowPublicApiAccess

boolean

required

Specifies whether the table can be read by public without authorization

columns

object[]

required

List of columns in the table

Show child attributes

dynamicMetaTags

object

required

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

Show child attributes

enableChildTablePages

boolean

required

Specifies creation of multi-level dynamic pages using child tables

label

string

required

Label of the table

name

string

required

Name of the table

useForPages

boolean

required

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

Response

successful operation

allowChildTables

boolean

required

Specifies whether child tables can be created

allowPublicApiAccess

boolean

required

Specifies whether the table can be read by public without authorization

columnCount

integer<int32>

required

Number of columns including deleted

columns

object[]

required

List of columns in the table

Show child attributes

Example:

"{name: \"column1\""

createdAt

string<date-time>

required

Timestamp at which the table is created

deleted

boolean

required

Specifies whether the table is marked as deleted.

deletedAt

string<date-time>

required

The timestamp indicating when the table was deleted.

dynamicMetaTags

object

required

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

Show child attributes

enableChildTablePages

boolean

required

Specifies creation of multi-level dynamic pages using child tables

string

required

Id of the table

label

string

required

Label of the table

name

string

required

Name of the table

published

boolean

required

Indicates whether the table is currently published.

publishedAt

string<date-time>

required

Timestamp at which the table is published recently

rowCount

integer<int32>

required

Number of rows in the table

updatedAt

string<date-time>

required

Timestamp at which the table is updated recently

useForPages

boolean

required

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

createdBy

object

Show child attributes

isOrderedManually

boolean

Indicates whether the table rows are ordered manually.

updatedBy

object

Show child attributes

Last modified on December 16, 2025