Prospects

Create prospect

Creates new prospect.

The id field returned by this request is the prospectId used to retrieve information on a specific prospect later.

Learn more about the Profile System and its other API endpoints.

⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plus, which is in closed beta phase, only available in select regions.

This feature is part of VTEX Shield. If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact Commercial Support. Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our contact form.

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:

Product	Category	Resource
Profile System	Documents	Get Item
Profile System	Documents	Save and Update Item
Profile System	Documents	Delete Item

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.

post/api/storage/profile-system/prospects

Headers

Content-Typestring required

Example:application/json

Type of the content being sent.

Acceptstring required

Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

emailstring

Prospect's email address.

firstNamestring

Prospect's first name.

lastNamestring

Prospect's last name.

documentstring

Prospect's document.

cellPhonestring

Prospect's cellphone number.

isPJboolean

Defines if a prospect is corporate (true) or not (false).

customerCodestring

Prospect's customer code.

Example request

{
  "availableAddresses": [
    {
      "disposable": true,
      "userId": "98478f6b-d025-4f35-a560-dd1ee7a6f26e",
      "addressName": "Home",
      "addressType": "residential",
      "postalCode": "32137",
      "city": "Palm Coast",
      "country": "USA",
      "street": "Fifth St.",
      "number": "9538",
      "complement": "Apartment 2B",
      "geoCoordinate": [
        "49.334934"
      ]
    }
  ],
  "paymentData": {
    "availableAccounts": [
      {
        "accountId": "D09F5E3F01054C959CFC4CB357961ADE",
        "paymentSystem": "2",
        "paymentSystemName": "Visa",
        "cardNumber": "************1111",
        "bin": "44443334",
        "availableAddresses": [
          "db267dcc53c14fb2b9a985532dd287bc"
        ],
        "expirationDate": "01/2032"
      }
    ],
    "availableTokens": [
      "12345"
    ],
    "transactions": [
      {
        "isActive": true,
        "transactionId": "418213DE29634837A63DD693A937A696",
        "merchantName": "luxstore",
        "payments": [
          {
            "id": "D3DEECAB3C6C4B9EAF8EF4C1FE062FF3",
            "paymentSystem": "6",
            "paymentSystemName": "Boleto Bancário",
            "value": 4450,
            "installments": 1,
            "referenceValue": 4450,
            "cardHolder": null,
            "cardNumber": null,
            "firstDigits": null,
            "lastDigits": null,
            "cvv2": null,
            "expireMonth": null,
            "expireYear": null,
            "url": "https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}",
            "giftCardId": null,
            "giftCardName": null,
            "giftCardCaption": null,
            "redemptionCode": null,
            "group": "bankInvoice",
            "tid": null,
            "dueDate": "2019-02-02",
            "connectorResponses": {}
          }
        ]
      }
    ],
    "giftCards": [
      "12345"
    ],
    "giftCardMessages": [
      "Message."
    ]
  },
  "contacts": [
    {
      "contactId": "0",
      "email": "jane@mail.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "phone": "12345678910",
      "document": "12345678910"
    }
  ],
  "invoiceSubject": {
    "invoiceSubjectId": "0",
    "email": "jane@mail.com",
    "firstName": "Jane",
    "lastName": "Doe",
    "phone": "12345678910"
  },
  "email": "jane@mail.com",
  "firstName": "Jane",
  "lastName": "Doe",
  "document": "5397eefef23741d4976ebdf772cc42e0",
  "cellPhone": "12345678910",
  "customerCode": "5397eefe-f237-41d4-976e-bdf772cc42e0"
}

Response

Created

idstring

ID of the prospect.

Example response

{
  "document": {
    "availableAddresses": [
      {
        "disposable": true,
        "userId": "98478f6b-d025-4f35-a560-dd1ee7a6f26e",
        "addressName": "Home",
        "addressType": "residential",
        "postalCode": "32137",
        "city": "Palm Coast",
        "country": "USA",
        "street": "Fifth St.",
        "number": "9538",
        "complement": "Apartment 2B",
        "geoCoordinate": [
          "49.334934"
        ]
      }
    ],
    "paymentData": {
      "availableAccounts": [
        {
          "accountId": "D09F5E3F01054C959CFC4CB357961ADE",
          "paymentSystem": "2",
          "paymentSystemName": "Visa",
          "cardNumber": "************1111",
          "bin": "44443334",
          "availableAddresses": [
            "db267dcc53c14fb2b9a985532dd287bc"
          ],
          "expirationDate": "01/2032"
        }
      ],
      "availableTokens": [
        "12345"
      ],
      "transactions": [
        {
          "isActive": true,
          "transactionId": "418213DE29634837A63DD693A937A696",
          "merchantName": "luxstore",
          "payments": [
            {
              "id": "D3DEECAB3C6C4B9EAF8EF4C1FE062FF3",
              "paymentSystem": "6",
              "paymentSystemName": "Boleto Bancário",
              "value": 4450,
              "installments": 1,
              "referenceValue": 4450,
              "cardHolder": null,
              "cardNumber": null,
              "firstDigits": null,
              "lastDigits": null,
              "cvv2": null,
              "expireMonth": null,
              "expireYear": null,
              "url": "https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}",
              "giftCardId": null,
              "giftCardName": null,
              "giftCardCaption": null,
              "redemptionCode": null,
              "group": "bankInvoice",
              "tid": null,
              "dueDate": "2019-02-02",
              "connectorResponses": {}
            }
          ]
        }
      ],
      "giftCards": [
        "12345"
      ],
      "giftCardMessages": [
        "Message."
      ]
    },
    "contacts": [
      {
        "contactId": "0",
        "email": "jane@mail.com",
        "firstName": "Jane",
        "lastName": "Doe",
        "phone": "12345678910",
        "document": "12345678910"
      }
    ],
    "invoiceSubject": {
      "invoiceSubjectId": "0",
      "email": "jane@mail.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "phone": "12345678910"
    },
    "email": "jane@mail.com",
    "firstName": "Jane",
    "lastName": "Doe",
    "document": "5397eefef23741d4976ebdf772cc42e0",
    "cellPhone": "12345678910",
    "customerCode": "5397eefe-f237-41d4-976e-bdf772cc42e0"
  }
}

Changes

Changed in 3 of the 50 revisions of this API.732

Nov 1, 20232ebc766ec8162See the full diff
- ▲
  the / request property type changed from string to array
  request-property-type-changed
- ▲
  the // response's property type changed from string to array for status
  response-property-type-changed
Nov 1, 20233a9d473a8e78418See the full diff
- ▲
  the // request property type changed from string to object
  request-property-type-changed
- ▲
  the / request property type changed from array to string
  request-property-type-changed
- ▲
  the /// response's property type changed from string to object for status
  response-property-type-changed
- ▲
  the // response's property type changed from array to string for status
  response-property-type-changed
- ○
  added the new optional request property ///
  new-optional-request-property
- ○
  added the new optional request property ///
  new-optional-request-property
- ○
  added the new optional request property ///
  new-optional-request-property
- ○
  added the new optional request property ///
  new-optional-request-property
- ○
  added the new optional request property ///
  new-optional-request-property
- ○
  added the new optional request property ///
  new-optional-request-property
- ○
  added the new optional request property ///
  new-optional-request-property
- ○
  added the new optional request property ///
  new-optional-request-property
- ○
  added the new optional request property ///
  new-optional-request-property
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
Oct 31, 2023c68a1fb04e5a114See the full diff
- ▲
  the request's body type changed from no type to object
  request-body-type-changed
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history