Sign in
Policy

Evaluate policies

This endpoint consults all policies and checks the ones that satisfy the request body’s conditions.

Permissions

Any user or application 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
Promotions Policy EnginePoliciesEvaluate Policy

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 app keys when assigning License Manager roles to integrations.

post/api/policy-engine/evaluate

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

resourcestring required

Scope on which this policy must be evaluated.

contextobject required

Conditions that the policy needs to satisfy.

Response

OK

idstring

Action ID.

metadataobject

Metadata object from the current action.

Example response

[
  {
    "id": "SendSlackMessage",
    "metadata": {
      "channel": "C01NJFF35R6",
      "relatedUsers": [
        "URUNDC2NB"
      ],
      "alertDescription": "Avoid selling products from Berenice with a discount greater than 70%."
    }
  }
]

Changes