Method Details
HTTP Methods:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing
There's a new version of the HubSpot API
As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.
HTTP Methods:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing
Required Parameters | How to use | Description |
---|---|---|
OAuth access token or private app access token | Authorization: Bearer {token} header | 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. |
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
|
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"} |