---
title: "Configure personal data fields"
method: PUT
path: "/api/dataentities/{dataEntityName}/personalData"
tags: ["Personal data"]
---

# Configure personal data fields

`PUT /api/dataentities/{dataEntityName}/personalData`

## Request

- Base URL: `https://apiexamples.vtexcommercestable.com.br`
- URL: `https://apiexamples.vtexcommercestable.com.br/api/dataentities/{dataEntityName}/personalData`
- Auth: one of:
  - API key in header `X-VTEX-API-AppKey` and API key in header `X-VTEX-API-AppToken`
  - API key in header `VtexIdclientAutCookie`

Defines which fields of a data entity contain personal data and which field identifies the data subject (owner of the data). Fields configured as personal data are stored separately with encryption and special data residency, are returned masked by default when retrieving documents, and participate in data subject requests such as the right to be forgotten.

>ℹ️ Personal data configuration is set at the data entity level, not within individual schemas. This avoids conflicts when multiple schemas coexist for the same data entity.

>⚠️ Saving a new configuration triggers a background process that re-tokenizes all existing documents in the entity. While this process runs, this endpoint is locked for the affected entity for up to 12 hours to prevent concurrent reprocessing jobs.

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Path parameters

- `dataEntityName` string, required

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Request body

- PersonalDataRequest: Configuration of personal data fields for a data entity.
  - `Fields` string[], required: Names of fields that contain personal data. These fields are stored with encryption and special data residency, and are returned masked by default when retrieving documents.
  - `SubjectIdField` string, required: Name of the field whose value identifies the data subject (owner of the personal data) in each document. Required for compliance with data subject requests such as the right to be forgotten. Every document saved in this entity must contain this field.

## Response `200`

OK

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `423`: Locked A previous configuration change is still being processed.

## Changes

- **2026-10-09** `4d580ec5be53`: 1 info
  - endpoint added
- **2026-05-14** `6d3f8010fa54`: 1 breaking
  - api path removed without deprecation
- **2026-04-08** `4d580ec5be53`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/vtex/apis/master-data-api-v2/changes/api/dataentities/:dataEntityName/personalData/put.md)

---

[API](https://skmtc.dev/vtex/apis/master-data-api-v2.md) - [All operations](https://skmtc.dev/vtex/apis/master-data-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/vtex/apis/master-data-api-v2/revisions/4d580ec5be53?raw)