VTEX · Example Payload

Vtex Put Apipolicy Enginepoliciesid Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Put Apipolicy Enginepoliciesid Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑
{
  "operationId": "put-apipolicy-enginepoliciesid",
  "method": "PUT",
  "path": "/api/policy-engine/policies/{id}",
  "summary": "VTex Update policy",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/octet-stream",
      "example": [
        {
          "id": "pa_test_001",
          "name": "TestAlarmBerenice",
          "description": "TesteMarcosPromotionsAlert",
          "statements": [
            {
              "effect": "Allow",
              "actions": [
                {
                  "id": "SendSlackMessage",
                  "metadata": {
                    "channel": "C01NJFF35R6",
                    "relatedUsers": [
                      "URUNDC2NB"
                    ],
                    "alertDescription": "Avoid selling products from Berenice with a discount greater than 40%."
                  }
                }
              ],
              "resource": "vrn:vtex.promotions-alert:aws-us-east-1:kamila:master:/_v/promotions_alert",
              "condition": {
                "conditions": [
                  {
                    "conditions": [],
                    "operation": "stringEquals",
                    "key": "brandId",
                    "values": [
                      "2000001"
                    ]
                  },
                  {
                    "conditions": [],
                    "operation": "numericGreaterThan",
                    "key": "discountPercentage",
                    "values": [
                      "40.00"
                    ]
                  }
                ],
                "operation": "and"
              }
            }
          ]
        }
      ]
    }
  ]
}

Work with this as data

Every example here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for examples

4 MCP tools reach this
  • find_examplesBrowse and filter every example in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This example
curl "https://apis.io/api/v1/examples/vtex-put-apipolicy-enginepoliciesid-example"
All examples
curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.