Criar etapa do funil

POST/api/v1/pipelines/{seq}/stages

Acrescenta uma etapa ativa antes das etapas finais de ganho e perda e retorna o funil atualizado. isWon/isLost são definidos pelo sistema: enviá-los resulta em 400. 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.

cURL

curl --request POST \
  --url "https://pipefacil-server.matchsales.com.br/api/v1/pipelines/$SEQ/stages" \
  --header "Authorization: Bearer $PIPEFACIL_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "name": "Proposta",
  "color": "#2563eb"
}'

JavaScript

const response = await fetch(`https://pipefacil-server.matchsales.com.br/api/v1/pipelines/${process.env.SEQ}/stages`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.PIPEFACIL_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "name": "Proposta",
  "color": "#2563eb"
}),
});

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 os
import json
import requests

response = requests.request(
    "POST",
    f"https://pipefacil-server.matchsales.com.br/api/v1/pipelines/{os.environ['SEQ']}/stages",
    headers={"Authorization": f"Bearer {os.environ['PIPEFACIL_API_KEY']}"},
    json=json.loads("{\n  \"name\": \"Proposta\",\n  \"color\": \"#2563eb\"\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

{
  "name": "Proposta",
  "color": "#2563eb"
}

Campo	Tipo	Obrigatório no objeto	Descrição
`name`	`string`	Sim	Até 255 caracteres.
`color`	`string`	Não	Cor hexadecimal. Padrão: `#6366f1`.
`description`	`string`	Não	Opcional. Condição esperada para o negócio estar nesta etapa; usada como contexto pela CIA. Aceita null. Até 2000 caracteres.

Esquema OpenAPI

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "color": {
      "type": "string",
      "pattern": "^#[0-9a-fA-F]{6}$",
      "example": "#6366f1",
      "description": "Cor hexadecimal. Padrão: `#6366f1`."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 2000,
      "description": "Opcional. Condição esperada para o negócio estar nesta etapa; usada como contexto pela CIA."
    }
  },
  "example": {
    "name": "Proposta",
    "color": "#2563eb"
  }
}

Respostas

201Criado: 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.
`data.stages[].isWon`	`boolean`	—
`data.stages[].isLost`	`boolean`	—
`data.stages[].isRequired`	`boolean`	—
`data.stages[].requiredMilestoneFieldId`	`string`	Aceita null.
`data.stages[].dealCount`	`integer`	Formato: int64.
`data.createdAt`	`string`	Formato: date-time.
`data.updatedAt`	`string`	Formato: date-time.
`message`	`string`	Aceita null.

Esquema OpenAPI

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/Pipeline"
    },
    "message": {
      "type": "string",
      "nullable": true
    }
  }
}

400Falha de validação dos campos; `fieldErrors` contém os erros.

Campo	Tipo	Descrição
`error`	`string`	—
`code`	`string`	Valores: BAD_REQUEST, VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, FEATURE_DISABLED, NOT_FOUND, CONFLICT, QUOTA_EXCEEDED, UNPROCESSABLE_ENTITY, INTERNAL_ERROR, SERVICE_UNAVAILABLE.
`requestId`	`string`	—
`details`	`string`	Aceita null.
`fieldErrors`	`array`	Aceita null.
`fieldErrors[].field`	`string`	—
`fieldErrors[].message`	`string`	—

Esquema OpenAPI

{
  "type": "object",
  "description": "Formato padrão de erro. `details` e `fieldErrors` são omitidos quando ausentes.",
  "properties": {
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "enum": [
        "BAD_REQUEST",
        "VALIDATION_ERROR",
        "UNAUTHORIZED",
        "FORBIDDEN",
        "FEATURE_DISABLED",
        "NOT_FOUND",
        "CONFLICT",
        "QUOTA_EXCEEDED",
        "UNPROCESSABLE_ENTITY",
        "INTERNAL_ERROR",
        "SERVICE_UNAVAILABLE"
      ]
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "type": "string",
      "nullable": true
    },
    "fieldErrors": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "error",
    "code",
    "requestId"
  ]
}

401Chave ausente, malformada, desconhecida, revogada ou expirada, ou membro emissor inativo.

Campo	Tipo	Descrição
`error`	`string`	—
`code`	`string`	Valores: BAD_REQUEST, VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, FEATURE_DISABLED, NOT_FOUND, CONFLICT, QUOTA_EXCEEDED, UNPROCESSABLE_ENTITY, INTERNAL_ERROR, SERVICE_UNAVAILABLE.
`requestId`	`string`	—
`details`	`string`	Aceita null.
`fieldErrors`	`array`	Aceita null.
`fieldErrors[].field`	`string`	—
`fieldErrors[].message`	`string`	—

Esquema OpenAPI

