Update task by Id

put

https://api.rocketlane.com/api/1.0/tasks/{taskId}

Path Params

taskId

int64

required

≥ 0

Defaults to 1

The task's unique, system-generated identifier, which can be used to identify the task globally

Query Params

includeFields

array of strings

This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned.

includeFields

includeAllFields

boolean

This query parameter allows you to specify if all the fields should be returned in the response body. If the field is left blank, the default properties are returned.

Body Params

taskName

string

The name of the task.

taskDescription

string

The description of the task. The description body needs to be in html format to avoid any formatting issues in the application.

taskPrivateNote

string

The privateNote for the task is intended exclusively for team members. The note's content should be in HTML format to prevent any formatting issues in the application.

startDate

string

The date when a task starts its execution. It can be empty. The format for the start date is YYYY-MM-DD.

dueDate

string

The date when a task completes its execution. It can be empty. If both startDate and dueDate are specified for a given task, it is necessary that the latter should be on or after the given startDate. The format for the due date is YYYY-MM-DD.

effortInMinutes

int32

The effort is the expected time required to complete the task. The value is determined in minutes.

progress

int32

The task's progress, if indicated, will be available here and ranges in value from 0 to 100. The task's status can be used in place of this field, however progress can offer more precise data.

atRisk

boolean

Indicates whether the task has been marked as At Risk. This parameter is used to indicate that immediate action is necessary to unblock the task's execution.

type

string

enum

The type of the task if specified will be available here. There are two options: MILESTONE or TASK. If a task is not explicitly marked as a milestone, it takes the default value as TASK. Milestones refer to critical tasks in the project that include an inbuilt CSAT capability that allows customers to offer CSAT evaluations depending on the task's execution.

Allowed:

fields

array of objects

The custom fields can be set during the task creation with the help of fields. The fieldValue can be either a string or a number or an array and it has to comply with the type of the field. Refer examples to know how to assign fieldValue based on their field_type.

fields

status

object

The value of the task status can be specified here and this is essential to keep track of it.

externalReferenceId

string

An externalReferenceId is a unique identifier that links entities or transactions between external systems and Rocketlane, ensuring accurate data correlation and consistency.

private

boolean

This depicts if the task is private or not.

Responses

200The requested action was successfully executed.

400This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.

401You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.

404If we were unable to locate the resource you were looking for or the proper API endpoint you were looking for, this error would show up.

500This error denotes that there is an error that occured within our servers. The response body could help narrow down the cause for the error by our support team.