Flows

Definição estrutural do flow: nome e lista ordenada de steps. Um flow nasce em draft, precisa ser published para aceitar execuções, e pode voltar a unpublished para ser editado de novo.

Endpoints Disponíveis

1. Listar Flows

• Método: GET
• Endpoint: /api/v1/flows
• Descrição: Lista todos os flows (definições) da conta, com status draft, published ou unpublished.
• URL: Página de Referência.

2. Criar Flow

• Método: POST
• Endpoint: /api/v1/flows
• Descrição: Cria um novo flow em modo draft, com nome e a lista de steps (acceptance, form, verify, kyc, signature, consent).
• URL: Página de Referência.

3. Obter Flow

• Método: GET
• Endpoint: /api/v1/flows/{id}
• Descrição: Retorna os detalhes de um flow específico, incluindo todos os seus steps.
• URL: Página de Referência.

4. Atualizar Flow

• Método: PUT
• Endpoint: /api/v1/flows/{id}
• Descrição: Atualiza nome e/ou steps de um flow. Só é permitido enquanto o flow não estiver published.
• URL: Página de Referência.

5. Remover Flow

• Método: DELETE
• Endpoint: /api/v1/flows/{id}
• Descrição: Remove (soft delete) um flow.
• URL: Página de Referência.

6. Publicar Flow

• Método: PATCH
• Endpoint: /api/v1/flows/{id}/publish
• Descrição: Publica um flow (draft ou unpublished → published), tornando-o disponível para iniciar execuções.
• URL: Página de Referência.

7. Despublicar Flow

• Método: PATCH
• Endpoint: /api/v1/flows/{id}/unpublish
• Descrição: Despublica um flow (published → unpublished), permitindo editá-lo novamente.
• URL: Página de Referência.