v1

latestOpenAPI 3.0.0Proprietary - Commercial Use Only2026-08-06172139621.6 KB
Assessment

Updates an existing assessment for a monitored company.

Updates the properties of an existing assessment for the specified company.

patch/api/v2/companies/{id}/assessments/{assessmentId}

Path parameters

idinteger required
Example:123

The id of the company for which the assessment will be updated.

assessmentIdinteger required
Example:456

The id of the assessment to be updated.

Request body

Namestring required

Assessment name. The name must be unique within the same company.

Descriptionstring

Assessment description.

Status'Analyzing' | 'InReview' | 'Completed'

Assessment status.

OnlyApiEditableboolean

Whether assessment should only be editable via API.

Summarystring

Assessment summary.

Example request

{
  "Name": "Updated Vendor Assessment Q3",
  "Description": "Updated quarterly vendor risk assessment.",
  "Status": "Completed",
  "OnlyApiEditable": true,
  "Summary": "Assessment summary with key findings and recommendations."
}

Response

Assessment updated successfully.