> ## 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.

# Create or update a batch of deals by unique property values

> Crie ou atualize registros identificados por um valor de propriedade exclusivo conforme especificado pelo parâmetro de consulta "idProperty". Esse parâmetro de consulta refere-se a uma propriedade cujos valores são exclusivos para o objeto.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/legacy/v3/crm-deals-v3.json POST /crm/v3/objects/0-3/batch/upsert
openapi: 3.0.1
info:
  title: Negócios
  description: >-
    CRM objects such as companies, contacts, deals, line items, products,
    tickets, and quotes are standard objects in HubSpot’s CRM. These core
    building blocks support custom properties, store critical information, and
    play a central role in the HubSpot application.


    ## Supported Object Types


    This API provides access to collections of CRM objects, which return a map
    of property names to values. Each object type has its own set of default
    properties, which can be found by exploring the [CRM Object Properties
    API](https://developers.hubspot.com/docs/methods/crm-properties/crm-properties-overview).


    |Object Type |Properties returned by default |

    |--|--|

    | `companies` | `name`, `domain` |

    | `contacts` | `firstname`, `lastname`, `email` |

    | `deals` | `dealname`, `amount`, `closedate`, `pipeline`, `dealstage` |

    | `products` | `name`, `description`, `price` |

    | `tickets` | `content`, `hs_pipeline`, `hs_pipeline_stage`,
    `hs_ticket_category`, `hs_ticket_priority`, `subject` |


    Find a list of all properties for an object type using the [CRM Object
    Properties](https://developers.hubspot.com/docs/methods/crm-properties/get-properties)
    API. e.g. `GET https://api.hubapi.com/properties/v2/companies/properties`.
    Change the properties returned in the response using the `properties` array
    in the request body.
  version: v3
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-api-use-case: >-
    Quando um representante de vendas começa a trabalhar com um possível
    cliente, crie um registro de negócio para acompanhar o processo de
    negociação. Quando o cliente fizer a compra, você pode atualizar o negócio
    para uma fase de negócio fechado.
  x-hubspot-related-documentation:
    - name: Deals Guide
      url: https://developers.hubspot.com/docs/guides/api/crm/objects/deals
  x-hubspot-introduction: >-
    Use a API de negócios para criar e gerenciar registros de CRM que
    representam transações com contatos e/ou empresas. Os negócios passam pelas
    fases do pipeline para refletir se a transação foi concluída, está ativa ou
    foi perdida.
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
  - name: Batch
  - name: Search
paths:
  /crm/v3/objects/0-3/batch/upsert:
    post:
      tags:
        - Batch
      summary: >-
        Criar ou atualizar um lote de negócios por valores de propriedades
        exclusivas
      description: >-
        Crie ou atualize registros identificados por um valor de propriedade
        exclusivo conforme especificado pelo parâmetro de consulta "idProperty".
        Esse parâmetro de consulta refere-se a uma propriedade cujos valores são
        exclusivos para o objeto.
      operationId: post-/crm/v3/objects/0-3/batch/upsert_upsert
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/BatchInputSimplePublicObjectBatchInputUpsert
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchResponseSimplePublicUpsertObject'
        '207':
          description: multiple statuses
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BatchResponseSimplePublicUpsertObjectWithErrors
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security: []
components:
  schemas:
    BatchInputSimplePublicObjectBatchInputUpsert:
      required:
        - inputs
      type: object
      properties:
        inputs:
          type: array
          description: >-
            Uma matriz de objetos públicos simples a serem inseridos ou
            atualizados. Cada objeto na matriz contém os dados necessários para
            criar ou atualizar um registro no HubSpot.
          items:
            $ref: '#/components/schemas/SimplePublicObjectBatchInputUpsert'
      description: >-
        Representa uma operação de entrada em lote para fazer upsert de objetos
        públicos simples no HubSpot. Este componente é usado para processar
        várias operações de upsert em uma única solicitação, melhorando a
        eficiência e o desempenho.
    BatchResponseSimplePublicUpsertObject:
      required:
        - completedAt
        - results
        - startedAt
        - status
      type: object
      properties:
        completedAt:
          type: string
          description: >-
            A data e hora em que o processo em lote foi concluído, no formato
            ISO 8601.
          format: date-time
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um objeto contendo links relevantes relacionados à solicitação em
            lote.
        requestedAt:
          type: string
          description: >-
            A data e hora em que o processo em lote foi iniciado, no formato ISO
            8601.
          format: date-time
        results:
          type: array
          description: >-
            Uma matriz de itens SimplePublicUpsertObject representando os
            resultados da operação de upsert em lote.
          items:
            $ref: '#/components/schemas/SimplePublicUpsertObject'
        startedAt:
          type: string
          description: >-
            A data e hora em que o processamento em lote começou a ser
            executado, no formato ISO 8601.
          format: date-time
        status:
          type: string
          description: >-
            O status da solicitação de processamento em lote. O valor esperado é
            "CONCLUÍDO".
          enum:
            - CANCELED
            - COMPLETE
            - PENDING
            - PROCESSING
      description: >-
        Representa o resultado de uma operação de upsert em lote, incluindo o
        status da operação, carimbos de data/hora e uma lista de objetos criados
        ou atualizados com sucesso.
    BatchResponseSimplePublicUpsertObjectWithErrors:
      required:
        - completedAt
        - results
        - startedAt
        - status
      type: object
      properties:
        completedAt:
          type: string
          description: >-
            A data e hora em que o processo em lote foi concluído, no formato
            ISO 8601.
          format: date-time
        errors:
          type: array
          items:
            $ref: '#/components/schemas/StandardError'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um objeto contendo links relevantes relacionados à solicitação em
            lote.
        numErrors:
          type: integer
          description: O número de erros encontrados durante o processamento em lote.
          format: int32
        requestedAt:
          type: string
          description: >-
            A data e hora em que o processo em lote foi iniciado, no formato ISO
            8601.
          format: date-time
        results:
          type: array
          items:
            $ref: '#/components/schemas/SimplePublicUpsertObject'
        startedAt:
          type: string
          description: >-
            A data e hora em que o processamento em lote começou a ser
            executado, no formato ISO 8601.
          format: date-time
        status:
          type: string
          description: >-
            O status da solicitação de processamento em lote. Pode ser:
            "PENDENTE", "PROCESSANDO", "CANCELADO" ou "CONCLUÍDO"
          enum:
            - CANCELED
            - COMPLETE
            - PENDING
            - PROCESSING
      description: >-
        Represents the response from a batch upsert operation, including the
        status, timestamps, successfully processed objects, and any errors that
        occurred during processing.
    SimplePublicObjectBatchInputUpsert:
      required:
        - id
        - properties
      type: object
      properties:
        id:
          type: string
          description: O ID exclusivo do objeto.
        idProperty:
          type: string
          description: >-
            O nome de uma propriedade cujos valores são exclusivos para este
            objeto
        objectWriteTraceId:
          type: string
          description: Um identificador para rastrear a solicitação de criação.
        properties:
          type: object
          additionalProperties:
            type: string
          description: Pares de chave-valor que representam as propriedades do objeto.
      description: >-
        Representa um objeto usado em operações de upsert em lote, contendo o
        identificador exclusivo de um objeto, suas propriedades e,
        opcionalmente, o nome da propriedade exclusiva e um ID de rastreamento
        de gravação.
    SimplePublicUpsertObject:
      required:
        - archived
        - createdAt
        - id
        - new
        - properties
        - updatedAt
      type: object
      properties:
        archived:
          type: boolean
          description: Se o objeto está arquivado ou não.
        archivedAt:
          type: string
          description: A data e hora em que o objeto foi arquivado, no formato ISO 8601.
          format: date-time
        createdAt:
          type: string
          description: A data e hora em que o objeto foi criado, no formato ISO 8601.
          format: date-time
        id:
          type: string
          description: O ID exclusivo do objeto.
        new:
          type: boolean
          description: Se o objeto foi criado.
        objectWriteTraceId:
          type: string
          description: >-
            Um identificador usado para rastrear a solicitação de criação ou
            atualização do objeto.
        properties:
          type: object
          additionalProperties:
            type: string
          description: Pares de chave-valor que representam as propriedades do objeto.
        propertiesWithHistory:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/ValueWithTimestamp'
          description: >-
            Pares de chave-valor que representam as propriedades do objeto junto
            com seu histórico.
        updatedAt:
          type: string
          description: >-
            A data e hora em que o objeto foi atualizado pela última vez, no
            formato ISO 8601.
          format: date-time
        url:
          type: string
          description: O URL associado ao objeto.
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/PublicObjectWarning'
      description: Representa um objeto do CRM que foi criado ou atualizado (upserted)
    StandardError:
      required:
        - category
        - context
        - errors
        - links
        - message
        - status
      type: object
      properties:
        category:
          type: string
          description: A categoria principal do erro.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Informações adicionais específicas do contexto relacionadas ao erro.
        errors:
          type: array
          description: Os objetos de erro detalhados.
          items:
            $ref: '#/components/schemas/ErrorDetail'
        id:
          type: string
          description: Um ID exclusivo para a instância de erro.
        links:
          type: object
          additionalProperties:
            type: string
          description: URLs com links para documentação ou recursos associados ao erro.
        message:
          type: string
          description: >-
            Uma string legível que descreve o erro e possíveis etapas de
            correção.
        status:
          type: string
          description: O código de status HTTP associado ao erro.
        subCategory:
          type: object
          properties: {}
          description: >-
            Uma categoria de erro mais específica dentro de cada categoria
            principal.
      description: >-
        Representa uma resposta de erro padrão na API do HubSpot, fornecendo
        informações detalhadas sobre um erro ocorrido durante uma solicitação de
        API.
    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
    ValueWithTimestamp:
      required:
        - sourceType
        - timestamp
        - value
      type: object
      properties:
        sourceId:
          type: string
          description: O ID exclusivo da propriedade.
        sourceLabel:
          type: string
          description: Um rótulo legível por humanos.
        sourceType:
          type: string
          description: O tipo de propriedade.
        timestamp:
          type: string
          description: >-
            A data e hora em que a propriedade foi atualizada, no formato ISO
            8601.
          format: date-time
        updatedByUserId:
          type: integer
          description: O ID do usuário que atualizou a propriedade pela última vez.
          format: int32
        value:
          type: string
          description: O valor da propriedade.
      description: Modelo de propriedade que inclui data e hora.
    PublicObjectWarning:
      required:
        - category
        - context
        - message
      type: object
      properties:
        category:
          type: string
          description: >-
            A classificação do aviso, indicando o tipo ou a natureza do
            problema.
        context:
          type: object
          additionalProperties:
            type: string
          description: >-
            Informações adicionais ou metadados sobre o aviso, fornecendo
            contexto para entender o problema.
        message:
          type: string
          description: >-
            O texto da mensagem de aviso, fornecendo informações sobre o
            problema ou alerta.
      description: >-
        Representa uma mensagem de aviso relacionada a um objeto público no
        HubSpot, fornecendo detalhes sobre a natureza e o contexto do aviso.
    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.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'

````