Create a new calendar task

Last updated September 8, 2020

POST /calendar/v1/events/task

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

content

Create a new task for Calendar. Creating a task of type BLOG_POST, EMAIL, or LANDING_PAGE will create a draft of the respective content and associate it with the task, returning a contentId in the response.

When specifying an owner, use the Owners API to get a list of owner Ids.

Note: This endpoint is for tasks on the Marketing calendar. For tasks associated with the CRM and CRM objects, please see the Engagements API

Required headers

Required headers How to use Description
X-Origin-UserId Provide the id for the individual user in the HubSpot account. Use the Owners API to get a list of Owner Ids. This id is used to associate the task with the user, displaying that user as the author.

Required parameters

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.

Allowed JSON Fields in the body

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
state string value of TODO or DONE
campaignGuid string value of campaign GUID associated with Task
contentGroupId long The ID of the content group (aka blog) that the associated Blog Post will belong to, if any. Only read for BLOG_POST Tasks. See Blog API to get a list of blogs ids.
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.
templatePath string (optional) The template to use for emails and landing pages. only read for EMAIL and LANDING_PAGE categories.
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

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/calendar/v1/events/task?hapikey=demo Example POST body: { "eventDate": 1425760557000, "category": "BLOG_POST", "state": "TODO", "campaignGuid": "f43fe9fd-4082-4a45-93d8-cb8a88f01654", "name": "Test Blog Task With topics 3", "description": "Cool Post with Topics", "ownerId": 13316, "topicIds": [ 330075656 ], "contentGroupId": 343029322 } Example response: HTTP/1.1 201 Created { "id": "600442", "eventType": "PUBLISHING_TASK", "eventDate": 1425760557000, "category": "BLOG_POST", "categoryId": 3, "contentId": 2557937936, "state": "TODO", "campaignGuid": "f43fe9fd-4082-4a45-93d8-cb8a88f01654", "portalId": 62515, "name": "Test Blog Task With topics 3", "description": "Cool Post with Topics", "url": null, "ownerId": 13316, "createdBy": 2124540710, "previewKey": null, "socialUsername": null, "socialDisplayName": null, "avatarUrl": null, "topicIds": [ 330075656 ], "contentGroupId": null, "startedDate": null, "publishedDate": 1425760557000, "recurring": false }