Create new document

Creates a new document with an ID automatically generated by VTEX, corresponding to a new or existing data entity. If an unexisting dataEntityName is informed in the path, this endpoint will create the data entity as well as the new document. For example, you can create a new customer profile or address.

ℹ️ You can use this request to create documents for any data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. However you should be aware of the fields allowed or required for each document you wish to create.

To create a document with a custom ID, refer to the Create document with custom ID endpoint.

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:

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.