Create a new Table

Last updated June 17, 2020

POST /hubdb/api/v2/tables

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Create a new HubDB table.
Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.		 Used to authenticate the request. Please see this page for more details about authentication.
Name "name":{name}
Used in the request		 The name of the table.

Optional Parameters How to use Description
Use for dynamic pages "useForPages": false
Used in the request		 Set this to true to use the page for dynamic pages.
Columns "columns":[ {list of columns} ]
Used in the request		 A list of column definitions that will be used for the table.
Published at "publishedAt":{millisecond timestamp}
Used in the request		 Set this to the current time to publish the table, making it available for use.

Columns

Each column should include the following fields.

Field How to use Description
Name "name":{name} The internal name of the column.
Label "label":{label} Optional - The label for the column. This will be displayed when editing the table in the HubSpot app.
Type "type":{type} The data type of the column. must be one of
  • TEXT - a simple text field
  • RICHTEXT - a text field that supports basic HTML
  • NUMBER - a number field
  • BOOLEAN - represented as a checkbox in HubSpot, uses 0 for unchecked and 1 for checked.
  • DATE - Stores a specific date as a millisecond timestamp set to midnight UTC for the specified date.
  • DATETIME - Stores a date and a time as a millisecond timestamp.
  • SELECT - The column can only be set to one of a set of options.
  • MULTISELECT - The column can be set to one or more of a set of options.
  • URL - Stores a URL.
  • LOCATION - Stores a lattitude and longitude location.
  • IMAGE - Stores the URL of an image.
Options "options": [ {list of options} ] If the column is the SELECT type, this will be used as the options for the column. Each option must include a name, and a type of "option":
[{"name":"a", "type":"option"}, {"name":"b", "type":"option"}

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example POST URL: https://api.hubapi.com/hubdb/api/v2/tables?hapikey=demo Example POST Body: Create a new table with a single TEXT column: { "name": "Test Table", "columns": [ { "name": "Name", "type": "TEXT" } ] } Create a table with a TEXT column and a SELECT column: { "name": "New Table", "columns": [ { "name": "Name", "type": "TEXT" }, { "name": "choices", "type": "SELECT", "options": [ { "name": "one", "type": "option" }, { "name": "two", "type": "option" } ] } ] } Example response body: { "id": 680019, "name": "New Table", "createdAt": 1523471278962, "publishedAt": null, "updatedAt": 0, "columns": [ { "name": "Name", "label": null, "id": 1, "deleted": false, "type": "TEXT" }, { "name": "choices", "label": null, "id": 2, "deleted": false, "options": [ { "id": 1, "name": "one", "type": "option" }, { "id": 2, "name": "two", "type": "option" } ], "type": "SELECT", "optionCount": 2 } ], "label": "New Table", "cosObjectType": "HUBDB_TABLE", "updated": 0, "deleted": false, "rowCount": 0, "useForPages": false, "columnCount": 2 }