VTEX · Example Payload

Vtex Createorupdateprofileschema Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Createorupdateprofileschema 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": "CreateOrUpdateProfileSchema",
  "method": "PUT",
  "path": "/api/storage/profile-system/schemas/profileSystem/custom",
  "summary": "VTex Create or delete custom fields",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "customField1": {
          "type": [
            "string",
            "null"
          ],
          "sensitive": true,
          "pii": true
        },
        "customField2": {
          "type": [
            "string",
            "null"
          ],
          "sensitive": false,
          "pii": false
        }
      }
    }
  ],
  "responseExamples": []
}