Skip to content

HubSpot: Hubdb schemas

33 HubSpot schemas with complete fields and constraints.

← Hubdb operations · All schemas

Add a new row to a table — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
childTableIdintegerRequired within parentSpecifies the value for the column child table id
Format: int64
displayIndexintegerRequired within parentThe index position for displaying the row within the table.
Format: int32
namestringOptionalSpecifies the value for `hs_name` column, which will be used as title in the dynamic pages
pathstringOptionalSpecifies the value for `hs_path` column, which will be used as slug in the dynamic pages
valuesobjectRequired within parentList of key value pairs with the column name and column value
Additional keys: see wildcard field
values.*ModelAdditional keysExpand List tags — response body

Referenced models: List tags — response body

Clone a row — response body

FieldTypePresenceDescription and constraints
$objectRoot
childTableIdstringRequired within parentSpecifies the value for the column child table id
createdAtstringRequired within parentTimestamp at which the row is created
Format: date-time
idstringRequired within parentThe id of the table row
namestringRequired within parentSpecifies the value for `hs_name` column, which will be used as title in the dynamic pages
pathstringRequired within parentSpecifies the value for `hs_path` column, which will be used as slug in the dynamic pages
publishedAtstringRequired within parentThe timestamp indicating when the row was last published, in date-time format.
Format: date-time
updatedAtstringRequired within parentTimestamp at which the row is updated last time
Format: date-time
valuesobjectRequired within parentList of key value pairs with the column name and column value
Additional keys: see wildcard field
values.*objectAdditional keys

Clone a table — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
copyRowsbooleanRequired within parentSpecifies whether to copy the rows during clone
isHubspotDefinedbooleanRequired within parentIndicates whether the table is defined by HubSpot.
newLabelstringOptionalThe new label for the cloned table
newNamestringOptionalThe new name for the cloned table

Clone a table — response body

