Create Task (Folder)

Create a task in a folder. The folder specified by {folderId} will become the 'parent' folder for the new task. To create a task in the account root, use the Root Folder API ID. When creating a subtask, use the Root API ID as {folderId} and specify the parent task in the 'superTasks' parameter.

Scopes: Default, wsReadWrite

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
string
required

Title of task, required

string

Description of task, will be left blank, if not set

string
enum

Status of task. Not available for the Team plan

  • Active - Active
  • Deferred - Deferred
  • Completed - Completed
  • Cancelled - Cancelled
Allowed:
string
enum

Importance of task

  • High
  • Low
  • Normal
Allowed:
dates
object

Task dates. If not specified, a backlogged task is created

shareds
array of objects

Shares task with specified users or invitations. The task is always shared with the author.

shareds
parents
array of objects

Parent folders for newly created task. Can not contain recycleBinId

parents
responsibles
array of strings

Makes specified users or invitations assignee for the task

responsibles
responsiblePlaceholders
array of objects

Makes specified placeholders assignee for the task

responsiblePlaceholders
followers
array of strings

Add specified users to task followers

followers
boolean

Follow task

string

Put newly created task before specified task in task list

string

Put newly created task after specified task in task list

superTasks
array of strings

Add the task as subtask to specified tasks

superTasks
metadata
array of objects
length ≤ 100

Metadata to be added to newly created task. Limit : 100

metadata
customFields
array of objects
length ≤ 100

List of custom fields to set in newly created task. Limit : 100

customFields
string

Custom status ID

effortAllocation
object

Set Task Effort fields: mode, total Effort

string
enum

Task's timelogs billing type

  • Billable - Billable
  • NonBillable - Non-Billable
Allowed:
boolean

Include invitations in sharedIds & responsibleIds lists

string

Custom Item Type ID to create a task from

boolean

Strip HTML tags from custom fields

string

Id of work schedule to assign to task

fields
array of strings

Json string array of optional fields to be included in the response model

  • customItemTypeId - Custom Item Type ID
  • billingType - Billing type
  • workScheduleId - Id of work schedule assigned to task
  • effortAllocation - Effort Allocation
  • responsiblePlaceholderIds - List of placeholder assignee IDs
fields
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json