Referência da APIFunil
Cria uma etapa no funil
Adiciona uma etapa. name e obrigatorio; rule define quando uma conversa entra nesta etapa (veja StageRule e o guia do funil). posicaoX/posicaoY sao a posicao no canvas; position a ordem (maior = mais avancada no funil).
Authorization
bearerAuth AuthorizationBearer <token>
API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...
In: header
Path Parameters
id*string
Identificador do funil.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/funnels/string/stages" \ -H "Content-Type: application/json" \ -d '{ "name": "Proposta enviada", "color": "amber", "rule": { "status": "open", "labelId": "lbl_01HV9Z3K8Q" }, "posicaoX": 320, "posicaoY": 120, "position": 2 }'{
"id": "string"
}{
"error": {
"code": "BAD_REQUEST",
"message": "Body invalido"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "API key ausente ou invalida"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Projeto inativo ou sem permissao"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Instancia nao encontrada"
}
}