PEPINO ZAPdocs
Referência da APIFluxos

Atualiza um fluxo (incl. ativar/desativar)

Ver como Markdown
PATCH
/v1/flows/{id}

Atualiza cabecalho do fluxo. Campos omitidos ficam como estao. Passar active: true ATIVA o fluxo e desativa automaticamente os outros da mesma instancia (so 1 ativo por numero) — conflito de unicidade retorna 409. active: false desativa.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Identificador do fluxo.

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 PATCH "https://example.com/v1/flows/string" \  -H "Content-Type: application/json" \  -d '{    "active": true  }'
Empty
{
  "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"
  }
}
{
  "error": {
    "code": "CONFLICT",
    "message": "limite de numeros do plano atingido — adicione um numero em \"Meu plano\""
  }
}