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

# Atualização de oportunidade

> Atualiza campos da oportunidade. O campo `lead_source` não é aceito; use `crm_lead_source_id`. Conflitos entre `organization_id` e `organization` são rejeitados. Pessoas marcadas com `delete: true` em `persons_id` são removidas; `organization_id: null` remove a organização.




## OpenAPI

````yaml /openapi.json put /integrations/external/deals/{id}
openapi: 3.0.3
info:
  title: >-
    Integração Externa - Leads, Oportunidades, Tarefas, Arquivos, Propostas,
    Chats, Satisfação e Campos Personalizados
  version: 1.0.0
  description: >
    Documentação oficial da API externa da Wegly para campos personalizados,
    leads, oportunidades, tarefas, arquivos, propostas, chats e satisfação
    (`/integrations/external/custom-fields`, `/integrations/external/files`,
    `/integrations/external/leads`, `/integrations/external/deals`,
    `/integrations/external/tasks`, `/integrations/external/proposals`,
    `/integrations/external/chats` e `/integrations/external/satisfaction`).
    Todas as descrições estão em português e refletem as regras aplicadas pelo
    serviço.
servers:
  - url: https://api.wegly.com.br
    description: Ambiente de produção Wegly
security:
  - bearerAuth: []
tags:
  - name: Campos Personalizados
    description: >-
      Consulta dos campos personalizados disponíveis para uso nas integrações
      externas.
  - name: Arquivos
    description: >-
      Upload de arquivos públicos de integração vinculados diretamente a leads
      ou oportunidades.
  - name: Leads
    description: >-
      Operações de listagem, criação, consulta e atualização de leads via
      integração externa.
  - name: Oportunidades
    description: Operações de criação de oportunidades (deals) via integração externa.
  - name: Tarefas
    description: >-
      Operações de listagem, criação, consulta, atualização e remoção de tarefas
      vinculadas a leads, oportunidades, entregas, pessoas ou organizações.
  - name: Satisfação
    description: >-
      Geração de links públicos para formulários de satisfação via integração
      externa.
  - name: Propostas
    description: >-
      Operações de listagem, criação, consulta, atualização e remoção de
      propostas via integração externa.
  - name: Chats
    description: >-
      Operações principais de listagem, criação, consulta e resumo de não lidas
      de chats via integração externa.
paths:
  /integrations/external/deals/{id}:
    put:
      tags:
        - Oportunidades
      summary: Atualização de oportunidade
      description: >
        Atualiza campos da oportunidade. O campo `lead_source` não é aceito; use
        `crm_lead_source_id`. Conflitos entre `organization_id` e `organization`
        são rejeitados. Pessoas marcadas com `delete: true` em `persons_id` são
        removidas; `organization_id: null` remove a organização.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: UUID da oportunidade a ser atualizada.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateExternalOpportunity'
      responses:
        '200':
          description: Oportunidade atualizada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpportunityUpdateResult'
        '400':
          description: >-
            Validação de dados falhou (IDs inexistentes, conflitos de
            parâmetros, estágio inválido, etc).
        '401':
          description: Token de integração ausente ou inválido.
        '403':
          description: >-
            Permissão `crm/deal.update` ausente ou domínio de origem não
            autorizado na chave.
        '404':
          description: Oportunidade não encontrada ou inacessível ao usuário da chave.
