Pipelines and Groups

curl -X POST "https://api.leavo.ai/backend/pipelines" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Inbound Sales",
    "description": "Leads coming from the website",
    "new_group_name": "Sales"
  }'

const response = await fetch('https://api.leavo.ai/backend/pipelines', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer your_api_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Inbound Sales',
    description: 'Leads coming from the website',
    new_group_name: 'Sales'
  })
});

import requests

response = requests.post(
    'https://api.leavo.ai/backend/pipelines',
    headers={'Authorization': 'Bearer your_api_key_here'},
    json={
        'name': 'Inbound Sales',
        'description': 'Leads coming from the website',
        'new_group_name': 'Sales'
    }
)

{
  "groups": [
    { "id": "aa0e8400-e29b-41d4-a716-446655440000", "name": "Sales", "position": 0 }
  ],
  "pipelines": [
    {
      "id": "bb0e8400-e29b-41d4-a716-446655440000",
      "group_id": "aa0e8400-e29b-41d4-a716-446655440000",
      "name": "Inbound Sales",
      "description": "Leads coming from the website",
      "position": 0,
      "created_at": "2026-07-16T09:00:00Z"
    }
  ]
}

List pipelines and groups

GET /backend/pipelines

Returns the account’s groups and pipelines, ready to build the selector.

Response

groups

Group[]

Groups ordered by position

pipelines

Pipeline[]

Pipelines ordered by position, each with its group_id

{
  "groups": [
    { "id": "aa0e8400-e29b-41d4-a716-446655440000", "name": "Sales", "position": 0 }
  ],
  "pipelines": [
    {
      "id": "bb0e8400-e29b-41d4-a716-446655440000",
      "group_id": "aa0e8400-e29b-41d4-a716-446655440000",
      "name": "Inbound Sales",
      "description": "Leads coming from the website",
      "position": 0,
      "created_at": "2026-07-16T09:00:00Z"
    }
  ]
}

Get a pipeline

GET /backend/pipelines/{id}

Returns the pipeline with its stages and loss reasons.

{
  "id": "bb0e8400-e29b-41d4-a716-446655440000",
  "group_id": "aa0e8400-e29b-41d4-a716-446655440000",
  "name": "Inbound Sales",
  "description": "Leads coming from the website",
  "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"
}

The default stage names (Entrada, Em andamento, Ganho, Perdido) and the default loss reasons are created by the API in Portuguese and returned verbatim. They are editable data — rename them with Configure a pipeline.

color uses the design system token format — an HSL triple without the hsl() wrapper, like "217 91% 60%".

Create a pipeline

POST /backend/pipelines

Requires the pipeline.manage permission. The created pipeline already comes with the four default stages and the default loss reasons.

Request Body

name

string

required

Pipeline name

description

string

Pipeline description

group_id

string

UUID of an existing group

new_group_name

string

Name of a group to create along with the pipeline

Provide group_id or new_group_name — a pipeline must belong to a group.

curl -X POST "https://api.leavo.ai/backend/pipelines" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Inbound Sales",
    "description": "Leads coming from the website",
    "new_group_name": "Sales"
  }'

const response = await fetch('https://api.leavo.ai/backend/pipelines', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer your_api_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Inbound Sales',
    description: 'Leads coming from the website',
    new_group_name: 'Sales'
  })
});

import requests

response = requests.post(
    'https://api.leavo.ai/backend/pipelines',
    headers={'Authorization': 'Bearer your_api_key_here'},
    json={
        'name': 'Inbound Sales',
        'description': 'Leads coming from the website',
        'new_group_name': 'Sales'
    }
)

Returns 201 Created with the pipeline.

Configure a pipeline

PUT /backend/pipelines/{id}

Transactional save of the “Configure pipeline” screen: name, description, the complete and ordered list of stages, and the loss reasons.

Request Body

name

string

required

Pipeline name

description

string

Pipeline description

stages

ConfigStage[]

required

The complete and ordered list of stages. The position in the array defines the order on the board.

Show ConfigStage properties

string

UUID of the existing stage. Omit to create a new stage.

name

string

required

Stage name

color

string

Color in the "H S% L%" format

loss_reasons

string[]

The complete list of the pipeline’s loss reasons

reallocation_targets

object

Map { "removed_stage_id": "destination_stage_id" } for the stages that left the list

Stages omitted from the stages list are deleted. If a removed stage still has deals, you must provide its destination in reallocation_targets — otherwise the request returns 409. The destination must be a stage that stayed in the list.

curl -X PUT "https://api.leavo.ai/backend/pipelines/bb0e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Inbound Sales",
    "description": "Leads coming from the website",
    "stages": [
      { "id": "cc0e8400-e29b-41d4-a716-446655440000", "name": "Entrada", "color": "217 91% 60%" },
      { "name": "Qualification", "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", "Price above expectations"],
    "reallocation_targets": {
      "cc1e8400-e29b-41d4-a716-446655440000": "cc0e8400-e29b-41d4-a716-446655440000"
    }
  }'

In the example above, the Em andamento stage left the list and its deals were moved to Entrada. The Qualification stage was created (it has no id).

Reorder a pipeline

PUT /backend/pipelines/reorder

Moves a pipeline before another one and/or into another group.

Request Body

pipeline_id

string

required

UUID of the moved pipeline

group_id

string

required

UUID of the destination group

before_id

string

UUID of the pipeline that should end up after the moved one. Omit to place it at the end of the group.

{ "success": true }

Delete a pipeline

DELETE /backend/pipelines/{id}

Deletes the pipeline and all of its content: stages, loss reasons, deals, deal products, tags, activities, files and history. The operation is irreversible.

{ "success": true }

Groups

Groups organize pipelines in the selector (e.g. Marketing, Sales, CS).

List groups

GET /backend/pipeline/groups

Create a group

POST /backend/pipeline/groups

name

string

required

Group name

Returns 201 Created.

Rename a group

PUT /backend/pipeline/groups/{id}

name

string

required

New group name

Delete a group

DELETE /backend/pipeline/groups/{id}

A group that still contains pipelines cannot be deleted — the response is 409 with the count. Move the pipelines to another group first.

409 Conflict

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

Error message strings are returned by the API in Portuguese. Match on code (ERR_CONFLICT), never on the message text.

Pipeline Overview Stages

Overview

Leads

Status

Tags

Pipeline (CRM)

Webhooks

Custom Fields

Cadences

Conversations

Messages

Departments

File Uploads

Templates (Meta/Gupshup)

Follow-up

Pipelines and Groups

List pipelines and groups

Response

Get a pipeline

Create a pipeline

Request Body

Configure a pipeline

Request Body

Reorder a pipeline

Request Body

Delete a pipeline

Groups

List groups

Create a group

Rename a group

Delete a group

​List pipelines and groups

​Response

​Get a pipeline

​Create a pipeline

​Request Body

​Configure a pipeline

​Request Body

​Reorder a pipeline

​Request Body

​Delete a pipeline

​Groups

​List groups

​Create a group

​Rename a group

​Delete a group

List pipelines and groups

Response

Get a pipeline

Create a pipeline

Request Body

Configure a pipeline

Request Body

Reorder a pipeline

Request Body

Delete a pipeline

Groups

List groups

Create a group

Rename a group

Delete a group