PEPINO ZAPdocs
Referência da APIFluxos

Cria um fluxo

Ver como Markdown
POST
/v1/flows

Cria um fluxo (cabecalho, sem nos ainda). name e obrigatorio. instanceId (opcional) vincula o fluxo a uma instancia do Projeto; instancia de outro Projeto/modo retorna 400. triggerType e any (qualquer mensagem inicia) ou keyword (so quando triggerValue aparece no texto recebido); valor diferente vira any. O fluxo nasce INATIVO — adicione os nos e ative com PATCH.

Authorization

bearerAuth
AuthorizationBearer <token>

API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/flows" \  -H "Content-Type: application/json" \  -d '{    "name": "Atendimento inicial",    "instanceId": "inst_01HV9Z3K8Q",    "triggerType": "any"  }'
{
  "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"
  }
}