VTEX Schemas API

openapi: 3.2.0
info:
  title: Vtex Schemas API
  version: '1.0'
  contact: {}
  description: 'Operations tagged Schemas across 2 of this provider''s published API definitions: vtex-master-data-openapi-original.yml, vtex-profile-system-openapi-original.yml. Each path carries the servers of the definition it was published in.'
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: Schemas
paths:
  /api/dataentities/{dataEntityName}/schemas:
    get:
      tags:
      - Schemas
      summary: VTex Get schemas
      description: "Retrieves all existing [schemas](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) for a given data entity. \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| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\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: Getschemas
      parameters:
      - $ref: '#/components/parameters/dataEntityName'
      - $ref: '#/components/parameters/Content-Type'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                description: Array with existing schemas. In case there is only one existing schema, it will be an object instead, without the `name` property and the named `schema` object, following the same structure as the [Get schema by name](https://developers.vtex.com/docs/api-reference/master-data-api-v2#get-/api/dataentities/-dataEntityName-/schemas/-schemaName-?endpoint=get-/api/dataentities/-dataEntityName-/schemas/-schemaName-) endpoint response.
                items:
                  $ref: '#/components/schemas/GetSchemasResponse'
              example:
              - name: testschema
                schema:
                  properties:
                    name:
                      type: string
      deprecated: false
    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
  /api/dataentities/{dataEntityName}/schemas/{schemaName}:
    get:
      tags:
      - Schemas
      summary: VTex Get schema by name
      description: "Returns an existing [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) for a given data entity. \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| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\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: Getschemabyname
      parameters:
      - $ref: '#/components/parameters/dataEntityName'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/schemaName'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SaveschemabynameRequest'
              example:
                properties:
                  name:
                    type: string
      deprecated: false
    put:
      tags:
      - Schemas
      summary: VTex Save schema by name
      description: "Creates or edits a data entity schema. Learn more about [Master Data schemas](https://developers.vtex.com/vtex-rest-api/docs/master-data-schema-lifecycle).\n\n> Note that if you send a `schemaName` that does not exist for that data entity, this request will create it.\n\nThis request can also be used to [create or edit Master Data v2 triggers](https://developers.vtex.com/vtex-rest-api/docs/setting-up-triggers-in-master-data-v2).\n\n> Each Master Data v2 data entity can have up to 60 schemas. \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| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\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: Saveschemabyname
      parameters:
      - $ref: '#/components/parameters/dataEntityName'
      - $ref: '#/components/parameters/schemaName'
      requestBody:
        description: Request body for saving schema
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveschemabynameRequest'
            example:
              properties:
                name:
                  type: string
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                description: Response body object.
                properties:
                  Message:
                    type: string
                    description: Success message.
              example:
                Message: JSON Schema persisted successfully. Revalidation and indexing process running in background.
      deprecated: false
    delete:
      tags:
      - Schemas
      summary: VTex Delete schema by name
      description: "Deletes an existing [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) for a given data entity. \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| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\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: Deleteschemabyname
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/dataEntityName'
      - $ref: '#/components/parameters/schemaName'
      responses:
        '204':
          description: No Content
      deprecated: false
    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
  /api/storage/profile-system/schemas/profileSystem:
    get:
      tags:
      - Schemas
      summary: VTex Get full schema
      description: "Retrieves the full profile schema, including custom fields.\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."
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schema'
              example:
                title: Profile System Profile Schema
                description: Schema used for integration testing with Checkout
                type: object
                properties:
                  firstName:
                    type:
                    - string
                    - 'null'
                    sensitive: true
                    pii: true
                  lastName:
                    type:
                    - string
                    - 'null'
                    sensitive: true
                    pii: true
                  email:
                    type: string
                    sensitive: true
                    pii: true
                  corporateName:
                    type:
                    - string
                    - 'null'
                    sensitive: false
                    pii: false
                  fancyName:
                    type:
                    - string
                    - 'null'
                    sensitive: false
                    pii: false
                  document:
                    type:
                    - string
                    - 'null'
                    sensitive: true
                    pii: true
                  businessDocument:
                    type:
                    - string
                    - 'null'
                    sensitive: false
                    pii: false
                  documentType:
                    type:
                    - string
                    - 'null'
                    sensitive: false
                    pii: false
                  homePhone:
                    type:
                    - string
                    - 'null'
                    sensitive: true
                    pii: true
                  cellPhone:
                    type:
                    - string
                    - 'null'
                    sensitive: true
                    pii: true
                  businessPhone:
                    type:
                    - string
                    - 'null'
                    sensitive: false
                    pii: false
                  gender:
                    type:
                    - string
                    - 'null'
                    sensitive: true
                    pii: false
                  birthdate:
                    type:
                    - string
                    - 'null'
                    sensitive: true
                    pii: true
                  priceTable:
                    type: string
                    sensitive: false
                    pii: false
                  tags:
                    type:
                    - array
                    - 'null'
                    items:
                      type: string
                      maxLength: 50
                    sensitive: false
                    pii: false
                  customerCode:
                    type:
                    - string
                    - 'null'
                    sensitive: true
                    pii: true
                required:
                - email
                additionalProperties: true
                v-indexed:
                - email
                - document
                v-unique:
                - email
      deprecated: false
    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
  /api/storage/profile-system/schemas/profileSystem/custom:
    put:
      tags:
      - Schemas
      summary: VTex Create or delete custom fields
      description: "Creates or deletes custom fields in the profile schema. To create custom fields, include a request body. To delete all custom fields, pass an empty JSON. \n\n> Each account has one profile schema. Updating it with this request will substitute the previous version.\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: CreateOrUpdateProfileSchema
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties:
                type: object
                description: Object with information about the custom property.
                required:
                - type
                - sensitive
                - pii
                properties:
                  type:
                    type: array
                    description: Array with information about the type of the custom property.
                    items:
                      type: string
                      description: Information about the type of field (e.g. `string`) or if it is nullable (`null`).
                      example: string
                  sensitive:
                    type: boolean
                    description: Indicates whether the property is sensitive data. Set to `true` if `pii` is `true` and set to `false` if `pii` is `false`.
                    example: true
                  pii:
                    type: boolean
                    description: Indicates whether the property is Personal Identifiable Information (PII).
                    example: true
            example:
              customField1:
                type:
                - string
                - 'null'
                sensitive: true
                pii: true
              customField2:
                type:
                - string
                - 'null'
                sensitive: false
                pii: false
      responses:
        '201':
          description: Created
      deprecated: false
    get:
      tags:
      - Schemas
      summary: VTex Get custom fields
      description: "Retrieves all custom fields in the profile schema.\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."
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schema'
      deprecated: false
    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
components:
  parameters:
    dataEntityName:
      name: dataEntityName
      in: path
      required: true
      description: Name of the data entity.
      schema:
        type: string
        example: Newsletter
    schemaName:
      name: schemaName
      in: path
      description: Name of the schema.
      required: true
      style: simple
      schema:
        type: string
        example: '{{schema}}'
    Content-Type:
      name: Content-Type
      in: header
      description: Type of the content being sent.
      required: true
      style: simple
      schema:
        type: string
        example: application/json
    Accept:
      name: Accept
      in: header
      description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
      required: true
      style: simple
      schema:
        type: string
        example: application/json
  schemas:
    Properties:
      title: Properties
      required:
      - name
      type: object
      description: Object containing schema properties.
      properties:
        name:
          $ref: '#/components/schemas/Name'
    GetSchemasResponse:
      title: GetSchemasResponse
      required:
      - name
      - schema
      type: object
      description: Schema.
      properties:
        name:
          type: string
          description: Schema name.
        schema:
          type: object
          description: Object with schema properties.
          properties:
            properties:
              $ref: '#/components/schemas/Properties'
    SaveschemabynameRequest:
      title: SaveschemabynameRequest
      required:
      - properties
      type: object
      description: Schema.
      properties:
        properties:
          $ref: '#/components/schemas/Properties'
    Name:
      title: Name
      required:
      - type
      type: object
      description: Property name.
      properties:
        type:
          type: string
          description: Type of property.
          enum:
          - array
          - boolean
          - integer
          - number
          - object
          - string
          example: string
    schema:
      title: Schema
      type: object
      description: Schema information.
      required:
      - title
      - type
      - description
      - required
      - properties
      properties:
        title:
          type: string
          description: Schema title.
          example: Client profile schema.
        type:
          type: string
          description: Schema type.
          example: object
        description:
          type: string
          description: Schema's human readable description.
          example: This schema describes a b2c customer profile.
        required:
          type: array
          description: Schema required fields.
          items:
            type: string
            description: Key of a field that is required in the schema.
          example:
          - firstName
          - lastName
          - email
          - document
          - documentType
        properties:
          type: object
          description: 'Object describing each field in your desired schema. In this object, each property is a new object, describing the field according to: `type` (string); `sensitive` (boolean); `pii` (boolean) and `items.type` (if field is array).'
          properties:
            additionalProperties:
              type: object
              description: Schema of any given field described in the `properties` field.
              required:
              - type
              - sensitive
              - pii
              properties:
                type:
                  type: string
                  description: Schema property type.
                  example: string
                sensitive:
                  type: boolean
                  description: Indicates whether the property is sensitive data. Set to `true` if `pii` is `true` and set to `false` if `pii` is `false`.
                  example: true
                pii:
                  type: boolean
                  description: Indicates whether the property is Personal Identifiable Information (PII).
                  example: true
                items:
                  type: object
                  description: Object containing the type of the items if the field is an array. Typically, arrays will contain strings and will be used for fields such as `email`.
                  properties:
                    type:
                      type: string
                      description: Field type.
                      example: string
                  example:
                    type: string
        documentTTL:
          type: integer
          description: Document time to live, in days. After this many days from its creation or update, any document cerated from this schema will be deleted.
          example: 1825
        version:
          type: integer
          description: Schema version.
          example: 1
        v-indexed:
          type: array
          description: List of fields to be indexed.
          example:
          - email
          - document
          items:
            type: string
            description: Field to be indexed.
        v-unique:
          type: array
          description: List of fields that must be unique.
          example:
          - email
          - document
          items:
            type: string
            description: Field that must be unique.
  securitySchemes:
    appKey:
      type: apiKey
      in: header
      name: X-VTEX-API-AppKey
      description: Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).
    appToken:
      type: apiKey
      in: header
      name: X-VTEX-API-AppToken
      description: Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).
    VtexIdclientAutCookie:
      type: apiKey
      in: header
      name: VtexIdclientAutCookie
      description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'
x-refined-from:
- vtex-master-data-openapi-original.yml
- vtex-profile-system-openapi-original.yml