Pipelines e Grupos

curl -X POST "https://api.leavo.ai/backend/pipelines" \
  -H "Authorization: Bearer sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Vendas Inbound",
    "description": "Leads vindos do site",
    "new_group_name": "Comercial"
  }'

const response = await fetch('https://api.leavo.ai/backend/pipelines', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sua_chave_aqui',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Vendas Inbound',
    description: 'Leads vindos do site',
    new_group_name: 'Comercial'
  })
});

import requests

response = requests.post(
    'https://api.leavo.ai/backend/pipelines',
    headers={'Authorization': 'Bearer sua_chave_aqui'},
    json={
        'name': 'Vendas Inbound',
        'description': 'Leads vindos do site',
        'new_group_name': 'Comercial'
    }
)

{
  "groups": [
    { "id": "aa0e8400-e29b-41d4-a716-446655440000", "name": "Comercial", "position": 0 }
  ],
  "pipelines": [
    {
      "id": "bb0e8400-e29b-41d4-a716-446655440000",
      "group_id": "aa0e8400-e29b-41d4-a716-446655440000",
      "name": "Vendas Inbound",
      "description": "Leads vindos do site",
      "position": 0,
      "created_at": "2026-07-16T09:00:00Z"
    }
  ]
}

Listar pipelines e grupos

GET /backend/pipelines

Retorna os grupos e as pipelines da conta, prontos para montar o seletor.

Response

groups

Group[]

Grupos ordenados por position

pipelines

Pipeline[]

Pipelines ordenadas por position, cada uma com seu group_id

{
  "groups": [
    { "id": "aa0e8400-e29b-41d4-a716-446655440000", "name": "Comercial", "position": 0 }
  ],
  "pipelines": [
    {
      "id": "bb0e8400-e29b-41d4-a716-446655440000",
      "group_id": "aa0e8400-e29b-41d4-a716-446655440000",
      "name": "Vendas Inbound",
      "description": "Leads vindos do site",
      "position": 0,
      "created_at": "2026-07-16T09:00:00Z"
    }
  ]
}

Obter uma pipeline

GET /backend/pipelines/{id}

Retorna a pipeline com suas etapas e motivos de perda.

{
  "id": "bb0e8400-e29b-41d4-a716-446655440000",
  "group_id": "aa0e8400-e29b-41d4-a716-446655440000",
  "name": "Vendas Inbound",
  "description": "Leads vindos do site",
  "position": 0,
  "stages": [
    { "id": "cc0e8400-e29b-41d4-a716-446655440000", "name": "Entrada", "color": "217 91% 60%", "position": 0 },
    { "id": "cc1e8400-e29b-41d4-a716-446655440000", "name": "Em andamento", "color": "38 92% 50%", "position": 1 },
    { "id": "cc2e8400-e29b-41d4-a716-446655440000", "name": "Ganho", "color": "152 60% 40%", "kind": "won", "position": 2 },
    { "id": "cc3e8400-e29b-41d4-a716-446655440000", "name": "Perdido", "color": "0 72% 56%", "kind": "lost", "position": 3 }
  ],
  "loss_reasons": [
    "Sem orçamento",
    "Sem resposta / sumiu",
    "Fechou com concorrente",
    "Sem fit com o produto",
    "Momento errado"
  ],
  "created_at": "2026-07-16T09:00:00Z"
}

color usa o formato de token do design system — uma tripla HSL sem o invólucro hsl(), como "217 91% 60%".

Criar pipeline

POST /backend/pipelines

Requer a permissão pipeline.manage. A pipeline criada já vem com as quatro etapas padrão e os motivos de perda padrão.

Request Body

name

string

obrigatório

Nome da pipeline

description

string

Descrição da pipeline

group_id

string

UUID de um grupo existente

new_group_name

string

Nome de um grupo a criar junto com a pipeline

Informe group_id ou new_group_name — a pipeline precisa pertencer a um grupo.

curl -X POST "https://api.leavo.ai/backend/pipelines" \
  -H "Authorization: Bearer sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Vendas Inbound",
    "description": "Leads vindos do site",
    "new_group_name": "Comercial"
  }'

const response = await fetch('https://api.leavo.ai/backend/pipelines', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sua_chave_aqui',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Vendas Inbound',
    description: 'Leads vindos do site',
    new_group_name: 'Comercial'
  })
});

import requests

response = requests.post(
    'https://api.leavo.ai/backend/pipelines',
    headers={'Authorization': 'Bearer sua_chave_aqui'},
    json={
        'name': 'Vendas Inbound',
        'description': 'Leads vindos do site',
        'new_group_name': 'Comercial'
    }
)

Retorna 201 Created com a pipeline.

Configurar pipeline

