Task

Create Many Tasks

POST

Create multiple new Tasks within a specified project with a single API call.

A Task is an individual element of work that must be performed to complete a Project. A Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to indicate whether they have a dependency or a connection.

Path parameters

projectIdstringRequired
The unique identifier of the Project that will contain these Tasks

Request

This endpoint expects a list of objects.
name
stringRequired
The name of the Task being created.
description
stringOptional
A description of the work involved in this Task.
percentComplete
integerOptional

The numerical percentage, from 0-100, representing the percentage completion for this Task. Any numbers below zero or above 100 will be clamped to the minimum or maximum value.

This value can be edited manually in the Gantt chart view of the application, or can be selected on the Task Detail page within the Kanban board.

statusId
stringOptional
The unique identifier of the TaskStatus that reflects the current status of this Task, if known.
priorityId
integerOptional
The unique identifier of the TaskPriority that reflects the current status of this Task, if that has been selected.
plannedStartDate
stringOptional

The date when work on this Task is planned to begin.

This value contains only the date in year-month-day format. For display, this date will always be shown as this same year-month-day regardless of time zone. For reporting purposes, this date is calculated against the official time zone of the Workspace.

For example: A Task has a planned completion date of July 5, 2023 in a Workspace that has a time zone of US Pacific Time (GMT-7 or GMT-8, depending on daylight savings time). This project is considered overdue on 12:01 AM July 6th 2023 in US Pacific time.

plannedFinishDate
stringOptional

The date when work on this Task is expected to complete.

This value contains only the date in year-month-day format. For display, this date will always be shown as this same year-month-day regardless of time zone. For reporting purposes, this date is calculated against the official time zone of the Workspace.

For example: A Task has a planned completion date of July 5, 2023 in a Workspace that has a time zone of US Pacific Time (GMT-7 or GMT-8, depending on daylight savings time). This project is considered overdue on 12:01 AM July 6th 2023 in US Pacific time.

actualStartDate
stringOptional

If set, this is the actual date when work began on the Task.

This value contains only the date in year-month-day format. For display, this date will always be shown as this same year-month-day regardless of time zone. For reporting purposes, this date is calculated against the official time zone of the Workspace.

For example: A Task has a planned completion date of July 5, 2023 in a Workspace that has a time zone of US Pacific Time (GMT-7 or GMT-8, depending on daylight savings time). This project is considered overdue on 12:01 AM July 6th 2023 in US Pacific time.

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
list of objectsOptional
If the API call succeeded, this will contain the results.
POST
1curl -X POST /project-api/public/projects/projectId/tasks/bulk \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '[
5  {
6    "name": "name"
7  }
8]'
200Successful
1{
2  "error": {
3    "message": "message"
4  },
5  "success": true,
6  "hasError": true,
7  "statusCode": "Continue",
8  "data": [
9    {
10      "changeSetId": "changeSetId",
11      "id": "id"
12    }
13  ]
14}
Built with