Validate document by 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 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:
| 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 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.
Path parameters
Name of the data entity.
ID of the Document.
Headers
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Request body
Example request
[
{
"name": "male",
"rule": "gender=male"
}
]Response
OK