PUT /backend/pipelines/{id}

Salvamento transacional da tela “Configurar pipeline”: nome, descrição, a lista completa e ordenada de etapas, e os motivos de perda.

Request Body

name

string

obrigatório

Nome da pipeline

description

string

Descrição da pipeline

stages

ConfigStage[]

obrigatório

Lista completa e ordenada de etapas. A posição no array define a ordem no quadro.

Mostrar Propriedades de ConfigStage

string

UUID da etapa existente. Omita para criar uma etapa nova.

name

string

obrigatório

Nome da etapa

color

string

Cor no formato "H S% L%"

loss_reasons

string[]

Lista completa de motivos de perda da pipeline

reallocation_targets

object

Mapa { "id_da_etapa_removida": "id_da_etapa_destino" } para as etapas que saíram da lista

Etapas omitidas da lista stages são excluídas. Se uma etapa removida ainda tiver negócios, é obrigatório informar seu destino em reallocation_targets — caso contrário a requisição retorna 409. O destino precisa ser uma etapa que permaneceu na lista.

curl -X PUT "https://api.leavo.ai/backend/pipelines/bb0e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Vendas Inbound",
    "description": "Leads vindos do site",
    "stages": [
      { "id": "cc0e8400-e29b-41d4-a716-446655440000", "name": "Entrada", "color": "217 91% 60%" },
      { "name": "Qualificação", "color": "271 81% 56%" },
      { "id": "cc2e8400-e29b-41d4-a716-446655440000", "name": "Ganho", "color": "152 60% 40%" },
      { "id": "cc3e8400-e29b-41d4-a716-446655440000", "name": "Perdido", "color": "0 72% 56%" }
    ],
    "loss_reasons": ["Sem orçamento", "Preço acima do esperado"],
    "reallocation_targets": {
      "cc1e8400-e29b-41d4-a716-446655440000": "cc0e8400-e29b-41d4-a716-446655440000"
    }
  }'

No exemplo acima, a etapa Em andamento saiu da lista e seus negócios foram movidos para Entrada. A etapa Qualificação foi criada (não tem id).

Reordenar pipeline

PUT /backend/pipelines/reorder

Move uma pipeline para antes de outra e/ou para outro grupo.

Request Body

pipeline_id

string

obrigatório

UUID da pipeline movida

group_id

string

obrigatório

UUID do grupo de destino

before_id

string

UUID da pipeline que deve ficar depois da movida. Omita para posicionar no fim do grupo.

{ "success": true }

Excluir pipeline

DELETE /backend/pipelines/{id}

Exclui a pipeline e todo o seu conteúdo: etapas, motivos de perda, negócios, produtos dos negócios, tags, atividades, arquivos e histórico. A operação é irreversível.

{ "success": true }

Grupos

Grupos organizam as pipelines no seletor (ex: Marketing, Comercial, CS).

Listar grupos

GET /backend/pipeline/groups

Criar grupo

POST /backend/pipeline/groups

name

string

obrigatório

Nome do grupo

Retorna 201 Created.

Renomear grupo

PUT /backend/pipeline/groups/{id}

name

string

obrigatório

Novo nome do grupo

Excluir grupo

DELETE /backend/pipeline/groups/{id}

Um grupo que ainda contém pipelines não pode ser excluído — a resposta é 409 com a contagem. Mova as pipelines para outro grupo antes.

409 Conflict

{
  "code": "ERR_CONFLICT",
  "message": "O grupo tem 2 pipeline(s). Mova-as para outro grupo antes de excluir."
}

Visão Geral da Pipeline Etapas

Visão Geral

Leads

Status

Tags

Pipeline (CRM)

Webhooks

Campos Personalizados

Cadências

Conversas

Mensagens

Departamentos

Upload de Arquivos

Templates (Meta/Gupshup)

Follow-up

Pipelines e Grupos

Listar pipelines e grupos

Response

Obter uma pipeline

Criar pipeline

Request Body

Configurar pipeline

Request Body

Reordenar pipeline

Request Body

Excluir pipeline

Grupos

Listar grupos

Criar grupo

Renomear grupo

Excluir grupo

​Listar pipelines e grupos

​Response

​Obter uma pipeline

​Criar pipeline

​Request Body

​Configurar pipeline

​Request Body

​Reordenar pipeline

​Request Body

​Excluir pipeline

​Grupos

​Listar grupos

​Criar grupo

​Renomear grupo

​Excluir grupo

Listar pipelines e grupos

Response

Obter uma pipeline

Criar pipeline

Request Body

Configurar pipeline

Request Body

Reordenar pipeline

Request Body

Excluir pipeline

Grupos

Listar grupos

Criar grupo

Renomear grupo

Excluir grupo