---
title: "Modify Object"
method: PATCH
path: "/v1/entities/{entityId}"
tags: ["Object Management"]
---

# Modify Object

`PATCH /v1/entities/{entityId}`

Use this API to partially update an existing object record.

> 🗒 Things to Know
> 
> - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.

## Path parameters

- `entityId` string, uuid, required — Identifier of the object to update

## Query parameters

- `entityTypeIdentifier` string, uuid — Identifier of the object type
- `entityTypeName` string — Name of the object type

## Request body

- EntityUpdateRequest
  - `name` string — The updated name of the entity. If not provided, the existing name will be retained.
  - `organization` EntityOrganizationInformation
    - `id` string, uuid, required — The unique identifier of the organization.
    - `name` string — The name of the organization.
  - `attributes` object — Custom attributes to update on the entity. Only the attributes provided will be updated; others will retain their existing values.

## Response `200`

OK - The object was successfully updated

- EntityInformation
  - `id` string, uuid, required — The unique identifier of the entity.
  - `number` integer, required — The numerical order in which the entity was created.
  - `name` string — The name of the entity.
  - `orgGroupId` string, uuid — The unique identifier of the organization.
  - `schemaId` string, uuid, required — The unique identifier of the schema.
  - `entityType` BasicEntityTypeInformation, required
    - `id` string, uuid, required — The unique identifier for the entity type.
    - `name` string, required — The name of the entity type.
    - `seeded` boolean — This parameter indicates whether the entity type is seeded or custom.
    - `moduleName` string — The name of the module where the entity exists.
    - `schemaName` string — The name of the schema.
  - `workflowAndStage` EntityWorkflowInformation
    - `id` string, uuid, required — The unique identifier of the workflow.
    - `name` string, required — The name of the workflow.
    - `type` string, required — The type of workflow.
    - `workflowMode` 'ADVANCED, BASIC' — This parameter indicates whether the workflow mode is null, basic, or advanced.
    - `stageId` string, uuid, required — The unique identifier of the workflow stage.
    - `stageName` string, required — The name of the workflow stage.
  - `attributes` object
  - `auditFields` EntityRecordAuditInformation
    - `createdDate` string, date-time, required — The date and time that the entity was last created.
    - `lastUpdatedDate` string, date-time — The date and time that the entity was last updated.
    - `createdBy` EntityBasicUserInformation
      - `id` string, uuid — The unique identifier of the user.
      - `name` string — The full name of the user.
      - `email` string — The email address of the user.
      - `initials` string — The initials for the first and last name of the user.
    - `lastModifiedBy` EntityBasicUserInformation
      - `id` string, uuid — The unique identifier of the user.
      - `name` string — The full name of the user.
      - `email` string — The email address of the user.
      - `initials` string — The initials for the first and last name of the user.

## 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.net/onetrust/apis/platform-access-management.md) · [All operations](https://skmtc.net/onetrust/apis/platform-access-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onetrust/platform-access-management/versions/21de3aa0b170/schema)