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

# Cria ou atualiza um lead (upsert)

> Acha o lead pelo **telefone** (DDD + 8 últimos dígitos, como o `GET`) ou
pelo **e-mail** (sem caixa) — ou pelo `visita_codigo` — e cria se não
existir. Precisa de token de escrita com `crm:operate`.

**Nunca piora o que já existe:** nome e e-mail só preenchem o vazio;
`campos` trocam o valor das chaves enviadas; `tags` só são
acrescentadas; `stage` só move para uma etapa **aberta** (ganho é
`POST /v1/sales`, que cria a venda e manda o Purchase; perdido pede o
motivo, pela ficha ou pelo MCP). O telefone de um lead que já existe
não muda.

**Lead novo precisa de telefone.** O telefone é a identidade do canal
(é por ele que a conversa de WhatsApp casa com o lead). O e-mail
sozinho **acha** quem já existe, mas não cria — `422`.

**`campos`** só aceita chaves que existem (as outras voltam em
`campos_ignorados`), e o valor é validado pelo tipo, como na ficha
(data `aaaa-mm-dd`, número, opção da lista): valor inválido é `422` e
nada é gravado. **`tags`** só aplica tags que existem
(`tags_ignoradas`); crie com `POST /v1/tags`.

**`visita_codigo` mantém a atribuição de anúncio:**
- **6 caracteres** = o código do envio do formulário do MetricaaS
  (`mtc.lead`): o lead daquele envio é o lead, e ele já nasceu com o
  clique e o anúncio;
- **9 caracteres** = o código da visita da tag `m.js`: o lead novo nasce
  com esse clique (UTMs, `fbc`/`fbp`, página). Lead que já existe e não
  tem clique também o ganha; quem já tem, mantém (a origem é o primeiro
  toque).

Sem código, um lead **novo** com `utm` ganha um clique com essas UTMs.

**Webhooks:** `lead.created` na criação; `lead.updated` quando algo
mudou num lead que já existia; `lead.stage_changed` quando a etapa mudou.

Telefone que já é de um lead **fora do alcance deste token** (de outra
pessoa, de outro canal ou excluído): `404`, e nada é criado.




## OpenAPI

````yaml /openapi.yaml post /leads
openapi: 3.1.0
info:
  title: Metricaas API
  version: 1.0.0
  description: >
    API do Metricaas para automatizar o CRM de fora dele — registrar vendas de
    uma

    plataforma de pagamento, ler leads e conferir a atribuição de origem.


    **Base:** `https://app.metricaas.com.br/v1`


    Todo endpoint é server-to-server. Não há CORS: um token de API nunca deve ir

    para o navegador.
servers:
  - url: https://app.metricaas.com.br/v1
security:
  - bearerAuth: []
tags:
  - name: Sessão
  - name: Leads
  - name: Vendas
  - name: Atendimento
  - name: Agente de IA
    description: |
      Ler a conversa, responder ao lead e pedir um humano — para um agente de IA
      (no n8n, por exemplo) atender pelo número da empresa sem sair do
      MetricaaS. A mensagem do agente aparece no inbox com selo próprio, não
      assume a conversa e não conta como primeira resposta do time.

      Gere o token em **Configurações → Tokens de API** com a finalidade
      **"Agente de atendimento"**: ele só conversa (`inbox:view` e
      `inbox:operate`). O texto do lead vai para um modelo de linguagem, e um
      modelo pode ser manipulado pela própria mensagem — o token não pode
      permitir nada além de conversar.

      **Este token é do seu servidor (o n8n), não do modelo.** Nunca o entregue
      ao modelo de IA como ferramenta: uma mensagem do lead poderia mandar o
      modelo ler outras conversas.
  - name: Comentários
    description: >
      Os comentários dos posts do Instagram e a resposta EM PÚBLICO, como a
      conta

      da empresa — a mesma fila da caixa de comentários. Uso típico: o webhook

      `comment.received` chega, um agente escreve a resposta, uma pessoa aprova,
      e

      o seu servidor publica por `POST
      /v1/comentarios/{comentario_id}/respostas`.
  - name: Fluxos
    description: >
      Criar um fluxo completo e ligar um post do Instagram a um fluxo de

      comentário — a ponte para quem publica o post fora do MetricaaS (o Estúdio

      do Horus, ou um motor de Reels) e quer que o fluxo certo responda a quem

      comentar nele.


      Gere o token em **Configurações → Tokens de API** com a finalidade

      **"Acesso completo do papel"** e o modo de **escrita**, herdando alguém
      que pode montar

      fluxos (`automations:manage`).
  - name: Configuração do CRM
    description: |
      Funis, etapas, tags e campos personalizados — para montar a operação por
      script (ex.: o funil "Infoproduto": Comentou → Abriu material → Lead →
      Clicou comprar → Comprou → Entregue → Cliente recorrente · Perdido).

      **Criar é idempotente pelo nome** (no campo, pela chave): repetir o
      script devolve `200` com `criado: false` e não duplica nada. O que já
      existe com **outro tipo** é `409`, e nada muda. Renomear, reordenar o que
      existe e remover ficam na tela. Ler pede a tela correspondente (Funil,
      Leads); criar pede `funnel:config`.
