API Reference

Update Goal

patch
https://api.scalepad.com/lifecycle-manager/v1/goals/

Partially update goal details including title, rich-text description, status, target period, and assigned contact.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The goal identifier.

Body Params

The fields to update.

Partial update payload for the editable details of an existing goal.

string | null

The title of the goal.

string | null

Rich-text description as a ProseMirror JSON document. Send null to clear the description; omit to preserve it.

string | null

The status of the goal.

  • Available values: OnTrack, AtRisk, OffTrack, OnHold, Complete.
target_period

The target period for achieving the goal.

outcome_ids
array of strings | null

Full replacement set of active Outcome identifiers. Omit to preserve the current set; send an empty array to clear it.

outcome_ids
string | null

The contact to assign to the goal. Send null to clear the assignment; omit to preserve it.

string | null
deprecated

Deprecated by 'description_json'. Sending this field will
overwrite any rich-text document currently stored on the
goal with a minimal ProseMirror projection of the plain
text, losing formatting, images, and (future) mentions.

A plain-text description of the goal.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses
200

OK

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
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?