VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/WhatsApp: fluxos do bot

Ligações

Lista, cria e apaga as ligações (setas) que definem qual bloco vem depois de qual.

Uma ligação é uma seta de um bloco para outro. O connection_type diz em que situação a seta é seguida: sempre (next), numa opção de menu (option_N), numa condição (condition_N) ou quando nada casou (default).

Listar as ligações de um fluxo

Devolve as ligações (as setas do desenho do fluxo), agrupadas por bloco de origem.

GET/api/v1/admin/whatsapp/flows/{id}/connectionsAdmin

Lista as ligações de um fluxo

Parâmetros de caminho

iduuidobrigatório
Id do fluxo.

Exemplo de requisição (Listar ligações)

bash
curl "$BASE_URL/api/v1/admin/whatsapp/flows/fa4b0c91-2883-43c6-94ef-86e5b540a2aa/connections" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Listar ligações)

200Ligações devolvidas
json
{
  "flow_id": "fa4b0c91-2883-43c6-94ef-86e5b540a2aa",
  "connections": [
    {
      "id": "532e0273-ca3c-4467-a9f5-5fdba15d7163",
      "flow_id": "fa4b0c91-2883-43c6-94ef-86e5b540a2aa",
      "from_block_id": "b8c1057a-d5b6-448f-af73-31734882b110",
      "to_block_id": "c9f47922-b163-47f0-a7db-8345287707fc",
      "connection_type": "option_0",
      "order_index": 0,
      "created_at": "2026-07-21T15:30:19.581855Z",
      "updated_at": "2026-07-21T15:30:19.581855Z"
    }
  ]
}

Campos da resposta

flow_iduuid
O fluxo pedido.
connectionsarray

Ligações do fluxo.

iduuid
Identificador da ligação.
flow_iduuid
Fluxo da ligação.
from_block_iduuid
Bloco de onde a ligação sai.
to_block_iduuid
Bloco para onde a ligação vai.
connection_typestring
Quando a ligação é seguida: next, option_N, condition_N ou default.
labelstring
Rótulo opcional mostrado no editor.
order_indexinteger
Ordem entre as ligações do mesmo bloco.
created_atstring
Criação (RFC 3339, UTC).
updated_atstring
Última alteração (RFC 3339, UTC).

Erros (Listar ligações)

StatusQuandoCorpo
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.{"error":"module_disabled","module":"whatsapp-commerce"} ou {"error":"insufficient privileges","required":"manage_settings"} ou {"error":"admin access required"}
500O id não é um UUID válido, ou falha ao consultar.{"error":"Failed to list connections: ..."}

Adicionar uma ligação

Liga um bloco a outro. O connection_type diz quando o bot segue essa seta.

POST/api/v1/admin/whatsapp/flows/{id}/connectionsAdmin

Liga dois blocos de um fluxo

Parâmetros de caminho

iduuidobrigatório
Id do fluxo.

Corpo da requisição

from_block_iduuidobrigatório
Bloco de origem. Obrigatório.
to_block_iduuidobrigatório
Bloco de destino. Obrigatório.
connection_typestringpadrão: next
Quando seguir: next, option_N (opção N de um menu, de zero), condition_N (ramo N de um condicional) ou default. Texto livre.
labelstring
Rótulo opcional.
order_indexintegerpadrão: 0
Ordem entre as ligações do mesmo bloco.

Exemplo de requisição (Adicionar uma ligação)

bash
curl -X POST "$BASE_URL/api/v1/admin/whatsapp/flows/fa4b0c91-2883-43c6-94ef-86e5b540a2aa/connections" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "from_block_id": "b8c1057a-d5b6-448f-af73-31734882b110",
    "to_block_id": "c9f47922-b163-47f0-a7db-8345287707fc",
    "connection_type": "option_0"
  }'

Resposta (Adicionar uma ligação)

201Ligação criada
json
{
  "id": "532e0273-ca3c-4467-a9f5-5fdba15d7163",
  "flow_id": "fa4b0c91-2883-43c6-94ef-86e5b540a2aa",
  "from_block_id": "b8c1057a-d5b6-448f-af73-31734882b110",
  "to_block_id": "c9f47922-b163-47f0-a7db-8345287707fc",
  "connection_type": "option_0",
  "order_index": 0,
  "created_at": "2026-07-21T15:30:19.581855Z",
  "updated_at": "2026-07-21T15:30:19.581855Z"
}

Campos da resposta

iduuid
Identificador da ligação.
flow_iduuid
Fluxo da ligação.
from_block_iduuid
Bloco de onde a ligação sai.
to_block_iduuid
Bloco para onde a ligação vai.
connection_typestring
Quando a ligação é seguida: next, option_N, condition_N ou default.
labelstring
Rótulo opcional mostrado no editor.
order_indexinteger
Ordem entre as ligações do mesmo bloco.
created_atstring
Criação (RFC 3339, UTC).
updated_atstring
Última alteração (RFC 3339, UTC).

Erros (Adicionar uma ligação)

StatusQuandoCorpo
400Corpo que não é JSON, from_block_id ou to_block_id ausentes, um id que não é UUID, ou uma segunda ligação ativa com o mesmo connection_type saindo do mesmo bloco.{"error":"whatsapp/flows: from_block_id and to_block_id are required"} ou {"error":"whatsapp/flows: insert connection: pq: duplicate key value violates unique constraint ..."}
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.{"error":"module_disabled","module":"whatsapp-commerce"} ou {"error":"insufficient privileges","required":"manage_settings"} ou {"error":"admin access required"}
A rota não confere o grafo

Ela não verifica se os blocos pertencem ao fluxo. Ela recusa (400) uma segunda ligação com o mesmo connection_type saindo do mesmo bloco. Rode GET /flows/{id}/validate para achar problemas como unknown_block_ref.

Apagar uma ligação

Remove a seta entre dois blocos (remoção lógica). Os blocos continuam.

DELETE/api/v1/admin/whatsapp/connections/{conn_id}Admin

Apaga uma ligação

Parâmetros de caminho

conn_iduuidobrigatório
Id da ligação.

Exemplo de requisição (Apagar uma ligação)

bash
curl -X DELETE "$BASE_URL/api/v1/admin/whatsapp/connections/532e0273-ca3c-4467-a9f5-5fdba15d7163" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Apagar uma ligação)

200Ligação apagada
json
{
  "status": "deleted",
  "id": "532e0273-ca3c-4467-a9f5-5fdba15d7163"
}

Campos da resposta

statusstring
deleted
Sempre deleted.
iduuid
O id enviado.

Erros (Apagar uma ligação)

StatusQuandoCorpo
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.{"error":"module_disabled","module":"whatsapp-commerce"} ou {"error":"insufficient privileges","required":"manage_settings"} ou {"error":"admin access required"}
500O id não é um UUID válido, ou falha ao apagar.{"error":"Failed to delete connection: ..."}
Também responde 200 se não existir

Como nas outras remoções, um id inexistente ou já apagado devolve deleted.

Veja também

  • Blocos
  • Ler fluxos
Anterior
Blocos
Próxima
Testar um fluxo
Nesta página
  • Listar as ligações de um fluxo
  • Exemplo de requisição (Listar ligações)
  • Resposta (Listar ligações)
  • Erros (Listar ligações)
  • Adicionar uma ligação
  • Exemplo de requisição (Adicionar uma ligação)
  • Resposta (Adicionar uma ligação)
  • Erros (Adicionar uma ligação)
  • Apagar uma ligação
  • Exemplo de requisição (Apagar uma ligação)
  • Resposta (Apagar uma ligação)
  • Erros (Apagar uma ligação)
  • Veja também