VTEX · Example Payload

Vtex Saveschemabyname Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Saveschemabyname 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": "Saveschemabyname",
  "method": "PUT",
  "path": "/api/dataentities/{dataEntityName}/schemas/{schemaName}",
  "summary": "VTex Save schema by name",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "properties": {
          "name": {
            "type": "string"
          }
        }
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Message": "JSON Schema persisted successfully. Revalidation and indexing process running in background."
      }
    }
  ]
}