FieldTypePresenceDescription and constraints
$objectRoot
allowChildTablesbooleanRequired within parentSpecifies whether child tables can be created
allowPublicApiAccessbooleanRequired within parentSpecifies whether the table can be read by public without authorization
columnCountJSONRequired within parent
columnCount (anyOf 1)integerAlternativeNumber of columns including deleted
Format: int64
columnCount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
columnsarrayRequired within parentList of columns in the table
columns[]ModelEach itemExpand Clone a table — response body — columns item
createdAtstringRequired within parentTimestamp at which the table is created
Format: date-time
createdByModelOptionalExpand Clone a table — response body — created By
deletedbooleanRequired within parentSpecifies whether the table is marked as deleted.
deletedAtstringRequired within parentThe timestamp indicating when the table was deleted.
Format: date-time
dynamicMetaTagsobjectRequired within parentSpecifies the key value pairs of the [metadata fields](https://developers.hubspot.com/docs/cms/guides/dynamic-pages/hubdb#dynamic-pages) with the associated column IDs.
Additional keys: see wildcard field
dynamicMetaTags.*JSONAdditional keys
dynamicMetaTags.* (anyOf 1)integerAlternativeFormat: int32
dynamicMetaTags.* (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
enableChildTablePagesbooleanRequired within parentSpecifies creation of multi-level dynamic pages using child tables
idstringRequired within parentId of the table
isOrderedManuallybooleanOptionalIndicates whether the table rows are ordered manually.
labelstringRequired within parentLabel of the table
namestringRequired within parentName of the table
publishedbooleanRequired within parentIndicates whether the table is currently published.
publishedAtstringRequired within parentTimestamp at which the table is published recently
Format: date-time
rowCountJSONRequired within parent
rowCount (anyOf 1)integerAlternativeNumber of rows in the table
Format: int32
rowCount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAtstringRequired within parentTimestamp at which the table is updated recently
Format: date-time
updatedByModelOptionalExpand Clone a table — response body — created By
useForPagesbooleanRequired within parentSpecifies whether the table can be used for creation of dynamic pages

Referenced models: Clone a table — response body — columns item, Clone a table — response body — created By

Clone a table — response body — columns item

FieldTypePresenceDescription and constraints
$objectRoot
createdAtstringOptionalThe timestamp when the column was created.
Format: date-time
createdByModelOptionalExpand Clone a table — response body — created By
createdByUserIdJSONOptional
createdByUserId (anyOf 1)integerAlternativeThe ID of the user who created the column.
Format: int32
createdByUserId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
deletedbooleanRequired within parentIndicates whether the column has been deleted.
descriptionstringRequired within parentThe description of the column.
foreignColumnIdJSONOptional
foreignColumnId (anyOf 1)integerAlternativeForeign Column id
Format: int32
foreignColumnId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
foreignIdsarrayOptionalForeign Ids
foreignIds[]ModelEach itemExpand Clone a table — response body — columns item foreign Ids item
foreignIdsByIdobjectOptionalForeign ids
Additional keys: see wildcard field
foreignIdsById.*ModelAdditional keysExpand Clone a table — response body — columns item foreign Ids item
foreignIdsByNameobjectOptionalForeign ids by name
Additional keys: see wildcard field
foreignIdsByName.*ModelAdditional keysExpand Clone a table — response body — columns item foreign Ids item
foreignTableIdJSONOptional
foreignTableId (anyOf 1)integerAlternativeForeign table id referenced
Format: int64
foreignTableId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentColumn Id
labelstringRequired within parentLabel of the column
namestringRequired within parentName of the column
optionCountJSONOptional
optionCount (anyOf 1)integerAlternativeNumber of options available
Format: int32
optionCount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
optionsarrayOptionalOptions to choose for select and multi-select columns
options[]ModelEach itemExpand Clone a table — response body — columns item options item
typestringRequired within parentType of the column
Known values: BOOLEAN, CODE, COMPOSITE, CTA, CURRENCY, DATE, DATETIME, EMBED, FILE, FOREIGN_ID, HUBSPOT_VIDEO, IMAGE, JSON, LOCATION, MULTISELECT, NULL, NUMBER, RICHTEXT, SELECT, TEXT, URL, VIDEO
updatedAtstringOptionalThe timestamp when the column was last updated.
Format: date-time
updatedByModelOptionalExpand Clone a table — response body — created By
updatedByUserIdJSONOptional
updatedByUserId (anyOf 1)integerAlternativeThe ID of the user who last updated the column.
Format: int32
updatedByUserId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
widthJSONOptional
width (anyOf 1)integerAlternativeColumn width for HubDB UI
Format: int32
width (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Clone a table — response body — columns item foreign Ids item, Clone a table — response body — columns item options item, Clone a table — response body — created By

Clone a table — response body — columns item foreign Ids item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for the foreign ID.
namestringRequired within parentName of the foreign ID.
typestringRequired within parentType of the foreign ID.

Clone a table — response body — columns item options item

FieldTypePresenceDescription and constraints
$objectRootA HubSpot property option
createdAtstringRequired within parentThe timestamp when the option was created, in ISO 8601 format.
Format: date-time
createdByModelOptionalExpand Clone a table — response body — created By
createdByUserIdJSONOptional
createdByUserId (anyOf 1)integerAlternativeThe ID of the user who created the option.
Format: int32
createdByUserId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentThe unique ID of the option.
labelstringRequired within parentA user-friendly label that identifies the option.
namestringRequired within parentAn internal name assigned to the option, distinct from the label.
orderJSONRequired within parent
order (anyOf 1)integerAlternativeThe order in which the option appears, represented as an integer.
Format: int32
order (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
typestringRequired within parentIndicates the category or data type of the option (e.g., string, number).
updatedAtstringRequired within parentThe timestamp when the option was last updated, in ISO 8601 format.
Format: date-time
updatedByModelOptionalExpand Clone a table — response body — created By
updatedByUserIdJSONOptional
updatedByUserId (anyOf 1)integerAlternativeThe ID of the user who last updated the option.
Format: int32
updatedByUserId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Clone a table — response body — created By

Clone a table — response body — created By

FieldTypePresenceDescription and constraints
$objectRoot
emailstringRequired within parentThe email address of the user.
firstNamestringRequired within parentThe first name of the user.
idstringRequired within parentThe unique identifier for the user.
lastNamestringRequired within parentThe last name of the user.

Clone rows in batch — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
inputsarrayRequired within parentAn array of HubDbTableRowBatchCloneRequest objects, each specifying the details of a row to be cloned. This property is required.
inputs[]ModelEach itemExpand Clone rows in batch — request body — body inputs item

Referenced models: Clone rows in batch — request body — body inputs item

Clone rows in batch — request body — body inputs item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe ID of the row to be cloned.
namestringOptionalThe name for the cloned row.

Clone rows in batch — response body

FieldTypePresenceDescription and constraints
$objectRoot
completedAtstringRequired within parentThe timestamp indicating when the batch processing was completed.
Format: date-time
linksobjectOptionalA collection of related links associated with the batch response.
Additional keys: see wildcard field
links.*stringAdditional keys
requestedAtstringOptionalThe timestamp indicating when the batch request was made.
Format: date-time
resultsarrayRequired within parentAn array of HubDbTableRowV3 objects representing the results of the batch operation.
results[]ModelEach itemExpand Clone a row — response body
startedAtstringRequired within parentThe timestamp indicating when the batch processing began.
Format: date-time
statusstringRequired within parentThe current status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.
Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Clone a row — response body

Create a new table — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
allowChildTablesbooleanRequired within parentSpecifies whether child tables can be created
allowPublicApiAccessbooleanRequired within parentSpecifies whether the table can be read by public without authorization
columnsarrayRequired within parentList of columns in the table
columns[]ModelEach itemExpand Create a new table — request body — body columns item
dynamicMetaTagsobjectRequired within parentSpecifies the key value pairs of the [metadata fields](https://developers.hubspot.com/docs/cms/guides/dynamic-pages/hubdb#dynamic-pages) with the associated column IDs.
Additional keys: see wildcard field
dynamicMetaTags.*integerAdditional keysFormat: int32
enableChildTablePagesbooleanRequired within parentSpecifies creation of multi-level dynamic pages using child tables
labelstringRequired within parentLabel of the table
namestringRequired within parentName of the table
useForPagesbooleanRequired within parentSpecifies whether the table can be used for creation of dynamic pages

Referenced models: Create a new table — request body — body columns item

Create a new table — request body — body columns item

FieldTypePresenceDescription and constraints
$objectRoot
foreignColumnIdintegerOptionalThe id of the column from another table to which the column refers/points to.
Format: int32
foreignTableIdintegerOptionalThe id of another table to which the column refers/points to.
Format: int64
idintegerRequired within parentColumn Id
Format: int32
labelstringRequired within parentLabel of the column
maxNumberOfCharactersintegerOptionalDefines the maximum number of characters allowed in the column.
Format: int32
maxNumberOfOptionsintegerOptionalSpecifies the maximum number of options that can be set for select and multi-select columns.
Format: int32
namestringRequired within parentName of the column
optionsarrayRequired within parentOptions to choose for select and multi-select columns
options[]ModelEach itemExpand Create a new table — request body — body columns item options item
typestringRequired within parentType of the column
One of: BOOLEAN, CODE, COMPOSITE, CTA, CURRENCY, DATE, DATETIME, EMBED, FILE, FOREIGN_ID, HUBSPOT_VIDEO, IMAGE, JSON, LOCATION, MULTISELECT, NULL, NUMBER, RICHTEXT, SELECT, TEXT, URL, VIDEO

Referenced models: Create a new table — request body — body columns item options item

Create a new table — request body — body columns item options item

FieldTypePresenceDescription and constraints
$objectRootA HubSpot property option
createdAtstringRequired within parentThe timestamp when the option was created, in ISO 8601 format.
Format: date-time
createdByModelOptionalExpand Clone a table — response body — created By
createdByUserIdintegerOptionalThe ID of the user who created the option.
Format: int32
idstringRequired within parentThe unique ID of the option.
labelstringRequired within parentA user-friendly label that identifies the option.
namestringRequired within parentAn internal name assigned to the option, distinct from the label.
orderintegerRequired within parentThe order in which the option appears, represented as an integer.
Format: int32
typestringRequired within parentIndicates the category or data type of the option (e.g., string, number).
updatedAtstringRequired within parentThe timestamp when the option was last updated, in ISO 8601 format.
Format: date-time
updatedByModelOptionalExpand Clone a table — response body — created By
updatedByUserIdintegerOptionalThe ID of the user who last updated the option.
Format: int32

Referenced models: Clone a table — response body — created By

Create rows in batch — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
inputsarrayRequired within parentAn array of HubDbTableRowV3Request objects, each representing a row to be created. This property is required.
inputs[]ModelEach itemExpand Add a new row to a table — request body — body

Referenced models: Add a new row to a table — request body — body

Get a set of rows — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
inputsarrayRequired within parentAn array of strings representing the batch input values. Each item in the array is a string.
inputs[]stringEach item

Get a set of rows — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING

FieldTypePresenceDescription and constraints
$objectRoot
completedAtstringRequired within parentThe timestamp indicating when the batch processing was completed.
Format: date-time
errorsarrayOptionalAn array of StandardError objects detailing any errors encountered during the batch operation.
errors[]ModelEach itemExpand Get a set of rows — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
linksobjectOptionalA collection of related links associated with the batch response.
Additional keys: see wildcard field
links.*stringAdditional keys
numErrorsJSONOptional
numErrors (anyOf 1)integerAlternativeThe number of errors encountered during the batch operation.
Format: int32
numErrors (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAtstringOptionalThe timestamp indicating when the batch request was made.
Format: date-time
resultsarrayRequired within parentAn array of HubDbTableRowV3 objects representing the successful results of the batch operation.
results[]ModelEach itemExpand Clone a row — response body
startedAtstringRequired within parentThe timestamp indicating when the batch processing began.
Format: date-time
statusstringRequired within parentThe current status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.
Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Clone a row — response body, Get a set of rows — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Get a set of rows — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

FieldTypePresenceDescription and constraints
$objectRootYe olde error
categorystringRequired within parentSpecifies the main category of the error, determining the broad area of issue.
contextobjectRequired within parentAn object containing context-specific information pertinent to the error.
Additional keys: see wildcard field
context.*arrayAdditional keys
context.*[]stringEach item
errorsarrayRequired within parentThe detailed error objects.
errors[]ModelEach itemExpand Batch insert events — response body — errors item errors item
idstringOptionalThe unique ID of the error instance.
linksobjectRequired within parentAn object containing links related to the error, such as documentation URLs or support contact pages.
Additional keys: see wildcard field
links.*stringAdditional keys
messagestringRequired within parentA detailed message describing the error.
statusstringRequired within parentThe HTTP status code associated with the error.
subCategoryobjectOptionalIdentifies the subcategory of the error, providing more specific context within the main category.

Referenced models: Batch insert events — response body — errors item errors item

Get rows for a table — response body

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Get rows for a table — response body — type: RANDOM ACCESS
$ (anyOf 2)ModelAlternativeExpand Get rows for a table — response body — type: STREAMING

Referenced models: Get rows for a table — response body — type: RANDOM ACCESS, Get rows for a table — response body — type: STREAMING

Get rows for a table — response body — type: RANDOM ACCESS

FieldTypePresenceDescription and constraints
$objectRoot
pagingModelOptionalExpand Get rows for a table — response body — type: RANDOM ACCESS paging
resultsarrayRequired within parentAn array containing the HubDb table rows wrapped in a HubDbTableRowV3Wrapper object.
results[]objectEach itemA HubDB table row in HubSpot's row wrapper (its shape is not published).
totalJSONRequired within parent
total (anyOf 1)integerAlternativeThe total number of rows available in the collection.
Format: int32
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
typestringRequired within parentIndicates the type of response, which is 'RANDOM_ACCESS' by default.
Known values: RANDOM_ACCESS
Default: RANDOM_ACCESS

Referenced models: Get rows for a table — response body — type: RANDOM ACCESS paging

Get rows for a table — response body — type: RANDOM ACCESS paging

FieldTypePresenceDescription and constraints
$objectRoot
nextModelOptionalExpand Get rows for a table — response body — type: RANDOM ACCESS paging next

Referenced models: Get rows for a table — response body — type: RANDOM ACCESS paging next

Get rows for a table — response body — type: RANDOM ACCESS paging next

FieldTypePresenceDescription and constraints
$objectRoot
linkstringOptionalA URL that can be used to retrieve the next set of results.
offsetJSONRequired within parent
offset (anyOf 1)integerAlternativeThe offset value indicating the starting point for the next set of results.
Format: int32
offset (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get rows for a table — response body — type: STREAMING

FieldTypePresenceDescription and constraints
$objectRoot
pagingModelOptionalExpand Return all draft tables — response body — paging
resultsarrayRequired within parentAn array containing the HubDB table rows returned in the current response. Each item is a HubDbTableRowV3Wrapper object.
results[]objectEach itemA HubDB table row in HubSpot's row wrapper (its shape is not published).
totalJSONRequired within parent
total (anyOf 1)integerAlternativeThe total number of rows available in the collection.
Format: int32
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
typestringRequired within parentIndicates the type of response, which is 'STREAMING' by default.
Known values: STREAMING
Default: STREAMING

Referenced models: Return all draft tables — response body — paging

Import data into draft table — response body

FieldTypePresenceDescription and constraints
$objectRoot
duplicateRowsJSONRequired within parent
duplicateRows (anyOf 1)integerAlternativeSpecifies number of duplicate rows
Format: int32
duplicateRows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
errorsarrayRequired within parentList of errors during import
errors[]ModelEach itemExpand Import data into draft table — response body — errors item
rowLimitExceededbooleanRequired within parentSpecifies whether row limit exceeded during import
rowsImportedJSONRequired within parent
rowsImported (anyOf 1)integerAlternativeSpecifies number of rows imported
Format: int32
rowsImported (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Import data into draft table — response body — errors item

Import data into draft table — response body — errors item

FieldTypePresenceDescription and constraints
$objectRootRepresents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.
categorystringRequired within parentThe error category
contextobjectOptionalContext about the error condition
Additional keys: see wildcard field
context.*arrayAdditional keys
context.*[]stringEach item
correlationIdstringRequired within parentA unique identifier for the request. Include this value with any error reports or support tickets
Format: uuid
errorsarrayOptionalfurther information about the error
errors[]ModelEach itemExpand Batch insert events — response body — errors item errors item
linksobjectOptionalA map of link names to associated URIs containing documentation about the error or recommended remediation steps
Additional keys: see wildcard field
links.*stringAdditional keys
messagestringRequired within parentA human readable message describing the error along with remediation steps where appropriate
subCategorystringOptionalA specific category that contains more specific detail about the error

Referenced models: Batch insert events — response body — errors item errors item

Return all draft tables — request body — query

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
afterstringOptional
archivedbooleanOptional
contentTypestringOptional
createdAfterstringOptionalFormat: date-time
createdAtstringOptionalFormat: date-time
createdBeforestringOptionalFormat: date-time
isGetLocalizedSchemabooleanOptional
limitintegerOptionalFormat: int32
sortarrayOptional
sort[]stringEach item
updatedAfterstringOptionalFormat: date-time
updatedAtstringOptionalFormat: date-time
updatedBeforestringOptionalFormat: date-time

Return all draft tables — response body

FieldTypePresenceDescription and constraints
$objectRoot
pagingModelOptionalExpand Return all draft tables — response body — paging
resultsarrayRequired within parentAn array of HubDbTableV3 objects, each representing the details of a HubDB table.
results[]ModelEach itemExpand Clone a table — response body
totalJSONRequired within parent
total (anyOf 1)integerAlternativeAn integer representing the total number of HubDB tables available.
Format: int32
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Return all draft tables — response body — paging, Clone a table — response body

Return all draft tables — response body — paging

FieldTypePresenceDescription and constraints
$objectRootRepresents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
nextModelOptionalExpand Get all tax rates — response body — paging next
prevModelOptionalExpand Return all draft tables — response body — paging prev

Referenced models: Get all tax rates — response body — paging next, Return all draft tables — response body — paging prev

Return all draft tables — response body — paging prev

FieldTypePresenceDescription and constraints
$objectRootspecifies the paging information needed to retrieve the previous set of results in a paginated API response
beforestringRequired within parentA paging cursor token for retrieving previous pages.
linkstringOptionalA URL that can be used to retrieve the previous pages' results.

Update an existing table — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
allowChildTablesbooleanOptionalSpecifies whether child tables can be created
allowPublicApiAccessbooleanOptionalSpecifies whether the table can be read by public without authorization
columnsarrayOptionalList of columns in the table
columns[]ModelEach itemExpand Create a new table — request body — body columns item
dynamicMetaTagsobjectOptionalSpecifies the key value pairs of the [metadata fields](https://developers.hubspot.com/docs/cms/guides/dynamic-pages/hubdb#dynamic-pages) with the associated column IDs.
Additional keys: see wildcard field
dynamicMetaTags.*integerAdditional keysFormat: int32
enableChildTablePagesbooleanOptionalSpecifies creation of multi-level dynamic pages using child tables
labelstringOptionalLabel of the table
namestringOptionalName of the table
useForPagesbooleanOptionalSpecifies whether the table can be used for creation of dynamic pages

Referenced models: Create a new table — request body — body columns item

Update rows in batch in draft table — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
inputsarrayRequired within parentAn array of HubDbTableRowV3BatchUpdateRequest objects, each containing details for a row update. This property is required.
inputs[]ModelEach itemExpand Update rows in batch in draft table — request body — body inputs item

Referenced models: Update rows in batch in draft table — request body — body inputs item

Update rows in batch in draft table — request body — body inputs item

FieldTypePresenceDescription and constraints
$objectRoot
childTableIdintegerRequired within parentSpecifies the value for the column child table id
Format: int64
displayIndexintegerRequired within parentThe index position for displaying the row within the table.
Format: int32
idstringOptionalThe id of the table row
namestringOptionalSpecifies the value for `hs_name` column, which will be used as title in the dynamic pages
pathstringOptionalSpecifies the value for `hs_path` column, which will be used as slug in the dynamic pages
valuesobjectRequired within parentList of key value pairs with the column name and column value
Additional keys: see wildcard field
values.*ModelAdditional keysExpand List tags — response body

Referenced models: List tags — response body

Updates an existing row — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
childTableIdintegerOptionalSpecifies the value for the column child table id
Format: int64
displayIndexintegerOptionalThe index position for displaying the row within the table.
Format: int32
namestringOptionalSpecifies the value for `hs_name` column, which will be used as title in the dynamic pages
pathstringOptionalSpecifies the value for `hs_path` column, which will be used as slug in the dynamic pages
valuesobjectOptionalList of key value pairs with the column name and column value
Additional keys: see wildcard field
values.*ModelAdditional keysExpand List tags — response body

Referenced models: List tags — response body

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.