Personal data

Configure personal data fields

Changed on

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 must have at least one of the appropriate License Manager resources 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:

ProductCategoryResource
Dynamic StorageDynamic storage generic resourcesMaster Data administrator

There are no applicable predefined roles for this resource list. You must create a custom 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.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

put/api/dataentities/{dataEntityName}/personalData

Request

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

Path parameters

dataEntityNamestring required
Example:Newsletter

Name of the data entity.

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

Fieldsstring[] 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.

SubjectIdFieldstring 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

OK

Changes