API Reference

Partially update an action item

patch
https://api.scalepad.com/controlmap/v1/clients//action-items/

Updates specific fields of an action item request. Only the fields provided in the request body will be updated.
All other fields will remain unchanged.

Allowed values for patchable fields:

  • status: Not Started, In Progress, Review, Completed, Not Applicable
  • roadmap: 3 months, 6 months, 12 months
  • priority: High, Medium, Low, Critical
  • currency: USD, EUR, AUD, CAD, SEK, NZD, SGD, INR
  • efforts_in_hours: must be zero or a positive number
  • cost: must be zero or a positive number
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the client

int32
required

Unique identifier of the action item request to be updated

Body Params

Fields to update for the action item. Only provided fields will be modified.

Payload for partially updating action item details. Only fields provided will be updated.

string
enum
^(3 months|6 months|12 months)$

Roadmap or implementation plan outlining the steps to complete the action item.

Allowed:
string

Title or name of the action item. If provided, must not be empty.

string

Detailed description providing more context about the action item.

string

Email of the person responsible for completing this action item.

string
enum
^(Not Started|In Progress|Review|Completed|Not Applicable)$

Updated status of the action item. If not provided, status remains unchanged.

Allowed:
string

Specific corrective actions or steps that need to be taken to resolve the issue.

string

Department or team responsible for the action item.

int32
0 to 8

Estimated effort required to complete the action item, in hours.

string
enum
^(High|Medium|Low|Critical)$
Defaults to High

Priority level indicating the importance and urgency of the action item.

Allowed:
string

The date when work on the action item is scheduled to begin.

string

The planned date by which the action item should be completed.

string

The actual date when work on the action item was started.

string

The actual date when the action item was completed.

string
^(USD|EUR|AUD|CAD|SEK|NZD|SGD|INR)$
Defaults to USD

ISO currency code for cost estimation.

int32

Estimated or actual cost associated with the action item.

string

Key milestones or checkpoints for tracking progress of the action item.

string

Description of any changes made to the original milestones or plan.

string

Additional notes or comments regarding the action item.

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?