find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
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 API

curl "https://apis.io/api/v1/apis/vtex-prospects-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

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

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: VTex Profile System - PII data architecture Prospects API
  description: '>⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.

    >

    > This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/).


    The **Profile System** is VTEX''s single source of truth regarding shoppers'' profile data for stores using the [PII data architecture](https://developers.vtex.com/docs/guides/pii-data-architecture-specifications) from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus). Other modules, such as **Checkout** and **Order Management**, can request data from the **Profile System** when necessary. Learn more at the [Profile System](https://developers.vtex.com/docs/guides/profile-system) guide.


    >⚠️ Data stored in the Profile System is not related to documents saved in [Master Data v1](https://developers.vtex.com/docs/api-reference/masterdata-api) or [Master Data v2](https://developers.vtex.com/docs/api-reference/master-data-api-v2). The API endpoints and features described in this article only apply to documents registered in the new Profile System designed to handle PII data architecture.


    ## Index


    ### Profiles


    - `POST` [Create client profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles)

    - `GET` [Get profile](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-)

    - `PATCH` [Update client profile](https://developers.vtex.com/docs/api-reference/profile-system#patch-/api/storage/profile-system/profiles/-profileId-)

    - `DELETE` [Delete client profile](https://developers.vtex.com/docs/api-reference/profile-system#delete-/api/storage/profile-system/profiles/-profileId-)

    - `GET` [Get unmasked profile](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/unmask)

    - `GET` [Get profile by version](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/versions/-profileVersionId-)

    - `GET` [Get unmasked profile by version](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/versions/-profileVersionId-/unmask)


    ### Addresses


    - `POST` [Create client address](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles/-profileId-/addresses)

    - `GET` [Get client addresses](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/addresses)

    - `GET` [Get unmasked client addresses](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/addresses/unmask)

    - `GET` [Get address](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-)

    - `PATCH` [Update client address](https://developers.vtex.com/docs/api-reference/profile-system#patch-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-)

    - `DELETE` [Delete address](https://developers.vtex.com/docs/api-reference/profile-system#delete-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-)

    - `GET` [Get unmasked address](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-/unmask)

    - `GET` [Get address by version](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-/versions/-addressVersionId-)

    - `GET` [Get unmasked address by version](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-/versions/-addressVersionId-/unmask)


    ### Prospects


    - `POST` [Create prospect](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/prospects)

    - `GET` [Get prospect](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/prospects/-prospectId-)

    - `PATCH` [Update prospect](https://developers.vtex.com/docs/api-reference/profile-system#patch-/api/storage/profile-system/prospects/-prospectId-)

    - `DELETE` [Delete prospect](https://developers.vtex.com/docs/api-reference/profile-system#delete-/api/storage/profile-system/prospects/-prospectId-)

    - `GET` [Get unmasked prospect](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/prospects/-prospectId-/unmask)


    ### Purchase information


    - `POST` [Create purchase information](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles/-profileId-/purchase-info)

    - `GET` [Get purchase information](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/purchase-info)

    - `PATCH` [Update purchase information](https://developers.vtex.com/docs/api-reference/profile-system#patch-/api/storage/profile-system/profiles/-profileId-/purchase-info)

    - `DELETE` [Delete purchase information](https://developers.vtex.com/docs/api-reference/profile-system#delete-/api/storage/profile-system/profiles/-profileId-/purchase-info)

    - `GET` [Get unmasked profile information](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/purchase-info/unmask)'
  contact: {}
  version: '1.0'
servers:
- url: https://{accountName}.{environment}.com.br
  description: VTEX server URL.
  variables:
    accountName:
      description: Name of the VTEX account. Used as part of the URL.
      default: apiexamples
    environment:
      description: Environment to use. Used as part of the URL.
      enum:
      - vtexcommercestable
      default: vtexcommercestable
security:
- appKey: []
  appToken: []
- VtexIdclientAutCookie: []
tags:
- name: Prospects
paths:
  /api/storage/profile-system/prospects:
    post:
      tags:
      - Prospects
      summary: VTex Create prospect
      description: '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](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.


        >⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.

        >

        > This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/).


        ## Permissions


        Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).


        >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.'
      operationId: CreateProspect
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Prospect'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnmaskedProspectResponse'
              example:
                id: 98478f6b-d025-4f35-a560-dd1ee7a6f26e
                document:
                  availableAddresses:
                  - disposable: true
                    userId: 98478f6b-d025-4f35-a560-dd1ee7a6f26e
                    addressName: customerAddressId
                    addressType: residential
                    postalCode: '32137'
                    city: Palm Coast
                    country: USA
                    street: Fifth St.
                    number: '9538'
                    complement: ''
                    receiverName: Jane Doe
                    geoCoordinate: []
                  paymentData:
                    availableAccounts: []
                    availableTokens: []
                    transactions: null
                    giftCards: []
                    giftCardMessages: []
                    numberOfPaymentErrors: 0
                    numberOfDeniedTransactions: 0
                    lastDeniedTransaction: null
                  contacts:
                  - contactId: '0'
                    email: ''
                    firstName: Jane
                    lastName: Doe
                    phone: ''
                    document: ''
                    documentType: ''
                  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'
                  isPJ: false
                  customerCode: 5397eefe-f237-41d4-976e-bdf772cc42e0
                meta:
                  version: af9117e9-4169-46ee-ab4b-d4b17b881488
                  author: d6d8269f-e7cc-4e4b-8b89-3b46a1407937
                  creationDate: '2023-10-25T13:59:52.7633627+00:00'
                  lastUpdateDate: '2023-10-25T14:02:45.7277154+00:00'
                  expirationDate: null
      deprecated: false
    get:
      tags:
      - Prospects
      summary: VTex Get prospects
      description: "Retrieves information of all prospects.\n\n> For security and privacy reasons, this request returns masked prospect data. For unmasked information, see [Get unmasked prospects](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/prospects/unmask).\n\nLearn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.\n\n>⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.\n>\n> This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/). \n\n## Permissions\n\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\n\n| **Product** | **Category** | **Resource** |\n| --------------- | ----------------- | ----------------- |\n| Profile System | Documents | **Get Item** |\n| Profile System | Documents | **Save and Update Item** |\n| Profile System | Documents | **Delete Item** |\n\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).\n\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: GetProspects
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                description: List of masked prospects.
                items:
                  $ref: '#/components/schemas/MaskedProspectResponse'
              example:
              - id: 98478f6b-d025-4f35-a560-dd1ee7a6f26e
                document:
                  availableAddresses:
                  - disposable: true
                    userId: 98478f6b-d025-4f35-a560-dd1ee7a6f26e
                    addressName: customerAddressId
                    addressType: residential
                    postalCode: 3*****
                    city: P*****
                    country: USA
                    street: F*****
                    number: 9****
                    complement: ''
                    receiverName: J*** D**
                    geoCoordinate: []
                  paymentData:
                    availableAccounts: []
                    availableTokens: []
                    transactions: null
                    giftCards: []
                    giftCardMessages: []
                    numberOfPaymentErrors: 0
                    numberOfDeniedTransactions: 0
                    lastDeniedTransaction: null
                  contacts:
                  - contactId: '0'
                    email: ''
                    firstName: J***
                    lastName: D**
                    phone: ''
                    document: ''
                    documentType: ''
                  invoiceSubject:
                    invoiceSubjectId: '0'
                    email: j***@m***.c**
                    firstName: J***
                    lastName: D**
                    phone: 1**********
                  email: j***@m***.c**
                  firstName: J***
                  lastName: D**
                  document: 1**********
                  cellPhone: 1**********
                  isPJ: false
                  customerCode: 5397eefe-f237-41d4-976e-bdf772cc42e0
                meta:
                  version: af9117e9-4169-46ee-ab4b-d4b17b881488
                  author: d6d8269f-e7cc-4e4b-8b89-3b46a1407937
                  creationDate: '2023-10-25T13:59:52.7633627+00:00'
                  lastUpdateDate: '2023-10-25T14:02:45.7277154+00:00'
                  expirationDate: null
      deprecated: false
  /api/storage/profile-system/prospects/unmask:
    get:
      tags:
      - Prospects
      summary: VTex Get unmasked prospects
      description: "Retrieves unmasked information of all prospects.\n\nLearn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.\n\n>⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.\n>\n> This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/). \n\n## Permissions\n\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\n\n| **Product** | **Category** | **Resource** |\n| --------------- | ----------------- | ----------------- |\n| Profile System | Documents | **Get Item** |\n| Profile System | Documents | **Save and Update Item** |\n| Profile System | Documents | **Delete Item** |\n\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).\n\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: GetUnmaskedProspects
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                description: List of prospects.
                items:
                  $ref: '#/components/schemas/UnmaskedProspectResponse'
              example:
              - id: 98478f6b-d025-4f35-a560-dd1ee7a6f26e
                document:
                  availableAddresses:
                  - disposable: true
                    userId: 98478f6b-d025-4f35-a560-dd1ee7a6f26e
                    addressName: customerAddressId
                    addressType: residential
                    postalCode: '32137'
                    city: Palm Coast
                    country: USA
                    street: Fifth St.
                    number: '9538'
                    complement: ''
                    receiverName: Jane Doe
                    geoCoordinate: []
                  paymentData:
                    availableAccounts: []
                    availableTokens: []
                    transactions: null
                    giftCards: []
                    giftCardMessages: []
                    numberOfPaymentErrors: 0
                    numberOfDeniedTransactions: 0
                    lastDeniedTransaction: null
                  contacts:
                  - contactId: '0'
                    email: ''
                    firstName: Jane
                    lastName: Doe
                    phone: ''
                    document: ''
                    documentType: ''
                  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'
                  isPJ: false
                  customerCode: 5397eefe-f237-41d4-976e-bdf772cc42e0
                meta:
                  version: af9117e9-4169-46ee-ab4b-d4b17b881488
                  author: d6d8269f-e7cc-4e4b-8b89-3b46a1407937
                  creationDate: '2023-10-25T13:59:52.7633627+00:00'
                  lastUpdateDate: '2023-10-25T14:02:45.7277154+00:00'
                  expirationDate: null
      deprecated: false
  /api/storage/profile-system/prospects/{prospectId}:
    get:
      tags:
      - Prospects
      summary: VTex Get prospect
      description: 'Retrieves the information of a specific prospect, by its `prospectId`.


        > For security and privacy reasons, this request returns masked prospect data. For unmasked information, see [Get unmasked prospect](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/prospects/-prospectId-/unmask).


        Learn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.


        >⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.

        >

        > This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/).


        ## Permissions


        Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).


        >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.'
      operationId: GetProspect
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/prospectId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaskedProspectResponse'
              example:
                id: 98478f6b-d025-4f35-a560-dd1ee7a6f26e
                document:
                  availableAddresses:
                  - disposable: true
                    userId: 98478f6b-d025-4f35-a560-dd1ee7a6f26e
                    addressName: customerAddressId
                    addressType: residential
                    postalCode: 3*****
                    city: P*****
                    country: USA
                    street: F*****
                    number: 9****
                    complement: ''
                    receiverName: J*** D**
                    geoCoordinate: []
                  paymentData:
                    availableAccounts: []
                    availableTokens: []
                    transactions: null
                    giftCards: []
                    giftCardMessages: []
                    numberOfPaymentErrors: 0
                    numberOfDeniedTransactions: 0
                    lastDeniedTransaction: null
                  contacts:
                  - contactId: '0'
                    email: ''
                    firstName: J***
                    lastName: D**
                    phone: ''
                    document: ''
                    documentType: ''
                  invoiceSubject:
                    invoiceSubjectId: '0'
                    email: j***@m***.c**
                    firstName: J***
                    lastName: D**
                    phone: 1**********
                  email: j***@m***.c**
                  firstName: J***
                  lastName: D**
                  document: 1**********
                  cellPhone: 1**********
                  isPJ: false
                  customerCode: 5397eefe-f237-41d4-976e-bdf772cc42e0
                meta:
                  version: af9117e9-4169-46ee-ab4b-d4b17b881488
                  author: d6d8269f-e7cc-4e4b-8b89-3b46a1407937
                  creationDate: '2023-10-25T13:59:52.7633627+00:00'
                  lastUpdateDate: '2023-10-25T14:02:45.7277154+00:00'
                  expirationDate: null
      deprecated: false
    patch:
      tags:
      - Prospects
      summary: VTex Update prospect
      description: 'Updates one or more fields of an existing prospect.


        Learn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.


        >⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.

        >

        > This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/).


        ## Permissions


        Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).


        >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.'
      operationId: UpdateProspect
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/prospectId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Prospect'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnmaskedProspectResponse'
              example:
                id: c2cbebba-214e-40b2-b68f-98f862e755d5
                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:
                    - string
                  paymentData:
                    availableAccounts:
                    - accountId: D09F5E3F01054C959CFC4CB357961ADE
                      paymentSystem: '2'
                      paymentSystemName: Visa
                      cardNumber: '************1111'
                      bin: '44443334'
                      availableAddresses:
                      - db267dcc53c14fb2b9a985532dd287bc
                      expirationDate: 01/2032
                      isExpired: false
                      accountStatus: null
                    availableTokens:
                    - '12345'
                    transactions:
                    - isActive: true
                      transactionId: 418213DE29634837A63DD693A937A696
                      merchantName: luxstore
                      payments:
                      - id: D3DEECAB3C6C4B9EAF8EF4C1FE062FF3
                        paymentSystem: '6'
                        paymentSystemName: Boleto Bancário
             

# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/openapi/vtex-prospects-api-openapi.yml