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.
Please note: all calendar API endpoints are being sunset and are no longer supported. These APIs will no longer function, and data from the marketing calendar will no longer be available via API. These APIs will be removed on August 31, 2023.
HTTP Methods:
POST
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Required Scope
Update a Task. this action will replace any existing allowed fields specified. Any fields not included will not change from existing values.
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. |
Field name | Type | Description |
---|---|---|
eventDate | long | When the task is set to be due, in milliseconds since the epoch |
eventType | string | Type of calendar event; for tasks this is always PUBLISHING_TASK |
category | string | type of task; one of BLOG_POST, EMAIL, LANDING_PAGE, CUSTOM. This must match existing value. |
state | string | value of TODO or DONE |
campaignGuid | string | value of campaign GUID associated with Task |
topicIds | list of longs | The list of ids of topics associated with the associated Blog Post, if any. Otherwise null. Only read for BLOG_POST Tasks. See Topics API to get a list of topic ids. |
name | string | Name of Task |
description | string | description of Task |
ownerId | long | HubSpot id of the user that the task is assigned to. See the Owners API to get a list of owner Ids |