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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
childTableId | integer | Required within parent | Specifies the value for the column child table id Format: int64 |
displayIndex | integer | Required within parent | The index position for displaying the row within the table. Format: int32 |
name | string | Optional | Specifies the value for `hs_name` column, which will be used as title in the dynamic pages |
path | string | Optional | Specifies the value for `hs_path` column, which will be used as slug in the dynamic pages |
values | object | Required within parent | List of key value pairs with the column name and column value Additional keys: see wildcard field |
values.* | Model | Additional keys | Expand List tags — response body |
Referenced models: List tags — response body
Clone a row — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
childTableId | string | Required within parent | Specifies the value for the column child table id |
createdAt | string | Required within parent | Timestamp at which the row is created Format: date-time |
id | string | Required within parent | The id of the table row |
name | string | Required within parent | Specifies the value for `hs_name` column, which will be used as title in the dynamic pages |
path | string | Required within parent | Specifies the value for `hs_path` column, which will be used as slug in the dynamic pages |
publishedAt | string | Required within parent | The timestamp indicating when the row was last published, in date-time format. Format: date-time |
updatedAt | string | Required within parent | Timestamp at which the row is updated last time Format: date-time |
values | object | Required within parent | List of key value pairs with the column name and column value Additional keys: see wildcard field |
values.* | object | Additional keys |
Clone a table — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
copyRows | boolean | Required within parent | Specifies whether to copy the rows during clone |
isHubspotDefined | boolean | Required within parent | Indicates whether the table is defined by HubSpot. |
newLabel | string | Optional | The new label for the cloned table |
newName | string | Optional | The new name for the cloned table |
Clone a table — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowChildTables | boolean | Required within parent | Specifies whether child tables can be created |
allowPublicApiAccess | boolean | Required within parent | Specifies whether the table can be read by public without authorization |
columnCount | JSON | Required within parent | |
columnCount (anyOf 1) | integer | Alternative | Number of columns including deleted Format: int64 |
columnCount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
columns | array | Required within parent | List of columns in the table |
columns[] | Model | Each item | Expand Clone a table — response body — columns item |
createdAt | string | Required within parent | Timestamp at which the table is created Format: date-time |
createdBy | Model | Optional | Expand Clone a table — response body — created By |
deleted | boolean | Required within parent | Specifies whether the table is marked as deleted. |
deletedAt | string | Required within parent | The timestamp indicating when the table was deleted. Format: date-time |
dynamicMetaTags | object | Required within parent | Specifies 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.* | JSON | Additional keys | |
dynamicMetaTags.* (anyOf 1) | integer | Alternative | Format: int32 |
dynamicMetaTags.* (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
enableChildTablePages | boolean | Required within parent | Specifies creation of multi-level dynamic pages using child tables |
id | string | Required within parent | Id of the table |
isOrderedManually | boolean | Optional | Indicates whether the table rows are ordered manually. |
label | string | Required within parent | Label of the table |
name | string | Required within parent | Name of the table |
published | boolean | Required within parent | Indicates whether the table is currently published. |
publishedAt | string | Required within parent | Timestamp at which the table is published recently Format: date-time |
rowCount | JSON | Required within parent | |
rowCount (anyOf 1) | integer | Alternative | Number of rows in the table Format: int32 |
rowCount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updatedAt | string | Required within parent | Timestamp at which the table is updated recently Format: date-time |
updatedBy | Model | Optional | Expand Clone a table — response body — created By |
useForPages | boolean | Required within parent | Specifies 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
createdAt | string | Optional | The timestamp when the column was created. Format: date-time |
createdBy | Model | Optional | Expand Clone a table — response body — created By |
createdByUserId | JSON | Optional | |
createdByUserId (anyOf 1) | integer | Alternative | The ID of the user who created the column. Format: int32 |
createdByUserId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
deleted | boolean | Required within parent | Indicates whether the column has been deleted. |
description | string | Required within parent | The description of the column. |
foreignColumnId | JSON | Optional | |
foreignColumnId (anyOf 1) | integer | Alternative | Foreign Column id Format: int32 |
foreignColumnId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
foreignIds | array | Optional | Foreign Ids |
foreignIds[] | Model | Each item | Expand Clone a table — response body — columns item foreign Ids item |
foreignIdsById | object | Optional | Foreign ids Additional keys: see wildcard field |
foreignIdsById.* | Model | Additional keys | Expand Clone a table — response body — columns item foreign Ids item |
foreignIdsByName | object | Optional | Foreign ids by name Additional keys: see wildcard field |
foreignIdsByName.* | Model | Additional keys | Expand Clone a table — response body — columns item foreign Ids item |
foreignTableId | JSON | Optional | |
foreignTableId (anyOf 1) | integer | Alternative | Foreign table id referenced Format: int64 |
foreignTableId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | Column Id |
label | string | Required within parent | Label of the column |
name | string | Required within parent | Name of the column |
optionCount | JSON | Optional | |
optionCount (anyOf 1) | integer | Alternative | Number of options available Format: int32 |
optionCount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
options | array | Optional | Options to choose for select and multi-select columns |
options[] | Model | Each item | Expand Clone a table — response body — columns item options item |
type | string | Required within parent | Type 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 |
updatedAt | string | Optional | The timestamp when the column was last updated. Format: date-time |
updatedBy | Model | Optional | Expand Clone a table — response body — created By |
updatedByUserId | JSON | Optional | |
updatedByUserId (anyOf 1) | integer | Alternative | The ID of the user who last updated the column. Format: int32 |
updatedByUserId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
width | JSON | Optional | |
width (anyOf 1) | integer | Alternative | Column width for HubDB UI Format: int32 |
width (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier for the foreign ID. |
name | string | Required within parent | Name of the foreign ID. |
type | string | Required within parent | Type of the foreign ID. |
Clone a table — response body — columns item options item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A HubSpot property option |
createdAt | string | Required within parent | The timestamp when the option was created, in ISO 8601 format. Format: date-time |
createdBy | Model | Optional | Expand Clone a table — response body — created By |
createdByUserId | JSON | Optional | |
createdByUserId (anyOf 1) | integer | Alternative | The ID of the user who created the option. Format: int32 |
createdByUserId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | The unique ID of the option. |
label | string | Required within parent | A user-friendly label that identifies the option. |
name | string | Required within parent | An internal name assigned to the option, distinct from the label. |
order | JSON | Required within parent | |
order (anyOf 1) | integer | Alternative | The order in which the option appears, represented as an integer. Format: int32 |
order (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Required within parent | Indicates the category or data type of the option (e.g., string, number). |
updatedAt | string | Required within parent | The timestamp when the option was last updated, in ISO 8601 format. Format: date-time |
updatedBy | Model | Optional | Expand Clone a table — response body — created By |
updatedByUserId | JSON | Optional | |
updatedByUserId (anyOf 1) | integer | Alternative | The ID of the user who last updated the option. Format: int32 |
updatedByUserId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Clone a table — response body — created By
Clone a table — response body — created By
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Required within parent | The email address of the user. |
firstName | string | Required within parent | The first name of the user. |
id | string | Required within parent | The unique identifier for the user. |
lastName | string | Required within parent | The last name of the user. |
Clone rows in batch — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inputs | array | Required within parent | An array of HubDbTableRowBatchCloneRequest objects, each specifying the details of a row to be cloned. This property is required. |
inputs[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The ID of the row to be cloned. |
name | string | Optional | The name for the cloned row. |
Clone rows in batch — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
completedAt | string | Required within parent | The timestamp indicating when the batch processing was completed. Format: date-time |
links | object | Optional | A collection of related links associated with the batch response. Additional keys: see wildcard field |
links.* | string | Additional keys | |
requestedAt | string | Optional | The timestamp indicating when the batch request was made. Format: date-time |
results | array | Required within parent | An array of HubDbTableRowV3 objects representing the results of the batch operation. |
results[] | Model | Each item | Expand Clone a row — response body |
startedAt | string | Required within parent | The timestamp indicating when the batch processing began. Format: date-time |
status | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowChildTables | boolean | Required within parent | Specifies whether child tables can be created |
allowPublicApiAccess | boolean | Required within parent | Specifies whether the table can be read by public without authorization |
columns | array | Required within parent | List of columns in the table |
columns[] | Model | Each item | Expand Create a new table — request body — body columns item |
dynamicMetaTags | object | Required within parent | Specifies 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.* | integer | Additional keys | Format: int32 |
enableChildTablePages | boolean | Required within parent | Specifies creation of multi-level dynamic pages using child tables |
label | string | Required within parent | Label of the table |
name | string | Required within parent | Name of the table |
useForPages | boolean | Required within parent | Specifies 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
foreignColumnId | integer | Optional | The id of the column from another table to which the column refers/points to. Format: int32 |
foreignTableId | integer | Optional | The id of another table to which the column refers/points to. Format: int64 |
id | integer | Required within parent | Column Id Format: int32 |
label | string | Required within parent | Label of the column |
maxNumberOfCharacters | integer | Optional | Defines the maximum number of characters allowed in the column. Format: int32 |
maxNumberOfOptions | integer | Optional | Specifies the maximum number of options that can be set for select and multi-select columns. Format: int32 |
name | string | Required within parent | Name of the column |
options | array | Required within parent | Options to choose for select and multi-select columns |
options[] | Model | Each item | Expand Create a new table — request body — body columns item options item |
type | string | Required within parent | Type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A HubSpot property option |
createdAt | string | Required within parent | The timestamp when the option was created, in ISO 8601 format. Format: date-time |
createdBy | Model | Optional | Expand Clone a table — response body — created By |
createdByUserId | integer | Optional | The ID of the user who created the option. Format: int32 |
id | string | Required within parent | The unique ID of the option. |
label | string | Required within parent | A user-friendly label that identifies the option. |
name | string | Required within parent | An internal name assigned to the option, distinct from the label. |
order | integer | Required within parent | The order in which the option appears, represented as an integer. Format: int32 |
type | string | Required within parent | Indicates the category or data type of the option (e.g., string, number). |
updatedAt | string | Required within parent | The timestamp when the option was last updated, in ISO 8601 format. Format: date-time |
updatedBy | Model | Optional | Expand Clone a table — response body — created By |
updatedByUserId | integer | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inputs | array | Required within parent | An array of HubDbTableRowV3Request objects, each representing a row to be created. This property is required. |
inputs[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inputs | array | Required within parent | An array of strings representing the batch input values. Each item in the array is a string. |
inputs[] | string | Each item |
Get a set of rows — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
completedAt | string | Required within parent | The timestamp indicating when the batch processing was completed. Format: date-time |
errors | array | Optional | An array of StandardError objects detailing any errors encountered during the batch operation. |
errors[] | Model | Each item | Expand Get a set of rows — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item |
links | object | Optional | A collection of related links associated with the batch response. Additional keys: see wildcard field |
links.* | string | Additional keys | |
numErrors | JSON | Optional | |
numErrors (anyOf 1) | integer | Alternative | The number of errors encountered during the batch operation. Format: int32 |
numErrors (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
requestedAt | string | Optional | The timestamp indicating when the batch request was made. Format: date-time |
results | array | Required within parent | An array of HubDbTableRowV3 objects representing the successful results of the batch operation. |
results[] | Model | Each item | Expand Clone a row — response body |
startedAt | string | Required within parent | The timestamp indicating when the batch processing began. Format: date-time |
status | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Ye olde error |
category | string | Required within parent | Specifies the main category of the error, determining the broad area of issue. |
context | object | Required within parent | An object containing context-specific information pertinent to the error. Additional keys: see wildcard field |
context.* | array | Additional keys | |
context.*[] | string | Each item | |
errors | array | Required within parent | The detailed error objects. |
errors[] | Model | Each item | Expand Batch insert events — response body — errors item errors item |
id | string | Optional | The unique ID of the error instance. |
links | object | Required within parent | An object containing links related to the error, such as documentation URLs or support contact pages. Additional keys: see wildcard field |
links.* | string | Additional keys | |
message | string | Required within parent | A detailed message describing the error. |
status | string | Required within parent | The HTTP status code associated with the error. |
subCategory | object | Optional | Identifies 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Get rows for a table — response body — type: RANDOM ACCESS |
$ (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
paging | Model | Optional | Expand Get rows for a table — response body — type: RANDOM ACCESS paging |
results | array | Required within parent | An array containing the HubDb table rows wrapped in a HubDbTableRowV3Wrapper object. |
results[] | object | Each item | A HubDB table row in HubSpot's row wrapper (its shape is not published). |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | The total number of rows available in the collection. Format: int32 |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Required within parent | Indicates 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
next | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
link | string | Optional | A URL that can be used to retrieve the next set of results. |
offset | JSON | Required within parent | |
offset (anyOf 1) | integer | Alternative | The offset value indicating the starting point for the next set of results. Format: int32 |
offset (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get rows for a table — response body — type: STREAMING
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
paging | Model | Optional | Expand Return all draft tables — response body — paging |
results | array | Required within parent | An array containing the HubDB table rows returned in the current response. Each item is a HubDbTableRowV3Wrapper object. |
results[] | object | Each item | A HubDB table row in HubSpot's row wrapper (its shape is not published). |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | The total number of rows available in the collection. Format: int32 |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Required within parent | Indicates 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
duplicateRows | JSON | Required within parent | |
duplicateRows (anyOf 1) | integer | Alternative | Specifies number of duplicate rows Format: int32 |
duplicateRows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
errors | array | Required within parent | List of errors during import |
errors[] | Model | Each item | Expand Import data into draft table — response body — errors item |
rowLimitExceeded | boolean | Required within parent | Specifies whether row limit exceeded during import |
rowsImported | JSON | Required within parent | |
rowsImported (anyOf 1) | integer | Alternative | Specifies number of rows imported Format: int32 |
rowsImported (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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. |
category | string | Required within parent | The error category |
context | object | Optional | Context about the error condition Additional keys: see wildcard field |
context.* | array | Additional keys | |
context.*[] | string | Each item | |
correlationId | string | Required within parent | A unique identifier for the request. Include this value with any error reports or support tickets Format: uuid |
errors | array | Optional | further information about the error |
errors[] | Model | Each item | Expand Batch insert events — response body — errors item errors item |
links | object | Optional | A map of link names to associated URIs containing documentation about the error or recommended remediation steps Additional keys: see wildcard field |
links.* | string | Additional keys | |
message | string | Required within parent | A human readable message describing the error along with remediation steps where appropriate |
subCategory | string | Optional | A 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
after | string | Optional | |
archived | boolean | Optional | |
contentType | string | Optional | |
createdAfter | string | Optional | Format: date-time |
createdAt | string | Optional | Format: date-time |
createdBefore | string | Optional | Format: date-time |
isGetLocalizedSchema | boolean | Optional | |
limit | integer | Optional | Format: int32 |
sort | array | Optional | |
sort[] | string | Each item | |
updatedAfter | string | Optional | Format: date-time |
updatedAt | string | Optional | Format: date-time |
updatedBefore | string | Optional | Format: date-time |
Return all draft tables — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
paging | Model | Optional | Expand Return all draft tables — response body — paging |
results | array | Required within parent | An array of HubDbTableV3 objects, each representing the details of a HubDB table. |
results[] | Model | Each item | Expand Clone a table — response body |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | An integer representing the total number of HubDB tables available. Format: int32 |
total (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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. |
next | Model | Optional | Expand Get all tax rates — response body — paging next |
prev | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | specifies the paging information needed to retrieve the previous set of results in a paginated API response |
before | string | Required within parent | A paging cursor token for retrieving previous pages. |
link | string | Optional | A URL that can be used to retrieve the previous pages' results. |
Update an existing table — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowChildTables | boolean | Optional | Specifies whether child tables can be created |
allowPublicApiAccess | boolean | Optional | Specifies whether the table can be read by public without authorization |
columns | array | Optional | List of columns in the table |
columns[] | Model | Each item | Expand Create a new table — request body — body columns item |
dynamicMetaTags | object | Optional | Specifies 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.* | integer | Additional keys | Format: int32 |
enableChildTablePages | boolean | Optional | Specifies creation of multi-level dynamic pages using child tables |
label | string | Optional | Label of the table |
name | string | Optional | Name of the table |
useForPages | boolean | Optional | Specifies 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inputs | array | Required within parent | An array of HubDbTableRowV3BatchUpdateRequest objects, each containing details for a row update. This property is required. |
inputs[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
childTableId | integer | Required within parent | Specifies the value for the column child table id Format: int64 |
displayIndex | integer | Required within parent | The index position for displaying the row within the table. Format: int32 |
id | string | Optional | The id of the table row |
name | string | Optional | Specifies the value for `hs_name` column, which will be used as title in the dynamic pages |
path | string | Optional | Specifies the value for `hs_path` column, which will be used as slug in the dynamic pages |
values | object | Required within parent | List of key value pairs with the column name and column value Additional keys: see wildcard field |
values.* | Model | Additional keys | Expand List tags — response body |
Referenced models: List tags — response body
Updates an existing row — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
childTableId | integer | Optional | Specifies the value for the column child table id Format: int64 |
displayIndex | integer | Optional | The index position for displaying the row within the table. Format: int32 |
name | string | Optional | Specifies the value for `hs_name` column, which will be used as title in the dynamic pages |
path | string | Optional | Specifies the value for `hs_path` column, which will be used as slug in the dynamic pages |
values | object | Optional | List of key value pairs with the column name and column value Additional keys: see wildcard field |
values.* | Model | Additional keys | Expand List tags — response body |
Referenced models: List tags — response body