Pipelines & stages

Discover the pipeline and stage IDs used when creating and moving leads (plus the lost reasons) and create, update, delete or install ready-made pipelines. Read = `pipelines:read` · write = `pipelines:write`.

Base URLhttps://app.syncro.chat/api/v1AuthX-API-Key: crm_SUA_CHAVE_AQUI

List pipelines and stages

GET/pipelines

Permission: pipelines:read

Returns all account pipelines with their stages (in order) and the list of lost reasons.

Request

curl "https://app.syncro.chat/api/v1/pipelines" \
  -H "X-API-Key: crm_SUA_CHAVE_AQUI"

Response

{
  "success": true,
  "pipelines": [
    {
      "id": 1,
      "name": "Vendas",
      "stages": [
        {
          "id": 5,
          "name": "Prospecção",
          "color": "#FF6B6B",
          "is_won": false,
          "is_lost": false
        },
        {
          "id": 6,
          "name": "Proposta",
          "color": "#4ECDC4",
          "is_won": false,
          "is_lost": false
        },
        {
          "id": 10,
          "name": "Ganho",
          "color": "#95E1D3",
          "is_won": true,
          "is_lost": false
        },
        {
          "id": 11,
          "name": "Perdido",
          "color": "#9CA3AF",
          "is_won": false,
          "is_lost": true
        }
      ]
    }
  ],
  "lost_reasons": [
    {
      "id": 1,
      "name": "Preço alto"
    },
    {
      "id": 3,
      "name": "Escolheu concorrente"
    }
  ]
}

Stage fields

Field	Description
`is_won`	`true` on won stages (used in `PUT /leads/{id}/won`)
`is_lost`	`true` on lost stages (used in `PUT /leads/{id}/lost`)

The lost_reasons feed the reason_id parameter of PUT /leads/{id}/lost.

Create and update pipelines

Beyond listing, you can create, update, delete and install ready-made pipelines.

Re-importable spec. GET /pipelines/{id} returns {name, color, auto_create_*, stages:[{name, is_won, is_lost, required_tasks:[...]}]} — the same object POST/PUT accept back.
Auto-capture starts OFF via API (auto_create_from_whatsapp / auto_create_from_instagram). Turn it on explicitly for the pipeline to capture WhatsApp/Instagram leads.
validate_only: true = dry-run (responds 200 with errors/warnings, writing nothing).
PUT replaces everything. Stages are matched by name, tasks by subject — the ones that remain keep their lead links; removing a stage that still has leads is rejected (stage_has_leads), so move the leads first.
A duplicate name on POST returns 422 name_conflict — POST never overwrites; use PUT to update.
Including one is_won and one is_lost stage is recommended: without them leads cannot be marked as won or lost (this is a warning, not an error).

Fetch a pipeline

GET/pipelines/1

Permission: pipelines:read

Returns the pipeline status plus the re-importable spec (the same object accepted in POST/PUT).

Request

curl "https://app.syncro.chat/api/v1/pipelines/1" \
  -H "X-API-Key: crm_SUA_CHAVE_AQUI"

Response

{
  "success": true,
  "data": {
    "id": 1,
    "is_default": true,
    "stage_count": 3,
    "lead_count": 128,
    "spec": {
      "name": "Funil de Vendas",
      "color": "#007DFF",
      "auto_create_from_whatsapp": false,
      "auto_create_from_instagram": false,
      "stages": [
        {
          "name": "Novo",
          "is_won": false,
          "is_lost": false,
          "required_tasks": [
            {
              "subject": "Ligar",
              "task_type": "call",
              "priority": "high"
            }
          ]
        },
        {
          "name": "Ganho",
          "is_won": true,
          "is_lost": false,
          "required_tasks": []
        },
        {
          "name": "Perdido",
          "is_won": false,
          "is_lost": true,
          "required_tasks": []
        }
      ]
    }
  }
}

Create pipeline

POST/pipelines

Permission: pipelines:write

Body parameters

namestringrequired

Pipeline name. If it already exists, returns 422 name_conflict

stagesarrayrequired

Pipeline stages, in order

stages[].namestringrequired

