Documentation Index Fetch the complete documentation index at: https://developers.matchsales.com.br/llms.txt Use this file to discover all available pages before exploring further.
Atualiza parcialmente o funil: campos ausentes permanecem iguais. exitStageId deve identificar uma etapa não final do próprio funil; caso contrário, responde 409. behaviors substitui todo o conjunto e exige PIPELINE_BEHAVIORS. Exige settings.pipelines.
Exemplos
A URL usa o servidor de produção. Defina PIPEFACIL_API_KEY e as variáveis de caminho (como SEQ ou ID) com os identificadores reais. Ajuste o corpo antes de executar: requisições de escrita alteram dados do workspace.
const response = await fetch(`https://pipefacil-server.matchsales.com.br/api/v1/pipelines/${process.env.SEQ}`, { method: "PATCH", headers: { Authorization: `Bearer ${process.env.PIPEFACIL_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "description": "Funil de novas oportunidades."}),});if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);const text = await response.text();const data = text ? JSON.parse(text) : null;
Python
import osimport jsonimport requestsresponse = requests.request( "PATCH", f"https://pipefacil-server.matchsales.com.br/api/v1/pipelines/{os.environ['SEQ']}", headers={"Authorization": f"Bearer {os.environ['PIPEFACIL_API_KEY']}"}, json=json.loads("{\n \"description\": \"Funil de novas oportunidades.\"\n}"),)response.raise_for_status()data = response.json() if response.content else None
Parâmetros
Nome
Local
Tipo
Obrigatório
Descrição
seq
path
integer
Sim
Número sequencial do funil no workspace (seq).
Corpo da requisição
Content-Type: application/json · obrigatório
{ "description": "Funil de novas oportunidades."}
Campo
Tipo
Obrigatório no objeto
Descrição
name
string
Não
Até 255 caracteres.
description
string
Não
Omitir ou enviar null preserva a descrição; texto em branco a remove. Aceita null. Até 2000 caracteres.
isDefault
boolean
Não
true define este funil como padrão do workspace.
exitStageId
string
Não
Etapa não final deste funil.
behaviors
array
Não
Substitui todo o conjunto.
attendanceQueueStageId
string
Não
Etapa não final do próprio funil. Adiciona attendance_queue a behaviors. Um valor em branco limpa a configuração e remove o comportamento.
pipelineType
string
Não
Entrada legada, ignorada. Configure behaviors para definir o comportamento do funil. Valores: standard, recurring_clients. Aceita null.
Esquema OpenAPI
{ "type": "object", "description": "Todos os campos são opcionais; campos ausentes permanecem iguais.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "nullable": true, "maxLength": 2000, "description": "Omitir ou enviar `null` preserva a descrição; texto em branco a remove." }, "isDefault": { "type": "boolean", "description": "`true` define este funil como padrão do workspace." }, "exitStageId": { "type": "string", "description": "Etapa não final deste funil." }, "behaviors": { "type": "array", "items": { "$ref": "#/components/schemas/PipelineBehavior" }, "description": "Substitui todo o conjunto." }, "attendanceQueueStageId": { "type": "string", "description": "Etapa não final do próprio funil. Adiciona `attendance_queue` a `behaviors`. Um valor em branco limpa a configuração e remove o comportamento." }, "pipelineType": { "type": "string", "nullable": true, "deprecated": true, "enum": [ "standard", "recurring_clients" ], "description": "Entrada legada, ignorada. Configure behaviors para definir o comportamento do funil." } }, "example": { "description": "Funil de novas oportunidades." }}
Respostas
200Sucesso: funil com todas as etapas.
Campo
Tipo
Descrição
data
Pipeline
—
data.id
string
—
data.seq
integer
Número sequencial no workspace usado em /api/v1/pipelines/{seq}.
data.position
integer
Ordem de exibição entre os funis ativos.
data.name
string
—
data.description
string
Aceita null.
data.isDefault
boolean
—
data.isArchived
boolean
—
data.exitStageId
string
Aceita null.
data.pipelineType
string
Derivado de behaviors; mantido por compatibilidade. Valores: standard, recurring_clients.
data.behaviors
array
—
data.attendanceQueueStageId
string
Aceita null.
data.stages
array
Etapas em ordem: ativas primeiro, seguidas das etapas finais de ganho e perda.
data.stages[].id
string
Identificador da etapa usado em stageId na API, por exemplo, em POST /api/v1/deals.
data.stages[].seq
integer
—
data.stages[].order
integer
—
data.stages[].name
string
—
data.stages[].color
string
—
data.stages[].description
string
Condição esperada para o negócio estar nesta etapa. Usada como contexto pela CIA. Aceita null.
403Autenticado, mas sem acesso: falta de permissão (`FORBIDDEN`), recurso desligado no workspace (`FEATURE_DISABLED`) ou tentativa de acessar uma agenda não permitida.
409Conflito de estado, como um negócio aberto duplicado para o contato/funil, ou limite do plano atingido (`QUOTA_EXCEEDED`), como na criação de um funil além da cota.
