Partially Update Client's Objective

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

Request property names use snake_case in JSON.

Common Use Cases:

  • Updating status (Supported values: Not Assessed, Not Compliant, Partially Compliant, In Review, Compliant, Not Applicable)
  • Updating target_maturity (Supported values: Not Implemented, Initial, Defined, Reviewed, Optimizing)
  • Updating current_maturity (Supported values for name: Not Implemented, Initial, Defined, Reviewed, Optimizing; observation is required with name)
  • Updating implementation_details, description, or remarks
  • Replacing assessment response notes with sub_objectives[].id and sub_objectives[].notes
  • Updating in_scope (true or false)

When both in_scope and status are supplied, status is applied last and may adjust
the final scope according to the existing objective status rules.
Note fields accept raw Unicode text or supported HTML; an empty string clears the field.
Use the mapped assessment ID for sub_objectives[].id, not the requirement ID. Assessment
notes do not change the assessment answer, status or POAM. A manual response-note change
clears auto-answer review in the same way as the existing single app save.
Note updates do not require a prior notes read. The objective notes read can be used
to retrieve unexpanded editable implementation source. The response includes framework_object with the containing framework id and framework_name.

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

Unique identifier of the client

Accepts either the client UUID or the client's tenant_id.

int32
required

Unique identifier of the framework that contains the objective.

int32
required

Unique identifier of the objective to update.

Body Params

JSON payload containing one or more fields to update.
Only the fields included in the request will be applied.

Partial update for an objective. Include only fields to change.
When status is included, it is applied after the other fields in the request.

string

Configured requirement status label. Common labels include Not Assessed, Not Compliant, Partially Compliant, In Review, Compliant, and Not Applicable.

string

Target maturity label available for this objective. Common labels include Not Implemented, Initial, Defined, Reviewed, and Optimizing.

current_maturity
object

Current maturity assessment values to update together

string | null

Implementation details, including HTML when applicable. Raw Unicode source; document variables are preserved without expansion. Empty text clears; omission or explicit null preserves the current value.

boolean

Whether the objective is in scope

string

Objective description

string | null

Objective remarks. Raw Unicode text or supported HTML; empty text clears. Omission or explicit null preserves the current value.

sub_objectives
array of objects
length between 0 and 500

Replacement assessment notes, addressed by mapped sub_objectives[].id. Up to 500 items. Omission or an empty array leaves assessment notes unchanged; an empty notes string clears one row

sub_objectives
Responses

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