Sign in

v1

latestOpenAPI 3.0.12026-07-2464217456.8 KB
Tasks

Remove followers from a task by Id

post/1.0/tasks/{taskId}/remove-followers

Path parameters

taskIdinteger required

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

Request body

Example request

{
  "members": [
    {
      "emailId": "john.doe@rocketlane.com",
      "userId": 201,
      "firstName": "John",
      "lastName": "Doe"
    }
  ]
}

Response

The requested action was successfully executed.

taskIdinteger

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

taskNamestring

The name of the task.

taskDescriptionstring

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

startDatestring

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

dueDatestring

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.

archivedboolean

The field archived denotes whether the task is archived or not. The task if archived will not be available in all search requests.

effortInMinutesinteger

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

progressinteger

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.

atRiskboolean

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.

createdAtinteger

The time when the task was created. The referenced time will be in epoch millis.

updatedAtinteger

The time when the task was last updated. Any changes that's related to the task are captured and specified here in epoch millis.

privateboolean

This depicts if the task is private or not.

Example response

{
  "taskId": 201,
  "taskName": "Kick off",
  "taskDescription": "<p>Schedule Kick off meeting with the stakeholders involved.</p>",
  "startDate": "2023-03-28",
  "dueDate": "2023-03-28",
  "effortInMinutes": 3000,
  "progress": 50,
  "atRisk": true,
  "createdAt": 1681319726000,
  "updatedAt": 1681319726000,
  "createdBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "updatedBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "project": {
    "projectId": 201,
    "projectName": "Acme onboarding"
  },
  "status": {
    "value": 2,
    "label": "In progress"
  },
  "fields": [
    {
      "fieldId": 201,
      "fieldLabel": "MRR",
      "fieldValueLabel": "1000"
    }
  ],
  "assignees": {
    "members": [
      {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe"
      }
    ],
    "placeholders": [
      {
        "placeholderId": 201,
        "placeholderName": "Customer Success",
        "role": {
          "roleId": 101,
          "roleName": "Designer"
        }
      }
    ]
  },
  "followers": {
    "members": [
      {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe"
      }
    ]
  }
}