VTEX · Example Payload

Vtex Createclientprofile Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Createclientprofile 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": "CreateClientProfile",
  "method": "POST",
  "path": "/api/storage/profile-system/profiles",
  "summary": "VTex Create client profile",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "201",
      "contentType": "application/json",
      "example": {
        "id": "c2cbebba-214e-40b2-b68f-98f862e755d5",
        "meta": {
          "version": "27112371-a71b-45d6-b3bc-93436a3a0b4f",
          "author": "82a2b53d-39be-4f49-bb7c-8971b58cb7dc",
          "creationDate": "2022-01-05T15:41:37.5009471+00:00",
          "lastUpdateDate": "2022-01-05T15:41:37.5009471+00:00"
        },
        "document": {
          "firstName": "John",
          "lastName": "Doe",
          "email": "john.doe@example.com",
          "birthDate": "1925-11-17",
          "document": "12345678911",
          "documentType": "CPF",
          "{customField}": "{value}"
        }
      }
    }
  ]
}