Stage name (the key PUT uses to match stages)

stages[].is_wonbooleanoptional

Marks the won stage

stages[].is_lostbooleanoptional

Marks the lost stage

stages[].required_tasksarrayoptional

Required tasks of the stage: { subject, task_type, priority } (matched by subject on PUT)

colorstringoptional

Pipeline color (hex)

auto_create_from_whatsappbooleanoptional

Automatically captures WhatsApp leads. Defaults to false via API

auto_create_from_instagrambooleanoptional

Automatically captures Instagram leads. Defaults to false via API

validate_onlybooleanoptional

Dry-run: validates and returns errors/warnings without writing anything

Request

curl -X POST "https://app.syncro.chat/api/v1/pipelines" \
  -H "X-API-Key: crm_SUA_CHAVE_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Funil de Vendas",
    "stages": [
      {
        "name": "Novo",
        "required_tasks": [
          {
            "subject": "Ligar",
            "task_type": "call",
            "priority": "high"
          }
        ]
      },
      {
        "name": "Ganho",
        "is_won": true
      },
      {
        "name": "Perdido",
        "is_lost": true
      }
    ]
  }'

Response

{
  "success": true,
  "warnings": [],
  "data": {
    "id": 7,
    "is_default": false,
    "stage_count": 3,
    "lead_count": 0,
    "spec": {
      "name": "Funil de Vendas",
      "color": "#007DFF",
      "auto_create_from_whatsapp": false,
      "auto_create_from_instagram": false,
      "stages": [
        {
          "name": "Novo",
          "is_won": false,
          "is_lost": false,
          "required_tasks": [
            {
              "subject": "Ligar",
              "task_type": "call",
              "priority": "high"
            }
          ]
        },
        {
          "name": "Ganho",
          "is_won": true,
          "is_lost": false,
          "required_tasks": []
        },
        {
          "name": "Perdido",
          "is_won": false,
          "is_lost": true,
          "required_tasks": []
        }
      ]
    }
  }
}

Update pipeline

PUT/pipelines/7

Permission: pipelines:write

Replaces the whole spec — send the complete object (do a GET first).

Stages are matched by name and tasks by subject: the ones that remain keep their lead links.

Removing a stage that still has leads is rejected with stage_has_leads — move the leads first.

Request

curl -X PUT "https://app.syncro.chat/api/v1/pipelines/7" \
  -H "X-API-Key: crm_SUA_CHAVE_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Funil de Vendas",
    "stages": [
      {
        "name": "Novo",
        "required_tasks": [
          {
            "subject": "Ligar",
            "task_type": "call",
            "priority": "high"
          }
        ]
      },
      {
        "name": "Proposta"
      },
      {
        "name": "Ganho",
        "is_won": true
      },
      {
        "name": "Perdido",
        "is_lost": true
      }
    ]
  }'

Delete pipeline

DELETE/pipelines/7

Permission: pipelines:write

Request

curl -X DELETE "https://app.syncro.chat/api/v1/pipelines/7" \
  -H "X-API-Key: crm_SUA_CHAVE_AQUI"

Response

{
  "success": true
}

Discover what is valid

GET/pipelines/capabilities

Permission: pipelines:read

Returns the accepted fields, the enums (task_type, priority), the limits and the update rules — always in sync with the server. Check it before assembling a pipeline.

Request

curl "https://app.syncro.chat/api/v1/pipelines/capabilities" \
  -H "X-API-Key: crm_SUA_CHAVE_AQUI"

List ready-made templates

GET/pipelines/templates

Permission: pipelines:read

Lists the official pipeline templates, organized by niche.

Request

curl "https://app.syncro.chat/api/v1/pipelines/templates" \
  -H "X-API-Key: crm_SUA_CHAVE_AQUI"

Install a template

POST/pipelines/templates/funil-de-vendas/install

Permission: pipelines:write

Installs a template into the account. Idempotent by name — installing twice does not duplicate the pipeline.

Request

curl -X POST "https://app.syncro.chat/api/v1/pipelines/templates/funil-de-vendas/install" \
  -H "X-API-Key: crm_SUA_CHAVE_AQUI"