v50

latestOpenAPI 3.0.0raw.githubusercontent.com2025-08-286653.1 KB

Policy

Update policy

Updates an existing policy at your account.

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
Promotions Policy Engine	Policies	Create or Update 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 API keys when assigning License Manager roles to integrations.

put/api/policy-engine/policies/{id}

Path parameters

idstring required

Example:pa_test_001

Policy ID.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

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

Request body

namestring required

Policy name.

descriptionstring required

Policy description, only for internal use.

statusstring

The status field defines if the policy is active or inactive. An active policy is enforced, while an inactive policy is stored but not applied.

Example request

{
  "name": "id",
  "description": "TesteMarcosPromotionsAlert",
  "status": "active",
  "statements": [
    {
      "effect": "Allow",
      "actions": [
        {
          "id": "SendSlackMessage"
        }
      ],
      "resource": "vrn:vtex.promotions-alert:aws-us-east-1:kamila:master:/_v/promotions_alert",
      "condition": {
        "operation": "None",
        "conditions": [
          {
            "conditions": [
              "None"
            ],
            "operation": "None",
            "key": "skuId",
            "values": [
              "40.00"
            ]
          }
        ]
      }
    }
  ]
}

v50