---
title: "Modify Assessment"
method: PATCH
path: "/api/assessment/v2/assessments/{assessmentId}/metadata"
tags: ["Assessment Management"]
---

# Modify Assessment

`PATCH /api/assessment/v2/assessments/{assessmentId}/metadata`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/assessment/v2/assessments/{assessmentId}/metadata`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `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.

## Path parameters

- `assessmentId` string, uuid, required

## Request body

- PrivacyAutomationAssessmentAutomationAssessmentBasicDetailsUpdateRequest
  - `name` string: The name of the assessment to be displayed in the UI
  - `description` string: Detailed description of the assessment's purpose and scope
  - `deadline` string, date-time: The date by which the assessment must be completed
  - `reminder` integer: The number of days before the deadline when a reminder notification should be sent to respondents

## Response `204`

No Content

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500`: Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/privacy-automation-assessment-automation.md) - [All operations](https://skmtc.dev/onetrust/apis/privacy-automation-assessment-automation/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/privacy-automation-assessment-automation/revisions/fbdf0c71bfe5?raw)