components:
  schemas:
    UpdateExternalOpportunity:
      type: object
      required:
        - title
      additionalProperties: false
      properties:
        stage_id:
          type: string
          format: uuid
        responsible_id:
          type: string
          format: uuid
        quality_rating:
          type: integer
          enum:
            - 1
            - 2
            - 3
            - 4
            - 5
        quality_reason:
          type: string
        title:
          type: string
          maxLength: 150
        value:
          type: number
        expected_close_date:
          type: string
          format: date-time
          nullable: true
        visibility:
          $ref: '#/components/schemas/OpportunityVisibility'
        temperature:
          $ref: '#/components/schemas/OpportunityTemperature'
        persons_id:
          type: array
          description: >
            Lista de operações de associação ou remoção de participantes.
            `delete: true` remove a pessoa da oportunidade; omita ou envie false
            para adicionar.
          items:
            type: object
            properties:
              person_id:
                type: string
                format: uuid
              delete:
                type: boolean
        person:
          $ref: '#/components/schemas/OpportunityPerson'
        primary_person_id:
          type: string
          format: uuid
        organization_id:
          type: string
          format: uuid
          nullable: true
        organization:
          $ref: '#/components/schemas/OpportunityOrganization'
        custom_fields:
          type: array
          items:
            $ref: '#/components/schemas/OpportunityCustomFieldValue'
        marketing:
          $ref: '#/components/schemas/MarketingTracking'
        crm_lead_source_id:
          type: string
          format: uuid
        crm_loss_reason_id:
          type: string
        lost_reason_description:
          type: string
        status:
          $ref: '#/components/schemas/OpportunityStatusEnum'
        won_date:
          type: string
          format: date-time
        lost_date:
          type: string
          format: date-time
        tags:
          type: array
          items:
            type: string
    OpportunityUpdateResult:
      type: object
      description: Retorno enxuto da atualização de oportunidade.
      properties:
        id:
          type: string
        code:
          type: integer
        title:
          type: string
        quality_rating:
          type: integer
          nullable: true
        quality_reason:
          type: string
          nullable: true
        status:
          $ref: '#/components/schemas/OpportunityStatusEnum'
        lost_reason_description:
          type: string
          nullable: true
    OpportunityVisibility:
      type: integer
      enum:
        - 0
        - 1
        - 2
      description: >
        0 = privado (responsável e supervisores), 1 = equipe/responsável, 2 =
        público.
    OpportunityTemperature:
      type: integer
      enum:
        - 1
        - 2
        - 3
      description: 1 = frio, 2 = morno, 3 = quente.
    OpportunityPerson:
      type: object
      description: >-
        Pessoa associada à oportunidade. Envie telefone, e-mail e redes sociais
        em `contacts`; `phone` e `email` no topo da oportunidade não fazem parte
        do contrato.
      required:
        - name
      properties:
        name:
          type: string
        birth_date:
          type: string
          format: date
        gender:
          type: integer
        notes:
          type: string
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/OpportunityPersonContact'
        documents:
          type: array
          items:
            $ref: '#/components/schemas/PersonDocumentInput'
        address:
          $ref: '#/components/schemas/AddressInput'
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/AddressInput'
        avoid_duplicate:
          type: boolean
          description: >
            Quando true, ativa deduplicação usando os tipos informados em
            `duplicate_check_types`. Se encontrar pessoa compatível, os contatos
            faltantes são adicionados e a pessoa é reaproveitada.
        duplicate_check_types:
          type: array
          items:
            $ref: '#/components/schemas/PersonContactType'
          description: Tipos de contato que devem ser usados para busca de duplicados.
    OpportunityOrganization:
      type: object
      required:
        - name
      properties:
        name:
          type: string
        legal_name:
          type: string
        document:
          type: string
        industry:
          type: string
        description:
          type: string
        phone:
          type: string
        email:
          type: string
        site:
          type: string
        status:
          type: integer
          enum:
            - 0
            - 1
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/AddressInput'
        address_name:
          type: string
        address_street:
          type: string
        address_number:
          type: string
        address_complement:
          type: string
        address_district:
          type: string
        address_city:
          type: string
        address_state:
          type: string
        address_postal_code:
          type: string
        address_status:
          type: integer
        address_type:
          type: integer
    OpportunityCustomFieldValue:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          description: ID do campo customizado.
        value:
          type: string
        option_id:
          type: string
        option_ids:
          type: array
          items:
            type: string
    MarketingTracking:
      type: object
      description: >
        Rastreio de marketing. Todos os valores são sanitizados (trim) e campos
        vazios são ignorados. `utm_*` são normalizados para `wegly_*`
        equivalentes quando estes não forem enviados. `utm_term` vira
        `utm_search_term` se o campo específico não for enviado.
        `url_conversion` tem seus parâmetros extraídos automaticamente (wegly_*,
        utm_*, gclid, fbclid, conversion_tool_name). Quando `wegly_code`
        referencia um tracker válido, a origem do lead é extraída do tracker.
        Quando não há tracker nem origem explícita, `wegly_source` ou
        `utm_source` busca/cria a origem automaticamente.
      properties:
        wegly_code:
          type: string
          description: >-
            Código de rastreio Wegly. Se existir, define a origem principal do
            lead.
        wegly_source:
          type: string
          description: >-
            Origem textual Wegly. Tem prioridade sobre `utm_source` quando for
            necessário buscar/criar origem automaticamente.
        wegly_campaign:
          type: string
        wegly_ad_set:
          type: string
        wegly_content:
          type: string
        wegly_displayed_on:
          type: string
        wegly_conversion_tool:
          type: string
          description: >
            ID, código ou nome da ferramenta de conversão. Se não existir, é
            criada automaticamente com código gerado.
        wegly_creative:
          type: string
        gclid:
          type: string
          description: Prioritário sobre fbclid quando ambos enviados.
        fbclid:
          type: string
        fbc:
          type: string
        fbp:
          type: string
        url_conversion:
          type: string
          description: >
            URL completa da conversão. Se não contiver protocolo, será
            normalizada para https://. É armazenada a base e a URL completa.
        utm_search_term:
          type: string
        utm_source:
          type: string
          description: >-
            Fonte textual de marketing. Busca/cria origem automaticamente quando
            não houver `wegly_code`, `wegly_source` nem `crm_lead_source_id`.
        utm_campaign:
          type: string
        utm_ad_set:
          type: string
        utm_content:
          type: string
        utm_term:
          type: string
        utm_display_on:
          type: string
        client_ip_address:
          type: string
        client_user_agent:
          type: string
        ga_client_id:
          type: string
    OpportunityStatusEnum:
      type: integer
      enum:
        - 1
        - 2
        - 3
      description: 1 = aberta, 2 = ganha, 3 = perdida.
    OpportunityPersonContact:
      type: object
      required:
        - type
        - value
      properties:
        type:
          $ref: '#/components/schemas/PersonContactType'
        value:
          type: string
          description: >
            Valor do contato. Telefones (tipos 0,2,3) têm caracteres não
            numéricos removidos automaticamente.
        primary:
          type: boolean
          description: Marca o contato como principal para a pessoa.
    PersonDocumentInput:
      type: object
      required:
        - type
        - value
      properties:
        type:
          type: integer
          description: Tipo do documento conforme cadastro interno de pessoas.
        value:
          type: string
        label:
          type: string
          description: Obrigatório quando o tipo do documento for personalizado.
    AddressInput:
      type: object
      properties:
        status:
          type: integer
        type:
          type: integer
        name:
          type: string
        street:
          type: string
        number:
          type: string
        complement:
          type: string
        district:
          type: string
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
    PersonContactType:
      type: integer
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
      description: >
        0=WhatsApp, 1=Email, 2=Celular, 3=Telefone, 4=Instagram, 5=Facebook,
        6=LinkedIn, 7=Outros.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Utilize o token de integração no header `Authorization: Bearer {token}`.
        O domínio de origem (Origin/Referer) deve respeitar `allowed_domain`,
        quando configurado na chave.

````