> ## 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 um funil (com as etapas do pedido)

> Com `etapas`, o funil nasce **exatamente** com elas, na ordem; a primeira
é a de entrada e tem de ser `aberta`. Sem `etapas`, nasce com as padrão
da tela (Novo → Em contato → Qualificado → Proposta → Ganho · Perdido).

Já existe um funil com o nome (sem caixa) e com todas as etapas pedidas,
do mesmo tipo: `200` com `criado: false`. Falta alguma: `409` (crie com
`POST /v1/funis/{id}/etapas`). Sem etapa de ganho, a resposta avisa:
uma venda de um lead desse funil não o move.




## OpenAPI

````yaml /openapi.yaml post /funis
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:
  /funis:
    post:
      tags:
        - Configuração do CRM
      summary: Cria um funil (com as etapas do pedido)
      description: >
        Com `etapas`, o funil nasce **exatamente** com elas, na ordem; a
        primeira

        é a de entrada e tem de ser `aberta`. Sem `etapas`, nasce com as padrão

        da tela (Novo → Em contato → Qualificado → Proposta → Ganho · Perdido).


        Já existe um funil com o nome (sem caixa) e com todas as etapas pedidas,

        do mesmo tipo: `200` com `criado: false`. Falta alguma: `409` (crie com

        `POST /v1/funis/{id}/etapas`). Sem etapa de ganho, a resposta avisa:

        uma venda de um lead desse funil não o move.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - nome
              properties:
                nome:
                  type: string
                  maxLength: 60
                etapas:
                  type: array
                  maxItems: 30
                  items:
                    oneOf:
                      - type: string
                      - type: object
                        required:
                          - nome
                        properties:
                          nome:
                            type: string
                            maxLength: 60
                          tipo:
                            type: string
                            enum:
                              - aberta
                              - ganho
                              - perdido
                            default: aberta
            example:
              nome: Infoproduto
              etapas:
                - Comentou
                - Abriu material
                - Lead
                - Clicou comprar
                - nome: Comprou
                  tipo: ganho
                - Entregue
                - Cliente recorrente
                - nome: Perdido
                  tipo: perdido
      responses:
        '200':
          description: 'Já existia com essas etapas (`criado: false`)'
        '201':
          description: Criado
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Funil'
                  - type: object
                    properties:
                      criado:
                        type: boolean
                      avisos:
                        type: array
                        items:
                          type: string
        '403':
          $ref: '#/components/responses/SemPermissao'
        '409':
          description: >-
            Já existe um funil com o nome, sem alguma das etapas pedidas (o `id`
            vem no corpo)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problema'
        '422':
          $ref: '#/components/responses/Invalido'
components:
  schemas:
    Funil:
      type: object
      properties:
        id:
          type: string
          format: uuid
        nome:
          type: string
        posicao:
          type: integer
        principal:
          type: boolean
          description: 'O primeiro funil: é nele que nasce o lead de mensagem.'
        etapas:
          type: array
          items:
            $ref: '#/components/schemas/Etapa'
    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
    Etapa:
      type: object
      properties:
        id:
          type: string
          format: uuid
        nome:
          type: string
        posicao:
          type: integer
        tipo:
          type: string
          enum:
            - aberta
            - ganho
            - perdido
  responses:
    SemPermissao:
      description: O token não tem a capacidade exigida, ou é de leitura
      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.