Skip to main content
PATCH
/
api
/
public
/
v1
/
planner
/
items
/
{id}
Update planner item
curl --request PATCH \
  --url https://app.msportal.ai/api/public/v1/planner/items/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "typeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "In Progress",
  "businessValue": "High",
  "hours": 1,
  "costEstimate": 1,
  "probability": 50,
  "startDate": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "publicNotes": "<string>",
  "privateNotes": "<string>",
  "isArchived": true
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "description": "<string>",
    "status": "In Progress",
    "businessValue": "High",
    "hours": 1,
    "costEstimate": 1,
    "probability": 50,
    "startDate": "2023-11-07T05:31:56Z",
    "dueDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "publicNotes": "<string>",
    "privateNotes": "<string>",
    "isArchived": true,
    "isOverdue": true,
    "fiscalYear": 123,
    "fiscalQuarter": 123,
    "company": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "type": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "linkedGoalsCount": 123,
    "linkedComplianceCount": 123,
    "linkedMeetingsCount": 123,
    "linkedProjectsCount": 123,
    "linkedSecureScoreCount": 123,
    "tagCount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "linkedGoals": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "customTitle": "<string>"
      }
    ],
    "linkedCompliance": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "customTitle": "<string>"
      }
    ],
    "linkedProjects": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "externalId": "<string>",
        "provider": "<string>"
      }
    ],
    "linkedOpportunities": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "summary": "<string>",
        "externalId": "<string>",
        "provider": "<string>"
      }
    ],
    "linkedSecureScore": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "customTitle": "<string>",
        "actionUrl": "<string>"
      }
    ],
    "tags": [
      "<string>"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Path Parameters

​
id
string<uuid>
required

Planner item ID

Body

application/json
​
title
string

Item title

Required string length: 1 - 255
​
description
string | null

Item description (null to clear)

Maximum string length: 10000
​
companyId
string<uuid> | null

Company ID (null to clear)

​
typeId
string<uuid> | null

Planner item type ID (null to clear)

​
status
enum<string>

Status

Available options:
In Progress,
Not Started,
Completed,
On Hold,
Cancelled,
Pending Approval
​
businessValue
enum<string>

Business value

Available options:
High,
Medium,
Low
​
hours
number

Estimated hours

Required range: x >= 0
​
costEstimate
number

Cost estimate

Required range: x >= 0
​
probability
number

Completion probability

Required range: 0 <= x <= 100
​
startDate
string<date-time> | null

Start date (null to clear)

​
dueDate
string<date-time> | null

Due date (null to clear)

​
endDate
string<date-time> | null

End date (null to clear)

​
publicNotes
string | null

Public notes (null to clear)

Maximum string length: 10000
​
privateNotes
string | null

Private notes (null to clear)

Maximum string length: 10000
​
isArchived
boolean

Whether the item is archived

Response

Planner item updated successfully

​
data
object
required