---
title: "Create partial document"
method: PATCH
path: "/api/dataentities/{dataEntityName}/documents"
tags: ["Documents"]
---

# Create partial document

`PATCH /api/dataentities/{dataEntityName}/documents`

This request allows you to partially update a document corresponding to a given data entity.

>ℹ️ You can use this request to create documents for any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update.

## 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 | **Insert or update document (not remove)** |
| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |
| 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

## Query parameters

- `_schema` string

## Headers

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

## Request body

- DocumentRequest — This can be any pure JSON document. Add new _Key-Value_ pairs to test.

## Response `200`

OK

- CreateDocumentResponse — Response body object.
  - `Id` string, required — ID of the document that was created, with data entity prefix.
  - `Href` string, required — Document reference URL.
  - `DocumentId` string, required — ID of the document that was created.

## Changes

- **2026-01-26** `c22f3bc5df7b` — 1 info
  - added the required property `DocumentId` to the response with the `200` status

[Change history](https://skmtc.dev/vtex/apis/master-data-api-v2/changes/api/dataentities/:dataEntityName/documents/patch.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-service-production.skmtc.workers.dev/v1/apis/vtex/master-data-api-v2/revisions/6d3f8010fa54/schema)