Etapas

Etapas são as colunas do quadro. Cada etapa pertence a uma pipeline e tem uma position que define sua ordem. Todas as rotas desta página exigem a permissão pipeline.manage.

Para criar ou reordenar várias etapas de uma vez, prefira Configurar pipeline — é uma operação transacional que salva a lista completa.

O objeto Etapa

string

UUID da etapa

name

string

Nome exibido no topo da coluna

color

string

Cor no formato de token "H S% L%" (tripla HSL sem o invólucro hsl())

kind

string

won, lost ou ausente para uma etapa comum

position

integer

Ordem da coluna no quadro (base 0)

Criar etapa

POST /backend/pipelines/{id}/stages

Adiciona uma etapa comum ao fim da pipeline. Não é possível criar etapas won ou lost — elas já existem desde a criação da pipeline.

Request Body

name

string

obrigatório

Nome da etapa

color

string

Cor no formato "H S% L%". Quando omitida, usa o cinza padrão "215 16% 47%".

curl -X POST "https://api.leavo.ai/backend/pipelines/bb0e8400-e29b-41d4-a716-446655440000/stages" \
  -H "Authorization: Bearer sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Proposta enviada", "color": "271 81% 56%" }'

const response = await fetch(
  'https://api.leavo.ai/backend/pipelines/bb0e8400-e29b-41d4-a716-446655440000/stages',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer sua_chave_aqui',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ name: 'Proposta enviada', color: '271 81% 56%' })
  }
);

{
  "id": "cc4e8400-e29b-41d4-a716-446655440000",
  "name": "Proposta enviada",
  "color": "271 81% 56%",
  "position": 4
}

Atualizar etapa

PUT /backend/pipeline/stages/{id}

Renomeia, recolore ou reposiciona uma etapa. Campos omitidos permanecem inalterados.

Request Body

name

string

Novo nome

color

string

Nova cor no formato "H S% L%"

position

integer

Nova posição no quadro

As etapas won e lost podem ser renomeadas e recoloridas normalmente — o kind é que não muda.

curl -X PUT "https://api.leavo.ai/backend/pipeline/stages/cc4e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Proposta", "position": 2 }'

Excluir etapa

DELETE /backend/pipeline/stages/{id}

Query Parameters

target_stage_id

string

Etapa que receberá os negócios da etapa excluída. Obrigatório quando a etapa ainda contém negócios.

Excluir uma etapa que ainda tem negócios sem target_stage_id retorna 409. Os negócios nunca são apagados junto com a etapa — a API obriga a escolher um destino.

O destino precisa pertencer à mesma pipeline e não pode ser a própria etapa sendo excluída — ambos os casos retornam 400.

As etapas de Ganho (kind: "won") e Perdido (kind: "lost") não podem ser excluídas (400), porque não existe rota que as recrie. A pipeline também precisa manter pelo menos uma etapa.

# Etapa vazia — nenhum destino necessário
curl -X DELETE "https://api.leavo.ai/backend/pipeline/stages/cc4e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer sua_chave_aqui"

# Etapa com negócios — destino obrigatório
curl -X DELETE "https://api.leavo.ai/backend/pipeline/stages/cc4e8400-e29b-41d4-a716-446655440000?target_stage_id=cc0e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer sua_chave_aqui"

{ "success": true }

{
  "code": "ERR_CONFLICT",
  "message": "A etapa \"Proposta enviada\" tem 12 negócio(s). Escolha para qual etapa eles devem ir."
}

{
  "code": "ERR_INVALID_INPUT",
  "message": "A etapa de ganho e a de perda não podem ser excluídas — a pipeline precisa delas para marcar negócios como ganhos ou perdidos"
}

Fluxo recomendado na interface: tente o DELETE sem target_stage_id; se vier 409, pergunte ao usuário para onde mover os negócios e repita com o parâmetro.

Visão Geral

Leads

Status

Tags

Pipeline (CRM)

Webhooks

Campos Personalizados

Cadências

Conversas

Mensagens

Departamentos

Upload de Arquivos

Templates (Meta/Gupshup)

Follow-up

O objeto Etapa

Criar etapa

Request Body

Atualizar etapa

Request Body

Excluir etapa

Query Parameters

​O objeto Etapa

​Criar etapa

​Request Body

​Atualizar etapa

​Request Body

​Excluir etapa

​Query Parameters

O objeto Etapa

Criar etapa

Request Body

Atualizar etapa

Request Body

Excluir etapa

Query Parameters