---
title: "Validate document by clusters"
method: POST
path: "/api/dataentities/{dataEntityName}/documents/{id}/clusters"
tags: ["Clusters"]
---

# Validate document by clusters

`POST /api/dataentities/{dataEntityName}/documents/{id}/clusters`

Checks if a document is present in one or more clusters (specific set of field values).

>ℹ️ There is a limit of five rules per request.  

## 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
- `id` string, required

## Headers

- `Accept` string, required

## Request body

- object[] — List of cluster validation rule information.
  - `name` string — Cluster name.
  - `rule` string — Cluster validation rule.

## Response `200`

OK

- object[] — Array with objects validating each cluster rule.
  - `name` string — Cluster name.
  - `isValid` boolean — Informs if the document is valid according to the cluster rule (`true`) or not (`false`).

## Changes

- **2023-10-19** `5bf3265c027c` — 1 breaking, 2 info
  - the request's body type/format changed from `string`/`json` to `array`/``
  - the request body `application/json` default value `[ { "name": "male", "rule": "gender=male" }, { "name": "complex", "rule": "((gender=male AND percent=0.35) AND any is null) AND (name=*go*)" }, { "name": "complex2", "rule": "((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)" }, { "name": "createdIn", "rule": "createdIn between 2015-10-28 AND 2015-10-30" } ]` was removed
  - added the media type `application/json` for the response with the status `200`

[Change history](https://skmtc.dev/vtex/apis/master-data-api-v2/changes/api/dataentities/:dataEntityName/documents/:id/clusters/post.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)
