Create taskPOST
Description
Creates a new task. Returns an object containing the created task's ID. If task numbering is enabled for the board, it will also return the task's number.
Permissions
Request format
curl -X POST https://kanbanflow.com/api/v1/tasks -H "Content-type: application/json" -d '{ "<PROPERTY_1>": <PROPERTY_VALUE_1>, "<PROPERTY_2>": <PROPERTY_VALUE_2>, ... "<PROPERTY_N>": <PROPERTY_VALUE_N> }'Example request
curl -X POST https://kanbanflow.com/api/v1/tasks -H "Content-type: application/json" -d '{ "name": "Write report", "columnId": "C9LIn5sEEpqT", "color": "red" }'Example response
{
"taskId": "T3s6UGyzY"
}Valid properties
| Property | Type | Comment |
|---|---|---|
| name | String | Required. The name of the task. |
| columnId | String | Required. The ID of the column to add the task to. See Get board for information about how to get a column's ID. |
| swimlaneId | String | The ID of the swimlane to add the task to. Required if the board has swimlanes. See Get board for information about how to get a swimlane's ID. |
| position | String / Integer | The index of the task in the column/swimlane or date group. groupingDate is required if the column is date grouped. Valid values: Positive number, "top" or "bottom". Note: The index is zero-based. |
| color | String | The color of the task. Valid color values: yellow, white, red, green, blue, purple, orange, cyan, brown, or magenta. It needs to be in lowercase. |
| description | String | The description of the task. |
| number | Object | The task number consists of an integer value and an optional prefix. If numbering is enabled on the board, the task will automatically be given a number if the property is not present. Examples: { "value": 5 }, { "prefix": "BUG-", "value": 5 } |
| responsibleUserId | String | The ID of the responsible user. See Get members for information about how to get a member's ID. |
| totalSecondsSpent | Integer | Deprecated. The time spent on the task in seconds. Examples: 1 hour = 3600, 2 hours = 7200 etc. Note: Manual time entries will be added to reflect the added time. See Add manual time entry for more control of how time is added to the task. |
| totalSecondsEstimate | Integer | The estimated time for the task in seconds. Examples: 1 hour = 3600, 2 hours = 7200 etc. Default: 0. |
| pointsEstimate | Float | Estimated points for the task. Default: 0. |
| groupingDate | String | The date that the task is grouped by. Can only be used if column is date grouped. Valid format is YYYY-MM-DD, e.g. 2023-12-31. Use null or empty string if you want it grouped as unknown date. If not set and column date grouped, then it will automatically use today's date for the UTC timezone. |
| dates | Array | A date requires a dueTimestamp and has an optional targetColumnId. See Create/update date for more details about the optional properties. Omit targetColumnId to make the date done when the task reaches any archived column. Examples: { "dueTimestamp": "2023-03-01T12:00:00Z", "targetColumnId": "COxkPjd0wra4" }, { "dueTimestamp": "2023-03-01T12:00:00Z" } |
| subTasks | Array | A subtask consists of a name and an optional finished flag. See Create subtask for more details. Examples: { "name": "Write", "finished": true }, { "name": "Proofread" } |
| labels | Array | A label consists of a name and an optional pinned flag. See Create label for more details. Examples: { "name": "Project X" }, { "name": "Priority", "pinned": true } |
| collaborators | Array | A collaborator consists of a userId. See Add collaborator for more details. Examples: { "userId": "UHJ9JgtA" } |
| timeline | Object | A timeline consists of a start and an end date. Valid format is YYYY-MM-DD, e.g. 2023-12-31. Example: { "start": "2024-01-01", "end": "2024-01-31" } |