paths:
  /leads:
    post:
      tags:
        - Leads
      summary: Cria ou atualiza um lead (upsert)
      description: >
        Acha o lead pelo **telefone** (DDD + 8 últimos dígitos, como o `GET`) ou

        pelo **e-mail** (sem caixa) — ou pelo `visita_codigo` — e cria se não

        existir. Precisa de token de escrita com `crm:operate`.


        **Nunca piora o que já existe:** nome e e-mail só preenchem o vazio;

        `campos` trocam o valor das chaves enviadas; `tags` só são

        acrescentadas; `stage` só move para uma etapa **aberta** (ganho é

        `POST /v1/sales`, que cria a venda e manda o Purchase; perdido pede o

        motivo, pela ficha ou pelo MCP). O telefone de um lead que já existe

        não muda.


        **Lead novo precisa de telefone.** O telefone é a identidade do canal

        (é por ele que a conversa de WhatsApp casa com o lead). O e-mail

        sozinho **acha** quem já existe, mas não cria — `422`.


        **`campos`** só aceita chaves que existem (as outras voltam em

        `campos_ignorados`), e o valor é validado pelo tipo, como na ficha

        (data `aaaa-mm-dd`, número, opção da lista): valor inválido é `422` e

        nada é gravado. **`tags`** só aplica tags que existem

        (`tags_ignoradas`); crie com `POST /v1/tags`.


        **`visita_codigo` mantém a atribuição de anúncio:**

        - **6 caracteres** = o código do envio do formulário do MetricaaS
          (`mtc.lead`): o lead daquele envio é o lead, e ele já nasceu com o
          clique e o anúncio;
        - **9 caracteres** = o código da visita da tag `m.js`: o lead novo nasce
          com esse clique (UTMs, `fbc`/`fbp`, página). Lead que já existe e não
          tem clique também o ganha; quem já tem, mantém (a origem é o primeiro
          toque).

        Sem código, um lead **novo** com `utm` ganha um clique com essas UTMs.


        **Webhooks:** `lead.created` na criação; `lead.updated` quando algo

        mudou num lead que já existia; `lead.stage_changed` quando a etapa
        mudou.


        Telefone que já é de um lead **fora do alcance deste token** (de outra

        pessoa, de outro canal ou excluído): `404`, e nada é criado.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                phone:
                  type: string
                  example: '11987654321'
                  description: Com DDD; qualquer formatação.
                email:
                  type: string
                  example: ana@exemplo.com
                name:
                  type: string
                  maxLength: 120
                origem:
                  type: string
                  enum:
                    - form
                    - manual
                  default: manual
                  description: >
                    Só para lead **novo**. `form` = a pessoa pediu contato (é o
                    que

                    libera a primeira mensagem de `POST /v1/conversas` e dos
                    fluxos).
                campos:
                  type: object
                  additionalProperties:
                    type:
                      - string
                      - number
                      - boolean
                      - 'null'
                  example:
                    data_de_nascimento: '1988-03-21'
                  description: >-
                    Pela **chave** do campo (`GET /v1/campos`). `null` ou vazio
                    limpa.
                tags:
                  type: array
                  items:
                    type: string
                  example:
                    - Lead
                stage:
                  type: string
                  example: Lead
                  description: Nome da etapa aberta; com mais de um funil, `Funil › Etapa`.
                utm:
                  type: object
                  properties:
                    utm_source:
                      type: string
                    utm_medium:
                      type: string
                    utm_campaign:
                      type: string
                    utm_content:
                      type: string
                    utm_term:
                      type: string
                visita_codigo:
                  type: string
                  example: K7M2PQ
            example:
              phone: '11987654321'
              email: ana@exemplo.com
              name: Ana Lima
              origem: form
              campos:
                data_de_nascimento: '1988-03-21'
              tags:
                - Lead
              stage: Lead
              utm:
                utm_source: instagram
                utm_medium: dm
                utm_campaign: mapa-cabalistico-nome_desenho
              visita_codigo: K7M2PQ
      responses:
        '200':
          description: Já existia (`mudou` diz o que mudou; vazio = nada)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LeadUpsert'
              example:
                id: 0f6c8e1a-1b2c-4d5e-8f90-1234567890ab
                criado: false
                mudou:
                  - email
                  - campos.data_de_nascimento
                campos_ignorados:
                  - inventado
                tags_ignoradas: []
                visita_ligada: false
        '201':
          description: Lead criado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LeadUpsert'
              example:
                id: 0f6c8e1a-1b2c-4d5e-8f90-1234567890ab
                criado: true
                mudou: []
                campos_ignorados: []
                tags_ignoradas: []
                visita_ligada: true
        '401':
          $ref: '#/components/responses/NaoAutenticado'
        '403':
          $ref: '#/components/responses/SemPermissao'
        '404':
          $ref: '#/components/responses/NaoEncontrado'
        '422':
          $ref: '#/components/responses/Invalido'
