Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

properties
enum<string>[]

Select the workspace plan task properties that should be returned

Available options:
isInternal,
status,
completedAt,
actionLinkUrl,
actionLinkName,
actionText,
actionType,
showActionText,
startDate,
title,
dueDate,
index,
createdAt,
updatedAt,
templatePlanTaskId,
description,
assignees,
parentTaskId

Body

application/json
workspacePlanId
string
required

ID of the workspace plan to create the task in

Example:

"RiHO4e0Ju3DS"

title
string
required

Title of the workspace plan task

Example:

"Create onboarding plan"

parentTaskId
string

ID of an existing task to create this task under as a subtask. Subtasks cannot be nested more than one level

Example:

"RiHO4e0Ju3DS"

isInternal
boolean
default:false

Whether the workspace plan task is internal. Subtasks of an internal parent task are always internal

startDate
string<date>

Start date of the workspace plan task. Must be on or before dueDate

Example:

"2024-01-01"

dueDate
string<date>

Due date of the workspace plan task

Example:

"2024-01-15"

description
string

Description of the workspace plan task as plain text. Newlines create separate paragraphs

Example:

"Kick off the onboarding project"

assignees
(User assignee · object | Email assignee · object | Company team assignee · object | Client team assignee · object)[]

Assignees of the workspace plan task. At most one companyTeam and one clientTeam assignee

Maximum array length: 50

Response

Create a workspace plan task

data
object