v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-142616180.5 KB

Customer profiles

Update customer profile

Partially updates a customer profile.

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
Dynamic Storage	Dynamic storage generic resources	Insert or update document (not remove)
Dynamic Storage	Dynamic storage generic resources	Full access to all documents
Dynamic Storage	Dynamic storage generic resources	Master Data administrator

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.

patch/api/dataentities/CL/documents/{id}

Path parameters

idstring required

Example:SP-b818cbda-e489-11e6-94f4-0ac138d2d42e

Unique identifier of the document.

Query parameters

_schemastring

Example:schema

Name of the schema that the document complies with. This field is required when using _where or _fields query parameters.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

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

Request body

emailstring nullable

Client email address. This field is required for B2B Buyer Portal.

firstNamestring nullable

Client first name. This field is required for B2B Buyer Portal.

lastNamestring nullable

Client last name. This field is required for B2B Buyer Portal.

phonestring nullable

Client telephone number.

documentTypestring nullable

Client document type. This field is required for B2B Buyer Portal.

documentstring nullable

Client document. This field is required for B2B Buyer Portal.

isCorporateboolean nullable

Indicates whether client is corporate. For the B2B Buyer Portal, this field is required and always true.

isNewsletterOptInboolean nullable

Indicates whether client otped to receive the store newsletter (true) or not (false).

localeDefaultstring nullable

Default locale, used to set store language and currency, for example.

corporateDocumentstring

The business document of the contract. This field is recommended for B2B Buyer Portal.

homePhonestring

The home phone number of the contract. This field is recommended for B2B Buyer Portal.

cellPhonestring

The cell phone number of the contract. This field is recommended for B2B Buyer Portal.

corporateNamestring

The corporate name of the contract. This field is required for B2B Buyer Portal.

tradeNamestring

The trade name ("doing business as") of the contract. This field is recommended for B2B Buyer Portal.

stateRegistrationstring

The state registration of the contract. This field is recommended for B2B Buyer Portal.

isFreeStateRegistrationboolean

Indicates if the state registration is free. This field is recommended for B2B Buyer Portal.

priceTablesstring

Price tables associated with the contract, separated by commas. This field is recommended for B2B Buyer Portal.

Example request

{
  "email": "clark.kent@examplemail.com",
  "firstName": "Clark",
  "lastName": "Kent",
  "phone": "+12025550195",
  "documentType": "CPF",
  "document": "12345678900",
  "localeDefault": "en-US"
}

Response

Idstring required

ID of the document that was created or updated.

Hrefstring required

Document reference URL.