Policy

Update policy

Changed on

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:

ProductCategoryResource
Promotions Policy EnginePoliciesCreate 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}

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/policy-engine/policies/{id}
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

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"
            ]
          }
        ]
      }
    }
  ]
}

Response

OK

Changes

  • f819dda515f1Revision changes
    • warning

      removed the request property //

    • warning

      removed the optional property /// from the response with the status

    • info

      api operation id Policy_Update was added

    • info

      added the new optional request property ///

    • info

      added the new optional request property

    • info

      added the optional property //// to the response with the status

  • 1a9c401a96f5Revision changes
    • breaking

      the //// request property type changed from no type to object