Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Assessment Management

Modify Assessment

Use this API to update basic assessment details such as assessment name, assessment description, assessment deadline and reminder.

🗒 Things to Know

  • If the assessment is in Completed stage, updates made using this API will be ignored.

  • If an update is made using this API, an event will be shown in the Assessment Activity.

  • This API can update assessments of the following types: PIA, Vendor, ITRM, Control, Exchange and Incident.

patch/api/assessment/v2/assessments/{assessmentId}/metadata

Path parameters

assessmentIdstring uuid required

UUID of the assessment to update

Request body

namestring

The name of the assessment to be displayed in the UI

descriptionstring

Detailed description of the assessment's purpose and scope

deadlinestring date-time

The date by which the assessment must be completed

reminderinteger

The number of days before the deadline when a reminder notification should be sent to respondents

Example request

{
  "name": "GDPR Compliance Assessment 2025",
  "description": "This assessment evaluates the organization's compliance with GDPR requirements and identifies potential data protection gaps",
  "deadline": "2025-12-31T23:59:59.000Z",
  "reminder": 7
}

Response

No Content