{
  "info": {
    "_postman_id": "7aae7e73-6c9d-4f63-a7f7-85ba549a26e8",
    "name": "FlowZap API 1.3.0-preview.20261116",
    "description": "Gerada de /openapi.json (OpenAPI 3.1.0). Preencha as variáveis da coleção: host, workspace_id, instance_id e api_key (a chave fica só no seu Postman).",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{api_key}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "host",
      "value": "https://flowzap.flowpost.com.br",
      "type": "string"
    },
    {
      "key": "workspace_id",
      "value": "",
      "type": "string"
    },
    {
      "key": "instance_id",
      "value": "",
      "type": "string"
    },
    {
      "key": "api_key",
      "value": "",
      "type": "string"
    }
  ],
  "item": [
    {
      "name": "Áreas de trabalho e operações",
      "description": "Áreas de trabalho visíveis para a chave e o resultado de operações que responderam 202.",
      "item": [
        {
          "name": "Consultar uma operação",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/operations/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "operations",
                ":id"
              ],
              "query": [
                {
                  "key": "envelope",
                  "value": "",
                  "description": "`1` responde sempre 200 com o estado dentro de `data` (ver acima).",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Resultado de uma operação que respondeu 202. Mesmo formato da resposta original: 200 com `data`, 202 enquanto roda (com `Retry-After: 1`: espere ao menos 1 s antes de perguntar de novo), 422/502/504 se terminou sem sucesso. Resultados com dados de pessoas (`group.list`, `group.info`, `contact.list`, `contact.check`, `contact.avatar`, `message.download`) são apagados 1 hora depois (410 `result_expired`), e o telefone que só o número conhece vem oculto sem o escopo `audiences:export`. A coleta de um público é interna e não aparece aqui.\n\n**Envelope (`?envelope=1`).** Sempre 200, com o estado dentro: `{\"data\": {\"id\", \"kind\", \"state\", \"result\", \"error\", \"created_at\", \"updated_at\", \"expires_at\"}}`. `state`: `queued`/`running` (ainda roda; `Retry-After: 1`), `succeeded` (`result` preenchido, ou `null` com `error.code` `result_expired`), `failed` (`error.code` do WhatsApp, `retryable: false`), `unknown` (`outcome_unknown` ou o código do motor, `retryable: false`: confira antes de repetir), `expired` (`engine_timeout`, `retryable: true`: nada foi feito). Sem o parâmetro, a resposta não muda.\n\nEscopo: `engine:read`; com só `calls:read` ou `calls:write`, apenas operações de ligação (as demais respondem 404)."
          }
        },
        {
          "name": "Ver plano, limites e uso da conta",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/account",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "account"
              ]
            },
            "description": "O plano em vigor da organização da chave, de onde ele vem (`source`: `subscription` assinatura, `license` licença, `courtesy` cortesia, `none` sem plano), os limites, os recursos do plano (`features`: `api`, `mcp`) e o uso atual. Cortesia e conta sem plano não têm `plan.code`: a cortesia usa os limites do Growth; sem plano, os do Start. Um limite `null` significa que o catálogo não tem versão do plano para lê-lo. `webhook_endpoints` vale por área de trabalho; `webhook_endpoints_used` soma a organização. `requests_this_minute` já conta este pedido.\n\nEscopo: `account:read` (chaves criadas antes dele: `workspaces:read`)."
          }
        },
        {
          "name": "Baixar os dados da conta",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/account/export",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "account",
                "export"
              ]
            },
            "description": "O mesmo arquivo de \"Baixar meus dados\" do console: um JSON com a conta, a equipe, os números, contatos e CRM, etiquetas, respostas rápidas e todas as mensagens guardadas, já abertas. É gerado na hora e enviado aos poucos (nunca fica guardado); o arquivo completo termina com `\"completo\": true` — sem isso, a transferência foi interrompida e vale baixar de novo.\n\nSó para uma chave da organização inteira (presa a área de trabalho ou número: 403 `scope_denied`) criada por quem é **dona da conta** agora (senão 403 `owner_required`). Conta nas 3 vezes por hora dessa pessoa, somando console e API (429 `rate_limited`), e fica registrado no histórico da equipe com a chave usada. Conta suspensa baixa pelo console.\n\nEscopo: `account:read` (o `workspaces:read` aceito em `GET /v1/account` não vale aqui)."
          }
        },
        {
          "name": "Listar áreas de trabalho",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces"
              ],
              "query": [
                {
                  "key": "limit",
                  "value": "",
                  "description": "Itens por página (1 a 200).",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "`next_cursor` da página anterior (opaco).",
                  "disabled": true
                }
              ]
            },
            "description": "Em ordem de nome. Uma chave presa a uma área de trabalho vê só ela.\n\n**Páginas:** `limit` (1 a 200, padrão 200) e `cursor`. Quando há mais, a resposta traz `next_cursor`; repita com `cursor=<next_cursor>` até vir `null`. Sem parâmetros, a resposta é a de sempre (as primeiras 200) mais `next_cursor`. Cursor inválido (ou de outra lista): 400 `invalid_cursor`.\n\nEscopo: `workspaces:read`."
          }
        },
        {
          "name": "Ler uma área de trabalho",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}"
              ]
            },
            "description": "Escopo: `workspaces:read`."
          }
        }
      ]
    },
    {
      "name": "Números",
      "description": "Criar, conectar por QR code, desconectar e excluir números; fila de envios, intervalo entre envios e proxy.",
      "item": [
        {
          "name": "Listar números",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances"
              ],
              "query": [
                {
                  "key": "limit",
                  "value": "",
                  "description": "Itens por página (1 a 200).",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "`next_cursor` da página anterior (opaco).",
                  "disabled": true
                }
              ]
            },
            "description": "Os números da área de trabalho, os mais novos primeiro, com a mesma situação que o console mostra na visão geral. Uma chave presa a um número vê só ele; presa a outra área de trabalho, 404.\n\n**Páginas:** `limit` (1 a 200, padrão 200) e `cursor`. Quando há mais, a resposta traz `next_cursor`; repita o pedido com `cursor=<next_cursor>` até vir `null`. Sem parâmetros, a resposta é a de sempre (os primeiros 200) mais `next_cursor`. Um cursor inválido (ou de outra lista) responde 400 `invalid_cursor`.\n\n**Telefone do número:** `phone_masked` para qualquer chave com acesso; `phone` (completo, E.164) só para chaves com `instances:read` — é o número da própria empresa conectado ao WhatsApp. `last_phone_masked` é o telefone mascarado da última conexão (mesmo depois que o celular desconectou): é com ele que se lê o QR ao reconectar. `phone_changed` é `true` quando o número foi reconectado com outro telefone.\n\n`session_status`: `none` (ainda sem sessão), `unpaired` (sem vaga reservada), `reservation_expired` (a reserva para conectar venceu), `awaiting_worker`, `partial_worker` e `awaiting_start` (preparando a conexão), `connected` (conectado e enviando), `unavailable` (conectado, mas fora do ar agora), ou a situação da sessão (`pairing`, `reconnecting`, `offline`, `needs_pairing`, `revoked`, `blocked`, `paused`). Para os detalhes de um número, `GET …/instances/{instanceId}/status`.\n\nEscopo: `instances:read` (ou `engine:read`)."
          }
        },
        {
          "name": "Criar número",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": false,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Cria o número (ainda sem WhatsApp conectado). Exige `Idempotency-Key`. Chave presa a um número não pode criar outro.\n\nEscopo: `instances:write`."
          }
        },
        {
          "name": "Renomear número",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Excluir número",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}"
              ]
            },
            "description": "Libera a vaga e cancela a fila. O número precisa estar desconectado antes (`POST /disconnect`).\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Iniciar conexão por QR code",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/connect",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "connect"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"phone\": \"+5511912345678\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Reserva a vaga e inicia o pareamento; leia o QR em `GET /qr`. Com `phone` (pareamento por código no telefone) responde **501 `not_supported_by_engine`**.\n\n**Reconectar um número já usado.** Quando o celular desconectou o número (`session_state` `needs_pairing` ou `revoked`) ou uma reconexão anterior venceu sem leitura do QR, a mesma rota começa um pareamento novo no mesmo número: a sessão antiga é encerrada, a vaga do número é trocada pela nova reserva (não ocupa outra vaga do plano, mesmo no limite) e os envios ainda na fila (`queued`) são cancelados com `message.canceled`. Conversas, campanhas, ajustes e a sequência de eventos do número continuam. Pode ler o QR com outro telefone: a lista de números mostra `last_phone_masked` antes e `phone_changed` depois. Repetir enquanto a tentativa está em andamento devolve a mesma reserva (200).\n\nNão reconecta (409): `number_still_linked` (o número continua ligado ao WhatsApp — conectado, reconectando ou fora do ar; use `POST …/restart`), `number_blocked` (bloqueio do WhatsApp), `number_paused` (outra sessão assumiu ou a versão foi recusada), `pairing_recovery_required` (a tentativa anterior ainda está sendo encerrada), `invalid_instance_state` (número excluído ou arquivado).\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Desconectar (sair do WhatsApp)",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/disconnect",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "disconnect"
              ]
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Limites de novas conversas",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/limits",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "limits"
              ]
            },
            "description": "Quando o WhatsApp limita o número a não iniciar conversas novas por um tempo, ele avisa o aparelho; cada aviso vira o evento `instance.reachout_timelock`. Esta rota mostra o **último aviso**: o motor não tem como perguntar o estado ao WhatsApp, então `unknown` significa que nenhum aviso chegou desde a conexão do número (não que não haja limite).\n\nEscopo: `instances:read` (ou `engine:read`)."
          }
        },
        {
          "name": "Ler proxy do número",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/proxy",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "proxy"
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Definir proxy do número",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/proxy",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "proxy"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Vale a partir da próxima conexão (`POST /restart`). O endereço fica cifrado.\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Remover proxy",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/proxy",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "proxy"
              ]
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Proxy gerenciado",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/proxy/managed",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "proxy",
                "managed"
              ]
            },
            "description": "**Não suportado pelo motor do WhatsApp usado hoje.** O FlowZap ainda não oferece proxy próprio; use o seu com `PUT /proxy`. A rota existe, autentica e responde 501 `not_supported_by_engine` (não adianta repetir).\n\nEscopo: `engine:read`."
          }
        },
        {
          "name": "Ler o QR code de pareamento",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/qr",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "qr"
              ]
            },
            "description": "`ready` traz o código para gerar o QR; `pending` (202) ainda está preparando; `linked` já está conectado. Um número que o celular desconectou nunca é `linked`: responde `pending` com `session_state` `needs_pairing` (ou `revoked`) até `POST …/connect` começar a reconexão.\n\nEscopo: `engine:read`."
          }
        },
        {
          "name": "Ver a fila de envios",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/queue",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "queue"
              ],
              "query": [
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ]
            },
            "description": "Escopo: `messages:read` (ou `instances:read`)."
          }
        },
        {
          "name": "Cancelar envios na fila",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/queue",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "queue"
              ]
            },
            "description": "Cancela o que ainda não saiu (`queued`). Cada envio cancelado gera o evento `message.canceled`.\n\nEscopo: `messages:send`."
          }
        },
        {
          "name": "Reservar vaga para conectar",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/reservations",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "reservations"
              ]
            },
            "description": "Reserva a vaga do plano para parear o número. Repetir devolve a mesma reserva (200). Num número já usado que o celular desconectou, reconecta como `POST …/connect`.\n\nEscopo: `instances:write`."
          }
        },
        {
          "name": "Reconectar a sessão",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/restart",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "restart"
              ]
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Ler intervalo entre envios",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/settings/delay",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "settings",
                "delay"
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Definir intervalo entre envios",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/settings/delay",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "settings",
                "delay"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"min_ms\": 0,\n  \"max_ms\": 0\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Ler assinatura do atendente",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/settings/signature",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "settings",
                "signature"
              ]
            },
            "description": "Com a assinatura ligada, as respostas enviadas pelo console começam com o nome de quem respondeu, em negrito e numa linha só (`*Ana:*` e, na linha de baixo, o texto). Vale para texto, legenda de foto, vídeo e documento, e a correção de uma mensagem assinada mantém o nome. Envios pela API não têm atendente e saem sem assinatura.\n\nEscopo: `engine:read`."
          }
        },
        {
          "name": "Ligar ou desligar assinatura do atendente",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/settings/signature",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "settings",
                "signature"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"enabled\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`. Vale para as próximas respostas do console; mensagens já aceitas não mudam."
          }
        },
        {
          "name": "Ler importação de histórico",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/settings/history",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "settings",
                "history"
              ]
            },
            "description": "Ligada (padrão), as conversas que o celular manda logo depois de conectar o número (até 90 dias, 50 mensagens por conversa) são guardadas como histórico: aparecem em `/chats`, nunca geram `message.received`. Desligada, nada desse histórico automático é guardado; um pedido explícito em `POST /chats/{jid}/history-sync` continua sendo atendido.\n\nEscopo: `engine:read`."
          }
        },
        {
          "name": "Ligar ou desligar importação de histórico",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/settings/history",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "settings",
                "history"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"enabled\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`. Vale para o histórico que chegar depois; o que já foi guardado continua (apague pela exclusão de dados da conta)."
          }
        },
        {
          "name": "Situação do número",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/status",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "status"
              ]
            },
            "description": "Situação do número lida do banco (sem ir ao WhatsApp). `phone` (telefone completo do próprio número) só aparece para chaves com `instances:read`; `disconnect_reason` e `last_connection_event` dizem por que ele parou, a partir do último evento `instance.connection`.\n\n**Vocabulário.** Esta rota traz `session_state` (a situação crua da sessão) e `connected`; a lista `GET /v1/workspaces/{id}/instances` traz `session_status`, que resume a mesma situação com a reserva da vaga e o serviço do número:\n\n| `session_status` (lista) | `session_state` (aqui) | Quer dizer |\n|---|---|---|\n| `none` | `null` | Número criado, ainda sem sessão (`POST …/connect`). |\n| `unpaired` | `unpaired` | Sessão sem vaga reservada. |\n| `reservation_expired` | `unpaired` | A reserva para conectar venceu; peça outra. |\n| `awaiting_worker`, `partial_worker`, `awaiting_start` | `unpaired` | Preparando a conexão (o QR vem a seguir). |\n| `pairing` | `pairing` | Esperando a leitura do QR (`GET …/qr`). |\n| `connected` | `connected` (com `connected: true`) | Conectado e enviando. |\n| `unavailable` | `connected` ou `reconnecting` (com `connected: false`) | O WhatsApp está conectado, mas o serviço do número está fora do ar agora (`disconnect_reason: worker_unavailable`). |\n| `reconnecting`, `offline` | igual | Queda de conexão; o FlowZap tenta reconectar. |\n| `needs_pairing`, `revoked` | igual | Desconectado pelo celular: reconecte com `POST …/connect` e leia o novo QR em `GET …/qr`. |\n| `blocked` | `blocked` | Bloqueio do WhatsApp (`disconnect_reason: temporary_ban`). |\n| `paused` | `paused` | Outra sessão assumiu ou a versão foi recusada. |\n\nEscopo: `instances:read` (ou `engine:read`, sem `phone`)."
          }
        },
        {
          "name": "O que esta conexão pode fazer",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/capabilities",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "capabilities"
              ]
            },
            "description": "Matriz de capacidades do número agora, lida do FlowZap (sem ir ao WhatsApp; não gera operação). Serve para a integração decidir antes de chamar: se pode enviar (e por que não), quais tipos de mensagem a API aceita, janelas de edição e de apagar, ligações, gravação, limites e o que o WhatsApp Web não oferece.\n\n- `can_send` / `can_send_reason`: as mesmas regras de `POST …/messages` — `number_not_connected` (503 ao enviar), `numbers_over_limit` (409: a conta passou dos números do plano), `send_unavailable` (503: sem o envio liberado no plano ou sem a vaga do número). `null` quando pode enviar.\n- `new_conversations`: `limited` quando o último aviso do WhatsApp proíbe iniciar conversas novas (`GET …/limits`).\n- `message_types` vem do próprio contrato de envio: o que aparece aqui é aceito por `POST …/messages` (publicações de status ficam em `…/status-posts`). `forward` e `lid.send` refletem o que a versão em produção aceita.\n- `edit.window_minutes` e `revoke.window_hours` são as janelas do WhatsApp; apagar mensagem de outra pessoa em grupo exige ser admin.\n- `calls.mode`: `off`, `test_callers` (beta: só os números de teste da conta) ou `any_caller` (módulo de ligações contratado). Sem vídeo, sem ligação em grupo e sem transferência (veja `unsupported`).\n- `limits.queue` é o máximo de envios aguardando na fila do número (plano); `send_rate_per_minute`/`send_burst` são por chave e número.\n- `engine.version` é `null` enquanto a versão do motor não é publicada.\n\nEscopo: `instances:read` (ou `engine:read`)."
          }
        }
      ]
    },
    {
      "name": "Mensagens e mídia",
      "description": "Envio de todos os tipos de mensagem, consulta do envio, upload e download de mídia.",
      "item": [
        {
          "name": "Buscar envios por referência",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/messages",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "messages"
              ],
              "query": [
                {
                  "key": "client_reference",
                  "value": "",
                  "description": "A referência enviada em `client_reference`.",
                  "disabled": true
                },
                {
                  "key": "provider_message_id",
                  "value": "",
                  "description": "ID da mensagem no WhatsApp (`3EB0…`).",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ]
            },
            "description": "Busca envios pela sua `client_reference` ou pelo ID no WhatsApp (`provider_message_id`): informe exatamente um dos dois. Devolve até `limit` envios (máximo 20), do mais novo ao mais antigo, só dentro do alcance da chave (organização, área de trabalho ou número a que ela pertence).\n\nUse na reconciliação: depois de um timeout ou de um resultado `unknown`, confira o que já foi aceito em vez de enviar de novo.\n\nEscopo: `messages:read`."
          }
        },
        {
          "name": "Consultar um envio",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/messages/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "messages",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Estado atual, tentativa (com `outcome_code` quando falhou), recibos (entregue, lida), origem (`source`: `api` ou `console`) e atendente (`actor_label`). Numa mensagem enviada a um grupo, `receipts` fica vazio e `group_receipts` conta os participantes que receberam e leram (\"lida por X de Y\"); a lista por participante está em `GET /v1/messages/{id}/receipts`.\n\nEscopo: `messages:read`."
          }
        },
        {
          "name": "Quem recebeu e leu (grupos)",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/messages/:id/receipts",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "messages",
                ":id",
                "receipts"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do envio."
                }
              ]
            },
            "description": "Recibos por participante de uma mensagem enviada a um grupo: um item por pessoa, com o primeiro momento em que o celular dela confirmou o recebimento (`delivered_at`) e a leitura (`read_at`). Uma leitura também conta como recebida. `summary.delivered` é quem já recebeu (celular desligado ainda não conta) e `summary.read`, quem leu: \"lida por `read` de `delivered`\". Numa mensagem direta, `group` é `false` e a lista vem vazia (os recibos estão em `GET /v1/messages/{id}`).\n\n`participant` é o telefone quando o próprio WhatsApp o mostra no grupo. Um telefone que só a sessão do número conhece vem mascarado, salvo para chaves com `audiences:export` (a mesma regra de `GET …/groups/{jid}`); sem telefone conhecido, `null`.\n\nA primeira confirmação de um grupo leva o envio a `delivered` (`message.delivered`). Em grupos o envio não passa a `read`: a leitura é por participante. Todos os recibos são gravados, mas as confirmações seguintes geram no máximo um evento `message.receipt` por mensagem a cada 60 segundos (só o ID do envio, como os demais eventos), e não um por participante: ao receber o evento, consulte esta rota para a contagem atual. Em mensagens diretas, `message.receipt` continua chegando a cada recibo que não muda o estado.\n\nEscopo: `messages:read`."
          }
        },
        {
          "name": "Baixar mídia recebida",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/inbound/:inboxId/media",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "inbound",
                ":inboxId",
                "media"
              ],
              "variable": [
                {
                  "key": "inboxId",
                  "value": "",
                  "description": "ID da mensagem recebida (`resource_id` de `message.received`)."
                }
              ]
            },
            "description": "Baixa pelo WhatsApp a foto, vídeo, áudio ou documento de uma mensagem recebida. Se demorar, responde 202 com a operação; repita o mesmo pedido: ele reaproveita o download em andamento em vez de baixar de novo. Mensagem sem mídia responde 404 `media_not_found`.\n\nAceita intervalos de bytes (`Accept-Ranges: bytes`), para tocar e avançar áudio e vídeo: um intervalo `Range: bytes=a-b`, `bytes=a-` ou `bytes=-n` responde 206 com `Content-Range`; começando depois do fim, 416 `range_not_satisfiable` com `Content-Range: bytes */<tamanho>`; vários intervalos ou cabeçalho inválido recebem o arquivo inteiro (200). O intervalo vale quando o download já terminou (enquanto isso, 202 com a operação). Mídia de visualização única nunca é baixada (404 `media_not_found`).\n\nEscopo: `messages:read`."
          }
        },
        {
          "name": "Enviar arquivo de mídia (upload)",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/octet-stream"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/media?kind=",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "media"
              ],
              "query": [
                {
                  "key": "kind",
                  "value": "",
                  "description": "",
                  "disabled": false
                }
              ]
            },
            "body": {
              "mode": "file",
              "file": {}
            },
            "description": "Corpo **binário** (não JSON): os bytes do arquivo, com `Content-Type` do arquivo e `?kind=`. Até 16 MiB. O arquivo fica cifrado e expira em 48 horas. Use o `id` devolvido em `media.id` no envio.\n\nEscopo: `messages:send`."
          }
        },
        {
          "name": "Ler dados de uma mídia",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/media/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "media",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Escopo: `messages:read`."
          }
        },
        {
          "name": "Apagar uma mídia",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/media/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "media",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Escopo: `messages:send`."
          }
        },
        {
          "name": "Listar publicações no Status",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/status-posts",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "status-posts"
              ],
              "query": [
                {
                  "key": "limit",
                  "value": "",
                  "description": "Quantas publicações (1 a 100, padrão 20).",
                  "disabled": true
                }
              ]
            },
            "description": "As publicações no Status feitas por este número pela FlowZap (API, console ou `POST .../messages` com `type: status`), da mais recente para a mais antiga. Não traz o conteúdo nem quem viu.\n\nEscopo: `engine:read`."
          }
        },
        {
          "name": "Publicar no Status",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": false,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/status-posts",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "status-posts"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"type\": \"text\",\n  \"text\": \"Promoção só hoje!\",\n  \"background_color\": \"#128C7E\",\n  \"font\": \"calistoga_regular\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Publica no Status (stories) do WhatsApp do número: texto com cor de fundo e fonte, ou foto/vídeo com legenda. É um envio como os de `POST .../messages` (`type: status`): entra na fila, o resultado chega pelos eventos `message.*` e pode ser acompanhado em `GET /v1/messages/{id}`.\n\n**Quem vê:** a privacidade do Status escolhida no celular (Configurações › Privacidade › Status): \"Meus contatos\", \"Meus contatos, exceto…\" ou \"Compartilhar só com…\". A FlowZap não escolhe nem guarda lista de quem vê.\n\nTexto: até 700 caracteres, sempre em branco; `background_color` em `#RRGGBB` (padrão `#075E54`) e `font` com o nome da fonte do WhatsApp (padrão `system`). Foto ou vídeo: `media_id` de um upload (`POST .../media`) ou `media_url` https — um dos dois. Vídeos do Status costumam ter até 1 minuto.\n\nSe o número não conseguir publicar em 6 horas (celular desligado, por exemplo), a publicação expira (`state: expired`) e não sai mais tarde.\n\nExige `Idempotency-Key`: repetir o mesmo pedido devolve a mesma publicação (`Idempotent-Replay: true`) e nunca publica duas vezes. Mesmo limite de envios de `POST .../messages` (429 `rate_limited`/`queue_full`), plano ativo e pausa por números acima do plano.\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Baixar uma mídia enviada",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/media/:id/content",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "media",
                ":id",
                "content"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Aceita intervalos de bytes (`Accept-Ranges: bytes`), para tocar e avançar áudio e vídeo: um intervalo `Range: bytes=a-b`, `bytes=a-` ou `bytes=-n` responde 206 com `Content-Range`; começando depois do fim, 416 `range_not_satisfiable` com `Content-Range: bytes */<tamanho>`; vários intervalos ou cabeçalho inválido recebem o arquivo inteiro (200).\n\nEscopo: `messages:read`."
          }
        },
        {
          "name": "Enviar mensagem",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": false,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/messages",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "messages"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"to\": {\n    \"kind\": \"phone\",\n    \"value\": \"+5511912345678\"\n  },\n  \"type\": \"text\",\n  \"text\": {\n    \"body\": \"Seu pedido saiu para entrega.\"\n  },\n  \"client_reference\": \"pedido-4821\",\n  \"expires_at\": \"2026-11-01T18:00:00Z\",\n  \"actor_label\": \"Ana (Atendimento)\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Aceita texto, mídia, localização, contato, reação, enquete, edição, apagar, encaminhar, botões, lista, carrossel (beta) e status. A resposta 202 só confirma que a mensagem entrou na fila; o resultado chega pelos eventos `message.*` e por `GET /v1/messages/{id}`.\n\nDestino (`to`): telefone (`phone`, conferido no WhatsApp), grupo (`group`) ou JID de uma conversa individual (`jid`, telefone ou LID, enviado direto). Citações, reações, edições, apagar e encaminhar apontam para qualquer mensagem guardada do número, enviada ou recebida (sem janela das mais recentes). `actor_label` (opcional, 1 a 80) identifica o atendente externo.\n\nGlossário de IDs:\n- `id` do envio (UUID): devolvido aqui; consulte em `GET /v1/messages/{id}`.\n- `provider_message_id`: o ID que a mensagem tem no WhatsApp (`3EB0…`).\n- ID da mensagem recebida (UUID): `resource_id` de `message.received`; usado em `GET …/inbound/{id}` e `GET …/inbound/{inboxId}/media`.\n- `message_id` em `reply_to`, `reaction`, `edit`, `revoke` e `forward`: o ID no WhatsApp de qualquer mensagem, enviada (`provider_message_id`) ou recebida (`message_id`).\n- `client_reference`: a sua referência; busque por ela em `GET /v1/messages?client_reference=…`.\n\nCiclo de estados: `queued` (na fila) → `dispatching` (o motor está enviando) → `provider_accepted` (o WhatsApp aceitou) → `delivered` (chegou ao aparelho) → `read` (lida; mensagens a grupos não chegam a `read`, a leitura é por participante em `GET /v1/messages/{id}/receipts`). Finais sem envio: `failed` (nada saiu; motivo em `attempt.outcome_code`), `expired` (passou de `expires_at` antes de sair), `canceled`. `unknown`: pode ter saído ou não (ex.: a conexão caiu durante o envio); nunca reenvie às cegas, consulte por `client_reference` ou espere os eventos.\n\n\"Apagar só para mim\" e outras ações locais do celular não são suportadas.\n\nExige `Idempotency-Key`: repetir o mesmo pedido devolve o mesmo envio (`Idempotent-Replay: true`) e nunca manda duas vezes.\n\nLimite por chave e número: 60 envios por minuto, com rajada de 10 (429 `rate_limited` + `Retry-After`). Com a fila do número no limite de envios aguardando do plano (`pending_messages` em `GET /v1/account`), novos pedidos recebem 429 `queue_full`.\n\nEscopo: `messages:send`."
          }
        }
      ]
    },
    {
      "name": "Conversas e etiquetas",
      "description": "Leitura das conversas pelo histórico do FlowZap, ações de conversa e de mensagem, etiquetas do WhatsApp.",
      "item": [
        {
          "name": "Listar conversas",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/chats",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "chats"
              ],
              "query": [
                {
                  "key": "search",
                  "value": "",
                  "description": "Parte do nome, telefone ou JID.",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ]
            },
            "description": "Da atividade mais recente para a mais antiga, a partir do histórico guardado pelo FlowZap (as 2000 mensagens mais recentes de cada origem: veja `window`). Para ler uma conversa inteira, sem esse limite, use `GET …/chats/{jid}/messages`.\n\nCada conversa traz o estado que ela tem no WhatsApp — `archived`, `pinned`, `muted`/`muted_until` — e as etiquetas (`labels`), feitos no celular (inclusive antes da conexão: a sincronização inicial do WhatsApp é aplicada) ou pela API. Uma mudança mais antiga nunca desfaz uma mais nova.\n\n`unread_count` conta as mensagens recebidas depois da nossa última resposta, não as não lidas do WhatsApp; a marca de leitura por pessoa existe só no console.\n\nConversas de grupo vêm misturadas às individuais, com `is_group: true` e `jid` do grupo (`…@g.us`); `name` é sempre `null` para grupos (o nome está em `GET …/groups`). As mensagens de um grupo (`GET …/chats/{jid}/messages`) trazem em `sender_jid` quem escreveu. Para responder no grupo, envie com `to: {\"kind\": \"group\", \"value\": \"…@g.us\"}`; respostas e reações a mensagens de um participante usam o mesmo `to`.\n\nEscopo: `messages:read`."
          }
        },
        {
          "name": "Contar conversas",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/chats/count",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "chats",
                "count"
              ]
            },
            "description": "Escopo: `messages:read`."
          }
        },
        {
          "name": "Apagar conversa no WhatsApp",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/chats/:jid",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "chats",
                ":jid"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "description": "Apaga no aparelho; o histórico do FlowZap (auditoria e leituras pela API) continua.\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Arquivar ou desarquivar",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/chats/:jid/archive",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "chats",
                ":jid",
                "archive"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"archive\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Mensagens temporárias da conversa",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/chats/:jid/ephemeral",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "chats",
                ":jid",
                "ephemeral"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"seconds\": 0\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Pedir mensagens antigas ao celular",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/chats/:jid/history-sync",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "chats",
                ":jid",
                "history-sync"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"count\": 50\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Pede ao celular até `count` mensagens anteriores à mais antiga que o FlowZap guardou desta conversa — a mais antiga que o próprio celular informou (recebida, vista no celular ou já importada), em qualquer grafia do contato, sem limite de janela; envios pela API não servem de âncora. Cada novo pedido vai mais para trás. Mesmas regras do botão \"Buscar mensagens anteriores\" do console:\n\n- um pedido por número a cada 30 s (`429 rate_limited`, com `Retry-After`); repetir com a mesma `Idempotency-Key` devolve o primeiro pedido, sem contar de novo;\n- recusado com `409 history_import_off` quando o número está com \"Importar histórico\" desligado;\n- `422 no_known_message` quando não há mensagem guardada desta conversa que o celular tenha informado.\n\nA resposta chega depois, só se o celular estiver online e ainda tiver essas mensagens; ela é guardada como histórico e aparece nas leituras de conversas (`/chats`, `…/messages`), sem gerar `message.received` em webhooks. Se o celular responder em até ~10 s, `data.stored` diz quantas mensagens novas foram guardadas (`0`: nada mais antigo do que já temos); sem `stored`, a resposta ainda pode chegar depois. Limites do WhatsApp: melhor esforço (o WhatsApp decide se o celular atende), até 50 por pedido, só o que ainda está no celular (mensagens apagadas, conversas limpas ou de outro aparelho não voltam), mídia antiga pode não ter download.\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Etiquetas de uma conversa",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/chats/:jid/labels",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "chats",
                ":jid",
                "labels"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Aplicar ou tirar etiqueta da conversa",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/chats/:jid/labels",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "chats",
                ":jid",
                "labels"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"label_id\": \"texto\",\n  \"labeled\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Mensagens de uma conversa",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/chats/:jid/messages",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "chats",
                ":jid",
                "messages"
              ],
              "query": [
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "before",
                  "value": "",
                  "description": "Valor de `next_before` da página anterior desta mesma conversa.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "description": "Da mais nova para a mais antiga, todas as mensagens que o FlowZap guardou desta conversa (recebidas, vistas no celular, enviadas pela API ou pelo console, histórico importado), em todas as grafias conhecidas do contato: o JID pedido, o telefone ↔ LID que o WhatsApp provou ou que a equipe associou em Conversas, e as duas grafias de celular brasileiro (com e sem o nono dígito). Não depende da janela de 2000 mensagens das listas.\n\nPaginação: passe `next_before` em `before` até `end_of_history: true` (com `next_before: null`), que diz que não há nada mais antigo guardado pelo FlowZap. Para trazer mensagens que só o celular ainda tem, use `POST …/chats/{jid}/history-sync` e leia de novo. O cursor é assinado para esta conversa (o mesmo `jid`); usado em outra, responde `400 invalid_cursor`. Cursores emitidos antes desta versão continuam aceitos.\n\n`paging: \"conversation\"` é o modo normal. Logo depois de uma atualização do FlowZap, enquanto as mensagens antigas do número ainda estão sendo indexadas, a resposta pode vir da janela (`paging: \"window\"`, com `window.truncated` e `end_of_history: false` quando há mensagens fora dela); repita depois para ler tudo.\n\nEdições, exclusões e reações aparecem como mensagens próprias (`kind`), e o alvo carregado ganha `edits`/`revoked`; `applied` diz se a mudança valeu (veja `ChatHistoryMessage`).\n\nEscopo: `messages:read`."
          }
        },
        {
          "name": "Silenciar conversa",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/chats/:jid/mute",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "chats",
                ":jid",
                "mute"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"mute\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Fixar ou desafixar conversa",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/chats/:jid/pin",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "chats",
                ":jid",
                "pin"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"pin\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Marcar conversa como lida ou não lida",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/chats/:jid/read",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "chats",
                ":jid",
                "read"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"read\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Listar etiquetas do WhatsApp",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/labels",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "labels"
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Criar ou editar etiqueta",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/labels",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "labels"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"texto\",\n  \"color\": 0\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Sincronizar etiquetas com o celular",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/labels/refresh",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "labels",
                "refresh"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"full_sync\": false\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Apagar etiqueta",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/labels/:labelId",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "labels",
                ":labelId"
              ],
              "variable": [
                {
                  "key": "labelId",
                  "value": "",
                  "description": "ID da etiqueta do WhatsApp."
                }
              ]
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Marcar mensagens como lidas",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/messages/read",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "messages",
                "read"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"chat\": \"120363025246125888@g.us\",\n  \"message_ids\": [\n    \"texto\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Buscar mensagens por texto",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/messages/search?q=",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "messages",
                "search"
              ],
              "query": [
                {
                  "key": "q",
                  "value": "",
                  "description": "",
                  "disabled": false
                },
                {
                  "key": "chat",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ]
            },
            "description": "Escopo: `messages:read`."
          }
        },
        {
          "name": "Fixar mensagem na conversa",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/messages/:messageId/pin",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "messages",
                ":messageId",
                "pin"
              ],
              "variable": [
                {
                  "key": "messageId",
                  "value": "",
                  "description": "ID da mensagem no WhatsApp."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"chat\": \"120363025246125888@g.us\",\n  \"pin\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Favoritar mensagem",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/messages/:messageId/star",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "messages",
                ":messageId",
                "star"
              ],
              "variable": [
                {
                  "key": "messageId",
                  "value": "",
                  "description": "ID da mensagem no WhatsApp."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"chat\": \"120363025246125888@g.us\",\n  \"star\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Juntar uma conversa sem telefone a um telefone",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/conversations/links",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "conversations",
                "links"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"lid_jid\": \"texto\",\n  \"phone\": \"+5511912345678\",\n  \"name\": \"texto\",\n  \"confirmed\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Algumas pessoas aparecem no WhatsApp sem o telefone (JID `@lid`), e as mensagens delas ficam numa conversa à parte. Este vínculo, o mesmo do console, junta essa conversa ao telefone informado. Vale só para este número, fica cifrado e pode ser desfeito. A conversa `@lid` precisa existir no histórico do número (senão 404 `conversation_not_found`).\n\nQuem faz o vínculo é a pessoa que criou a chave: ela precisa operar este número no console (dona, administradora, desenvolvedora ou operadora da organização ou desta área de trabalho), senão 403 `operator_required`. O histórico registra essa pessoa e a chave.\n\nRepetir o mesmo vínculo (mesmo `lid_jid`, `phone` e `name`) responde 200 com o mesmo `id` e `Idempotent-Replay: true`; o `lid_jid` já ligado a outro telefone ou nome responde 409 `contact_already_linked` (desfaça antes).\n\nEscopo: `messages:send`."
          }
        },
        {
          "name": "Desfazer o vínculo de uma conversa",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/conversations/links/:linkId",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "conversations",
                "links",
                ":linkId"
              ],
              "variable": [
                {
                  "key": "linkId",
                  "value": "",
                  "description": "O `id` devolvido ao criar o vínculo."
                }
              ]
            },
            "description": "A conversa `@lid` volta a aparecer separada. Mesma regra de quem age do vínculo: a pessoa que criou a chave, operando este número. Repetir depois de desfeito responde 404 `contact_link_not_found`.\n\nEscopo: `messages:send`."
          }
        }
      ]
    },
    {
      "name": "Grupos e comunidades",
      "description": "Criar e administrar grupos, convites, participantes, pedidos de entrada e comunidades.",
      "item": [
        {
          "name": "Criar comunidade",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/communities",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "communities"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Grupos de uma comunidade",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/communities/:jid/groups",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "communities",
                ":jid",
                "groups"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Vincular ou desvincular grupos",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/communities/:jid/groups",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "communities",
                ":jid",
                "groups"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"action\": \"link\",\n  \"groups\": [\n    \"120363025246125888@g.us\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Listar grupos do número",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups"
              ],
              "query": [
                {
                  "key": "include_participants",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "search",
                  "value": "",
                  "description": "Parte do nome ou do JID; ignora maiúsculas e acentos. Vazio não filtra.",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "offset",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ]
            },
            "description": "Uma consulta ao WhatsApp traz todos os grupos de que o número participa; a API filtra (`search`) e pagina (`limit`, `offset`) essa resposta, em ordem de nome. `data` continua sendo a lista; `total` conta os grupos depois do filtro e `next_offset` é o `offset` da próxima página (`null` na última). Cada página repete a consulta: para varrer tudo, prefira `limit=1000`. Se a resposta for 202, a lista completa (sem filtro nem ordem) fica em `/v1/operations/{id}`.\n\nEm grupos por LID (`addressing_mode: lid`) o WhatsApp pode esconder telefones: `phone` vem do próprio grupo ou do que o número já conhece (`phone_source`), e pode faltar. O telefone que o grupo esconde e só o número conhece (`phone_source: lid_map`) vem `null`, com `masked_phone`, a menos que a chave tenha o escopo `audiences:export`. `is_admin` do grupo diz se o próprio número administra o grupo.\n\nParticipantes são dados pessoais: o resultado guardado de uma consulta de grupos (repetição pela mesma `Idempotency-Key` ou `/v1/operations/{id}`) é apagado 1 hora depois; a partir daí a resposta é 410 `result_expired` e basta consultar de novo.\n\nEscopo: `engine:read`."
          }
        },
        {
          "name": "Criar grupo",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"texto\",\n  \"participants\": [\n    \"+5511912345678\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Ver grupo pelo convite",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups/invites/:code",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups",
                "invites",
                ":code"
              ],
              "variable": [
                {
                  "key": "code",
                  "value": "",
                  "description": "Código do convite ou o link completo (codificado na URL)."
                }
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Entrar em grupo por convite",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups/join",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups",
                "join"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "null",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Dados do grupo e participantes",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups/:jid",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups",
                ":jid"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Só administradores enviam",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups/:jid/announce",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups",
                ":jid",
                "announce"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"enabled\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Alterar descrição do grupo",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups/:jid/description",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups",
                ":jid",
                "description"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"description\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Descrição vazia remove a atual.\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Mensagens temporárias do grupo",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups/:jid/ephemeral",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups",
                ":jid",
                "ephemeral"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"seconds\": 0\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Trocar foto do grupo",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups/:jid/image",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups",
                ":jid",
                "image"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"image\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "JPEG até 700 KiB, em base64 ou por `media_id` de uma mídia enviada antes.\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Link de convite",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups/:jid/invite-link",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups",
                ":jid",
                "invite-link"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Gerar novo link de convite",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups/:jid/invite-link/reset",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups",
                ":jid",
                "invite-link",
                "reset"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Aprovar entrada pelo link",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups/:jid/join-approval",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups",
                ":jid",
                "join-approval"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"enabled\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Sair do grupo",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups/:jid/leave",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups",
                ":jid",
                "leave"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Só administradores editam o grupo",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups/:jid/locked",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups",
                ":jid",
                "locked"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"enabled\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Quem pode adicionar membros",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups/:jid/member-add-mode",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups",
                ":jid",
                "member-add-mode"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"mode\": \"admins\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Renomear grupo",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups/:jid/name",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups",
                ":jid",
                "name"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Adicionar, remover, promover ou rebaixar",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups/:jid/participants",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups",
                ":jid",
                "participants"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"action\": \"add\",\n  \"participants\": [\n    \"+5511912345678\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Enviar convite individual",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups/:jid/invite-message",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups",
                ":jid",
                "invite-message"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"phone\": \"+5511912345678\",\n  \"code\": \"texto\",\n  \"expires_at\": \"2026-10-30T12:00:00Z\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Envia o cartão \"Entrar no grupo\" numa conversa privada com quem a privacidade impediu de adicionar. Use o `add_request` (`code` e `expires_at`) que `POST …/groups/{jid}/participants` com `action: add` devolveu para **essa** pessoa neste grupo, por este número, nos últimos 8 dias: qualquer outro par telefone/código é recusado (422 `invite_not_requested`). O código só vale para ela e vence em cerca de 3 dias. Como é uma mensagem, pede o mesmo que um envio (envio liberado e vaga do número ativa: senão 503 `send_unavailable`), aceita legenda de até 200 caracteres e no máximo um convite a cada 3 segundos por número (429 `rate_limited`). Para divulgar o grupo a várias pessoas, envie o link de convite como texto.\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Pedidos de entrada pendentes",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups/:jid/requests",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups",
                ":jid",
                "requests"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Aprovar ou recusar pedidos de entrada",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/groups/:jid/requests",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "groups",
                ":jid",
                "requests"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"action\": \"approve\",\n  \"participants\": [\n    \"+5511912345678\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        }
      ]
    },
    {
      "name": "Contatos e perfil",
      "description": "Contatos, verificação de números, bloqueio, perfil do número, privacidade e presença.",
      "item": [
        {
          "name": "Lista de bloqueados",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/blocklist",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "blocklist"
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Listar contatos da agenda",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/contacts",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "contacts"
              ],
              "query": [
                {
                  "key": "search",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "offset",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ]
            },
            "description": "`name` junta os nomes que o WhatsApp conhece (agenda do celular, senão o nome que a pessoa escolheu, senão o nome comercial); `agenda_name`, `push_name` e `business_name` trazem cada um separado e `name_source` diz de onde veio `name`.\n\nEscopo: `engine:read`."
          }
        },
        {
          "name": "Adicionar contato à agenda",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/contacts",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "contacts"
              ]
            },
            "description": "**Não suportado pelo motor do WhatsApp usado hoje.** O WhatsApp Web não oferece gravar contatos na agenda do celular. A rota existe, autentica e responde 501 `not_supported_by_engine` (não adianta repetir).\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Verificar se telefones têm WhatsApp",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/contacts/check",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "contacts",
                "check"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"phones\": [\n    \"+5511912345678\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Dados de um contato",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/contacts/:jid",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "contacts",
                ":jid"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Remover contato da agenda",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/contacts/:jid",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "contacts",
                ":jid"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "description": "**Não suportado pelo motor do WhatsApp usado hoje.** O WhatsApp Web não oferece apagar contatos da agenda do celular. A rota existe, autentica e responde 501 `not_supported_by_engine` (não adianta repetir).\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Foto de perfil de um contato ou grupo",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/contacts/:jid/avatar",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "contacts",
                ":jid",
                "avatar"
              ],
              "query": [
                {
                  "key": "preview",
                  "value": "",
                  "description": "`true` devolve a miniatura.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID de pessoa ou, só nesta rota, de grupo (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "description": "Com um JID de grupo (`...@g.us`), devolve a foto do grupo no mesmo formato. `data` é `{url, id, type}`, ou `null` quando a foto está oculta pela privacidade ou não existe.\n\nEscopo: `engine:read`."
          }
        },
        {
          "name": "Bloquear ou desbloquear",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/contacts/:jid/block",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "contacts",
                ":jid",
                "block"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"block\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Ficar online ou offline",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/presence",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "presence"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"state\": \"available\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Mostrar digitando ou gravando",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/presence/chat",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "presence",
                "chat"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"to\": \"+5511912345678\",\n  \"state\": \"composing\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Acompanhar presença de um contato",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/presence/subscribe",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "presence",
                "subscribe"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"jid\": \"5511912345678@s.whatsapp.net\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "As mudanças chegam como evento `presence.update`.\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Ler configurações de privacidade",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/privacy",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "privacy"
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Alterar uma configuração de privacidade",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/privacy",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "privacy"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"setting\": \"last\",\n  \"value\": \"all\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Perfil do próprio número",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/profile",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "profile"
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Trocar foto de perfil",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/profile/image",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "profile",
                "image"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"image\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "JPEG até 700 KiB, em base64 (`image`) ou por `media_id`.\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Alterar nome de exibição",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/profile/name",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "profile",
                "name"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Alterar recado (sobre)",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/profile/status",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "profile",
                "status"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"text\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        }
      ]
    },
    {
      "name": "Canais",
      "description": "Canais do WhatsApp: criar, seguir, ler, reagir e publicar.",
      "item": [
        {
          "name": "Canais que o número segue",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/newsletters",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "newsletters"
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Criar canal",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/newsletters",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "newsletters"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Foto opcional: JPEG em base64 (`picture`) ou `media_id` — não os dois.\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Ver canal pelo convite",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/newsletters/invites/:code",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "newsletters",
                "invites",
                ":code"
              ],
              "variable": [
                {
                  "key": "code",
                  "value": "",
                  "description": "Código do convite ou o link completo (codificado na URL)."
                }
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Pesquisar canais públicos",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/newsletters/search",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "newsletters",
                "search"
              ]
            },
            "description": "**Não suportado pelo motor do WhatsApp usado hoje.** O WhatsApp Web não expõe a pesquisa do diretório de canais. A rota existe, autentica e responde 501 `not_supported_by_engine` (não adianta repetir).\n\nEscopo: `engine:read`."
          }
        },
        {
          "name": "Dados do canal",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/newsletters/:jid",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "newsletters",
                ":jid"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Convidar administrador do canal",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/newsletters/:jid/admins",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "newsletters",
                ":jid",
                "admins"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "description": "**Não suportado pelo motor do WhatsApp usado hoje.** O WhatsApp Web não oferece administrar canais. A rota existe, autentica e responde 501 `not_supported_by_engine` (não adianta repetir).\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Seguir ou deixar de seguir",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/newsletters/:jid/follow",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "newsletters",
                ":jid",
                "follow"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"follow\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Receber novidades ao vivo",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/newsletters/:jid/live",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "newsletters",
                ":jid",
                "live"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "description": "As mudanças chegam como evento `newsletter.live_update`.\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Publicações do canal",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/newsletters/:jid/messages",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "newsletters",
                ":jid",
                "messages"
              ],
              "query": [
                {
                  "key": "count",
                  "value": "",
                  "description": "1 a 100.",
                  "disabled": true
                },
                {
                  "key": "before",
                  "value": "",
                  "description": "Só publicações com `server_id` menor.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Silenciar canal",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/newsletters/:jid/mute",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "newsletters",
                ":jid",
                "mute"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"mute\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Publicar texto no canal",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/newsletters/:jid/posts",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "newsletters",
                ":jid",
                "posts"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"text\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Editar publicação",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/newsletters/:jid/posts/:serverId",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "newsletters",
                ":jid",
                "posts",
                ":serverId"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                },
                {
                  "key": "serverId",
                  "value": "",
                  "description": "`server_id` da publicação."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"text\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Apagar publicação",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/newsletters/:jid/posts/:serverId",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "newsletters",
                ":jid",
                "posts",
                ":serverId"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                },
                {
                  "key": "serverId",
                  "value": "",
                  "description": "`server_id` da publicação."
                }
              ]
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Reagir a uma publicação",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/newsletters/:jid/reaction",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "newsletters",
                ":jid",
                "reaction"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"server_id\": 1,\n  \"reaction\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Reação vazia remove a anterior.\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Novidades (visualizações e reações)",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/newsletters/:jid/updates",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "newsletters",
                ":jid",
                "updates"
              ],
              "query": [
                {
                  "key": "count",
                  "value": "",
                  "description": "1 a 100.",
                  "disabled": true
                },
                {
                  "key": "since",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Marcar publicações como vistas",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/newsletters/:jid/viewed",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "newsletters",
                ":jid",
                "viewed"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"server_ids\": [\n    1\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        }
      ]
    },
    {
      "name": "Perfil comercial",
      "description": "Leitura de perfis comerciais. Catálogo e edição do perfil não existem no WhatsApp Web.",
      "item": [
        {
          "name": "Listar catálogo",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/business/catalog",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "business",
                "catalog"
              ]
            },
            "description": "**Não suportado pelo motor do WhatsApp usado hoje.** O catálogo não está disponível no WhatsApp Web. A rota existe, autentica e responde 501 `not_supported_by_engine` (não adianta repetir).\n\nEscopo: `engine:read`."
          }
        },
        {
          "name": "Criar produto",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/business/catalog",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "business",
                "catalog"
              ]
            },
            "description": "**Não suportado pelo motor do WhatsApp usado hoje.** O catálogo não está disponível no WhatsApp Web. A rota existe, autentica e responde 501 `not_supported_by_engine` (não adianta repetir).\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Ler produto",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/business/catalog/:productId",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "business",
                "catalog",
                ":productId"
              ],
              "variable": [
                {
                  "key": "productId",
                  "value": "",
                  "description": "ID do produto."
                }
              ]
            },
            "description": "**Não suportado pelo motor do WhatsApp usado hoje.** O catálogo não está disponível no WhatsApp Web. A rota existe, autentica e responde 501 `not_supported_by_engine` (não adianta repetir).\n\nEscopo: `engine:read`."
          }
        },
        {
          "name": "Editar produto",
          "request": {
            "method": "PUT",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/business/catalog/:productId",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "business",
                "catalog",
                ":productId"
              ],
              "variable": [
                {
                  "key": "productId",
                  "value": "",
                  "description": "ID do produto."
                }
              ]
            },
            "description": "**Não suportado pelo motor do WhatsApp usado hoje.** O catálogo não está disponível no WhatsApp Web. A rota existe, autentica e responde 501 `not_supported_by_engine` (não adianta repetir).\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Apagar produto",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/business/catalog/:productId",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "business",
                "catalog",
                ":productId"
              ],
              "variable": [
                {
                  "key": "productId",
                  "value": "",
                  "description": "ID do produto."
                }
              ]
            },
            "description": "**Não suportado pelo motor do WhatsApp usado hoje.** O catálogo não está disponível no WhatsApp Web. A rota existe, autentica e responde 501 `not_supported_by_engine` (não adianta repetir).\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Perfil comercial do próprio número",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/business/profile",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "business",
                "profile"
              ]
            },
            "description": "Conta pessoal responde 200 com `data: null`.\n\nEscopo: `engine:read`."
          }
        },
        {
          "name": "Editar perfil comercial",
          "request": {
            "method": "PUT",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/business/profile",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "business",
                "profile"
              ]
            },
            "description": "**Não suportado pelo motor do WhatsApp usado hoje.** O WhatsApp Web só lê perfis comerciais. A rota existe, autentica e responde 501 `not_supported_by_engine` (não adianta repetir).\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Perfil comercial de um contato",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/business/profile/:jid",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "business",
                "profile",
                ":jid"
              ],
              "variable": [
                {
                  "key": "jid",
                  "value": "",
                  "description": "JID (codifique `@` como `%40` se o seu cliente exigir)."
                }
              ]
            },
            "description": "Conta pessoal responde 200 com `data: null`.\n\nEscopo: `engine:read`."
          }
        }
      ]
    },
    {
      "name": "Eventos, webhooks e SSE",
      "description": "Eventos em ordem por número, fluxo SSE, mensagens recebidas e cadastro de webhooks.",
      "item": [
        {
          "name": "Receber eventos ao vivo (SSE)",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/events/stream",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "events",
                "stream"
              ],
              "query": [
                {
                  "key": "last_event_id",
                  "value": "",
                  "description": "O mesmo que `Last-Event-ID`, na URL (útil no primeiro `EventSource`, que não manda cabeçalho). Inválido: 400 `invalid_last_event_id`.",
                  "disabled": true
                },
                {
                  "key": "token",
                  "value": "",
                  "description": "Token de `POST /v1/events/stream-token`, no lugar do cabeçalho `Authorization`.",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "`map`: o `id` de cada evento traz a posição exata de todos os números (veja acima).",
                  "disabled": true
                },
                {
                  "key": "instance_id",
                  "value": "",
                  "description": "Só os eventos deste número.",
                  "disabled": true
                },
                {
                  "key": "types",
                  "value": "",
                  "description": "Tipos separados por vírgula, do catálogo `EventType` (ex.: `message.received,message.read`).",
                  "disabled": true
                },
                {
                  "key": "after_sequence",
                  "value": "",
                  "description": "Começa depois desta sequência (exige um número: `instance_id` ou chave presa a ele).",
                  "disabled": true
                }
              ]
            },
            "description": "Fluxo contínuo (Server-Sent Events) dos eventos da organização, da área de trabalho ou de um número, conforme a chave.\n\nCada evento chega assim:\n\n```\nid: <instance_id>:<sequence>\nevent: message.received\ndata: {\"event_id\":\"…\",\"type\":\"message.received\",\"resource_id\":\"…\",\"sequence\":42,…}\n```\n\nO servidor manda `retry: 3000` no início, um comentário `: heartbeat` a cada 15 segundos e encerra a conexão depois de 10 minutos. Reconecte enviando o último `id` recebido no cabeçalho `Last-Event-ID` (o `EventSource` do navegador faz isso sozinho) para continuar de onde parou. Sem `Last-Event-ID`, `last_event_id` nem `after_sequence`, começa a partir de agora.\n\n## Navegador (`EventSource`)\nO `EventSource` não envia `Authorization`. Peça um token com `POST /v1/events/stream-token` (no seu servidor, com a chave) e abra `GET /v1/events/stream?token=…`. O token vale 5 minutos e pode ser reaproveitado nas reconexões automáticas; a chave é conferida de novo a cada abertura e a cada `heartbeat` (chave revogada encerra o fluxo). Vencido: 401 `stream_token_expired` — peça outro.\n\n## Retomada exata com vários números (`cursor=map`)\nNo formato padrão, o `id` é do número daquele evento: num fluxo de **vários** números, retomar por ele é aproximado (os outros números voltam a partir do horário desse evento). Com `cursor=map`, o `id` vira `m1.<base64url>`, um mapa da última sequência de **cada** número (até 100 números com eventos; acima disso, 400 `cursor_map_too_large`). O servidor também manda um `id` sem evento logo no início e a cada `heartbeat`, para que a reconexão seja exata mesmo antes do primeiro evento. O formato padrão não muda para quem não pede `cursor=map`.\n\n## Ordem, repetição e perda\nNão há ordem global entre números: a ordem vale **por número**, pela `sequence` (crescente, sem lacunas). Trate cada `event_id` uma vez só (o mesmo evento pode chegar de novo após uma reconexão). Para buscar o que perdeu num número, use `GET …/events?after_sequence=`.\n\nEscopo: `engine:read` (todos os eventos), `calls:read` (só `call.*`, inclusive `call.recording_*`) ou `crm:read` (só `ticket.*`, `lead.stage_changed` e `csat.answered`). Com escopo restrito, `types` só pode pedir tipos permitidos (senão 403 `scope_denied`); sem `types`, o fluxo traz só os permitidos."
          }
        },
        {
          "name": "Token para o fluxo SSE no navegador",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/events/stream-token",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "events",
                "stream-token"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Gera, para a chave que chama, um token de 5 minutos para abrir `GET /v1/events/stream?token=…` sem o cabeçalho `Authorization` (o `EventSource` do navegador não envia cabeçalhos). Chame do seu servidor e entregue só o token ao navegador: ele não serve para nenhuma outra rota.\n\nO token leva só os escopos de eventos da chave e as mesmas restrições de área de trabalho e número; a chave é conferida de novo em cada abertura e a cada `heartbeat`. Só é emitido para chave de API (`fzk_`): com token OAuth (`fzo_`), 403 `stream_token_requires_api_key` (use `Authorization` no fluxo). Pode ser reaproveitado durante os 5 minutos (reconexões); depois, 401 `stream_token_expired`.\n\nEscopo: `engine:read`, `calls:read` ou `crm:read` (o mesmo do fluxo)."
          }
        },
        {
          "name": "Ler um evento",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/events/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "events",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "`event_id` do aviso, ou o ID do evento do motor (`resource_id`)."
                }
              ]
            },
            "description": "Conteúdo de um evento que não é mensagem.\n\n- **Eventos do motor** (conexão, grupos, chamadas, etiquetas…): aceita o `resource_id` ou o `event_id` do aviso e devolve o evento decifrado (`EngineEvent`).\n- **Funil, atendimento e gravações** (`ticket.*`, `lead.stage_changed`, `csat.answered`, `call.recording_ready`, `call.recording_deleted`, `call.recording_failed`): pelo `event_id` do aviso, devolve `ControlEvent`, com o recurso **como está agora** (o atendimento, o estado do lead ou a ligação; `null` se foi apagado). Quem mudou e o motivo estão no histórico do atendimento (`GET …/tickets/{id}/events`).\n- **Mensagens**: 404 `use_message_routes` (leia em `GET /v1/messages/{id}` ou `GET …/inbound/{id}`).\n\nEscopo: `engine:read` lê todos; `calls:read` só `call.*`; `crm:read` só funil e atendimento. Evento fora do escopo: 403 `scope_denied`."
          }
        },
        {
          "name": "Listar endereços de webhook",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/webhook-endpoints?workspace_id=2f1c7a52-3f6e-4f1b-9a51-0d8f3c2b9e10",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "webhook-endpoints"
              ],
              "query": [
                {
                  "key": "workspace_id",
                  "value": "2f1c7a52-3f6e-4f1b-9a51-0d8f3c2b9e10",
                  "description": "",
                  "disabled": false
                }
              ]
            },
            "description": "Até 200 endereços da área de trabalho, em qualquer estado (removidos aparecem como `disabled`). Escopo: `webhooks:read`."
          }
        },
        {
          "name": "Cadastrar endereço de webhook",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/webhook-endpoints",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "webhook-endpoints"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"workspace_id\": \"2f1c7a52-3f6e-4f1b-9a51-0d8f3c2b9e10\",\n  \"url\": \"https://hooks.exemplo.com.br/flowzap\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Chave válida para a área de trabalho inteira (não presa a um número). O `secret` aparece só nesta resposta.\n\nFiltros opcionais: `event_types` (só esses tipos) e `instance_ids` (só esses números da área). Sem filtro, o endereço recebe todos os tipos de todos os números da área, inclusive os criados depois.\n\nEscopo: `webhooks:write`."
          }
        },
        {
          "name": "Ver um endereço de webhook",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/webhook-endpoints/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "webhook-endpoints",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do endereço de webhook."
                }
              ]
            },
            "description": "O endereço em qualquer estado, com os filtros e quantos avisos estão guardados (`held_deliveries`) enquanto pausado. Chave presa a um número: 403; presa a outra área de trabalho ou de outra organização: 404.\n\nEscopo: `webhooks:read`."
          }
        },
        {
          "name": "Alterar endereço de webhook",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/webhook-endpoints/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "webhook-endpoints",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do endereço de webhook."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"state\": \"active\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Muda o endereço (`url`, conferido de novo contra destinos privados), os filtros (`event_types`, `instance_ids`; `null` tira o filtro) e o estado (`active` ou `paused`). Só os campos enviados mudam; corpo vazio é 400.\n\n**Pausa sem perder avisos.** Com o endereço `paused` (por você, ou pelo FlowZap depois de 401/403 três vezes ou de um destino bloqueado), cada aviso novo fica guardado como `held` (até 10.000 por endereço; acima disso o aviso não é guardado para ele). Ao voltar para `active`, os guardados dos últimos 7 dias entram na fila na ordem em que aconteceram (`released_deliveries` diz quantos) e os mais antigos terminam como `dead` com `held_expired`. As entregas que já estavam pendentes quando pausou continuam de onde pararam.\n\nEndereço removido (`disabled`): 409 `endpoint_disabled` — cadastre outro. Chave presa a um número: 403.\n\nEscopo: `webhooks:write`."
          }
        },
        {
          "name": "Remover endereço de webhook",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/webhook-endpoints/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "webhook-endpoints",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do endereço de webhook."
                }
              ]
            },
            "description": "Para de entregar (estado `disabled`); avisos guardados (`held`) terminam como `dead` com `endpoint_disabled`. Chave presa a um número: 403. Escopo: `webhooks:write`."
          }
        },
        {
          "name": "Testar endereço de webhook (ping)",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/webhook-endpoints/:id/ping",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "webhook-endpoints",
                ":id",
                "ping"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do endereço de webhook."
                }
              ]
            },
            "description": "Envia agora um aviso de teste assinado e responde com o resultado (espera até 15 s). Mesmos cabeçalhos (`X-Flow-Timestamp`, `X-Flow-Event-Id`, `X-Flow-Signature`) e a mesma assinatura de um aviso real; o corpo traz `type: \"webhook.ping\"`, `instance_id: null`, `sequence: 0` e `data.resource_id: null` (esquema `WebhookPingBody`). Nada é guardado: não vira evento, não entra no histórico de entregas e não é repetido. Vale para endereços ativos e pausados (teste antes de reativar); removido: 409 `endpoint_disabled`.\n\nUm teste por endereço a cada 5 segundos (429 `rate_limited` com `Retry-After`). Sem corpo no pedido.\n\nEscopo: `webhooks:write`."
          }
        },
        {
          "name": "Trocar o segredo de um webhook",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": false,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/webhook-endpoints/:id/rotate-secret",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "webhook-endpoints",
                ":id",
                "rotate-secret"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do endereço de webhook."
                }
              ]
            },
            "description": "Gera um segredo novo e o devolve **uma vez** (`secret`, base64url, com o `secret_kid` novo). O segredo anterior continua assinando por 24 horas (`previous_secret_valid_until`): nesse período cada aviso traz `X-Flow-Signature` com dois valores separados por vírgula, `v1:<secret_kid novo>:<hex>,v1:<secret_kid anterior>:<hex>`, e o seu sistema aceita o aviso quando qualquer um confere com o segredo que você guarda. Troque o segredo no seu sistema dentro das 24 horas; depois disso só o novo assina. Trocar de novo dentro das 24 horas descarta o mais antigo.\n\nExige `Idempotency-Key`: repetir com a mesma chave (e a mesma chave de API) devolve o mesmo segredo com `Idempotent-Replay: true`, sem trocar de novo; uma `Idempotency-Key` nova troca de novo. Se outra troca já aconteceu depois daquela, repetir a chave antiga responde 409 `idempotency_conflict` e não troca de novo (o que descartaria o segredo daquela troca): ele segue assinando como o anterior, ao lado do da troca mais recente, até o fim das 24 horas. Sem o segredo em mãos, faça uma troca nova com outra `Idempotency-Key`. Vale para endereços ativos ou pausados; removido, 404. Chave presa a um número: 403; presa a outra área de trabalho: 404.\n\nEscopo: `webhooks:write`."
          }
        },
        {
          "name": "Histórico de entregas de webhook",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/webhook-deliveries?workspace_id=2f1c7a52-3f6e-4f1b-9a51-0d8f3c2b9e10",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "webhook-deliveries"
              ],
              "query": [
                {
                  "key": "workspace_id",
                  "value": "2f1c7a52-3f6e-4f1b-9a51-0d8f3c2b9e10",
                  "description": "",
                  "disabled": false
                },
                {
                  "key": "endpoint_id",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "state",
                  "value": "dead",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "event_type",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "since",
                  "value": "2026-10-30T00:00:00Z",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ]
            },
            "description": "Entregas da área de trabalho, das mais recentes para as mais antigas, com tentativas, rodada e último erro. Sem filtros, responde como antes: as 200 mais recentes (agora com `next_cursor` para continuar).\n\nFiltros: `endpoint_id`, `state` (inclui `held`), `event_type`, `since` (criadas a partir de, ISO 8601). Paginação: `limit` (1 a 200, padrão 200) e `cursor` com o `next_cursor` da página anterior; `next_cursor: null` marca o fim. Cursor que não veio desta rota: 400 `invalid_cursor`.\n\nEscopo: `webhooks:read`."
          }
        },
        {
          "name": "Reenviar uma entrega de webhook",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/webhook-deliveries/:id/retry",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "webhook-deliveries",
                ":id",
                "retry"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID da entrega (de `GET /v1/webhook-deliveries`)."
                }
              ]
            },
            "description": "Põe de novo na fila uma entrega `delivered` ou `dead`, numa rodada nova (`round` + 1, `attempts` zerado, mesma programação de tentativas de uma entrega nova). O aviso é o mesmo (`X-Flow-Event-Id` igual): trate repetidos pelo `event_id`. As tentativas das rodadas anteriores continuam no histórico. Até 10 rodadas por entrega.\n\nCom o endereço pausado, a entrega fica guardada (`held`) até ele voltar a `active`. Entrega ainda na fila (`pending`, `sending` ou `held`): 409 `delivery_in_progress`. Endereço removido: 409 `endpoint_disabled`. Chave presa a um número: 403.\n\nEscopo: `webhooks:write`."
          }
        },
        {
          "name": "Eventos de um número, em ordem",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/events",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "events"
              ],
              "query": [
                {
                  "key": "types",
                  "value": "",
                  "description": "Tipos separados por vírgula, do catálogo `EventType` (ex.: `message.received,message.read`).",
                  "disabled": true
                },
                {
                  "key": "after_sequence",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ]
            },
            "description": "Para buscar o que perdeu: pagine com `after_sequence` = `next_after_sequence` da resposta anterior. A `sequence` é crescente e sem lacunas por número; trate cada `event_id` uma vez só.\n\n## Retenção\nOs eventos ficam disponíveis por **pelo menos 90 dias** (`GET …/events`, `GET /v1/events/{id}`, SSE e reenvio de webhooks). Hoje nada é apagado antes de a conta ser excluída, mas não conte com eventos mais antigos que 90 dias: uma limpeza automática poderá ser ligada com aviso prévio no changelog. Os recursos (mensagens, conversas, atendimentos, ligações) têm as próprias regras de guarda.\n\nEscopo: `engine:read` (todos), `calls:read` (só `call.*`) ou `crm:read` (só funil e atendimento). Com escopo restrito, sem `types` a lista traz só os permitidos; `types` fora do escopo: 403 `scope_denied`."
          }
        },
        {
          "name": "Mensagens recebidas",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/inbound",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "inbound"
              ],
              "query": [
                {
                  "key": "chat",
                  "value": "",
                  "description": "Telefone ou JID da conversa.",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ]
            },
            "description": "Escopo: `engine:read`. Lista as mensagens que o número recebeu desde que foi conectado. O histórico que o celular envia (conversas anteriores à conexão e respostas a `history-sync`) não entra aqui nem gera `message.received` em webhooks; ele aparece nas leituras de conversas (`/chats`)."
          }
        },
        {
          "name": "Ler uma mensagem recebida",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/inbound/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "inbound",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Use o `resource_id` do evento `message.received`.\n\nEscopo: `engine:read`."
          }
        }
      ]
    },
    {
      "name": "CRM e respostas rápidas",
      "description": "Leads com consentimento, etiquetas de lead, anotações e respostas rápidas.",
      "item": [
        {
          "name": "Listar leads",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/leads",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "leads"
              ],
              "query": [
                {
                  "key": "status",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "tag",
                  "value": "",
                  "description": "ID de etiqueta de lead.",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "Valor de `next_cursor` da página anterior.",
                  "disabled": true
                }
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Ler um lead",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/leads/:contact",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "leads",
                ":contact"
              ],
              "variable": [
                {
                  "key": "contact",
                  "value": "",
                  "description": "Telefone E.164 (`+` codificado como `%2B`) ou JID. Um JID `@s.whatsapp.net` vira o telefone; `@lid` continua JID."
                }
              ]
            },
            "description": "Um contato `@lid` associado a um telefone em Conversas encontra o lead guardado pelo telefone, e o telefone encontra o do `@lid`; o lead do próprio contato vem primeiro. Vale também para gravar, anotar e mover.\n\nEscopo: `engine:read`."
          }
        },
        {
          "name": "Criar ou atualizar lead",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/leads/:contact",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "leads",
                ":contact"
              ],
              "variable": [
                {
                  "key": "contact",
                  "value": "",
                  "description": "Telefone E.164 (`+` codificado como `%2B`) ou JID. Um JID `@s.whatsapp.net` vira o telefone; `@lid` continua JID."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"texto\",\n  \"status\": \"texto\",\n  \"assigned_user_id\": \"00000000-0000-4000-8000-000000000000\",\n  \"tags\": [\n    \"00000000-0000-4000-8000-000000000000\"\n  ],\n  \"fields\": {},\n  \"opted_in\": {\n    \"at\": \"2026-10-30T12:00:00Z\",\n    \"source\": \"texto\"\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "`opted_in` registra o consentimento (data e origem) exigido pelas campanhas.\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Apagar lead",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/leads/:contact",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "leads",
                ":contact"
              ],
              "variable": [
                {
                  "key": "contact",
                  "value": "",
                  "description": "Telefone E.164 (`+` codificado como `%2B`) ou JID. Um JID `@s.whatsapp.net` vira o telefone; `@lid` continua JID."
                }
              ]
            },
            "description": "Apaga o contato com as anotações, os atendimentos (abertos e resolvidos, com as notas da pesquisa de satisfação) e o que as respostas automáticas guardavam dele, inclusive pelo telefone associado ao contato `…@lid` em Conversas. Não apaga as mensagens. Com `auto_create_lead` ligado nas respostas automáticas, uma nova mensagem dessa pessoa cria o contato de novo (sem consentimento).\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Anotações do lead",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/leads/:contact/notes",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "leads",
                ":contact",
                "notes"
              ],
              "query": [
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "Valor de `next_cursor` da página anterior.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "contact",
                  "value": "",
                  "description": "Telefone E.164 (`+` codificado como `%2B`) ou JID. Um JID `@s.whatsapp.net` vira o telefone; `@lid` continua JID."
                }
              ]
            },
            "description": "Mais recentes primeiro, em páginas de até `limit` (padrão 200). Continue com `cursor` = `next_cursor` da página anterior; `next_cursor` nulo é a última página.\n\nEscopo: `engine:read`."
          }
        },
        {
          "name": "Criar anotação",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/leads/:contact/notes",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "leads",
                ":contact",
                "notes"
              ],
              "variable": [
                {
                  "key": "contact",
                  "value": "",
                  "description": "Telefone E.164 (`+` codificado como `%2B`) ou JID. Um JID `@s.whatsapp.net` vira o telefone; `@lid` continua JID."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"text\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Sem `author_user_id`, a autora é a chave de API (seu prefixo). Com ele, a chave só assina pela pessoa que a criou, a não ser que essa pessoa seja dona ou administradora da conta (ou da área de trabalho): aí a integração pode assinar por qualquer pessoa da equipe.\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Registrar saída da lista (opt-out)",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/leads/:contact/opt-out",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "leads",
                ":contact",
                "opt-out"
              ],
              "variable": [
                {
                  "key": "contact",
                  "value": "",
                  "description": "Telefone E.164 (`+` codificado como `%2B`) ou JID. Um JID `@s.whatsapp.net` vira o telefone; `@lid` continua JID."
                }
              ]
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Apagar anotação",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/notes/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "notes",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Listar etiquetas de lead",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/tags",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "tags"
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Criar etiqueta de lead",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/tags",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "tags"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Apagar etiqueta de lead",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/tags/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "tags",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Listar respostas rápidas",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/quick-replies",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "quick-replies"
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Criar resposta rápida",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/quick-replies",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "quick-replies"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"shortcut\": \"texto\",\n  \"message\": {\n    \"type\": \"text\"\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Editar resposta rápida",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/quick-replies/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "quick-replies",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"shortcut\": \"texto\",\n  \"message\": {\n    \"type\": \"text\"\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Apagar resposta rápida",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/quick-replies/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "quick-replies",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Escopo: `engine:write`."
          }
        }
      ]
    },
    {
      "name": "Funil e atendimentos",
      "description": "Funil de contatos por etapa (kanban), campos personalizados, atendimentos Abertos/Resolvidos com responsável e a pesquisa de satisfação (nota de 1 a 5).",
      "item": [
        {
          "name": "Listar etapas do funil",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/stages",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "stages"
              ]
            },
            "description": "Escopo: `crm:read` (ou `engine:read`)."
          }
        },
        {
          "name": "Criar etapa",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/stages",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "stages"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `crm:write` (ou `engine:write`)."
          }
        },
        {
          "name": "Alterar etapa",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/stages/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "stages",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"texto\",\n  \"color\": 0,\n  \"kind\": \"open\",\n  \"position\": 0\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `crm:write` (ou `engine:write`)."
          }
        },
        {
          "name": "Apagar etapa",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/stages/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "stages",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Escopo: `crm:write` (ou `engine:write`)."
          }
        },
        {
          "name": "Ver funil",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/pipeline",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "pipeline"
              ],
              "query": [
                {
                  "key": "stage",
                  "value": "",
                  "description": "Só esta etapa (id) ou `none` (sem etapa). Obrigatório com `cursor`.",
                  "disabled": true
                },
                {
                  "key": "assigned",
                  "value": "",
                  "description": "`me` (a pessoa que criou a chave), `none` (sem responsável) ou o id de uma pessoa.",
                  "disabled": true
                },
                {
                  "key": "tag",
                  "value": "",
                  "description": "Só contatos com esta etiqueta.",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "Valor de `next_cursor` da página anterior.",
                  "disabled": true
                }
              ]
            },
            "description": "Escopo: `crm:read` (ou `engine:read`)."
          }
        },
        {
          "name": "Mover contato de etapa",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/leads/:contact/move",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "leads",
                ":contact",
                "move"
              ],
              "variable": [
                {
                  "key": "contact",
                  "value": "",
                  "description": "Telefone E.164 (`+` codificado como `%2B`) ou JID. Um JID `@s.whatsapp.net` vira o telefone; `@lid` continua JID."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"stage_id\": \"00000000-0000-4000-8000-000000000000\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Mudar de etapa gera o evento `lead.stage_changed`. Repetir o mesmo movimento chega ao mesmo lugar.\n\nEscopo: `crm:write` (ou `engine:write`)."
          }
        },
        {
          "name": "Listar campos personalizados",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/fields",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "fields"
              ]
            },
            "description": "Escopo: `crm:read` (ou `engine:read`)."
          }
        },
        {
          "name": "Criar campo personalizado",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/fields",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "fields"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"key\": \"texto\",\n  \"label\": \"texto\",\n  \"type\": \"text\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Os valores ficam em `fields` de cada lead (`PUT …/crm/leads/{contact}`), conferidos pelo tipo ao gravar.\n\nEscopo: `crm:write` (ou `engine:write`)."
          }
        },
        {
          "name": "Alterar campo personalizado",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/fields/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "fields",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"label\": \"texto\",\n  \"type\": \"text\",\n  \"options\": [\n    \"texto\"\n  ],\n  \"position\": 0\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `crm:write` (ou `engine:write`)."
          }
        },
        {
          "name": "Apagar campo personalizado",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/crm/fields/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "crm",
                "fields",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Escopo: `crm:write` (ou `engine:write`)."
          }
        },
        {
          "name": "Listar atendimentos",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/tickets",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "tickets"
              ],
              "query": [
                {
                  "key": "status",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "assigned",
                  "value": "",
                  "description": "`me` (a pessoa que criou a chave), `none` (sem responsável) ou o id de uma pessoa.",
                  "disabled": true
                },
                {
                  "key": "updated_since",
                  "value": "",
                  "description": "Só atendimentos alterados a partir deste instante (`updated_at`), em ISO 8601 com fuso (por exemplo `2026-10-30T12:00:00Z`): para sincronizar só o que mudou.",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "Valor de `next_cursor` da página anterior.",
                  "disabled": true
                }
              ]
            },
            "description": "Escopo: `crm:read` (ou `engine:read`)."
          }
        },
        {
          "name": "Abrir atendimento",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/tickets",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "tickets"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"contact\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Abre à mão o atendimento de uma conversa sem atendimento aberto, inclusive de um grupo (`group:<jid>`): mensagens recebidas abrem o de uma pessoa sozinhas, mas o de um grupo só abre assim. Se o contato já tem um aberto, ele volta como está (repetir o pedido é seguro). Gera `ticket.opened` só quando abre; o responsável vem do contato no funil, como numa mensagem recebida. Depois, use as rotas de pendência e resolver com o id devolvido. Quando abre, entra no histórico com `reason` e `actor_label`, se enviados.\n\nEscopo: `crm:write` (ou `engine:write`)."
          }
        },
        {
          "name": "Resumo da pesquisa de satisfação",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/tickets/csat-summary",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "tickets",
                "csat-summary"
              ],
              "query": [
                {
                  "key": "days",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ]
            },
            "description": "Escopo: `crm:read` (ou `engine:read`)."
          }
        },
        {
          "name": "Alterar vários atendimentos",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/tickets/bulk",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "tickets",
                "bulk"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"action\": \"resolve\",\n  \"contacts\": [\n    \"texto\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Aplica uma ação (`resolve`, `reopen`, `pending_set`, `pending_clear` ou `assign`) a até 100 atendimentos, um de cada vez, com as mesmas regras e eventos das rotas de um atendimento só. Cada item é o id do atendimento, o contato (telefone E.164, `…@lid`, `group:<jid>`) ou, para um grupo sem atendimento, `{contact, name}`. `resolve` e `pending_set` abrem o atendimento de um contato que nunca teve um. A resposta traz o resultado de cada item, na ordem enviada: `applied` (a mudança vale, inclusive se já valia; repetir o pedido é seguro), `skipped` (não se aplica: `ticket_pending`, `ticket_not_open`, `ticket_already_open`, `not_found`) ou `error`. `reason` e `actor_label` entram no histórico de cada item alterado (inclusive na abertura de um atendimento que não existia).\n\nEscopo: `crm:write` (ou `engine:write`)."
          }
        },
        {
          "name": "Ler atendimento",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/tickets/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "tickets",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "O id do atendimento, ou o contato (telefone E.164 com `%2B`, `…@lid` ou o grupo `group:<jid>`): o aberto, ou o último."
                }
              ]
            },
            "description": "Escopo: `crm:read` (ou `engine:read`)."
          }
        },
        {
          "name": "Histórico do atendimento",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/tickets/:id/events",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "tickets",
                ":id",
                "events"
              ],
              "query": [
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "Valor de `next_cursor` da página anterior.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "O id do atendimento, ou o contato (telefone E.164 com `%2B`, `…@lid` ou o grupo `group:<jid>`): o aberto, ou o último."
                }
              ]
            },
            "description": "Cada mudança real do atendimento, da mais antiga à mais nova: aberto (por mensagem recebida, `via: system`, ou à mão), resolvido, reaberto, responsável trocado, pendência marcada ou retirada. Traz quem fez (`via`: `console`, `api` ou `system`; a pessoa, a chave de API e o atendente declarado em `actor_label`), o motivo, o estado antes e depois (só os campos que mudaram, nunca o contato) e o `event_id` do evento de webhook anunciado com a mudança. Repetir uma ação que já vale não gera entrada. Reabrir não apaga nada: quem resolveu e por quê continua aqui.\n\nEscopo: `crm:read` (ou `engine:read`)."
          }
        },
        {
          "name": "Resolver atendimento",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/tickets/:contact/resolve",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "tickets",
                ":contact",
                "resolve"
              ],
              "variable": [
                {
                  "key": "contact",
                  "value": "",
                  "description": "O id do atendimento, o telefone E.164 (`+` como `%2B`), o contato `…@lid` ou o grupo `group:<jid>`. Pelo contato vale o atendimento aberto (ou o último)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"send_csat\": true,\n  \"reason\": \"texto\",\n  \"actor_label\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Gera `ticket.resolved`. Com a pesquisa de satisfação ligada no número, a pergunta entra na fila (`csat.status: pending`); um grupo nunca recebe a pesquisa. Um atendimento reaberto e resolvido de novo recebe a pesquisa outra vez, salvo se ela já foi respondida: a nota fica e nenhuma pesquisa nova é enviada. Um atendimento com pendência só é resolvido depois de retirar a pendência. Toda mudança aceita `reason` (motivo) e `actor_label` (o nome do atendente no seu sistema, guardado como enviado) e entra no histórico (`GET …/tickets/{id}/events`) com a pessoa que criou a chave e a chave.\n\nEscopo: `crm:write` (ou `engine:write`)."
          }
        },
        {
          "name": "Reabrir atendimento",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/tickets/:contact/reopen",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "tickets",
                ":contact",
                "reopen"
              ],
              "variable": [
                {
                  "key": "contact",
                  "value": "",
                  "description": "O id do atendimento, o telefone E.164 (`+` como `%2B`), o contato `…@lid` ou o grupo `group:<jid>`. Pelo contato vale o atendimento aberto (ou o último)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"reason\": \"texto\",\n  \"actor_label\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Gera `ticket.reopened`. `resolved_by_user_id` volta a `null`; o histórico guarda quem resolveu e por quê. O corpo é opcional: `reason` e `actor_label` entram no histórico.\n\nEscopo: `crm:write` (ou `engine:write`)."
          }
        },
        {
          "name": "Atribuir atendimento",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/tickets/:contact/assignee",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "tickets",
                ":contact",
                "assignee"
              ],
              "variable": [
                {
                  "key": "contact",
                  "value": "",
                  "description": "O id do atendimento, o telefone E.164 (`+` como `%2B`), o contato `…@lid` ou o grupo `group:<jid>`. Pelo contato vale o atendimento aberto (ou o último)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"user_id\": \"00000000-0000-4000-8000-000000000000\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Gera `ticket.assigned` quando o responsável muda. Toda mudança aceita `reason` (motivo) e `actor_label` (o nome do atendente no seu sistema, guardado como enviado) e entra no histórico (`GET …/tickets/{id}/events`) com a pessoa que criou a chave e a chave.\n\nEscopo: `crm:write` (ou `engine:write`)."
          }
        },
        {
          "name": "Marcar pendência no atendimento",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/tickets/:contact/pending",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "tickets",
                ":contact",
                "pending"
              ],
              "variable": [
                {
                  "key": "contact",
                  "value": "",
                  "description": "O id do atendimento, o telefone E.164 (`+` como `%2B`), o contato `…@lid` ou o grupo `group:<jid>`. Pelo contato vale o atendimento aberto (ou o último)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"level\": \"urgent\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Marca o atendimento aberto como pendente, com nível (`urgent`, `medium` ou `low`) e observação opcional. No console a conversa fica no topo da lista; o atendimento só é resolvido depois de retirar a pendência. Gera `ticket.pending_set` quando o nível ou a observação mudam (repetir o mesmo pedido devolve o atendimento como está). Toda mudança aceita `reason` (motivo) e `actor_label` (o nome do atendente no seu sistema, guardado como enviado) e entra no histórico (`GET …/tickets/{id}/events`) com a pessoa que criou a chave e a chave.\n\nEscopo: `crm:write` (ou `engine:write`)."
          }
        },
        {
          "name": "Retirar pendência do atendimento",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/tickets/:contact/pending",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "tickets",
                ":contact",
                "pending"
              ],
              "query": [
                {
                  "key": "reason",
                  "value": "",
                  "description": "Motivo da mudança, guardado no histórico do atendimento.",
                  "disabled": true
                },
                {
                  "key": "actor_label",
                  "value": "",
                  "description": "Nome do atendente no seu sistema, guardado no histórico como enviado (declarado, não verificado).",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "contact",
                  "value": "",
                  "description": "O id do atendimento, o telefone E.164 (`+` como `%2B`), o contato `…@lid` ou o grupo `group:<jid>`. Pelo contato vale o atendimento aberto (ou o último)."
                }
              ]
            },
            "description": "Gera `ticket.pending_cleared` (sem pendência, devolve o atendimento como está). `reason` e `actor_label` vão na query string e entram no histórico.\n\nEscopo: `crm:write` (ou `engine:write`)."
          }
        }
      ]
    },
    {
      "name": "Respostas automáticas",
      "description": "Boas-vindas, fora do horário, menu numerado, palavras-chave e a pesquisa de satisfação de cada número. Só respondem quem escreveu primeiro, nunca em grupos.",
      "item": [
        {
          "name": "Ver respostas automáticas",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/auto-replies",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "auto-replies"
              ]
            },
            "description": "Configuração das respostas automáticas do número. Um número que nunca foi configurado devolve os padrões, com `updated_at: null`.\n\nEscopo: `crm:read` (ou `engine:read`)."
          }
        },
        {
          "name": "Alterar respostas automáticas",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/auto-replies",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "auto-replies"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"enabled\": true,\n  \"welcome\": {\n    \"enabled\": true,\n    \"text\": \"texto\",\n    \"cooldown_hours\": 24\n  },\n  \"away\": {\n    \"enabled\": true,\n    \"text\": \"texto\",\n    \"hours\": {\n      \"days\": [\n        1\n      ],\n      \"start\": \"texto\",\n      \"end\": \"texto\",\n      \"tz\": \"texto\"\n    },\n    \"cooldown_hours\": 12\n  },\n  \"menu\": {\n    \"enabled\": true,\n    \"text\": \"texto\",\n    \"options\": [\n      {\n        \"key\": \"1\",\n        \"label\": \"texto\",\n        \"reply\": \"texto\"\n      }\n    ]\n  },\n  \"keywords\": [\n    {\n      \"match\": \"contains\",\n      \"terms\": [\n        \"texto\"\n      ],\n      \"reply\": \"texto\"\n    }\n  ],\n  \"pause_minutes_after_human\": 120,\n  \"auto_create_lead\": true,\n  \"csat\": {\n    \"enabled\": true,\n    \"text\": \"texto\",\n    \"thanks_text\": \"texto\"\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Substitui toda a configuração (não é merge). Respostas automáticas só respondem uma mensagem recebida de uma pessoa (nunca iniciam conversa nem respondem grupos), no máximo 5 por contato por hora, só com o número conectado, até 15 minutos depois de a mensagem chegar (passado isso, não respondem mais), e param para o contato quando alguém da equipe responde. O remetente aparece nas conversas como \"Resposta automática\" (ou \"Pesquisa de satisfação\").\n\nOs textos (boas-vindas, fora do horário, menu, palavras-chave e pesquisa) são guardados como configuração da conta, como nomes de etapas e etiquetas: não são cifrados como as mensagens. Não coloque senhas, chaves ou dados pessoais neles.\n\nEscopo: `crm:write` (ou `engine:write`)."
          }
        }
      ]
    },
    {
      "name": "Públicos",
      "description": "Públicos de anúncios: participantes dos grupos do número exportados para o Meta e o Google, com declaração de base legal (LGPD). Ninguém do público recebe mensagem.",
      "item": [
        {
          "name": "Listar públicos",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/audiences",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "audiences"
              ],
              "query": [
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "Valor de `next_cursor` da página anterior.",
                  "disabled": true
                }
              ]
            },
            "description": "Escopo: `audiences:read`."
          }
        },
        {
          "name": "Coletar um público",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/audiences",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "audiences"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Junta os participantes dos grupos em que o número **já está** num público para anúncios (Meta e Google). Lê os grupos uma única vez (sem entrar em grupo nenhum) e no máximo uma vez a cada 10 minutos por número. Cada telefone entra uma vez; o próprio número fica de fora; quem aparece sem telefone é só contado em `participants_without_phone`. **Ninguém do público recebe mensagem pelo FlowZap**: campanhas continuam exigindo consentimento. Os membros ficam cifrados e são apagados depois de 180 dias sem atualizar.\n\nResponde 201 com a coleta pronta ou 202 enquanto ainda lê os grupos (consulte `GET …/audiences/{id}`).\n\nEscopo: `audiences:write`."
          }
        },
        {
          "name": "Tirar uma pessoa de todos os públicos",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/audiences/members/:phone",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "audiences",
                "members",
                ":phone"
              ],
              "variable": [
                {
                  "key": "phone",
                  "value": "",
                  "description": "Telefone E.164 com `+` (codificado na URL: `%2B5511…`)."
                }
              ]
            },
            "description": "Pedido do titular (LGPD): apaga a pessoa de todos os públicos do número e a deixa de fora das próximas coletas (fica guardado só um resumo do telefone, um hash com chave secreta). Escopo: `audiences:write`."
          }
        },
        {
          "name": "Ler um público",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/audiences/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "audiences",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do público."
                }
              ]
            },
            "description": "Contagens, grupos de origem, quando o número pode coletar de novo e o texto da declaração exigida na exportação. Escopo: `audiences:read`."
          }
        },
        {
          "name": "Apagar um público",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/audiences/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "audiences",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do público."
                }
              ]
            },
            "description": "Apaga os membros e os grupos de origem na hora (LGPD). O histórico de exportações continua. Escopo: `audiences:write`."
          }
        },
        {
          "name": "Histórico de exportações",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/audiences/:id/exports",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "audiences",
                ":id",
                "exports"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do público."
                }
              ]
            },
            "description": "As últimas 100 exportações do público. Escopo: `audiences:read`."
          }
        },
        {
          "name": "Exportar para Meta, Google ou planilha",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/audiences/:id/exports",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "audiences",
                ":id",
                "exports"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do público."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"format\": \"meta\",\n  \"declaration_accepted\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Devolve o arquivo CSV (`text/csv`). `meta` e `google`: para subir no Gerenciador de Anúncios do Meta (Público Personalizado) ou no Google Ads (Customer Match), com telefones e nomes em SHA-256, nunca em texto; os dois recebem o público inteiro (o Google aceita só listas de clientes da própria empresa: lista vinda de grupos de terceiros pode ser recusada por ele). `csv`: planilha com telefone completo, nome e grupos legíveis de todo o público, para eventos e listas (arquivo `publico-<nome>-<aaaa-mm-dd>.csv`); trate como dado pessoal. Toda exportação exige `declaration_accepted: true` (a planilha tem declaração própria, em `export_declarations.csv`) e fica registrada (quem, quando, quantas linhas, endereço IP e versão da declaração). A planilha não sai pelo MCP.\n\nEscopo: `audiences:export`."
          }
        },
        {
          "name": "Membros de um público",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/audiences/:id/members",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "audiences",
                ":id",
                "members"
              ],
              "query": [
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "Valor de `next_cursor` da página anterior.",
                  "disabled": true
                },
                {
                  "key": "full",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do público."
                }
              ]
            },
            "description": "Telefones mascarados e sem nome. `full=1` mostra telefone e nome completos e exige também `audiences:export`. Escopo: `audiences:read`."
          }
        },
        {
          "name": "Atualizar um público",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/audiences/:id/refresh",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "audiences",
                ":id",
                "refresh"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do público."
                }
              ]
            },
            "description": "Coleta de novo os mesmos grupos: quem saiu do grupo sai do público. Mesmo limite de uma coleta a cada 10 minutos por número. Escopo: `audiences:write`."
          }
        }
      ]
    },
    {
      "name": "Modelos e agendamentos",
      "description": "Modelos de mensagem (avisos, cobranças, lembretes) com variáveis, envio por modelo na hora ou agendado, e mensagens avulsas agendadas.",
      "item": [
        {
          "name": "Listar modelos de mensagem",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/message-templates",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "message-templates"
              ],
              "query": [
                {
                  "key": "category",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ]
            },
            "description": "Os modelos da conta (`workspace_id` nulo) e os desta área de trabalho, por nome, com as variáveis que o envio precisa preencher.\n\nEscopo: `messages:read`."
          }
        },
        {
          "name": "Criar modelo de mensagem",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/message-templates",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "message-templates"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Carrinho abandonado\",\n  \"category\": \"aviso\",\n  \"message\": {\n    \"type\": \"text\",\n    \"text\": {\n      \"body\": \"Oi {{primeiro_nome|tudo bem}}! Você deixou {{var:produto}} no carrinho. Finalize aqui: {{var:link}} {{var:cupom|}}\"\n    }\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Um modelo para avisos, cobranças e lembretes: texto (ou arquivo por link com legenda) com dados do CRM (`{{primeiro_nome}}`…) e variáveis livres (`{{var:link}}`…) preenchidas no envio. Por padrão vale para todos os números da conta; uma chave presa a uma área de trabalho ou número cria modelos só da sua área (e não muda os da conta: 403 `template_read_only`). `Idempotency-Key` é opcional.\n\nEscopo: `messages:send`."
          }
        },
        {
          "name": "Ler um modelo",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/message-templates/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "message-templates",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Escopo: `messages:read`."
          }
        },
        {
          "name": "Alterar um modelo",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/message-templates/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "message-templates",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"texto\",\n  \"category\": \"aviso\",\n  \"message\": {\n    \"type\": \"text\"\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Troca nome, tipo e mensagem. Envios já agendados guardam a mensagem de quando foram criados.\n\nEscopo: `messages:send`."
          }
        },
        {
          "name": "Apagar um modelo",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/message-templates/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "message-templates",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Envios já agendados com ele continuam (guardam a própria mensagem).\n\nEscopo: `messages:send`."
          }
        },
        {
          "name": "Enviar por modelo",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/messages/template",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "messages",
                "template"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"to\": {\n    \"kind\": \"phone\",\n    \"value\": \"+5511912345678\"\n  },\n  \"template_id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n  \"variables\": {\n    \"nome\": \"Ana Souza\",\n    \"produto\": \"Tênis Corrida 42\",\n    \"link\": \"https://loja.exemplo/carrinho/abc123\"\n  },\n  \"client_reference\": \"carrinho-abc123\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Preenche o modelo para a pessoa (dados do CRM do número + `variables`) e envia pelo mesmo caminho de `POST …/messages`: envio liberado no plano, conta dentro do limite de números (409 `numbers_over_limit`), limites por chave e fila (429), assinatura do número. Sem `scheduled_at`: **202** com o envio (como `POST …/messages`; expira em 2 h se não sair). Com `scheduled_at`: **201** com a mensagem agendada (`GET …/scheduled-messages/{id}`).\n\n`Idempotency-Key` (ou `idempotency_key` no corpo) é obrigatória: repetir devolve o mesmo envio sem preencher de novo; com outros dados, 409 `idempotency_conflict`. Uma recusa (por exemplo 503 `send_unavailable`) não guarda nada, e a mesma chave pode tentar de novo. Faltou variável sem alternativo: 422 `missing_variables` com `missing`.\n\nEscopo: `messages:send`."
          }
        },
        {
          "name": "Listar mensagens agendadas",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/scheduled-messages",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "scheduled-messages"
              ],
              "query": [
                {
                  "key": "state",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "Valor de `next_cursor` da página anterior.",
                  "disabled": true
                }
              ]
            },
            "description": "Por situação (padrão `scheduled`, mais próximas primeiro; as outras, mais recentes primeiro). Envios imediatos por modelo não aparecem aqui.\n\nEscopo: `messages:read`."
          }
        },
        {
          "name": "Agendar mensagem",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/scheduled-messages",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "scheduled-messages"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"to\": {\n    \"kind\": \"phone\",\n    \"value\": \"+5511912345678\"\n  },\n  \"scheduled_at\": \"2026-10-20T08:00:00-03:00\",\n  \"message\": {\n    \"type\": \"text\",\n    \"text\": {\n      \"body\": \"Bom dia! Lembrete: sua consulta é hoje às 14h. Responda 1 para confirmar.\"\n    }\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Uma mensagem avulsa (`message`) ou um modelo (`template_id` + `variables`) para um telefone ou grupo, de 1 minuto a 90 dias à frente. A mensagem é preenchida agora (faltas respondem 422 já) e sai no horário pelo mesmo caminho de `POST …/messages`, **uma vez só**, mesmo se o serviço reiniciar. Número desconectado no horário: novas tentativas a cada minuto por 1 hora; depois, `failed` com `error_code`. Até 1.000 agendadas por número.\n\nEscopo: `messages:send`."
          }
        },
        {
          "name": "Ler uma mensagem agendada",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/scheduled-messages/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "scheduled-messages",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Escopo: `messages:read`."
          }
        },
        {
          "name": "Cancelar mensagem agendada",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/scheduled-messages/:id/cancel",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "scheduled-messages",
                ":id",
                "cancel"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Cancela uma mensagem que ainda aguarda. Cancelar de novo responde o mesmo. Se ela já saiu (mesmo que o registro ainda não mostrasse), 409 `already_sent` com `message_id`; em outra situação, 409 `not_cancelable` com `state`.\n\nEscopo: `messages:send`."
          }
        }
      ]
    },
    {
      "name": "Lançamento em grupos",
      "description": "Mensagem para vários grupos que o número administra e links públicos que enchem os grupos em ordem.",
      "item": [
        {
          "name": "Listar envios para grupos",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/group-broadcasts",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "group-broadcasts"
              ],
              "query": [
                {
                  "key": "state",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "Valor de `next_cursor` da página anterior.",
                  "disabled": true
                }
              ]
            },
            "description": "Escopo: `messages:read` (ou `campaigns:read`)."
          }
        },
        {
          "name": "Enviar mensagem a vários grupos",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": false,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/group-broadcasts",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "group-broadcasts"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"texto\",\n  \"groups\": [\n    \"120363025246125888@g.us\"\n  ],\n  \"message\": {\n    \"type\": \"text\"\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "A mesma mensagem para vários grupos em que o número é **administrador** — grupos em que ele só participa são recusados (422 `not_group_admin`, com `not_admin` e `not_found` no erro) ou pulados com `skip_non_admin`. A conferência é uma leitura dos grupos no WhatsApp (sem participantes); enquanto ela não termina, 503 `groups_not_ready`: repita com a mesma `Idempotency-Key`. Antes de cada grupo o envio confere de novo (uma leitura por envio a cada 10 minutos no máximo): um grupo em que o número deixou de ser administrador, ou que não existe mais, fica `failed` com `error_code` `not_group_admin` ou `group_not_found`, sem mensagem.\n\nUma mensagem por grupo, nunca repetida (chave `group-broadcast:<envio>:<grupo>`). Proteções das campanhas: pausa aleatória entre grupos (padrão 10 a 30 s), `daily_limit` por número (padrão 200, dia de Brasília, somando os envios para grupos do número), `window` e pausa automática `paused_by_safety` (mais de 20% de falhas nos últimos 50 envios, ou limite do WhatsApp para o número). Até 500 grupos e 10 envios ativos por número. Exige `Idempotency-Key`.\n\nEscopo: `messages:send` (ou `campaigns:write`)."
          }
        },
        {
          "name": "Ler um envio para grupos",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/group-broadcasts/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "group-broadcasts",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Com a contagem de grupos por situação. Escopo: `messages:read`."
          }
        },
        {
          "name": "Resultado por grupo",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/group-broadcasts/:id/report",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "group-broadcasts",
                ":id",
                "report"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Cada grupo do envio, na ordem: aceito, falhou (com `error_code`), pendente ou cancelado, e o estado da mensagem (`message_state`). Escopo: `messages:read`."
          }
        },
        {
          "name": "Pausar envio para grupos",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/group-broadcasts/:id/pause",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "group-broadcasts",
                ":id",
                "pause"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Os grupos que faltam esperam até retomar. Escopo: `messages:send`."
          }
        },
        {
          "name": "Retomar envio para grupos",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/group-broadcasts/:id/resume",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "group-broadcasts",
                ":id",
                "resume"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Retoma também o pausado pela proteção (a contagem de falhas recomeça). Escopo: `messages:send`."
          }
        },
        {
          "name": "Cancelar envio para grupos",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/group-broadcasts/:id/cancel",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "group-broadcasts",
                ":id",
                "cancel"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Os grupos que faltam não recebem. Não tem volta. Escopo: `messages:send`."
          }
        },
        {
          "name": "Listar links de lançamento",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/launch-links",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "launch-links"
              ],
              "query": [
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "Valor de `next_cursor` da página anterior.",
                  "disabled": true
                }
              ]
            },
            "description": "Como estão guardados (sem ler o WhatsApp). Escopo: `engine:read`."
          }
        },
        {
          "name": "Criar link de lançamento",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/launch-links",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "launch-links"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"slug\": \"texto\",\n  \"name\": \"texto\",\n  \"groups\": [\n    \"120363025246125888@g.us\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Um link público `https://flowzap.flowpost.com.br/g/<slug>` (sem chave, sem login) que leva cada pessoa (302) ao convite do **primeiro grupo da lista com vaga** abaixo de `cap` (o WhatsApp aceita 1024 por grupo). As pessoas de cada grupo são lidas do WhatsApp no máximo a cada 2 minutos por link; entre uma leitura e outra, cada clique conta como uma pessoa a mais (no máximo 200 por grupo), para nenhum grupo passar do limite numa onda de acessos. Como clique não é entrada, quando os cliques fazem todos os grupos parecerem cheios o link continua levando ao último grupo com vaga pela contagem do WhatsApp. Visualizações de link (prévia do WhatsApp, redes sociais) não contam. Cliques são só um número por grupo: nada da pessoa nem o IP é guardado. A rota pública tem limite de acessos por IP (429; um endereço IPv6 conta pela sua rede /64).\n\nTodos os grupos precisam ser administrados pelo número (o link usa o convite de cada um): 422 `not_group_admin`. Com `auto_create`, quando a contagem do próprio WhatsApp diz que todos lotaram (nunca pelos cliques), o próximo grupo é criado sozinho. O `slug` é único para sempre (409 `slug_taken`). `Idempotency-Key` opcional.\n\nEscopo: `engine:write`."
          }
        },
        {
          "name": "Ler um link de lançamento",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/launch-links/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "launch-links",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Aplica as contagens e os convites que já chegaram do WhatsApp. Ler o link nunca pede nada ao WhatsApp: as leituras novas, os convites e o grupo novo são pedidos pelos acessos ao link público. Escopo: `engine:read`."
          }
        },
        {
          "name": "Alterar link de lançamento",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/launch-links/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "launch-links",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"texto\",\n  \"groups\": [\n    \"120363025246125888@g.us\"\n  ],\n  \"cap\": 1,\n  \"active\": true,\n  \"auto_create\": {\n    \"enabled\": true,\n    \"name\": \"texto\",\n    \"phones\": [\n      \"+5511912345678\"\n    ]\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Nome, grupos (nova ordem; conferidos como na criação), `cap`, `active` e `auto_create`. O slug não muda. Escopo: `engine:write`."
          }
        },
        {
          "name": "Apagar link de lançamento",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/launch-links/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "launch-links",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "O endereço público para de funcionar (404) e o slug nunca é reaproveitado. Escopo: `engine:write`."
          }
        }
      ]
    },
    {
      "name": "Campanhas",
      "description": "Envio em massa só para contatos com consentimento registrado.",
      "item": [
        {
          "name": "Listar campanhas",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/campaigns",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "campaigns"
              ],
              "query": [
                {
                  "key": "state",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "Valor de `next_cursor` da página anterior.",
                  "disabled": true
                }
              ]
            },
            "description": "Escopo: `messages:read`."
          }
        },
        {
          "name": "Criar campanha",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": false,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/campaigns",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "campaigns"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"texto\",\n  \"message\": {\n    \"type\": \"text\"\n  },\n  \"recipients\": [\n    \"+5511912345678\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Envio em massa **só para quem deu consentimento** (lead com `opted_in` e sem opt-out): uma lista de telefones ou uma etiqueta do CRM. Públicos coletados de grupos nunca são destinatários. Até 5000 destinatários, 10 campanhas ativas por número, pausa aleatória de 3 s a 10 min entre envios. Exige `Idempotency-Key`. Se algum destinatário não tiver consentimento, responde 422 `consent_required` com `rejected` e `total` no erro, a menos que `skip_unconsented` seja true.\n\nRecursos: `variants` (2 a 5 textos alternados por destinatário), personalização com `{{nome}}`, `{{primeiro_nome}}` e `{{campo:<chave>}}` (com alternativo: `{{nome|cliente}}`; marcador inválido responde 422 `invalid_placeholder` com `placeholder` no erro), `daily_limit` por número (padrão 200, dia de Brasília, somando as campanhas do número), `window` (dias e horário de envio) e pausa automática `paused_by_safety` quando mais de 20% dos últimos 50 envios falham ou quando o WhatsApp limita conversas novas do número. Quem pede para sair é pulado mesmo depois de criada a campanha.\n\nEscopo: `messages:send`."
          }
        },
        {
          "name": "Painel de campanhas do número",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/campaigns/summary",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "campaigns",
                "summary"
              ],
              "query": [
                {
                  "key": "days",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ]
            },
            "description": "Envios de hoje contra o limite diário (dia de Brasília), campanhas por estado, métricas dos envios feitos nos últimos `days` dias (enviados, entregues, lidos, falhas, respostas e saídas) com série por dia, e as campanhas pausadas por segurança.\n\nEscopo: `messages:read`."
          }
        },
        {
          "name": "Ler campanha e contagens",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/campaigns/:id",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "campaigns",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Escopo: `messages:read`."
          }
        },
        {
          "name": "Cancelar campanha",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/campaigns/:id/cancel",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "campaigns",
                ":id",
                "cancel"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Escopo: `messages:send`."
          }
        },
        {
          "name": "Pausar campanha",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/campaigns/:id/pause",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "campaigns",
                ":id",
                "pause"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Escopo: `messages:send`."
          }
        },
        {
          "name": "Destinatários e resultado",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/campaigns/:id/recipients",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "campaigns",
                ":id",
                "recipients"
              ],
              "query": [
                {
                  "key": "state",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "Valor de `next_cursor` da página anterior.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Escopo: `messages:read`."
          }
        },
        {
          "name": "Painel da campanha",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/campaigns/:id/report",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "campaigns",
                ":id",
                "report"
              ],
              "query": [
                {
                  "key": "bucket",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Série por hora ou por dia (America/Sao_Paulo) de enviados, entregues, lidos, falhas, respostas e saídas, com os totais. Cada métrica conta pela hora do próprio evento (entrega, leitura, resposta, saída).\n\nEscopo: `messages:read`."
          }
        },
        {
          "name": "Retomar campanha",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/campaigns/:id/resume",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "campaigns",
                ":id",
                "resume"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "ID do recurso."
                }
              ]
            },
            "description": "Retoma uma campanha pausada (também `paused_by_safety`; a janela de falhas recomeça). Escopo: `messages:send`."
          }
        }
      ]
    },
    {
      "name": "Chatwoot, n8n e Make",
      "description": "Integração nativa com o Chatwoot. n8n e Make usam os webhooks e a API (guias em docs/integracoes).",
      "item": [
        {
          "name": "Webhook chamado pelo Chatwoot",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/chatwoot/hooks/:token",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "chatwoot",
                "hooks",
                ":token"
              ],
              "variable": [
                {
                  "key": "token",
                  "value": "",
                  "description": "Token secreto da integração, gerado pelo FlowZap."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "auth": {
              "type": "noauth"
            },
            "description": "**Sem chave de API.** O Chatwoot chama este endereço (o `webhook_url` da configuração); o token de 256 bits no caminho identifica o número. Só respostas enviadas por atendentes (não notas privadas) viram mensagem no WhatsApp. Limite: 600 pedidos por minuto por endereço de origem e 300 por token.\n\nSem autenticação por chave de API."
          }
        },
        {
          "name": "Ler integração com o Chatwoot",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/chatwoot",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "chatwoot"
              ]
            },
            "description": "Escopo: `engine:read`."
          }
        },
        {
          "name": "Ligar ou alterar integração com o Chatwoot",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/chatwoot",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "chatwoot"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"texto\",\n  \"account_id\": 1,\n  \"inbox_id\": 1,\n  \"enabled\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Escopo: `engine:write`."
          }
        },
        {
          "name": "Remover integração com o Chatwoot",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/chatwoot",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "chatwoot"
              ]
            },
            "description": "Escopo: `engine:write`."
          }
        }
      ]
    },
    {
      "name": "Equipe",
      "description": "Pessoas e convites da organização, com as regras da tela Equipe do console. A chave age por quem a criou.",
      "item": [
        {
          "name": "Listar pessoas da equipe",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/team/members",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "team",
                "members"
              ]
            },
            "description": "As pessoas da organização que quem criou a chave administra, como na tela Equipe do console: dono vê todas; administrador vê as que pode gerenciar. Uma pessoa com acesso a mais de uma área de trabalho aparece uma vez por acesso. Uma chave presa a uma área de trabalho vê só os acessos daquela área.\n\n**A chave age por quem a criou**, com o papel atual dessa pessoa. Chave sem criador (anterior ao registro de criador) ou cuja pessoa não é mais dona nem administradora: 403 `team_manager_required`. Chave presa a um número não administra a equipe (403 `scope_denied`).\n\nEscopo: `team:read`."
          }
        },
        {
          "name": "Remover uma pessoa da equipe",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/team/members/:membershipId",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "team",
                "members",
                ":membershipId"
              ],
              "variable": [
                {
                  "key": "membershipId",
                  "value": "",
                  "description": "`id` do acesso, de `GET /v1/team/members`."
                }
              ]
            },
            "description": "Remove um acesso e encerra as sessões do console dessa pessoa, com as mesmas regras do console: o dono nunca é removido; administrador remove só desenvolvedor, operador e leitura; ninguém remove a si mesmo (a pessoa que criou a chave). No histórico da equipe, quem removeu é a pessoa que criou a chave, com a indicação da chave usada.\n\n`Idempotency-Key` opcional: repetir com a mesma chave depois de remover responde 204 com `Idempotent-Replay: true`; sem ela, a repetição responde 404.\n\nEscopo: `team:write`."
          }
        },
        {
          "name": "Listar convites da equipe",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/team/invitations",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "team",
                "invitations"
              ]
            },
            "description": "Os 100 convites mais recentes que quem criou a chave administra, com a situação (`pending`, `accepted`, `revoked`, `expired`). Uma chave presa a uma área de trabalho vê só os convites daquela área.\n\nEscopo: `team:read`."
          }
        },
        {
          "name": "Convidar uma pessoa",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": false,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/team/invitations",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "team",
                "invitations"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"email\": \"pessoa@exemplo.com.br\",\n  \"role\": \"admin\",\n  \"workspace_id\": \"00000000-0000-4000-8000-000000000000\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Envia o convite por e-mail (link válido por 7 dias), como a tela Equipe do console, sem pedir senha: a chave é a credencial. O papel vai no máximo até `admin`, e só se quem criou a chave for o dono; administrador convida só `developer`, `operator` e `viewer`. `owner` nunca: a transferência de propriedade fica só no console. `workspace_id: null` dá acesso à organização inteira; uma chave presa a uma área de trabalho só convida para ela (outra área ou `null`: 404).\n\nAs pessoas da equipe seguem o plano (pessoas da organização + convites pendentes válidos; convidar quem já conta não soma): acima do limite, 409 `member_limit_reached`. Até 20 convites a cada 15 minutos por chave.\n\nExige `Idempotency-Key`: repetir o mesmo pedido devolve o mesmo convite (200, `Idempotent-Replay: true`) sem mandar outro e-mail; com outro conteúdo, 409 `idempotency_conflict`.\n\nEscopo: `team:write`."
          }
        },
        {
          "name": "Cancelar um convite",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/team/invitations/:invitationId",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "team",
                "invitations",
                ":invitationId"
              ],
              "variable": [
                {
                  "key": "invitationId",
                  "value": "",
                  "description": "`id` do convite."
                }
              ]
            },
            "description": "Cancela um convite pendente; o link do e-mail deixa de valer. Mesmas regras de papel do convite.\n\n`Idempotency-Key` opcional: repetir com a mesma chave depois de cancelar responde 204 com `Idempotent-Replay: true`; sem ela, a repetição responde 409 `invitation_closed`.\n\nEscopo: `team:write`."
          }
        }
      ]
    },
    {
      "name": "Cobrança",
      "description": "Assinatura, ofertas, ligações e pagamentos; o pagamento acontece no checkout do Asaas (a resposta traz o link).",
      "item": [
        {
          "name": "Ver assinatura, faturas e pagamentos pendentes",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/billing/subscription",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "billing",
                "subscription"
              ]
            },
            "description": "O que a tela Assinatura do console mostra, numa resposta só: o plano em vigor e de onde vem (`plan`), a situação comercial (`commercial`: `state` e `until`), a assinatura (`subscription`: situação, fim do período pago, `cancel_at_period_end`, forma de pagamento, `last_invoice_url` da última fatura do cartão e `next_charge_date`), a **fatura de renovação em aberto** (`renewal_cycle`: período, `amount_minor` em centavos e `link` do Pix enquanto vale), o **checkout ainda aberto** da primeira contratação (`checkout`: `state`, `attempt_state`, `link`, valor), as ligações (`calls`), as Gravações no FlowZap (`recordings`) e os avisos: mudança de plano agendada (`plan_change`, com o `id` para confirmar), desconto, prorrogação e números extras que vencem. Ausente: `null`.\n\nNão há histórico de pagamentos antigos nesta versão (o console também não mostra): a fatura aberta e o link da última fatura do cartão estão acima. Valores em centavos.\n\n**Cobrança é da conta inteira**: a chave não pode estar presa a uma área de trabalho ou número, e age por quem a criou, que precisa ser dono ou responsável pela cobrança da conta (como no console).\n\nEscopo: `billing:read`."
          }
        },
        {
          "name": "Listar ofertas de planos",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/billing/offers",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "billing",
                "offers"
              ]
            },
            "description": "As ofertas à venda e as propostas liberadas pela equipe FlowZap para esta conta. Use o `id` da oferta como `price_id` no checkout.\n\nEscopo: `billing:read`."
          }
        },
        {
          "name": "Ver pendências da renovação",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/billing/renewal-attention",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "billing",
                "renewal-attention"
              ]
            },
            "description": "O que pede atenção na renovação e no pagamento dela (atraso, Pix vencido, conferência com o Asaas atrasada), como o aviso do console.\n\nEscopo: `billing:read`."
          }
        },
        {
          "name": "Ver ligações contratadas",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/billing/addons/calls",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "billing",
                "addons",
                "calls"
              ]
            },
            "description": "Em quantos números a conta tem ligações, o máximo do plano, o preço por número, a redução agendada e o aumento ainda por pagar.\n\nEscopo: `billing:read`."
          }
        },
        {
          "name": "Mudar a quantidade de números com ligações",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": false,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/billing/addons/calls",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "billing",
                "addons",
                "calls"
              ]
            },
            "description": "Corpo: `{\"quantity\": N, \"method\": \"pix\" | \"credit_card\"}`. **Aumento**: cobra agora o proporcional dos dias que faltam no período (mínimo R$ 5,00), por Pix ou cartão (`method` obrigatório), num checkout avulso do Asaas; responde 201 com o `link` e a quantidade sobe depois do pagamento confirmado. **Redução**: agendada para a próxima renovação, sem reembolso (200, `result: scheduled`). A quantidade atual de novo cancela a redução agendada (200, `result: unchanged`).\n\n`Idempotency-Key` obrigatória (16 a 128 caracteres): repetir com a mesma chave devolve o mesmo resultado e o mesmo link, sem novo checkout; com outra quantidade ou forma, 409 `idempotency_conflict`.\n\nEscopo: `billing:write`."
          }
        },
        {
          "name": "Ver Gravações no FlowZap contratadas",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/billing/addons/recordings",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "billing",
                "addons",
                "recordings"
              ]
            },
            "description": "O módulo Gravações no FlowZap (R$ 29 por número/mês): ouvir e baixar as gravações das ligações no console e guardá-las até 90 dias, com até 10 GB por conta. Sem o módulo, a gravação fica disponível 7 dias só pela API. Mostra em quantos números a conta tem o módulo, o máximo do plano, o preço por número, a redução agendada e o aumento ainda por pagar.\n\nEscopo: `billing:read`."
          }
        },
        {
          "name": "Mudar a quantidade de números com Gravações no FlowZap",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": false,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/billing/addons/recordings",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "billing",
                "addons",
                "recordings"
              ]
            },
            "description": "Igual a `POST /v1/billing/addons/calls`, para o módulo Gravações no FlowZap. Corpo: `{\"quantity\": N, \"method\": \"pix\" | \"credit_card\"}`. **Aumento**: cobra agora o proporcional dos dias que faltam no período (mínimo R$ 5,00), por Pix ou cartão (`method` obrigatório), num checkout avulso do Asaas; responde 201 com o `link` e a quantidade sobe depois do pagamento confirmado. **Redução**: agendada para a próxima renovação, sem reembolso (200, `result: scheduled`). A quantidade atual de novo cancela a redução agendada (200, `result: unchanged`). Depois de contratar, escolha no console quais números usam o módulo.\n\n`Idempotency-Key` obrigatória (16 a 128 caracteres): repetir com a mesma chave devolve o mesmo resultado e o mesmo link, sem novo checkout; com outra quantidade, forma ou com a chave usada nas ligações, 409 `idempotency_conflict`.\n\nEscopo: `billing:write`."
          }
        },
        {
          "name": "Contratar um plano por Pix",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": false,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/billing/checkout/pix",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "billing",
                "checkout",
                "pix"
              ]
            },
            "description": "A primeira contratação da conta. Corpo: `{\"price_id\": \"<id da oferta>\", \"call_quantity\": 0}` — `call_quantity` são os números com ligações (0 até os números do plano), cobrados junto com o plano. Responde 201 com o `link` do checkout do Asaas; a assinatura começa quando o Pix é pago. Um plano por conta: mudar de plano passa pela equipe FlowZap.\n\n`Idempotency-Key` obrigatória (16 a 128 caracteres): a mesma chave devolve o mesmo checkout e nunca cria outro no Asaas; com outra oferta, 409 `idempotency_conflict`. Checkout vencido sem pagamento (2 horas): 410, peça de novo com outra chave.\n\nEscopo: `billing:write`."
          }
        },
        {
          "name": "Contratar um plano com cartão de crédito",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": false,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/billing/checkout/card",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "billing",
                "checkout",
                "card"
              ]
            },
            "description": "Igual ao Pix, com a assinatura recorrente no cartão: **o cartão é digitado na página do Asaas** (`link`), nunca enviado ao FlowZap. Só planos mensais e sem cupom. Disponível quando `meta.card_enabled` é true; senão 503 `card_checkout_unavailable`.\n\n`Idempotency-Key` obrigatória (16 a 128 caracteres).\n\nEscopo: `billing:write`."
          }
        },
        {
          "name": "Pagar a renovação por Pix",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/billing/renewal-cycles/:cycleId/checkout/pix",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "billing",
                "renewal-cycles",
                ":cycleId",
                "checkout",
                "pix"
              ],
              "variable": [
                {
                  "key": "cycleId",
                  "value": "",
                  "description": "`renewal_cycle.id` de `GET /v1/billing/subscription`."
                }
              ]
            },
            "description": "Cria (ou devolve) o Pix da fatura de renovação em aberto. Idempotente pela fatura: pedir de novo devolve o mesmo link enquanto vale; depois de vencido (2 horas), 410 e o próximo pedido cria outro. Sem corpo; `Idempotency-Key` não é necessária.\n\nEscopo: `billing:write`."
          }
        },
        {
          "name": "Encerrar (ou manter) a assinatura no fim do período",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": false,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/billing/subscription/renewal",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "billing",
                "subscription",
                "renewal"
              ]
            },
            "description": "Corpo: `{\"subscription_id\": \"<subscription.id>\", \"cancel_at_period_end\": true}`. `true` agenda o encerramento para o fim do período pago (nada é cobrado depois); `false` desfaz. Sem reembolso.\n\n`Idempotency-Key` obrigatória e **no formato UUID**: a mesma chave devolve o mesmo resultado; com outro conteúdo, 409 `renewal_conflict`.\n\nEscopo: `billing:write`."
          }
        },
        {
          "name": "Confirmar a mudança de plano agendada",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/billing/plan-changes/:changeId/confirm",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "billing",
                "plan-changes",
                ":changeId",
                "confirm"
              ],
              "variable": [
                {
                  "key": "changeId",
                  "value": "",
                  "description": "`plan_change.id` de `GET /v1/billing/subscription`."
                }
              ]
            },
            "description": "Confirma a mudança de plano agendada pela equipe FlowZap que aumenta o valor (`plan_change.requires_confirmation`), antes de a renovação ser preparada. Idempotente: confirmar de novo responde 200 sem refazer. Sem corpo; `Idempotency-Key` não é necessária.\n\nEscopo: `billing:write`."
          }
        }
      ]
    },
    {
      "name": "Ligações",
      "description": "Beta: fazer, atender, recusar, desligar e silenciar ligações (com áudio por WebSocket), escolher os números com ligações, liberar as origens do áudio no navegador, definir os números de teste do piloto e ver se um número está pronto para ligações.",
      "item": [
        {
          "name": "Ver os números com ligações (beta)",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/calls/numbers",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "calls",
                "numbers"
              ]
            },
            "description": "**Beta.** A quantidade de números com ligações contratada (assinatura, licença ou cortesia), quantos estão escolhidos, se a conta tem a liberação de teste (`trial`, o piloto) e cada número com `selected` e `calls_enabled` (ligações ativas agora). Uma chave presa a uma área de trabalho ou a um número vê só os números dela; `quantity` e `selected` são da conta.\n\nUma chave da organização inteira vê a escolha da conta toda, como no console: só enquanto quem criou a chave é **dona ou administradora da conta inteira** (senão 403 `owner_or_admin_required`).\n\nEscopo: `calls:read` ou `calls:admin`."
          }
        },
        {
          "name": "Escolher os números com ligações (beta)",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/calls/numbers",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "calls",
                "numbers"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"instance_ids\": [\n    \"00000000-0000-4000-8000-000000000000\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "**Beta.** Os números com ligações passam a ser exatamente `instance_ids` (até a quantidade contratada; acima, 409 `call_quantity_exceeded` com `quantity` e `requested`). Cada número que mudou reconecta para aplicar (`changes[].reconnect`: `now`, `later` com `retry_after_s` — reconectou há menos de 10 minutos — ou `not_connected`, aplicado quando o número voltar); desligar vale na hora. Acompanhe a conclusão por `GET /v1/calls/numbers` (`calls_enabled`) ou por `GET …/calls/readiness` do número. Enviar a mesma lista de novo não muda nada nem reconecta: a rota é idempotente por si (`Idempotency-Key` é aceita, não necessária). Fica registrado como feito por quem criou a chave.\n\nSó chaves da organização inteira: chave presa a uma área de trabalho ou a um número recebe 403 `organization_key_required`. Quem criou a chave precisa ser, agora, **dona ou administradora da conta inteira**, como no console (senão 403 `owner_or_admin_required`).\n\nEscopo: `calls:write` ou `calls:admin`."
          }
        },
        {
          "name": "Ver as origens do áudio no navegador (beta)",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/calls/media-origins",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "calls",
                "media-origins"
              ]
            },
            "description": "**Beta.** Os endereços de sistema (origens exatas, `https://host[:porta]`) que podem abrir o áudio das ligações desta conta pelo navegador, até 10. Valem para a conta inteira (todos os números) e só para ela: cada conta, homologação ou produção, tem a própria lista.\n\nSem nenhuma origem, o áudio abre no domínio do FlowZap e em clientes fora do navegador (servidor, app nativo), que não enviam origem. Com origens cadastradas, o bilhete de áudio emitido pela API (`POST …/calls` com `audio`, `…/answer`, `…/media-ticket`) passa a levá-las assinadas, e o WebSocket recusa um navegador de outra origem. Nada é guardado na URL do navegador além do bilhete de 60 s.\n\nSó chaves da organização inteira (chave presa a área de trabalho ou número: 403 `organization_key_required`), criadas por quem é, agora, **dona ou administradora da conta inteira** (senão 403 `owner_or_admin_required`).\n\nEscopo: `calls:read` ou `calls:admin`."
          }
        },
        {
          "name": "Cadastrar uma origem do áudio no navegador (beta)",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/calls/media-origins",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "calls",
                "media-origins"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"origin\": \"https://app.exemplo.com.br\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "**Beta.** Libera uma origem exata para o áudio das ligações da conta. Aceita `https://host` ou `https://host:porta`; para desenvolvimento, também `http://localhost[:porta]` e `http://127.0.0.1[:porta]`. Recusa (400 `invalid_origin`) caminho, `?`, `#`, usuário e senha, `*` e qualquer outro `http://`. A origem é guardada na forma canônica (minúsculas, sem barra final, sem `:443`), com até 120 caracteres.\n\nIdempotente por si: cadastrar uma origem que já está na lista responde 200 com a mesma lista, sem registrar nada; uma nova responde 201. A 11ª recebe 409 `media_origins_limit` (remova uma antes). Vale para os bilhetes emitidos depois; um bilhete já emitido continua com as origens que tinha. Cada inclusão fica registrada (quem criou a chave, qual chave, quando).\n\nEscopo: `calls:admin`."
          }
        },
        {
          "name": "Remover uma origem do áudio no navegador (beta)",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/calls/media-origins?origin=https://homologacao.exemplo.com.br",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "calls",
                "media-origins"
              ],
              "query": [
                {
                  "key": "origin",
                  "value": "https://homologacao.exemplo.com.br",
                  "description": "",
                  "disabled": false
                }
              ]
            },
            "description": "**Beta.** Remove a origem informada em `origin` (qualquer grafia da mesma origem serve). Idempotente: remover uma origem que não está na lista responde 200 com `removed: false`. Os bilhetes emitidos depois deixam de aceitá-la; um bilhete já emitido vale até vencer (60 s para conectar). Cada remoção fica registrada (quem criou a chave, qual chave, quando).\n\nEscopo: `calls:admin`."
          }
        },
        {
          "name": "Ver os números de teste do piloto (beta)",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/calls/test-numbers",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "calls",
                "test-numbers"
              ]
            },
            "description": "**Beta.** No piloto (`trial: true`, liberação de teste ligada pela equipe FlowZap), só os números de teste tocam no FlowZap quando ligam e só eles podem receber ligações; até 20. Um número com ligações contratadas (`PUT /v1/calls/numbers`) não tem essa restrição: liga e recebe de qualquer telefone. `added_at` é a última inclusão pela API (`null`: cadastrado antes pela equipe FlowZap). A lista aparece mesmo com o piloto desligado, mas só vale com ele ligado.\n\nSair do piloto é contratar ligações (`POST /v1/billing/addons/calls`) e escolher os números; ligar ou desligar o piloto continua com a equipe FlowZap.\n\nSó chaves da organização inteira (403 `organization_key_required`), de quem é, agora, **dona ou administradora da conta inteira** (403 `owner_or_admin_required`).\n\nEscopo: `calls:read` ou `calls:admin`."
          }
        },
        {
          "name": "Definir os números de teste do piloto (beta)",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/calls/test-numbers",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "calls",
                "test-numbers"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"phones\": [\n    \"+5511900000001\",\n    \"+5541900000002\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "**Beta.** Os números de teste passam a ser exatamente `phones` (E.164; repetidos contam uma vez). Só com o piloto ligado (senão 409 `call_trial_not_enabled`; esta rota nunca liga o piloto); até 20 números diferentes ao mesmo tempo e até 40 números diferentes incluídos em 30 dias (acima, 409 `call_test_numbers_limit`: o piloto é para testar, não para trocar a lista a cada ligação). Vale na próxima ligação, sem reconectar o número. Um número brasileiro de celular casa com a grafia sem o nono dígito, como o WhatsApp às vezes informa.\n\nIdempotente por si: a mesma lista (em qualquer ordem) não muda nada (`changes` vazios); `Idempotency-Key` é aceita, não necessária. Cada inclusão e remoção fica registrada (quem criou a chave, qual chave, quando).\n\nEscopo: `calls:admin`."
          }
        },
        {
          "name": "Histórico de ligações do número",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/calls",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "calls"
              ],
              "query": [
                {
                  "key": "status",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "direction",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "from",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "to",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "phone",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "user_id",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "Valor de `next_cursor` da página anterior.",
                  "disabled": true
                }
              ]
            },
            "description": "Ligações do número, da mais nova para a mais antiga: recebidas e feitas pelo FlowZap (console ou API com áudio) e as que só tocaram no celular. `missed` marca recebidas não atendidas; `via` diz por onde foi atendida ou feita; `user_id` é a pessoa da equipe que atendeu ou ligou pelo console; `actor_label` e `ended_by_label`, o atendente do seu sistema que fez, atendeu, recusou ou desligou pela API. Cada ligação traz `recording` (metadados da gravação) quando há gravação; o áudio é baixado em `GET …/calls/{callId}/recording`.\n\n**Situação e tempos.** `state` resume a ligação (`ringing`, `answered`, `in_progress` — a voz conectou —, `completed`, `missed`, `no_answer`, `declined`, `cancelled`, `failed`, `ended`) e `ended_by` diz quem encerrou (`agent`, `contact`, `system`). `requested_at` (pedido), `started_at` (início do toque), `answered_at`, `audio_connected_at` (voz conectada) e `ended_at`, em UTC; `wait_duration_ms` é a espera e `talk_duration_ms` a conversa (`duration_ms` inclui o toque). O WhatsApp não informa \"ocupado\": um contato ocupado aparece como `declined`. Veja `Call` para a tabela completa de `reason` → `state`/`ended_by`.\n\nO histórico vem dos eventos `call.*` do número e aparece em segundos; as ligações dos últimos 90 dias anteriores a esta versão também entram.\n\nFiltros: `status` (`all`, `missed`, `answered`), `direction`, `from`/`to` (início da ligação, ISO 8601; `to` exclusivo), `phone` (E.164), `user_id`. Páginas de até 100 (`limit`, padrão 50) com `next_cursor`.\n\nEscopo: `calls:read`."
          }
        },
        {
          "name": "Fazer ligação (beta)",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/calls",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "calls"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"to\": \"+5511999990000\",\n  \"audio\": true,\n  \"actor_label\": \"Ana (Gonzaga)\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "**Beta.** Só para números com ligações: os números escolhidos para ligações (`PUT /v1/calls/numbers`, dentro da quantidade contratada) ligam para qualquer número; sem números contratados, a liberação de teste da conta liga só para os números de teste dela (aceitos também sem o nono dígito de celular brasileiro) — fora deles, 403 `call_target_not_allowed`. Número sem ligações: 403 `calls_not_enabled`.\n\n**Sem `audio`** (ligação de teste): a resposta é 202 com o `operation_id` (uma repetição de operação já concluída devolve o resultado). Acompanhe por `GET /v1/operations/{id}`: a operação termina com sucesso, `{\"call_id\", \"status\": \"ringing\"}`, assim que a chamada é oferecida (em até 20 s); quem atende ouve um aviso de teste. A ligação continua depois disso e é informada pelos eventos `call.started`, `call.answered` e `call.ended`. Sem atender em 45 s, a ligação é cancelada.\n\n**Com `audio: true`** (ligação ao vivo, como no console): a resposta é 202 com `media_session_id` e `media` (`CallMediaStarted`). Os eventos `call.started`, `call.answered`, `call.media_connected` e `call.ended` trazem o `media_session_id`. Conecte o WebSocket de áudio (`media.url`) logo após a resposta 202, sem esperar a operação: o telefone do contato só toca depois que o áudio do atendente estiver conectado. A operação termina com sucesso, `{\"call_id\", \"status\": \"ringing\"}`, assim que a chamada é oferecida — em até 45 s no pior caso (até 20 s esperando o áudio do atendente conectar e até 20 s para oferecer a chamada). Se o áudio do atendente não conectar em 20 s, a operação falha com `media_failed` e o telefone do contato não chega a tocar (nenhum evento `call.*` é emitido).\n\n### Áudio pelo WebSocket (contrato)\n- **Conexão:** `GET` com upgrade para WebSocket em `media.url` (`wss://<host>/v1/calls/media?ticket=…`), sem cabeçalho de autenticação: o bilhete na URL é a credencial. Ele vale **60 s** para conectar e **uma única conexão**; vencido ou já usado, o hub fecha com **4001**. Antes de conectar, um bilhete novo para a mesma sessão sai em `POST …/calls/{media_session_id}/media-ticket` (ou repetindo o pedido com a mesma `Idempotency-Key`). Sem compressão (permessage-deflate desligado).\n- **Origem (navegador):** o hub aceita o próprio endereço do FlowZap, conexões sem cabeçalho `Origin` (clientes fora do navegador: servidor, app nativo) e as origens exatas cadastradas para a sua conta (`GET/POST/DELETE /v1/calls/media-origins`, escopo `calls:admin`, até 10, como `https://softphone.cliente.com.br`, sem curinga; `http://localhost[:porta]` e `http://127.0.0.1[:porta]` para desenvolvimento). A lista vai assinada dentro do bilhete: vale para os bilhetes emitidos depois da mudança. Cada conta (homologação, produção) tem a própria lista; nada muda nas outras. Uma página de outra origem chega a abrir o WebSocket, mas recebe `{\"type\":\"state\",\"state\":\"ended\",\"reason\":\"origin_not_allowed\"}` e o fechamento **4003** (`origin_not_allowed`), visíveis no seu JavaScript. O bilhete não é consumido: dentro dos 60 s, o mesmo bilhete ainda conecta a partir de uma página autorizada.\n- **Áudio:** quadros **binários** de 20 ms, PCM16 little-endian, mono, 16 kHz = **640 bytes** por quadro, nos dois sentidos. Quadros de outro tamanho são descartados; mensagem acima de 16 KiB fecha a conexão. Em atraso, o hub descarta os quadros mais novos (fila de ~1 s por lado) em vez de atrasar o outro lado.\n- **Controle:** mensagens de **texto** JSON (`CallMediaControl`): `state` (`waiting_peer`, `connected`, `ended` com `reason`), `ping` do hub a cada 10 s (não precisa responder) e `pong` em resposta ao seu `{\"type\":\"ping\"}`.\n- **Manter viva:** qualquer mensagem sua (áudio ou `{\"type\":\"ping\"}`) zera o relógio; **30 s** sem receber nada fecham a sessão (4008, `idle_timeout`). Mande áudio continuamente (silêncio também) ou um `ping` a cada 10 s.\n- **Espera pelo número:** se você conectar antes do número, a sessão espera o número por até 30 s (90 s quando o número conecta primeiro); depois, 4008 `pair_timeout`.\n- **Limites:** 10 sessões de áudio simultâneas por organização (a 11ª recebe `ended`/`org_full` e fecha com **1013**), duração máxima de **2 h** (4008 `max_duration`), uma conexão por lado (a segunda recebe **4009** `duplicate_leg` sem afetar a primeira).\n- **Códigos de fechamento:** `1000` fim normal (o outro lado saiu: `peer_left`, ou você fechou); `1001` hub em manutenção (`shutdown`); `1013` sem capacidade agora (`org_full`/`hub_full`: tente de novo em alguns segundos); `4001` bilhete inválido, vencido ou já usado (peça outro); `4003` origem da página não permitida para a conta (`origin_not_allowed`; o bilhete continua valendo); `4008` tempo esgotado (`idle_timeout`, `pair_timeout`, `max_duration`); `4009` conexão repetida para a mesma sessão. Antes de fechar depois de um bilhete válido, o hub envia `{\"type\":\"state\",\"state\":\"ended\",\"reason\":…}`.\n- **Voz conectada:** o evento `call.media_connected` (e `audio_connected_at` em `GET …/calls/{callId}`) é o sinal de que a voz está passando: o WhatsApp atendeu, o seu WebSocket estava conectado e o primeiro áudio chegou. Uma ligação sem esse evento nunca teve voz.\n- **Queda da conexão:** se o seu WebSocket cair, a ligação termina (o número desliga); não é possível reconectar o áudio a uma ligação em andamento (por exemplo, depois de recarregar a página).\n- **Limitações:** só ligações de voz individuais (sem ligações em grupo, sem vídeo, sem transferência para outro atendente ou número). Uma ligação recebida é atendida uma vez: o segundo `…/answer` para a mesma chamada recebe 409 `call_already_answering`.\n\nFalhas da operação (`error.code`, operação `failed`): `calls_not_enabled` e `call_target_not_allowed` (o número verifica de novo), `call_in_progress` (o número já está em uma ligação), `calls_unavailable` (ligações indisponíveis neste número agora), `invalid_phone`, `media_failed` (com áudio: o número não conectou o áudio; o telefone nem toca).\n\n**Aviso de gravação** (só com `audio: true`; a ligação de teste nunca é gravada, e `recording_notice` sem `audio` é 400 `invalid_input`): quando o número grava as ligações, `recording_notice: false` dispensa o aviso falado só nesta ligação — a gravação começa assim que o áudio conecta e o cliente ouve o atendente direto; `true` toca o aviso mesmo com o padrão do número desligado. Sem o campo vale `notice_default` do número (`GET …/call-recording`). Sem o aviso, a empresa precisa informar a gravação ao cliente de outra forma (LGPD).\n\n**Atendente do seu sistema** (só com `audio: true`): `actor_label` (1 a 80 caracteres, espaços nas pontas removidos) guarda quem fez a ligação, como enviado (declarado, não verificado) — as mesmas regras de `actor_label` dos atendimentos. Volta em `actor_label` de `GET …/calls/{callId}`; nunca vai para o WhatsApp. Sem `audio`, 400 `invalid_input`.\n\nUse `Idempotency-Key`: repetir com a mesma chave devolve a mesma operação e nunca faz uma segunda ligação; com áudio, a repetição traz um bilhete novo para a mesma sessão. A mesma chave com e sem `audio` (ou com outro `recording_notice` ou `actor_label`) é conteúdo diferente (409 `idempotency_conflict`).\n\nEscopo: `calls:write` (chaves criadas antes dele: `engine:write`)."
          }
        },
        {
          "name": "Ver se o número está pronto para ligações (beta)",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/calls/readiness",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "calls",
                "readiness"
              ],
              "query": [
                {
                  "key": "to",
                  "value": "+5511912345678",
                  "description": "Destino a avaliar (E.164). Inválido não é 400: aparece como `invalid_phone` em `target`.",
                  "disabled": true
                }
              ]
            },
            "description": "**Beta.** Diagnóstico de leitura: se este número consegue fazer (`can_place`) e atender (`can_receive`) ligações agora por esta chave e, quando não, o motivo objetivo. Nunca liga, nunca consulta o celular. `mode`: `off` (sem ligações), `test_callers` (piloto: só os números de teste) ou `any_caller` (ligações contratadas).\n\n`checks`, em ordem, cada um `{name, ok, code, detail?}` (`code` só quando bloqueia; `blockers` junta esses códigos):\n- `account`: `organization_suspended`.\n- `calls_module`: `calls_not_enabled` (o número não tem ligações; escolha-o em `PUT /v1/calls/numbers`).\n- `number_connection`: `number_not_connected`.\n- `key_scope`: `scope_denied` (esta chave não tem `calls:write`, então não faz nem atende).\n- `target` (só com `to` e chave com `calls:write`; uma chave só de leitura não recebe esta checagem): `invalid_phone` ou `call_target_not_allowed` (no piloto, `to` não é número de teste; a grafia sem o nono dígito de um celular brasileiro conta como o mesmo número). Os números de teste nunca aparecem aqui.\n- `media_origins` (informativo, sempre `ok`): quantas origens de navegador a conta tem; sem nenhuma, o áudio abre no domínio do FlowZap e em clientes fora do navegador.\n- `recording` (informativo, sempre `ok`): se o número grava e se o aviso falado toca por padrão.\n\nFora deste diagnóstico, porque acontecem na ligação: microfone negado, origem recusada pelo WebSocket, bilhete vencido ou já usado, falha de mídia, ausência de áudio e a permissão do atendente. Uma chave presa a área de trabalho ou número só consulta os próprios números (404 nos demais).\n\nEscopo: `calls:read`."
          }
        },
        {
          "name": "Ver ligação",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/calls/:callId",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "calls",
                ":callId"
              ],
              "variable": [
                {
                  "key": "callId",
                  "value": "",
                  "description": "Id da ligação no histórico (`id`) ou o `call_id` do WhatsApp."
                }
              ]
            },
            "description": "Uma ligação do histórico, com a situação da gravação.\n\nEscopo: `calls:read`."
          }
        },
        {
          "name": "Baixar gravação da ligação",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/calls/:callId/recording",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "calls",
                ":callId",
                "recording"
              ],
              "variable": [
                {
                  "key": "callId",
                  "value": "",
                  "description": "Id da ligação no histórico (`id`) ou o `call_id` do WhatsApp."
                }
              ]
            },
            "description": "O áudio da ligação: Ogg/Opus estéreo, 16 kHz — canal esquerdo, a outra pessoa; canal direito, o que ela ouviu (o aviso de gravação e a equipe). Aceita `Range` (206 com `Content-Range`), para tocar e avançar sem baixar tudo; nunca vai para cache. Cada resposta com áudio (200 ou 206) é registrada (quem, quando, por qual chave), uma vez a cada 5 minutos por chave e gravação. `HEAD` responde só os cabeçalhos (tamanho em `Content-Length`), sem registro.\n\nO arquivo é `audio/ogg; codecs=opus`, 2 canais, 16 kHz (`recording.mime`, `channels`, `sample_rate_hz`).\n\nDisponível enquanto a gravação está guardada: 7 dias sem o módulo Gravações no FlowZap; o prazo escolhido (até 90 dias) com ele. Sem arquivo, 404 `recording_not_found` com `reason`: `not_recorded` (a ligação não foi gravada: sem áudio pelo FlowZap, gravação desligada ou espaço esgotado — veja `recording_state`), `failed` (a gravação falhou: `recording.failure_reason`), `expired` (o prazo acabou) ou `deleted` (apagada por alguém). Ainda gravando ou em conversão (segundos depois do fim), 409 `recording_not_ready` com `recording_state` (`recording` ou `processing`) — espere o webhook `call.recording_ready` (ou `call.recording_failed`).\n\nEscopo: `calls:recordings` (à parte de `calls:read`: listar ligações não dá acesso ao áudio)."
          }
        },
        {
          "name": "Apagar gravação da ligação",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/calls/:callId/recording",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "calls",
                ":callId",
                "recording"
              ],
              "variable": [
                {
                  "key": "callId",
                  "value": "",
                  "description": "Id da ligação no histórico (`id`) ou o `call_id` do WhatsApp."
                }
              ]
            },
            "description": "Apaga a gravação agora (o arquivo deixa de ser servido na hora e é removido do disco em segundos); a ligação continua no histórico com `recording.state: deleted` e `recording.deleted_reason: api`. Repetir devolve a mesma resposta. Gera o webhook `call.recording_deleted`. A exclusão é registrada (quem, quando, por qual chave).\n\nEscopos: `calls:write` e `calls:recordings`."
          }
        },
        {
          "name": "Ver gravação das ligações do número",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/call-recording",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "call-recording"
              ]
            },
            "description": "Se o número grava as ligações, por quantos dias guarda, se tem o módulo Gravações no FlowZap, o texto do aviso e o espaço usado pela conta.\n\nEscopo: `calls:read`."
          }
        },
        {
          "name": "Ligar ou desligar a gravação das ligações",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/call-recording",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "call-recording"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"enabled\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Liga ou desliga a gravação das ligações do número (desligada por padrão). Só são gravadas as ligações que passam pelo FlowZap com áudio (console ou API com `audio: true`); atendidas no celular e ligações de teste nunca. Repetir os mesmos valores não muda nada.\n\n**Aviso e LGPD.** Com a gravação ligada, cada ligação começa com o aviso falado \"Esta ligação pode ser gravada para fins de qualidade e segurança.\", ouvido pelos dois lados, e a gravação começa nele. `notice_default: false` (só o proprietário, um administrador ou uma chave com `calls:write`) faz as ligações gravadas começarem sem o aviso, a não ser que a própria ligação peça (`recording_notice: true` em `POST …/calls` com `audio` ou em `…/answer`); cada ligação também pode dispensá-lo (`recording_notice: false`). Sem o aviso, a empresa precisa informar a gravação ao cliente de outra forma. A gravação feita sem aviso por escolha fica guardada e aparece com `recording.notice_mode: skipped_by_choice`; quem escolheu é a pessoa da ligação (`user_id`) ou a chave da API (`via: api`). A conta é a controladora desses dados: cabe a ela ter base legal para gravar (por exemplo, legítimo interesse ou consentimento), informar a finalidade na sua política de privacidade e atender os pedidos dos titulares (acesso e exclusão: `GET` e `DELETE …/calls/{callId}/recording`). O FlowZap guarda o áudio cifrado, fora do banco e dos backups, apaga-o sozinho no fim do prazo e registra cada acesso.\n\n**Prazo.** Sem o módulo Gravações no FlowZap, 7 dias (o áudio fica disponível só pela API, MCP e webhook). Com o módulo, `retention_days` de 7 a 90 (padrão 90), e o console ganha ouvir e baixar. `retention_days` acima de 7 sem o módulo: 403 `recording_module_required`. O prazo vale para as gravações novas; um prazo menor encurta também as já guardadas (nunca alonga). Sem o módulo (ou quando ele sai do número), as gravações guardadas ficam 7 dias a partir de quando ficaram prontas, e `retention_until` mostra isso.\n\n**Gravação descartada.** Se a pessoa desliga antes do fim de um aviso que devia tocar, a gravação é descartada na hora (`state: failed`, `notice_mode: incomplete`, sem arquivo): sem o aviso inteiro nada fica guardado. Uma gravação vai no máximo até 2 horas; a ligação segue sem gravar depois disso.\n\n**Espaço.** 10 GiB por conta; no limite, as ligações seguem sem gravar (`recording_state: skipped_quota`).\n\nEscopo: `calls:write`."
          }
        },
        {
          "name": "Atender ligação (beta)",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": false,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/calls/:callId/answer",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "calls",
                ":callId",
                "answer"
              ],
              "variable": [
                {
                  "key": "callId",
                  "value": "",
                  "description": "ID da chamada, do evento `call.ringing`."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"recording_notice\": false,\n  \"actor_label\": \"Ana (Gonzaga)\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "**Beta.** Atende uma ligação que está tocando neste número (evento `call.ringing` sem `call.ended`); fora disso, 409 `call_not_ringing`. A resposta é 202 com `media_session_id` e `media`: conecte o áudio pelo WebSocket como em `POST …/calls` com `audio` (contrato completo lá: PCM16 mono 16 kHz, quadros de 20 ms / 640 bytes, nos dois sentidos, bilhete de 60 s e uso único). Mesmas regras de ligações do número.\n\n**Um atendimento por ligação:** se outra pessoa (pelo console ou por outra chave) já atendeu esta chamada — atendimento na fila, em andamento ou concluído nos últimos 5 minutos —, a resposta é 409 `call_already_answering` na hora, sem criar operação. Repetir o seu próprio pedido com a mesma `Idempotency-Key` continua devolvendo a sua operação. Se o atendimento anterior falhou ou venceu, um novo `…/answer` é aceito.\n\n**O atendimento espera o seu áudio:** a ligação só é atendida no WhatsApp depois que o seu WebSocket conecta em `media.url`; até lá ela continua tocando para quem ligou. Sem conexão em 20 s, a ligação termina com `reason: media_failed` sem ter sido atendida (`answered: false`). O evento `call.media_connected` é o sinal de que a voz está passando.\n\nCorpo vazio (`{}`) ou `{\"recording_notice\": false}`: quando o número grava, dispensa o aviso falado só nesta ligação (`true` toca mesmo com o padrão do número desligado; ausente, vale o `notice_default` do número). `actor_label` (1 a 80 caracteres) guarda o atendente do seu sistema que atendeu, como enviado (declarado, não verificado); volta em `actor_label` da ligação. `Idempotency-Key` obrigatória; a repetição traz um bilhete novo para a mesma sessão; a mesma chave com outro `recording_notice` ou `actor_label` é 409 `idempotency_conflict`.\n\nEscopo: `calls:write` (chaves criadas antes dele: `engine:write`)."
          }
        },
        {
          "name": "Recusar ligação que está tocando (beta)",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": false,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/calls/:callId/decline",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "calls",
                ":callId",
                "decline"
              ],
              "variable": [
                {
                  "key": "callId",
                  "value": "",
                  "description": "ID da chamada, do evento `call.ringing`."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"actor_label\": \"Ana (Gonzaga)\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "**Beta.** Recusa uma ligação que está tocando neste número à espera de atendimento (`call.ringing`); fora disso, 409 `call_not_ringing`. Corpo vazio (`{}`) ou `{\"actor_label\": \"…\"}`: o atendente do seu sistema que recusou, guardado na ligação (`ended_by_label`, com `state: declined` e `ended_by: agent`). Espera até 15 s pelo número, como as outras operações. `Idempotency-Key` obrigatória; a mesma chave com outro `actor_label` é 409 `idempotency_conflict`.\n\nEscopo: `calls:write` (chaves criadas antes dele: `engine:write`)."
          }
        },
        {
          "name": "Desligar ligação (beta)",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": false,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/calls/:callId/hangup",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "calls",
                ":callId",
                "hangup"
              ],
              "variable": [
                {
                  "key": "callId",
                  "value": "",
                  "description": "ID da chamada (`call.started`, `call.ringing` ou o resultado de `POST …/calls`)."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"actor_label\": \"Ana (Gonzaga)\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "**Beta.** Encerra uma ligação do número em andamento. Corpo vazio (`{}`) ou `{\"actor_label\": \"…\"}`: o atendente do seu sistema que desligou, guardado na ligação (`ended_by_label`, com `ended_by: agent`). Espera até 15 s pelo número. `Idempotency-Key` obrigatória; a mesma chave com outro `actor_label` é 409 `idempotency_conflict`.\n\nEscopo: `calls:write` (chaves criadas antes dele: `engine:write`)."
          }
        },
        {
          "name": "Silenciar ou reativar o áudio enviado (beta)",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": false,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/calls/:callId/mute",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "calls",
                ":callId",
                "mute"
              ],
              "variable": [
                {
                  "key": "callId",
                  "value": "",
                  "description": "ID da chamada em andamento."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"muted\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "**Beta.** `{\"muted\": true}` para de enviar o seu áudio a quem está na ligação; `false` volta a enviar. Espera até 15 s pelo número. `Idempotency-Key` obrigatória.\n\nEscopo: `calls:write` (chaves criadas antes dele: `engine:write`)."
          }
        },
        {
          "name": "Novo bilhete de áudio (beta)",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/calls/:callId/media-ticket",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "calls",
                ":callId",
                "media-ticket"
              ],
              "variable": [
                {
                  "key": "callId",
                  "value": "",
                  "description": "ID da chamada ou o `media_session_id` devolvido por `POST …/calls` (com `audio`) ou `…/answer`."
                }
              ]
            },
            "description": "**Beta.** Emite um bilhete novo (60 s, uma conexão) para a sessão de áudio de uma ligação deste número aberta nas últimas 2 horas e ainda não encerrada, quando o bilhete anterior venceu antes de conectar. Não reabre uma sessão: se a conexão de áudio caiu, a ligação já terminou. Ligação encerrada (`call.ended`): 409 `call_ended`. Corpo vazio (`{}`); não cria operação.\n\nEscopo: `calls:write` (chaves criadas antes dele: `engine:write`)."
          }
        },
        {
          "name": "Recusar chamada recebida no celular",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "disabled": true,
                "description": "Nova chave por pedido; repita a mesma para refazer com segurança."
              }
            ],
            "url": {
              "raw": "{{host}}/v1/workspaces/{{workspace_id}}/instances/{{instance_id}}/calls/:callId/reject",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "workspaces",
                "{{workspace_id}}",
                "instances",
                "{{instance_id}}",
                "calls",
                ":callId",
                "reject"
              ],
              "variable": [
                {
                  "key": "callId",
                  "value": "",
                  "description": "ID da chamada, do evento `call.offer`."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"from\": \"5511912345678@s.whatsapp.net\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Recusa uma chamada que toca no celular do número (evento `call.offer`), sem o módulo de ligações. Use o `callId` e o `from` do evento. Para uma ligação que toca à espera de atendimento (`call.ringing`), use `…/decline`.\n\nEscopo: `calls:write` (chaves criadas antes dele: `engine:write`)."
          }
        }
      ]
    },
    {
      "name": "Convite de dono",
      "description": "Página do console para aceitar o convite de dono enviado pela equipe FlowZap. Sem chave de API: o link do e-mail é a prova.",
      "item": [
        {
          "name": "Abrir um convite para ser dono",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/owner-invitations/preview",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "owner-invitations",
                "preview"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"token\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "auth": {
              "type": "noauth"
            },
            "description": "**Sem chave de API.** A página do console \"Aceitar convite para ser dono\" mostra a conta criada pela equipe FlowZap, o e-mail convidado (mascarado) e se esse e-mail já tem cadastro confirmado. O link vale 7 dias. O token vai no corpo, para não ficar em registros de acesso. Limite: 30 pedidos a cada 15 minutos por endereço de origem.\n\nSem autenticação por chave de API."
          }
        },
        {
          "name": "Aceitar um convite para ser dono",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{host}}/v1/owner-invitations/accept",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "owner-invitations",
                "accept"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"token\": \"texto\",\n  \"name\": \"texto\",\n  \"password\": \"texto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "auth": {
              "type": "noauth"
            },
            "description": "**Sem chave de API.** E-mail sem cadastro confirmado: o corpo `{token, name, password}` (senha de 12 a 128 caracteres, a mesma regra do cadastro) cria a pessoa com o e-mail já confirmado e a torna dona (um cadastro ainda não confirmado desse e-mail é aproveitado, com o nome e a senha novos); depois ela entra pelo login. E-mail com cadastro confirmado: a pessoa entra no console antes e envia `{token}` com `Authorization: Bearer` da sessão dela; o e-mail da sessão precisa ser o convidado. Limite: 10 pedidos a cada 15 minutos por endereço de origem.\n\nSem autenticação por chave de API."
          }
        }
      ]
    },
    {
      "name": "Conteúdo público",
      "description": "Sem chave de API: o que está publicado no blog, glossário, comparativos, segmentos e autores do site, e as listas do sitemap, do RSS e do llms.txt.",
      "item": [
        {
          "name": "Listar conteúdos publicados",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/public/content/items",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "public",
                "content",
                "items"
              ],
              "query": [
                {
                  "key": "type",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "tag",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ]
            },
            "auth": {
              "type": "noauth"
            },
            "description": "**Sem chave de API.** Lista paginada (20 por página) do que está publicado, do mais recente para o mais antigo. Filtros opcionais por tipo e por palavra-chave (`tag`). Usada pelo site para montar `/blog`, `/glossario`, `/comparativos` e `/segmentos`.\n\nSem autenticação por chave de API."
          }
        },
        {
          "name": "Ler um conteúdo publicado",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/public/content/items/:type/:slug",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "public",
                "content",
                "items",
                ":type",
                ":slug"
              ],
              "variable": [
                {
                  "key": "type",
                  "value": "",
                  "description": ""
                },
                {
                  "key": "slug",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "auth": {
              "type": "noauth"
            },
            "description": "**Sem chave de API.** O conteúdo publicado com o HTML já sanitizado (`html`), sumário (`toc`), tempo de leitura, TL;DR, perguntas frequentes, fontes, autor e revisor, capa (`cover.path` é o caminho no próprio site; `cover.og_url` é JPEG 1200×630), até 3 relacionados e o JSON-LD pronto (`json_ld`). Alterações ainda não publicadas nunca aparecem.\n\nSem autenticação por chave de API."
          }
        },
        {
          "name": "Ler um autor",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/public/content/authors/:slug",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "public",
                "content",
                "authors",
                ":slug"
              ],
              "variable": [
                {
                  "key": "slug",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "auth": {
              "type": "noauth"
            },
            "description": "**Sem chave de API.** Nome, bio, credenciais (`role_title`), foto (`photo_url`), perfis (`same_as`) e os conteúdos publicados do autor.\n\nSem autenticação por chave de API."
          }
        },
        {
          "name": "Entradas do sitemap",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/public/content/sitemap-entries",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "public",
                "content",
                "sitemap-entries"
              ]
            },
            "auth": {
              "type": "noauth"
            },
            "description": "**Sem chave de API.** Todo conteúdo publicado e indexável, com `updated_at` e a imagem de capa, para o `sitemap.xml` do site.\n\nSem autenticação por chave de API."
          }
        },
        {
          "name": "Entradas do feed RSS",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/public/content/feed-entries",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "public",
                "content",
                "feed-entries"
              ]
            },
            "auth": {
              "type": "noauth"
            },
            "description": "**Sem chave de API.** Os 50 artigos publicados mais recentes, para o `rss.xml` do site.\n\nSem autenticação por chave de API."
          }
        },
        {
          "name": "Entradas do llms.txt",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{host}}/v1/public/content/llms-entries",
              "host": [
                "{{host}}"
              ],
              "path": [
                "v1",
                "public",
                "content",
                "llms-entries"
              ]
            },
            "auth": {
              "type": "noauth"
            },
            "description": "**Sem chave de API.** Título, endereço, resumo e TL;DR de cada conteúdo publicado e indexável, para o `llms.txt` e o `llms-full.txt` do site.\n\nSem autenticação por chave de API."
          }
        }
      ]
    }
  ]
}