components:
  schemas:
    LeadUpsert:
      type: object
      properties:
        id:
          type: string
          format: uuid
        criado:
          type: boolean
          description: '`true` = 201, o lead nasceu agora.'
        mudou:
          type: array
          items:
            type: string
          description: >-
            O que mudou num lead que já existia: `name`, `email`, `stage`,
            `tags`, `visita`, `campos.<chave>`.
        campos_ignorados:
          type: array
          items:
            type: string
          description: Chaves de campo que não existem na empresa.
        tags_ignoradas:
          type: array
          items:
            type: string
          description: Tags que não existem na empresa.
        visita_ligada:
          type: boolean
          description: O clique da visita (`visita_codigo` de 9) entrou no lead.
    Problema:
      type: object
      description: Erros seguem RFC 7807.
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
  responses:
    NaoAutenticado:
      description: Token ausente, inválido, expirado ou revogado
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
    SemPermissao:
      description: O token não tem a capacidade exigida, ou é de leitura
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
    NaoEncontrado:
      description: >
        Não existe **ou** é de outra empresa. A API responde `404` nos dois
        casos

        de propósito: um `403` confirmaria que o id existe.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
    Invalido:
      description: Validação — veja `errors[]`
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        `Authorization: Bearer mcp_…` — gere em **Configurações → Tokens de
        API**.


        O token de API tem modo `read` ou `write`. Um token `read` responde
        `403`

        a qualquer verbo que não seja `GET`. As capacidades do token são a

        **interseção** com as da pessoa de quem ele herda o papel: se ela perder

        acesso na grade de Equipe, o token perde junto, sem ninguém revogar
        nada.


        **Token de agência** (gerado no console da agência): vale para as

        empresas da agência, e a empresa de cada chamada vai no header

        **`X-Empresa: <slug da empresa>`**. Sem o header, `401`. Num token de

        empresa o header é opcional e, se vier, tem de ser a própria empresa. O

        modo `read` vale igual: um token de agência de leitura só faz `GET` —

        é o token para pôr numa função que só consulta.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.