> ## Documentation Index
> Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Start an export

> Inicia a exportação de dados de CRM para o portal conforme especificado no corpo da solicitação

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/legacy/v3/crm-exports-v3.json POST /crm/v3/exports/export/async
openapi: 3.0.1
info:
  title: CRM Exports
  description: Basepom for all HubSpot Projects
  version: v3
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-related-documentation:
    - name: Export CRM Guide
      url: https://developers.hubspot.com/docs/guides/api/crm/exports
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Advanced
  - name: Basic
paths:
  /crm/v3/exports/export/async:
    post:
      tags:
        - Advanced
      summary: Comece uma exportação
      description: >-
        Inicia a exportação de dados de CRM para o portal conforme especificado
        no corpo da solicitação
      operationId: post-/crm/v3/exports/export/async_start
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicExportRequest'
        required: true
      responses:
        '202':
          description: accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskLocator'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - crm.export
components:
  schemas:
    PublicExportRequest:
      properties: {}
      oneOf:
        - $ref: '#/components/schemas/PublicExportViewRequest'
        - $ref: '#/components/schemas/PublicExportListRequest'
    TaskLocator:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          description: O ID exclusivo da exportação.
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um objeto contendo links relevantes relacionados ao processo de
            exportação.
    PublicExportViewRequest:
      required:
        - associatedObjectType
        - exportInternalValuesOptions
        - exportName
        - exportType
        - format
        - includeLabeledAssociations
        - includePrimaryDisplayPropertyForAssociatedObjects
        - language
        - objectProperties
        - objectType
        - overrideAssociatedObjectsPerDefinitionPerRowLimit
      type: object
      properties:
        associatedObjectType:
          type: array
          items:
            type: string
        exportInternalValuesOptions:
          type: array
          items:
            type: string
            enum:
              - NAMES
              - VALUES
        exportName:
          type: string
        exportType:
          type: string
          default: VIEW
          enum:
            - VIEW
        format:
          type: string
          enum:
            - CSV
            - XLS
            - XLSX
        includeLabeledAssociations:
          type: boolean
        includePrimaryDisplayPropertyForAssociatedObjects:
          type: boolean
        language:
          type: string
          enum:
            - AF_ZA
            - AR_EG
            - BG
            - BN
            - CA_ES
            - CS
            - DA_DK
            - DE
            - EL_GR
            - EN
            - EN_GB
            - ES
            - ES_MX
            - ET_EE
            - FI
            - FR
            - FR_CA
            - HE_IL
            - HI_IN
            - HR
            - HU
            - ID
            - IT
            - JA
            - KO_KR
            - LT_LT
            - MS
            - NL
            - 'NO'
            - PL
            - PT_BR
            - PT_PT
            - RO
            - RU
            - SK_SK
            - SL
            - SV
            - TH
            - TL
            - TR
            - UK
            - VI_VN
            - ZH_CN
            - ZH_HK
            - ZH_TW
        objectProperties:
          type: array
          items:
            type: string
        objectType:
          type: string
        overrideAssociatedObjectsPerDefinitionPerRowLimit:
          type: boolean
        publicCrmSearchRequest:
          $ref: '#/components/schemas/PublicCrmSearchRequest'
      x-hubspot-sub-type-impl: true
    PublicExportListRequest:
      required:
        - associatedObjectType
        - exportInternalValuesOptions
        - exportName
        - exportType
        - format
        - includeLabeledAssociations
        - includePrimaryDisplayPropertyForAssociatedObjects
        - language
        - listId
        - objectProperties
        - objectType
        - overrideAssociatedObjectsPerDefinitionPerRowLimit
      type: object
      properties:
        associatedObjectType:
          type: array
          items:
            type: string
        exportInternalValuesOptions:
          type: array
          items:
            type: string
            enum:
              - NAMES
              - VALUES
        exportName:
          type: string
        exportType:
          type: string
          default: LIST
          enum:
            - LIST
        format:
          type: string
          enum:
            - CSV
            - XLS
            - XLSX
        includeLabeledAssociations:
          type: boolean
        includePrimaryDisplayPropertyForAssociatedObjects:
          type: boolean
        language:
          type: string
          enum:
            - AF_ZA
            - AR_EG
            - BG
            - BN
            - CA_ES
            - CS
            - DA_DK
            - DE
            - EL_GR
            - EN
            - EN_GB
            - ES
            - ES_MX
            - ET_EE
            - FI
            - FR
            - FR_CA
            - HE_IL
            - HI_IN
            - HR
            - HU
            - ID
            - IT
            - JA
            - KO_KR
            - LT_LT
            - MS
            - NL
            - 'NO'
            - PL
            - PT_BR
            - PT_PT
            - RO
            - RU
            - SK_SK
            - SL
            - SV
            - TH
            - TL
            - TR
            - UK
            - VI_VN
            - ZH_CN
            - ZH_HK
            - ZH_TW
        listId:
          type: string
        objectProperties:
          type: array
          items:
            type: string
        objectType:
          type: string
        overrideAssociatedObjectsPerDefinitionPerRowLimit:
          type: boolean
      x-hubspot-sub-type-impl: true
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: A categoria de erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Um identificador exclusivo para a solicitação. Inclua este valor em
            relatórios de erro ou tickets de suporte
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: mais informações sobre o erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa de nomes de links para URIs associados que contêm
            documentação sobre o erro ou as etapas de correção recomendadas
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa uma resposta de erro retornada pela API quando uma operação
        falha. Este componente é usado em vários endpoints para fornecer
        informações detalhadas sobre o erro encontrado.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    PublicCrmSearchRequest:
      required:
        - filterGroups
        - filters
        - sorts
      type: object
      properties:
        filterGroups:
          type: array
          items:
            $ref: '#/components/schemas/FilterGroup'
        filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
        query:
          type: string
          description: >-
            A string de consulta de pesquisa usada para filtrar registros do
            CRM.
        sorts:
          type: array
          description: Define a ordem em que os registros do CRM devem ser retornados.
          items:
            type: string
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: O código de status associado ao detalhe do erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: O nome do campo ou parâmetro no qual o erro foi encontrado.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa informações detalhadas sobre um erro ocorrido na API. Este
        componente é usado para fornecer contexto e detalhes adicionais sobre os
        erros, geralmente como parte de uma resposta de erro.
    FilterGroup:
      required:
        - filters
      type: object
      properties:
        filters:
          type: array
          description: >-
            Uma lista de critérios de filtro individuais que são aplicados
            juntos como um grupo. Cada filtro especifica uma condição que os
            registros devem atender para serem incluídos nos resultados.
          items:
            $ref: '#/components/schemas/Filter'
      description: >-
        Representa um grupo de filtros usados para consultar dados no HubSpot.
        Este componente é usado para definir critérios de filtragem de registros
        em vários endpoints de API.
    Filter:
      required:
        - operator
        - propertyName
      type: object
      properties:
        highValue:
          type: string
          description: O valor de limite superior ao usar filtros baseados em intervalo.
        operator:
          type: string
          description: O operador de comparação usado no filtro, como "EQ" ou "GT".
          enum:
            - BETWEEN
            - CONTAINS_TOKEN
            - EQ
            - GT
            - GTE
            - HAS_PROPERTY
            - IN
            - LT
            - LTE
            - NEQ
            - NOT_CONTAINS_TOKEN
            - NOT_HAS_PROPERTY
            - NOT_IN
        propertyName:
          type: string
          description: O nome da propriedade à qual o filtro será aplicado.
        value:
          type: string
          description: O valor a ser comparado com a propriedade.
        values:
          type: array
          description: Os valores a serem comparados com a propriedade.
          items:
            type: string
      description: >-
        Define uma única condição para pesquisar objetos do CRM, especificando a
        propriedade a ser filtrada, o operador a ser usado (como igual a, maior
        que ou contém) e o(s) valor(es) a ser(em) comparado(s). 
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            crm.export: ''

````