{
  "type": "object",
  "description": "Formato padrão de erro. `details` e `fieldErrors` são omitidos quando ausentes.",
  "properties": {
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "enum": [
        "BAD_REQUEST",
        "VALIDATION_ERROR",
        "UNAUTHORIZED",
        "FORBIDDEN",
        "FEATURE_DISABLED",
        "NOT_FOUND",
        "CONFLICT",
        "QUOTA_EXCEEDED",
        "UNPROCESSABLE_ENTITY",
        "INTERNAL_ERROR",
        "SERVICE_UNAVAILABLE"
      ]
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "type": "string",
      "nullable": true
    },
    "fieldErrors": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "error",
    "code",
    "requestId"
  ]
}

403Autenticado, mas sem acesso: falta de permissão (`FORBIDDEN`), recurso desligado no workspace (`FEATURE_DISABLED`) ou tentativa de acessar uma agenda não permitida.

Campo	Tipo	Descrição
`error`	`string`	—
`code`	`string`	Valores: BAD_REQUEST, VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, FEATURE_DISABLED, NOT_FOUND, CONFLICT, QUOTA_EXCEEDED, UNPROCESSABLE_ENTITY, INTERNAL_ERROR, SERVICE_UNAVAILABLE.
`requestId`	`string`	—
`details`	`string`	Aceita null.
`fieldErrors`	`array`	Aceita null.
`fieldErrors[].field`	`string`	—
`fieldErrors[].message`	`string`	—

Esquema OpenAPI

{
  "type": "object",
  "description": "Formato padrão de erro. `details` e `fieldErrors` são omitidos quando ausentes.",
  "properties": {
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "enum": [
        "BAD_REQUEST",
        "VALIDATION_ERROR",
        "UNAUTHORIZED",
        "FORBIDDEN",
        "FEATURE_DISABLED",
        "NOT_FOUND",
        "CONFLICT",
        "QUOTA_EXCEEDED",
        "UNPROCESSABLE_ENTITY",
        "INTERNAL_ERROR",
        "SERVICE_UNAVAILABLE"
      ]
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "type": "string",
      "nullable": true
    },
    "fieldErrors": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "error",
    "code",
    "requestId"
  ]
}

404Recurso não encontrado ou fora da visibilidade do membro.

Campo	Tipo	Descrição
`error`	`string`	—
`code`	`string`	Valores: BAD_REQUEST, VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, FEATURE_DISABLED, NOT_FOUND, CONFLICT, QUOTA_EXCEEDED, UNPROCESSABLE_ENTITY, INTERNAL_ERROR, SERVICE_UNAVAILABLE.
`requestId`	`string`	—
`details`	`string`	Aceita null.
`fieldErrors`	`array`	Aceita null.
`fieldErrors[].field`	`string`	—
`fieldErrors[].message`	`string`	—

Esquema OpenAPI

{
  "type": "object",
  "description": "Formato padrão de erro. `details` e `fieldErrors` são omitidos quando ausentes.",
  "properties": {
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "enum": [
        "BAD_REQUEST",
        "VALIDATION_ERROR",
        "UNAUTHORIZED",
        "FORBIDDEN",
        "FEATURE_DISABLED",
        "NOT_FOUND",
        "CONFLICT",
        "QUOTA_EXCEEDED",
        "UNPROCESSABLE_ENTITY",
        "INTERNAL_ERROR",
        "SERVICE_UNAVAILABLE"
      ]
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "type": "string",
      "nullable": true
    },
    "fieldErrors": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "error",
    "code",
    "requestId"
  ]
}

429Limite de requisições excedido por workspace ou IP.

Campo	Tipo	Descrição
`error`	`string`	—
`code`	`string`	Valores: BAD_REQUEST, VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, FEATURE_DISABLED, NOT_FOUND, CONFLICT, QUOTA_EXCEEDED, UNPROCESSABLE_ENTITY, INTERNAL_ERROR, SERVICE_UNAVAILABLE.
`requestId`	`string`	—
`details`	`string`	Aceita null.
`fieldErrors`	`array`	Aceita null.
`fieldErrors[].field`	`string`	—
`fieldErrors[].message`	`string`	—

Esquema OpenAPI

{
  "type": "object",
  "description": "Formato padrão de erro. `details` e `fieldErrors` são omitidos quando ausentes.",
  "properties": {
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "enum": [
        "BAD_REQUEST",
        "VALIDATION_ERROR",
        "UNAUTHORIZED",
        "FORBIDDEN",
        "FEATURE_DISABLED",
        "NOT_FOUND",
        "CONFLICT",
        "QUOTA_EXCEEDED",
        "UNPROCESSABLE_ENTITY",
        "INTERNAL_ERROR",
        "SERVICE_UNAVAILABLE"
      ]
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "type": "string",
      "nullable": true
    },
    "fieldErrors": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "error",
    "code",
    "requestId"
  ]
}

OpenAPI JSON Markdown desta operação

Criar etapa do funil

Exemplos

cURL

Parâmetros

Corpo da requisição

Respostas

Precisa de ajuda?