Update Goal

patch

https://api.scalepad.com/lifecycle-manager/v1/goals/{id}

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The goal identifier.

Body Params

The fields to update.

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

title

string

The title of the goal.

description_json

string | null

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

status

string

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

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

outcome_ids

assigned_contact_id

string | null

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

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad Request

402Payment Required

403Forbidden

404Not Found