{ "info": { "_postman_id": "62a14512-2f1c-4c80-a80c-cloudwhatsapi", "name": "CloudWhats API v1", "description": "Referência completa dos endpoints autenticáveis por chave de API. O conteúdo é gerado diretamente dos handlers e validadores do aplicativo para acompanhar o contrato implementado.\n\nFonte oficial: /docs/api e /api/openapi.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "item": [ { "name": "Automações", "item": [ { "name": "Listar automations", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations?credentialId={{credentialId}}&page={{page}}&pageSize={{pageSize}}&search={{search}}&status={{status}}&trigger={{trigger}}&view={{view}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "page", "value": "{{page}}", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "pageSize", "value": "{{pageSize}}", "description": "Quantidade de itens por página.", "disabled": true }, { "key": "search", "value": "{{search}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true }, { "key": "trigger", "value": "{{trigger}}", "description": "Valor opcional de trigger.", "disabled": true }, { "key": "view", "value": "{{view}}", "description": "Valor opcional de view.", "disabled": true } ] }, "description": "Lista automações da empresa, com suporte a escopo por conta quando necessário.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `automations:read`.\n\nPermissão: automations:read" }, "response": [] }, { "name": "Criar ou executar automations", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Cria uma automação. A validação do gatilho e do grafo acontece no backend.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"Automação API - Boas-vindas\",\n \"isActive\": false,\n \"triggerType\": \"MANUAL\",\n \"triggerConfig\": {},\n \"nodes\": [],\n \"edges\": []\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar automations", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/{{id}}?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "{{id}}" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Busca uma automação específica.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `automations:read`.\n\nPermissão: automations:read" }, "response": [] }, { "name": "Atualizar automations", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/{{id}}?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "{{id}}" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Atualiza uma automação existente.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"Automação API - Atualizada\",\n \"isActive\": false,\n \"nodes\": [],\n \"edges\": []\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir automations", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/{{id}}?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "{{id}}" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Remove a automação e seus dados associados.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write" }, "response": [] }, { "name": "Duplicar automations", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/{{id}}/duplicate?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "{{id}}", "duplicate" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Cria uma cópia completa da automação.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"Cópia da automação API\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar execuções", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/{{id}}/executions?credentialId={{credentialId}}&limit={{limit}}&mode={{mode}}&page={{page}}&stats={{stats}}&status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "{{id}}", "executions" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "mode", "value": "{{mode}}", "description": "all, live ou test", "disabled": true }, { "key": "page", "value": "{{page}}", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "stats", "value": "{{stats}}", "description": "Valor opcional de stats.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true } ] }, "description": "Consulta o histórico de execuções de uma automação.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `automations:read`.\n\nPermissão: automations:read" }, "response": [] }, { "name": "Consultar execuções", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/{{id}}/executions/{{executionId}}?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "{{id}}", "executions", "{{executionId}}" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Retorna os detalhes completos de uma execução específica.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `automations:read`.\n\nPermissão: automations:read" }, "response": [] }, { "name": "Listar schedule diagnostics", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/{{id}}/schedule-diagnostics?credentialId={{credentialId}}&schedule={{schedule}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "{{id}}", "schedule-diagnostics" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "schedule", "value": "{{schedule}}", "description": "Valor opcional de schedule.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:read`.\n\nPermissão: automations:read" }, "response": [] }, { "name": "Listar sessões", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/{{id}}/sessions?credentialId={{credentialId}}&limit={{limit}}&page={{page}}&search={{search}}&status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "{{id}}", "sessions" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "page", "value": "{{page}}", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "search", "value": "{{search}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:read`.\n\nPermissão: automations:read" }, "response": [] }, { "name": "Excluir sessões", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/{{id}}/sessions?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "{{id}}", "sessions" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Testar automations", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/{{id}}/test?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "{{id}}", "test" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Executa um teste da automação e retorna eventos/timeline da execução.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{\n \"testContext\": {\n \"contactId\": \"{{contactId}}\",\n \"credentialId\": \"{{credentialId}}\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Alternar automations", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/{{id}}/toggle?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "{{id}}", "toggle" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Ativa ou desativa a automação.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{\n \"isActive\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar trigger test", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/{{id}}/trigger-test?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "{{id}}", "trigger-test" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar trigger test session", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/{{id}}/trigger-test-session?credentialId={{credentialId}}&sessionId={{sessionId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "{{id}}", "trigger-test-session" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "sessionId", "value": "{{sessionId}}", "description": "Valor opcional de session.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write" }, "response": [] }, { "name": "Excluir trigger test session", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/{{id}}/trigger-test-session?credentialId={{credentialId}}&sessionId={{sessionId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "{{id}}", "trigger-test-session" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "sessionId", "value": "{{sessionId}}", "description": "Valor opcional de session.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write" }, "response": [] }, { "name": "Listar trigger webhook", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/{{id}}/trigger-webhook", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "{{id}}", "trigger-webhook" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:read`.\n\nPermissão: automations:read" }, "response": [] }, { "name": "Listar designer", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/designer?automationId={{automationId}}&credentialId={{credentialId}}&mode=CREATE", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "designer" ], "query": [ { "key": "automationId", "value": "{{automationId}}", "description": "Valor opcional de automation.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "mode", "value": "CREATE", "description": "Valor opcional de mode.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write" }, "response": [] }, { "name": "Criar ou executar designer", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/designer", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "designer" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{\n \"mode\": \"string\",\n \"automationId\": \"string\",\n \"credentialId\": \"string\",\n \"requestSummary\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar sessões", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/designer/sessions/{{sessionId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "designer", "sessions", "{{sessionId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write" }, "response": [] }, { "name": "Listar auditoria", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/designer/sessions/{{sessionId}}/audit", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "designer", "sessions", "{{sessionId}}", "audit" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write" }, "response": [] }, { "name": "Criar ou executar mensagens", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/designer/sessions/{{sessionId}}/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "designer", "sessions", "{{sessionId}}", "messages" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{\n \"role\": \"USER\",\n \"kind\": \"INSTRUCTION\",\n \"content\": \"string\",\n \"structuredPayload\": {\n \"selectedOptionId\": \"string\",\n \"selectedOptionLabel\": \"string\",\n \"clarificationId\": \"string\",\n \"payload\": {}\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar revisões", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/designer/sessions/{{sessionId}}/revisions", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "designer", "sessions", "{{sessionId}}", "revisions" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{\n \"requestedCredentialId\": \"string\",\n \"forceRegenerate\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Aprovar revisões", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/designer/sessions/{{sessionId}}/revisions/{{revisionId}}/approve", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "designer", "sessions", "{{sessionId}}", "revisions", "{{revisionId}}", "approve" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{\n \"requestedCredentialId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar diff", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/designer/sessions/{{sessionId}}/revisions/{{revisionId}}/diff", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "designer", "sessions", "{{sessionId}}", "revisions", "{{revisionId}}", "diff" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write" }, "response": [] }, { "name": "Rejeitar revisões", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/designer/sessions/{{sessionId}}/revisions/{{revisionId}}/reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "designer", "sessions", "{{sessionId}}", "revisions", "{{revisionId}}", "reject" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar catálogo", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/studio/catalog?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "studio", "catalog" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:read`.\n\nPermissão: automations:read" }, "response": [] }, { "name": "Instalar receitas", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/studio/recipes/{{recipeId}}/install?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "studio", "recipes", "{{recipeId}}", "install" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write" }, "response": [] }, { "name": "Listar timeline", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/studio/timeline?credentialId={{credentialId}}&limit={{limit}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "studio", "timeline" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:read`.\n\nPermissão: automations:read" }, "response": [] }, { "name": "Criar ou executar suggestions", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automations/suggestions?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automations", "suggestions" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{\n \"conversationId\": \"string\",\n \"sourceMessageId\": \"string\",\n \"generator\": \"rule_based\",\n \"action\": \"preview\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar automações por código", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/code-automations", "host": [ "{{baseUrl}}" ], "path": [ "api", "code-automations" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:read`.\n\nPermissão: automations:read" }, "response": [] }, { "name": "Criar ou executar automações por código", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/code-automations", "host": [ "{{baseUrl}}" ], "path": [ "api", "code-automations" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": {},\n \"triggerType\": \"string\",\n \"triggerConfig\": {},\n \"runtimeConfig\": {},\n \"draftSourceCode\": \"string\",\n \"isActive\": false,\n \"credentialId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar automações por código", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/code-automations/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "code-automations", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:read`.\n\nPermissão: automations:read" }, "response": [] }, { "name": "Atualizar automações por código", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/code-automations/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "code-automations", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": {},\n \"triggerType\": \"string\",\n \"triggerConfig\": {},\n \"runtimeConfig\": {},\n \"draftSourceCode\": \"string\",\n \"isActive\": false,\n \"credentialId\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir automações por código", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/code-automations/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "code-automations", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write" }, "response": [] }, { "name": "Listar execuções", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/code-automations/{{id}}/executions", "host": [ "{{baseUrl}}" ], "path": [ "api", "code-automations", "{{id}}", "executions" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:read`.\n\nPermissão: automations:read" }, "response": [] }, { "name": "Consultar execuções", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/code-automations/{{id}}/executions/{{executionId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "code-automations", "{{id}}", "executions", "{{executionId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:read`.\n\nPermissão: automations:read" }, "response": [] }, { "name": "Publicar automações por código", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/code-automations/{{id}}/publish", "host": [ "{{baseUrl}}" ], "path": [ "api", "code-automations", "{{id}}", "publish" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{\n \"activateAfterPublish\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Reverter automações por código", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/code-automations/{{id}}/rollback", "host": [ "{{baseUrl}}" ], "path": [ "api", "code-automations", "{{id}}", "rollback" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{\n \"revisionId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar trigger test", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/code-automations/{{id}}/trigger-test", "host": [ "{{baseUrl}}" ], "path": [ "api", "code-automations", "{{id}}", "trigger-test" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{\n \"triggerType\": \"string\",\n \"payload\": {},\n \"headers\": {},\n \"query\": {},\n \"path\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar quick automations", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/quick-automations?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "quick-automations" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:read`.\n\nPermissão: automations:read" }, "response": [] }, { "name": "Criar ou executar quick automations", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/quick-automations", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "quick-automations" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"recipeSlug\": \"string\",\n \"automationName\": \"string\",\n \"keywords\": \"string\",\n \"publicReplyMessage\": \"string\",\n \"privateReplyMessage\": \"string\",\n \"quickReplyMessage\": \"string\",\n \"quickReplyOptions\": \"string\",\n \"aiAgentId\": \"string\",\n \"aiAgentInstructions\": \"string\",\n \"sourceSurface\": \"instagram-content-tab\",\n \"instagramPublishedContentId\": \"string\",\n \"existingMedia\": {\n \"igMediaId\": \"string\",\n \"permalink\": \"string\",\n \"caption\": \"string\",\n \"thumbnailUrl\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar quick automations", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/quick-automations/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "quick-automations", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.\n\nPermissão: automations:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"recipeSlug\": \"string\",\n \"automationName\": \"string\",\n \"keywords\": \"string\",\n \"publicReplyMessage\": \"string\",\n \"privateReplyMessage\": \"string\",\n \"quickReplyMessage\": \"string\",\n \"quickReplyOptions\": \"string\",\n \"aiAgentId\": \"string\",\n \"aiAgentInstructions\": \"string\",\n \"existingMedia\": {\n \"igMediaId\": \"string\",\n \"permalink\": \"string\",\n \"caption\": \"string\",\n \"thumbnailUrl\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Chat interno", "item": [ { "name": "Listar channels", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/internal/channels", "host": [ "{{baseUrl}}" ], "path": [ "api", "internal", "channels" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:read`.\n\nPermissão: internalChat:read" }, "response": [] }, { "name": "Criar ou executar channels", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/internal/channels", "host": [ "{{baseUrl}}" ], "path": [ "api", "internal", "channels" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:write`.\n\nPermissão: internalChat:write" }, "response": [] }, { "name": "Consultar channels", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/internal/channels/{{channelId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "internal", "channels", "{{channelId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:read`.\n\nPermissão: internalChat:read" }, "response": [] }, { "name": "Atualizar channels", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/internal/channels/{{channelId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "internal", "channels", "{{channelId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:write`.\n\nPermissão: internalChat:write" }, "response": [] }, { "name": "Criar ou executar membros", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/internal/channels/{{channelId}}/members", "host": [ "{{baseUrl}}" ], "path": [ "api", "internal", "channels", "{{channelId}}", "members" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:write`.\n\nPermissão: internalChat:write" }, "response": [] }, { "name": "Excluir membros", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/internal/channels/{{channelId}}/members", "host": [ "{{baseUrl}}" ], "path": [ "api", "internal", "channels", "{{channelId}}", "members" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:write`.\n\nPermissão: internalChat:write" }, "response": [] }, { "name": "Criar ou executar mensagens", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/internal/channels/{{channelId}}/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "internal", "channels", "{{channelId}}", "messages" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:write`.\n\nPermissão: internalChat:write" }, "response": [] }, { "name": "Atualizar mensagens", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/internal/channels/{{channelId}}/messages/{{messageId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "internal", "channels", "{{channelId}}", "messages", "{{messageId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:write`.\n\nPermissão: internalChat:write" }, "response": [] }, { "name": "Excluir mensagens", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/internal/channels/{{channelId}}/messages/{{messageId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "internal", "channels", "{{channelId}}", "messages", "{{messageId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:write`.\n\nPermissão: internalChat:write" }, "response": [] }, { "name": "Criar ou executar reactions", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/internal/channels/{{channelId}}/reactions", "host": [ "{{baseUrl}}" ], "path": [ "api", "internal", "channels", "{{channelId}}", "reactions" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:write`.\n\nPermissão: internalChat:write" }, "response": [] }, { "name": "Atualizar read state", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/internal/channels/{{channelId}}/read-state", "host": [ "{{baseUrl}}" ], "path": [ "api", "internal", "channels", "{{channelId}}", "read-state" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:read`.\n\nPermissão: internalChat:read", "body": { "mode": "raw", "raw": "{\n \"lastReadMessageId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar contagem de não lidas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/internal/unread-count", "host": [ "{{baseUrl}}" ], "path": [ "api", "internal", "unread-count" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:read`.\n\nPermissão: internalChat:read" }, "response": [] } ] }, { "name": "Conectores", "item": [ { "name": "Listar configuração", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/channels/email/config", "host": [ "{{baseUrl}}" ], "path": [ "api", "channels", "email", "config" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar configuração", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/channels/sms/config", "host": [ "{{baseUrl}}" ], "path": [ "api", "channels", "sms", "config" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar connectors", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar attention", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/attention", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "attention" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Reivindicar bitrix24", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/bitrix24/claim", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "bitrix24", "claim" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"claimCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar configuração", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/bitrix24/config", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "bitrix24", "config" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Atualizar configuração", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/bitrix24/config", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "bitrix24", "config" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"preferredCredentialId\": \"string\",\n \"isActive\": false,\n \"customClientId\": \"string\",\n \"customClientSecret\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Desconectar bitrix24", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/bitrix24/disconnect", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "bitrix24", "disconnect" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Listar registros", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/bitrix24/logs?limit={{limit}}&page={{page}}&search={{search}}&status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "bitrix24", "logs" ], "query": [ { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "page", "value": "{{page}}", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "search", "value": "{{search}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/bitrix24/status?forceRefresh={{forceRefresh}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "bitrix24", "status" ], "query": [ { "key": "forceRefresh", "value": "{{forceRefresh}}", "description": "Valor opcional de force refresh.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar templates", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/bitrix24/templates?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "bitrix24", "templates" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Testar bitrix24", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/bitrix24/test-send", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "bitrix24", "test-send" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"phone\": \"string\",\n \"message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar catálogo", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/catalog?categories={{categories}}&slugs={{slugs}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "catalog" ], "query": [ { "key": "categories", "value": "{{categories}}", "description": "Valor opcional de categories.", "disabled": true }, { "key": "slugs", "value": "{{slugs}}", "description": "Valor opcional de slugs.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Cancelar agent", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/firecrawl/agent/{{jobId}}/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "firecrawl", "agent", "{{jobId}}", "cancel" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Listar status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/firecrawl/agent/{{jobId}}/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "firecrawl", "agent", "{{jobId}}", "status" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar credits", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/firecrawl/credits", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "firecrawl", "credits" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Criar ou executar extract", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/firecrawl/extract", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "firecrawl", "extract" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"mode\": \"SCRAPE\",\n \"urls\": [\n \"string\"\n ],\n \"query\": \"string\",\n \"limit\": 0,\n \"prompt\": \"string\",\n \"schema\": {},\n \"maxCredits\": 0,\n \"strictConstrainToURLs\": false,\n \"model\": \"spark-1-mini\",\n \"requirePhone\": false,\n \"tags\": [\n \"string\"\n ],\n \"mapping\": {},\n \"customFieldMap\": {},\n \"scrapeOptions\": {\n \"onlyMainContent\": false,\n \"onlyCleanContent\": false,\n \"includeTags\": [\n \"string\"\n ],\n \"excludeTags\": [\n \"string\"\n ],\n \"maxAge\": 0,\n \"minAge\": 0,\n \"waitFor\": 0,\n \"mobile\": false,\n \"skipTlsVerification\": false,\n \"timeout\": 0,\n \"location\": {\n \"country\": \"string\",\n \"languages\": [\n \"string\"\n ]\n },\n \"removeBase64Images\": false,\n \"blockAds\": false,\n \"proxy\": \"basic\",\n \"storeInCache\": false,\n \"lockdown\": false,\n \"redactPII\": false\n },\n \"quickAutomation\": {\n \"recipeSlug\": \"string\",\n \"templateId\": {},\n \"templateMappings\": {},\n \"quickReplyOptions\": {},\n \"aiAgentId\": {},\n \"aiAgentInstructions\": {}\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar jobs", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/firecrawl/jobs?includeImported={{includeImported}}&includeRejected={{includeRejected}}&jobLimit={{jobLimit}}&leadLimit={{leadLimit}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "firecrawl", "jobs" ], "query": [ { "key": "includeImported", "value": "{{includeImported}}", "description": "Valor opcional de include imported.", "disabled": true }, { "key": "includeRejected", "value": "{{includeRejected}}", "description": "Valor opcional de include rejected.", "disabled": true }, { "key": "jobLimit", "value": "{{jobLimit}}", "description": "Valor opcional de job limit.", "disabled": true }, { "key": "leadLimit", "value": "{{leadLimit}}", "description": "Valor opcional de lead limit.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar registros", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/firecrawl/jobs/{{jobId}}/logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "firecrawl", "jobs", "{{jobId}}", "logs" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar oportunidades", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/firecrawl/leads?page={{page}}&pageSize={{pageSize}}&status=PENDING", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "firecrawl", "leads" ], "query": [ { "key": "page", "value": "{{page}}", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "pageSize", "value": "{{pageSize}}", "description": "Quantidade de itens por página.", "disabled": true }, { "key": "status", "value": "PENDING", "description": "Status usado para filtrar os resultados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Aprovar oportunidades", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/firecrawl/leads/approve", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "firecrawl", "leads", "approve" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"leadId\": \"string\",\n \"leadIds\": [\n \"string\"\n ],\n \"jobId\": \"string\",\n \"jobIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Rejeitar oportunidades", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/firecrawl/leads/reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "firecrawl", "leads", "reject" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"leadId\": \"string\",\n \"leadIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Visualizar prévia de firecrawl", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/firecrawl/preview", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "firecrawl", "preview" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"mode\": \"SCRAPE\",\n \"urls\": [\n \"string\"\n ],\n \"query\": \"string\",\n \"limit\": 0,\n \"prompt\": \"string\",\n \"schema\": {},\n \"scrapeOptions\": {\n \"onlyMainContent\": false,\n \"onlyCleanContent\": false,\n \"includeTags\": [\n \"string\"\n ],\n \"excludeTags\": [\n \"string\"\n ],\n \"maxAge\": 0,\n \"minAge\": 0,\n \"waitFor\": 0,\n \"mobile\": false,\n \"skipTlsVerification\": false,\n \"timeout\": 0,\n \"location\": {\n \"country\": \"string\",\n \"languages\": [\n \"string\"\n ]\n },\n \"removeBase64Images\": false,\n \"blockAds\": false,\n \"proxy\": \"basic\",\n \"storeInCache\": false,\n \"lockdown\": false,\n \"redactPII\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/firecrawl/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "firecrawl", "status" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar calendars", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/google-calendar/calendars?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "google-calendar", "calendars" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Criar ou executar configuração", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/google-calendar/config", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "google-calendar", "config" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"calendarId\": \"string\",\n \"includeDetailsDefault\": false,\n \"includeDetails\": false,\n \"channelAccountId\": \"string\",\n \"credentialId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Desconectar google calendar", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/google-calendar/disconnect", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "google-calendar", "disconnect" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar init", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/google-calendar/init", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "google-calendar", "init" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/google-calendar/status?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "google-calendar", "status" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Criar ou executar delete", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/instagram/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "instagram", "delete" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Desconectar instagram", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/instagram/disconnect", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "instagram", "disconnect" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar init", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/instagram/init", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "instagram", "init" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar repair", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/instagram/repair", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "instagram", "repair" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/instagram/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "instagram", "status" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Atualizar configuração", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/linear/config", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "linear", "config" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar cycles", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/linear/cycles?teamId={{teamId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "linear", "cycles" ], "query": [ { "key": "teamId", "value": "{{teamId}}", "description": "Valor opcional de team.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Desconectar linear", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/linear/disconnect", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "linear", "disconnect" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Criar ou executar init", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/linear/init", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "linear", "init" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Listar issues", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/linear/issues?conversationId={{conversationId}}&taskId={{taskId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "linear", "issues" ], "query": [ { "key": "conversationId", "value": "{{conversationId}}", "description": "Valor opcional de conversation.", "disabled": true }, { "key": "taskId", "value": "{{taskId}}", "description": "Valor opcional de task.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Criar ou executar issues", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/linear/issues", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "linear", "issues" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar issues", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/linear/issues/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "linear", "issues", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir issues", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/linear/issues/{{id}}?deleteFromLinear={{deleteFromLinear}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "linear", "issues", "{{id}}" ], "query": [ { "key": "deleteFromLinear", "value": "{{deleteFromLinear}}", "description": "Valor opcional de delete from linear.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Listar etiquetas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/linear/labels?teamId={{teamId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "linear", "labels" ], "query": [ { "key": "teamId", "value": "{{teamId}}", "description": "Valor opcional de team.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar projetos", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/linear/projects", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "linear", "projects" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/linear/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "linear", "status" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar equipes", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/linear/teams", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "linear", "teams" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar usuários", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/linear/users", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "linear", "users" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar workflow states", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/linear/workflow-states?teamId={{teamId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "linear", "workflow-states" ], "query": [ { "key": "teamId", "value": "{{teamId}}", "description": "Valor opcional de team.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar análises", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/mcp/analytics?range={{range}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "mcp", "analytics" ], "query": [ { "key": "range", "value": "{{range}}", "description": "Valor opcional de range.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar endpoints", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/mcp/endpoints", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "mcp", "endpoints" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Testar endpoints", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/mcp/endpoints/{{id}}/test", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "mcp", "endpoints", "{{id}}", "test" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Listar status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/mcp/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "mcp", "status" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar catalogs", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/meta-catalog/catalogs?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "meta-catalog", "catalogs" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Criar ou executar catalogs", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/meta-catalog/catalogs", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "meta-catalog", "catalogs" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir catalogs", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/meta-catalog/catalogs", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "meta-catalog", "catalogs" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"catalogId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar configuração", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/meta-catalog/config", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "meta-catalog", "config" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"catalogId\": \"string\",\n \"catalogName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar configuração", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/meta-catalog/config", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "meta-catalog", "config" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"isCartEnabled\": false,\n \"isCatalogVisible\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir configuração", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/meta-catalog/config", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "meta-catalog", "config" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"catalogId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar product image", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/meta-catalog/product-image", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "meta-catalog", "product-image" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Listar product sets", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/meta-catalog/product-sets", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "meta-catalog", "product-sets" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Criar ou executar product sets", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/meta-catalog/product-sets", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "meta-catalog", "product-sets" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"catalogId\": \"string\",\n \"name\": \"string\",\n \"filter\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar product sets", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/meta-catalog/product-sets/{{productSetId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "meta-catalog", "product-sets", "{{productSetId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"catalogId\": \"string\",\n \"name\": \"string\",\n \"filter\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir product sets", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/meta-catalog/product-sets/{{productSetId}}?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "meta-catalog", "product-sets", "{{productSetId}}" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Listar produtos", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/meta-catalog/products", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "meta-catalog", "products" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Criar ou executar produtos", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/meta-catalog/products", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "meta-catalog", "products" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"catalogId\": \"string\",\n \"retailer_id\": \"string\",\n \"name\": \"string\",\n \"price\": \"string\",\n \"currency\": \"string\",\n \"availability\": \"in stock\",\n \"description\": \"string\",\n \"image_url\": \"string\",\n \"url\": \"string\",\n \"brand\": \"string\",\n \"item_group_id\": \"string\",\n \"color\": \"string\",\n \"size\": \"string\",\n \"material\": \"string\",\n \"pattern\": \"string\",\n \"gender\": \"female\",\n \"age_group\": \"newborn\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar produtos", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/meta-catalog/products/{{productItemId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "meta-catalog", "products", "{{productItemId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"name\": \"string\",\n \"price\": \"string\",\n \"currency\": \"string\",\n \"availability\": \"in stock\",\n \"description\": \"string\",\n \"image_url\": {},\n \"url\": {},\n \"brand\": \"string\",\n \"item_group_id\": \"string\",\n \"color\": \"string\",\n \"size\": \"string\",\n \"material\": \"string\",\n \"pattern\": \"string\",\n \"gender\": {},\n \"age_group\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir produtos", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/meta-catalog/products/{{productItemId}}?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "meta-catalog", "products", "{{productItemId}}" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Listar status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/meta-catalog/status?catalogId={{catalogId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "meta-catalog", "status" ], "query": [ { "key": "catalogId", "value": "{{catalogId}}", "description": "Valor opcional de catalog.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Criar ou executar tracking", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/meta-catalog/tracking", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "meta-catalog", "tracking" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"catalogId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/microsoft-calendar/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "microsoft-calendar", "status" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar auditoria", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/nuvemshop/audit?eventType={{eventType}}&limit=30&page=1&status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "nuvemshop", "audit" ], "query": [ { "key": "eventType", "value": "{{eventType}}", "description": "Valor opcional de event type.", "disabled": true }, { "key": "limit", "value": "30", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "page", "value": "1", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Criar ou executar auditoria", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/nuvemshop/audit", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "nuvemshop", "audit" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"eventId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Desconectar nuvemshop", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/nuvemshop/disconnect", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "nuvemshop", "disconnect" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Criar ou executar init", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/nuvemshop/init", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "nuvemshop", "init" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Listar pedidos", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/nuvemshop/orders?limit=25&page=1&search={{search}}&status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "nuvemshop", "orders" ], "query": [ { "key": "limit", "value": "25", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "page", "value": "1", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "search", "value": "{{search}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Sincronizar produtos", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/nuvemshop/products/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "nuvemshop", "products", "sync" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Listar receitas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/nuvemshop/recipes", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "nuvemshop", "recipes" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Substituir receitas", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/nuvemshop/recipes", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "nuvemshop", "recipes" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar create template", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/nuvemshop/recipes/create-template", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "nuvemshop", "recipes", "create-template" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/nuvemshop/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "nuvemshop", "status" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Atualizar status", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/nuvemshop/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "nuvemshop", "status" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Sincronizar nuvemshop", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/nuvemshop/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "nuvemshop", "sync" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Listar webhooks", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/nuvemshop/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "nuvemshop", "webhooks" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Criar ou executar webhooks", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/nuvemshop/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "nuvemshop", "webhooks" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Listar chaves de API", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/resend/api-keys?refresh={{refresh}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "resend", "api-keys" ], "query": [ { "key": "refresh", "value": "{{refresh}}", "description": "Valor opcional de refresh.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar connection", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/resend/connection", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "resend", "connection" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar domínios", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/resend/domains?refresh={{refresh}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "resend", "domains" ], "query": [ { "key": "refresh", "value": "{{refresh}}", "description": "Valor opcional de refresh.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Criar ou executar domínios", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/resend/domains", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "resend", "domains" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"region\": \"us-east-1\",\n \"customReturnPath\": \"string\",\n \"tls\": \"opportunistic\",\n \"capabilities\": {\n \"sending\": \"enabled\",\n \"receiving\": {}\n },\n \"trackingSubdomain\": {},\n \"openTracking\": false,\n \"clickTracking\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar domínios", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/resend/domains/{{domainId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "resend", "domains", "{{domainId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Atualizar domínios", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/resend/domains/{{domainId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "resend", "domains", "{{domainId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"trackingSubdomain\": {},\n \"openTracking\": false,\n \"clickTracking\": false,\n \"tls\": \"opportunistic\",\n \"capabilities\": {\n \"sending\": \"enabled\",\n \"receiving\": \"enabled\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir domínios", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/resend/domains/{{domainId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "resend", "domains", "{{domainId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Verificar domínios", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/resend/domains/{{domainId}}/verify", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "resend", "domains", "{{domainId}}", "verify" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Listar status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/resend/status?includeActivity={{includeActivity}}&refresh={{refresh}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "resend", "status" ], "query": [ { "key": "includeActivity", "value": "{{includeActivity}}", "description": "Valor opcional de include activity.", "disabled": true }, { "key": "refresh", "value": "{{refresh}}", "description": "Valor opcional de refresh.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar templates", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/resend/templates?refresh={{refresh}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "resend", "templates" ], "query": [ { "key": "refresh", "value": "{{refresh}}", "description": "Valor opcional de refresh.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Criar ou executar templates", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/resend/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "resend", "templates" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"html\": \"string\",\n \"subject\": \"string\",\n \"text\": \"string\",\n \"alias\": \"string\",\n \"from\": \"string\",\n \"replyTo\": [\n \"string\"\n ],\n \"variables\": [\n {\n \"key\": \"string\",\n \"type\": \"string\",\n \"fallbackValue\": {}\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar templates", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/resend/templates/{{templateId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "resend", "templates", "{{templateId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Atualizar templates", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/resend/templates/{{templateId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "resend", "templates", "{{templateId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"html\": \"string\",\n \"subject\": \"string\",\n \"text\": \"string\",\n \"alias\": \"string\",\n \"from\": \"string\",\n \"replyTo\": [\n \"string\"\n ],\n \"variables\": [\n {\n \"key\": \"string\",\n \"type\": \"string\",\n \"fallbackValue\": {}\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir templates", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/resend/templates/{{templateId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "resend", "templates", "{{templateId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Publicar templates", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/resend/templates/{{templateId}}/publish", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "resend", "templates", "{{templateId}}", "publish" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Testar resend", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/resend/test", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "resend", "test" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"channelAccountId\": \"string\",\n \"to\": \"string\",\n \"subject\": \"string\",\n \"html\": \"string\",\n \"text\": \"string\",\n \"includeSignature\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar webhook", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/resend/webhook", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "resend", "webhook" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Criar ou executar webhook", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/resend/webhook", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "resend", "webhook" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Criar ou executar request number", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/sms/request-number", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "sms", "request-number" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/sms/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "sms", "status" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Testar sms", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/sms/test", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "sms", "test" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"channelAccountId\": \"string\",\n \"fromNumber\": \"string\",\n \"to\": \"string\",\n \"message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar charges", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/stripe/charges", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "stripe", "charges" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"mode\": \"invoice_email\",\n \"amountCents\": 0,\n \"currency\": {},\n \"title\": \"string\",\n \"description\": {},\n \"contactId\": {},\n \"customerName\": {},\n \"customerEmail\": {},\n \"customerPhone\": {},\n \"dueInDays\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Desconectar stripe", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/stripe/disconnect", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "stripe", "disconnect" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Criar ou executar init", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/stripe/init", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "stripe", "init" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Listar receitas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/stripe/recipes", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "stripe", "recipes" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Substituir receitas", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/stripe/recipes", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "stripe", "recipes" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"recipeType\": \"string\",\n \"isEnabled\": false,\n \"credentialId\": {},\n \"templateName\": {},\n \"templateLanguage\": {},\n \"delayMinutes\": \"0\",\n \"metadata\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar create template", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/stripe/recipes/create-template", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "stripe", "recipes", "create-template" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"recipeType\": \"string\",\n \"credentialId\": \"string\",\n \"mode\": \"create\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/stripe/status?refresh={{refresh}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "stripe", "status" ], "query": [ { "key": "refresh", "value": "{{refresh}}", "description": "Valor opcional de refresh.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Tentar novamente webhook events", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/stripe/webhook-events/{{id}}/retry", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "stripe", "webhook-events", "{{id}}", "retry" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Listar bots", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/typebot/bots?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "typebot", "bots" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar configuração", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/typebot/config?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "typebot", "config" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Excluir configuração", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/typebot/config?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "typebot", "config" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Listar flows", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/typebot/flows?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "typebot", "flows" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Criar ou executar flows", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/typebot/flows?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "typebot", "flows" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"typebotId\": \"string\",\n \"name\": \"string\",\n \"description\": {},\n \"triggerMode\": \"KEYWORD\",\n \"triggerKeywords\": [\n \"string\"\n ],\n \"triggerKeywordMatchMode\": \"EXACT\",\n \"handoffEnabled\": false,\n \"handoffAssignToUserId\": {},\n \"handoffAssignToTeamId\": {},\n \"sessionTimeoutMinutes\": \"240\",\n \"messageBubbleDelayMs\": \"1500\",\n \"priority\": \"0\",\n \"isActive\": false,\n \"prefilledVariableMapping\": {},\n \"unknownMessageReply\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar flows", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/typebot/flows/{{flowId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "typebot", "flows", "{{flowId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Atualizar flows", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/typebot/flows/{{flowId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "typebot", "flows", "{{flowId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"typebotId\": \"string\",\n \"name\": \"string\",\n \"description\": {},\n \"triggerMode\": \"KEYWORD\",\n \"triggerKeywords\": [\n \"string\"\n ],\n \"triggerKeywordMatchMode\": \"EXACT\",\n \"handoffEnabled\": false,\n \"handoffAssignToUserId\": {},\n \"handoffAssignToTeamId\": {},\n \"sessionTimeoutMinutes\": \"240\",\n \"messageBubbleDelayMs\": \"1500\",\n \"priority\": \"0\",\n \"isActive\": false,\n \"prefilledVariableMapping\": {},\n \"unknownMessageReply\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir flows", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/typebot/flows/{{flowId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "typebot", "flows", "{{flowId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Visualizar prévia de typebot", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/typebot/preview?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "typebot", "preview" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read", "body": { "mode": "raw", "raw": "{\n \"typebotId\": \"string\",\n \"message\": \"string\",\n \"isStreamEnabled\": false,\n \"prefilledVariables\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar sessões", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/typebot/sessions?conversationId={{conversationId}}&credentialId={{credentialId}}&cursor={{cursor}}&limit={{limit}}&status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "typebot", "sessions" ], "query": [ { "key": "conversationId", "value": "{{conversationId}}", "description": "Valor opcional de conversation.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "cursor", "value": "{{cursor}}", "description": "Cursor opaco recebido na página anterior.", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Criar ou executar sessões", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/typebot/sessions", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "typebot", "sessions" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"conversationId\": \"string\",\n \"flowConfigId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar sessões", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/typebot/sessions/{{sessionId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "typebot", "sessions", "{{sessionId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Criar ou executar sessões", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/typebot/sessions/{{sessionId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "typebot", "sessions", "{{sessionId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"action\": \"end\",\n \"status\": \"COMPLETED\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir sessões", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/typebot/sessions/{{sessionId}}?status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "typebot", "sessions", "{{sessionId}}" ], "query": [ { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Iniciar typebot", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/typebot/start", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "typebot", "start" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{\n \"conversationId\": \"string\",\n \"flowConfigId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/typebot/status?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "typebot", "status" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Listar endpoints", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/webhook/endpoints", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "webhook", "endpoints" ] }, "description": "Lista os endpoints outbound configurados para a empresa.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Testar endpoints", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/webhook/endpoints/{{id}}/test", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "webhook", "endpoints", "{{id}}", "test" ] }, "description": "Dispara uma entrega de teste para validar conectividade, autenticação e processamento.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Listar registros", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/webhook/logs?event={{event}}&limit=20&page=1&success={{success}}&webhookId={{webhookId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "webhook", "logs" ], "query": [ { "key": "event", "value": "{{event}}", "description": "Valor opcional de event.", "disabled": true }, { "key": "limit", "value": "20", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "page", "value": "1", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "success", "value": "{{success}}", "description": "Valor opcional de success.", "disabled": true }, { "key": "webhookId", "value": "{{webhookId}}", "description": "Valor opcional de webhook.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Consultar registros", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/webhook/logs/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "webhook", "logs", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Reprocessar registros", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/webhook/logs/{{id}}/replay", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "webhook", "logs", "{{id}}", "replay" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write" }, "response": [] }, { "name": "Listar status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/webhook/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "webhook", "status" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Consultar data", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/webhooks/test/data/{{sessionId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "webhooks", "test", "data", "{{sessionId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Consultar eventos", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/webhooks/test/events/{{sessionId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "webhooks", "test", "events", "{{sessionId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.\n\nPermissão: connectors:read" }, "response": [] }, { "name": "Iniciar test", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/webhooks/test/start", "host": [ "{{baseUrl}}" ], "path": [ "api", "webhooks", "test", "start" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Interromper test", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/webhooks/test/stop", "host": [ "{{baseUrl}}" ], "path": [ "api", "webhooks", "test", "stop" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.\n\nPermissão: connectors:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Configurações", "item": [ { "name": "Listar ai provider keys", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-provider-keys?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-provider-keys" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Listar gallery", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/gallery?credentialId={{credentialId}}&folderId={{folderId}}&isActive={{isActive}}&labelIds={{labelIds}}&page={{page}}&pageSize={{pageSize}}&search={{search}}&type={{type}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "gallery" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "folderId", "value": "{{folderId}}", "description": "Valor opcional de folder.", "disabled": true }, { "key": "isActive", "value": "{{isActive}}", "description": "Valor opcional de is active.", "disabled": true }, { "key": "labelIds", "value": "{{labelIds}}", "description": "Valor opcional de label ids.", "disabled": true }, { "key": "page", "value": "{{page}}", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "pageSize", "value": "{{pageSize}}", "description": "Quantidade de itens por página.", "disabled": true }, { "key": "search", "value": "{{search}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "type", "value": "{{type}}", "description": "Valor opcional de type.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Criar ou executar gallery", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/gallery?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "gallery" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\",\n \"aiContext\": \"string\",\n \"folderId\": \"string\",\n \"type\": \"IMAGE\",\n \"url\": \"string\",\n \"fileName\": \"string\",\n \"mimeType\": \"string\",\n \"fileSize\": 0,\n \"thumbnailUrl\": {},\n \"includeInAgentContext\": false,\n \"inheritFolderAiContext\": false,\n \"labelIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar gallery", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/gallery/{{itemId}}?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "gallery", "{{itemId}}" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Atualizar gallery", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/gallery/{{itemId}}?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "gallery", "{{itemId}}" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\",\n \"aiContext\": \"string\",\n \"folderId\": \"string\",\n \"isActive\": false,\n \"includeInAgentContext\": false,\n \"inheritFolderAiContext\": false,\n \"labelIds\": [\n \"string\"\n ],\n \"thumbnailUrl\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir gallery", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/gallery/{{itemId}}?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "gallery", "{{itemId}}" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write" }, "response": [] }, { "name": "Criar ou executar upload", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/gallery/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "gallery", "upload" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write" }, "response": [] }, { "name": "Listar ice breakers", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/ice-breakers?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "ice-breakers" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Criar ou executar ice breakers", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/ice-breakers", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "ice-breakers" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir ice breakers", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/ice-breakers", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "ice-breakers" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar persistent menu", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/persistent-menu?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "persistent-menu" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Criar ou executar persistent menu", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/persistent-menu", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "persistent-menu" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir persistent menu", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/persistent-menu", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "persistent-menu" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar referrals", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/referrals?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "referrals" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Criar ou executar referrals", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/referrals", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "referrals" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"name\": \"string\",\n \"username\": \"string\",\n \"ref\": \"string\",\n \"campaignName\": \"string\",\n \"source\": \"string\",\n \"destination\": \"string\",\n \"expiresAt\": \"string\",\n \"metadata\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar referrals", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/referrals/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "referrals", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIVE\",\n \"name\": \"string\",\n \"campaignName\": \"string\",\n \"destination\": \"string\",\n \"expiresAt\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir referrals", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/referrals/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "referrals", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write" }, "response": [] }, { "name": "Listar usage", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/usage?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "usage" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Listar contacts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/settings/contacts?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "settings", "contacts" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Atualizar contacts", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/settings/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "settings", "contacts" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"mode\": \"MERGED\",\n \"strategy\": \"KEEP_ALL\",\n \"credentialId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar jobs", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/settings/contacts/jobs/{{jobId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "settings", "contacts", "jobs", "{{jobId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Listar flow encryption", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/settings/flow-encryption", "host": [ "{{baseUrl}}" ], "path": [ "api", "settings", "flow-encryption" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Criar ou executar flow encryption", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/settings/flow-encryption", "host": [ "{{baseUrl}}" ], "path": [ "api", "settings", "flow-encryption" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir flow encryption", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/settings/flow-encryption", "host": [ "{{baseUrl}}" ], "path": [ "api", "settings", "flow-encryption" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write" }, "response": [] }, { "name": "Listar privacy", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/settings/privacy?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "settings", "privacy" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Atualizar privacy", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/settings/privacy?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "settings", "privacy" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"sendReadReceipts\": false,\n \"sendTypingIndicators\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar satisfaction", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/settings/satisfaction?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "settings", "satisfaction" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Criar ou executar satisfaction", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/settings/satisfaction", "host": [ "{{baseUrl}}" ], "path": [ "api", "settings", "satisfaction" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"isEnabled\": false,\n \"delayMinutes\": 0,\n \"messageMode\": \"BUTTONS\",\n \"questionText\": \"string\",\n \"footerText\": \"string\",\n \"listButtonText\": \"string\",\n \"templateId\": \"string\",\n \"responseOptions\": [\n {\n \"id\": \"string\",\n \"label\": \"string\",\n \"score\": 0,\n \"aliases\": [\n \"string\"\n ]\n }\n ],\n \"lowScoreThreshold\": 0,\n \"reopenOnLowScore\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir satisfaction", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/settings/satisfaction", "host": [ "{{baseUrl}}" ], "path": [ "api", "settings", "satisfaction" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar surveys", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/settings/satisfaction/surveys/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "settings", "satisfaction", "surveys", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"action\": \"cancel\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar template ai", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/settings/template-ai", "host": [ "{{baseUrl}}" ], "path": [ "api", "settings", "template-ai" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Atualizar template ai", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/settings/template-ai", "host": [ "{{baseUrl}}" ], "path": [ "api", "settings", "template-ai" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"enabled\": false,\n \"providerKeyId\": \"string\",\n \"model\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar shortcuts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/shortcuts", "host": [ "{{baseUrl}}" ], "path": [ "api", "shortcuts" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Criar ou executar shortcuts", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/shortcuts", "host": [ "{{baseUrl}}" ], "path": [ "api", "shortcuts" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read", "body": { "mode": "raw", "raw": "{\n \"type\": \"PAGE\",\n \"label\": \"string\",\n \"icon\": \"string\",\n \"href\": \"string\",\n \"category\": \"string\",\n \"pinned\": false,\n \"keybinding\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar shortcuts", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/shortcuts/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "shortcuts", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read", "body": { "mode": "raw", "raw": "{\n \"label\": \"string\",\n \"icon\": \"string\",\n \"href\": \"string\",\n \"category\": \"string\",\n \"pinned\": false,\n \"keybinding\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir shortcuts", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/shortcuts/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "shortcuts", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Atualizar reorder", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/shortcuts/reorder", "host": [ "{{baseUrl}}" ], "path": [ "api", "shortcuts", "reorder" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar invite", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/team/invite", "host": [ "{{baseUrl}}" ], "path": [ "api", "team", "invite" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"string\",\n \"role\": \"OWNER\",\n \"credentialIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar usuários", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/team/users/{{userId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "team", "users", "{{userId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"role\": \"ADMIN\",\n \"isActive\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir usuários", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/team/users/{{userId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "team", "users", "{{userId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write" }, "response": [] }, { "name": "Listar permissions", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/team/users/{{userId}}/permissions", "host": [ "{{baseUrl}}" ], "path": [ "api", "team", "users", "{{userId}}", "permissions" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Substituir permissions", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/team/users/{{userId}}/permissions", "host": [ "{{baseUrl}}" ], "path": [ "api", "team", "users", "{{userId}}", "permissions" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"permissions\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir permissions", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/team/users/{{userId}}/permissions", "host": [ "{{baseUrl}}" ], "path": [ "api", "team", "users", "{{userId}}", "permissions" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write" }, "response": [] }, { "name": "Listar equipes", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/teams?includeInactive={{includeInactive}}&includeMembers={{includeMembers}}&search={{search}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "teams" ], "query": [ { "key": "includeInactive", "value": "{{includeInactive}}", "description": "Valor opcional de include inactive.", "disabled": true }, { "key": "includeMembers", "value": "{{includeMembers}}", "description": "Quando true, inclui membros e contagens na resposta", "disabled": true }, { "key": "search", "value": "{{search}}", "description": "Texto usado na busca.", "disabled": true } ] }, "description": "Lista as equipes ativas do ambiente.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Criar ou executar equipes", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/teams", "host": [ "{{baseUrl}}" ], "path": [ "api", "teams" ] }, "description": "Cria uma nova equipe. Requer OWNER ou ADMIN.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"Equipe API\",\n \"description\": \"Equipe criada para testar a API pública.\",\n \"color\": \"#6366f1\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar equipes", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/teams/{{teamId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "teams", "{{teamId}}" ] }, "description": "Retorna uma equipe específica com membros e quantidade de atribuições.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Atualizar equipes", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/teams/{{teamId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "teams", "{{teamId}}" ] }, "description": "Atualiza nome, descrição, cor e estado ativo da equipe. Requer OWNER ou ADMIN.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"Equipe API Atualizada\",\n \"description\": \"Equipe revisada pela API.\",\n \"color\": \"#8b5cf6\",\n \"isActive\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir equipes", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/teams/{{teamId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "teams", "{{teamId}}" ] }, "description": "Exclui a equipe informada. Falha se ainda houver conversas atribuídas a ela.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write" }, "response": [] }, { "name": "Criar ou executar membros", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/teams/{{teamId}}/members", "host": [ "{{baseUrl}}" ], "path": [ "api", "teams", "{{teamId}}", "members" ] }, "description": "Adiciona uma pessoa à equipe. O papel pode ser `LEAD` ou `MEMBER`.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"userId\": \"{{userId}}\",\n \"role\": \"MEMBER\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar membros", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/teams/{{teamId}}/members?userId={{userId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "teams", "{{teamId}}", "members" ], "query": [ { "key": "userId", "value": "{{userId}}", "description": "Usuário cujo papel será atualizado", "disabled": true } ] }, "description": "Atualiza o papel de uma pessoa já vinculada à equipe.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"role\": \"LEAD\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir membros", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/teams/{{teamId}}/members?userId={{userId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "teams", "{{teamId}}", "members" ], "query": [ { "key": "userId", "value": "{{userId}}", "description": "Valor opcional de user.", "disabled": true } ] }, "description": "Remove a pessoa informada da equipe e retorna `{ success: true }`.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write" }, "response": [] }, { "name": "Atualizar update", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/tenant/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "tenant", "update" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar configs", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/widgets/configs", "host": [ "{{baseUrl}}" ], "path": [ "api", "widgets", "configs" ] }, "description": "Lista as configurações de widget disponíveis.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Criar ou executar configs", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/widgets/configs", "host": [ "{{baseUrl}}" ], "path": [ "api", "widgets", "configs" ] }, "description": "Cria uma nova configuração de widget.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"{{credentialId}}\",\n \"name\": \"Widget API\",\n \"slug\": \"widget-api\",\n \"description\": \"Configuração criada pela API.\",\n \"isActive\": true,\n \"theme\": {\n \"primaryColor\": \"#6366f1\"\n },\n \"welcomeTitle\": \"Olá!\",\n \"welcomeMessage\": \"Como podemos ajudar?\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar configs", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/widgets/configs/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "widgets", "configs", "{{id}}" ] }, "description": "Busca uma configuração específica do widget.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Atualizar configs", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/widgets/configs/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "widgets", "configs", "{{id}}" ] }, "description": "Atualiza uma configuração existente do widget.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"Widget API Atualizado\",\n \"description\": \"Configuração atualizada pela API.\",\n \"isActive\": true,\n \"welcomeTitle\": \"Bem-vindo!\",\n \"welcomeMessage\": \"Estamos online para te atender.\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir configs", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/widgets/configs/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "widgets", "configs", "{{id}}" ] }, "description": "Exclui a configuração do widget e seus dados associados.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write" }, "response": [] }, { "name": "Criar ou executar avatar", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/widgets/configs/{{id}}/avatar", "host": [ "{{baseUrl}}" ], "path": [ "api", "widgets", "configs", "{{id}}", "avatar" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write" }, "response": [] }, { "name": "Excluir avatar", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/widgets/configs/{{id}}/avatar", "host": [ "{{baseUrl}}" ], "path": [ "api", "widgets", "configs", "{{id}}", "avatar" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write" }, "response": [] }, { "name": "Listar tokens", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/widgets/tokens?widgetConfigId={{widgetConfigId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "widgets", "tokens" ], "query": [ { "key": "widgetConfigId", "value": "{{widgetConfigId}}", "description": "Valor opcional de widget config.", "disabled": true } ] }, "description": "Lista os tokens de acesso ligados a uma configuração de widget.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Criar ou executar tokens", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/widgets/tokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "widgets", "tokens" ] }, "description": "Cria um token de acesso para uso do widget/SDK.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"widgetConfigId\": \"{{widgetConfigId}}\",\n \"name\": \"Token API\",\n \"scopes\": [\n \"widget:read\",\n \"widget:write\"\n ],\n \"allowedOrigins\": [\n \"https://example.com\"\n ],\n \"expiresAt\": \"2026-12-31T23:59:59.999Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar tokens", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/widgets/tokens/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "widgets", "tokens", "{{id}}" ] }, "description": "Busca um token específico. O segredo costuma vir mascarado na resposta.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.\n\nPermissão: settings:read" }, "response": [] }, { "name": "Atualizar tokens", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/widgets/tokens/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "widgets", "tokens", "{{id}}" ] }, "description": "Atualiza metadados e permissões do token.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"Token API Atualizado\",\n \"scopes\": [\n \"widget:read\"\n ],\n \"allowedOrigins\": [\n \"https://example.com\"\n ],\n \"isActive\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir tokens", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/widgets/tokens/{{id}}?mode={{mode}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "widgets", "tokens", "{{id}}" ], "query": [ { "key": "mode", "value": "{{mode}}", "description": "Use soft para revogar sem apagar definitivamente", "disabled": true } ] }, "description": "Revoga ou exclui um token do widget.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.\n\nPermissão: settings:write" }, "response": [] } ] }, { "name": "Contas conectadas", "item": [ { "name": "Listar settings", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/calls/settings?credentialId={{credentialId}}&includeSipCredentials={{includeSipCredentials}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "calls", "settings" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "includeSipCredentials", "value": "{{includeSipCredentials}}", "description": "Valor opcional de include sip credentials.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `credentials:read`.\n\nPermissão: credentials:read" }, "response": [] }, { "name": "Listar contas de canal", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/channel-accounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "channel-accounts" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `credentials:read`.\n\nPermissão: credentials:read" }, "response": [] }, { "name": "Consultar contas de canal", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/channel-accounts/{{channelAccountId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "channel-accounts", "{{channelAccountId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `credentials:read`.\n\nPermissão: credentials:read" }, "response": [] }, { "name": "Atualizar contas de canal", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/channel-accounts/{{channelAccountId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "channel-accounts", "{{channelAccountId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `credentials:write`.\n\nPermissão: credentials:write", "body": { "mode": "raw", "raw": "{\n \"label\": \"string\",\n \"isActive\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar overview", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/channel-accounts/overview", "host": [ "{{baseUrl}}" ], "path": [ "api", "channel-accounts", "overview" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `credentials:read`.\n\nPermissão: credentials:read" }, "response": [] }, { "name": "Listar números de telefone", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/phone-numbers", "host": [ "{{baseUrl}}" ], "path": [ "api", "phone-numbers" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `credentials:read`.\n\nPermissão: credentials:read" }, "response": [] } ] }, { "name": "Contatos e CRM", "item": [ { "name": "Criar ou executar eventos", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/google-calendar/events", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "google-calendar", "events" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"contactId\": \"string\",\n \"channelAccountId\": \"string\",\n \"credentialId\": \"string\",\n \"title\": \"string\",\n \"startAt\": \"string\",\n \"endAt\": \"string\",\n \"includeDetails\": false,\n \"calendarId\": \"string\",\n \"description\": \"string\",\n \"attendees\": [\n {\n \"email\": \"string\",\n \"displayName\": \"string\"\n }\n ],\n \"addContactAsAttendee\": false,\n \"addVideoConference\": false,\n \"sendUpdates\": \"all\",\n \"reminders\": {\n \"useDefault\": false,\n \"overrides\": [\n {\n \"method\": \"email\",\n \"minutes\": 0\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar list", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/connectors/google-calendar/events/list?contactId={{contactId}}&credentialId={{credentialId}}&maxResults={{maxResults}}&timeMax={{timeMax}}&timeMin={{timeMin}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "connectors", "google-calendar", "events", "list" ], "query": [ { "key": "contactId", "value": "{{contactId}}", "description": "Valor opcional de contact.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "maxResults", "value": "{{maxResults}}", "description": "Valor opcional de max results.", "disabled": true }, { "key": "timeMax", "value": "{{timeMax}}", "description": "Valor opcional de time max.", "disabled": true }, { "key": "timeMin", "value": "{{timeMin}}", "description": "Valor opcional de time min.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Listar contacts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts?credentialId={{credentialId}}&labelIds={{labelIds}}&orderBy={{orderBy}}&page={{page}}&pageSize={{pageSize}}&search={{search}}&sortDirection={{sortDirection}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "labelIds", "value": "{{labelIds}}", "description": "Valor opcional de label ids.", "disabled": true }, { "key": "orderBy", "value": "{{orderBy}}", "description": "Valor opcional de order by.", "disabled": true }, { "key": "page", "value": "{{page}}", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "pageSize", "value": "{{pageSize}}", "description": "Quantidade de itens por página.", "disabled": true }, { "key": "search", "value": "{{search}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "sortDirection", "value": "{{sortDirection}}", "description": "Valor opcional de sort direction.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Criar ou executar contacts", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"phone\": \"{{contactPhoneRaw}}\",\n \"name\": \"{{contactName}}\",\n \"email\": \"{{contactEmail}}\",\n \"city\": \"Sao Paulo\",\n \"customAttributes\": {\n \"segmento\": \"postman\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar contacts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/{{id}}?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "{{id}}" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Atualizar contacts", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/{{id}}?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "{{id}}" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"phone\": \"{{updatedContactPhoneRaw}}\",\n \"name\": \"{{updatedContactName}}\",\n \"city\": \"Campinas\",\n \"customAttributes\": {\n \"segmento\": \"enterprise\"\n },\n \"metadata\": {\n \"notes\": \"{{contactNotes}}\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir contacts", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/{{id}}?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "{{id}}" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:delete`.\n\nPermissão: contacts:delete" }, "response": [] }, { "name": "Listar 360", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/{{id}}/360?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "{{id}}", "360" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Listar ai memory", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/{{id}}/ai-memory?channelAccountId={{channelAccountId}}&conversationId={{conversationId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "{{id}}", "ai-memory" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "conversationId", "value": "{{conversationId}}", "description": "Valor opcional de conversation.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Criar ou executar ai memory", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/{{id}}/ai-memory?channelAccountId={{channelAccountId}}&conversationId={{conversationId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "{{id}}", "ai-memory" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "conversationId", "value": "{{conversationId}}", "description": "Valor opcional de conversation.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir ai memory", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/{{id}}/ai-memory?channelAccountId={{channelAccountId}}&conversationId={{conversationId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "{{id}}", "ai-memory" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "conversationId", "value": "{{conversationId}}", "description": "Valor opcional de conversation.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar avatar", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/{{id}}/avatar?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "{{id}}", "avatar" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Faz upload de uma imagem como avatar do contato. Formatos aceitos: JPEG, PNG, WebP, GIF. Tamanho maximo: 5 MB.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write" }, "response": [] }, { "name": "Excluir avatar", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/{{id}}/avatar?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "{{id}}", "avatar" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Remove o avatar do contato.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write" }, "response": [] }, { "name": "Criar ou executar block", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/{{id}}/block", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "{{id}}", "block" ] }, "description": "Bloqueia um contato no WhatsApp via Meta API. O contato nao podera mais enviar mensagens.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"phoneNumberId\": \"{{phoneNumberId}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar blocked", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/{{id}}/blocked?phoneNumberId={{phoneNumberId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "{{id}}", "blocked" ], "query": [ { "key": "phoneNumberId", "value": "{{phoneNumberId}}", "description": "ID do numero de telefone Meta", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Listar custom field values", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/{{id}}/custom-field-values?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "{{id}}", "custom-field-values" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Retorna os valores dos campos customizados de um contato especifico.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Listar etiquetas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/{{id}}/labels?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "{{id}}", "labels" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Atualizar etiquetas", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/{{id}}/labels?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "{{id}}", "labels" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Define as labels do contato. Acoes disponiveis: `add` (adicionar), `remove` (remover), `set` (substituir todas).\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"action\": \"set\",\n \"labels\": [\n \"{{testLabelId}}\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar merge candidates", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/{{id}}/merge-candidates?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "{{id}}", "merge-candidates" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Listar timeline", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/{{id}}/timeline?channelAccountId={{channelAccountId}}&conversationId={{conversationId}}&credentialId={{credentialId}}&cursor={{cursor}}&kinds={{kinds}}&limit={{limit}}&since={{since}}&take=40&until={{until}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "{{id}}", "timeline" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "conversationId", "value": "{{conversationId}}", "description": "Valor opcional de conversation.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "cursor", "value": "{{cursor}}", "description": "Cursor opaco recebido na página anterior.", "disabled": true }, { "key": "kinds", "value": "{{kinds}}", "description": "Valor opcional de kinds.", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "since", "value": "{{since}}", "description": "Valor opcional de since.", "disabled": true }, { "key": "take", "value": "40", "description": "Quantidade máxima de itens retornados.", "disabled": true }, { "key": "until", "value": "{{until}}", "description": "Valor opcional de until.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Desbloquear contacts", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/{{id}}/unblock", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "{{id}}", "unblock" ] }, "description": "Desbloqueia um contato no WhatsApp via Meta API.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"phoneNumberId\": \"{{phoneNumberId}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar ações em massa", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/bulk-actions?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "bulk-actions" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar bulk labels", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/bulk-labels?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "bulk-labels" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Adiciona, remove ou define labels em massa para multiplos contatos. Acoes: `add`, `remove`, `set`. Labels referenciadas por UUID.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"contactIds\": [\n \"{{labelContactId}}\"\n ],\n \"action\": \"add\",\n \"labels\": [\n \"{{testLabelId}}\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar create", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/create?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "create" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar atributos personalizados", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/custom-attributes?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "custom-attributes" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da credencial compatível usada para restringir o escopo desta consulta", "disabled": true } ] }, "description": "Retorna um resumo dos atributos customizados em uso, com contagem de utilização dentro do escopo resolvido.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Listar campos personalizados", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/custom-fields?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "custom-fields" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Criar ou executar campos personalizados", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/custom-fields?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "custom-fields" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Cria um campo customizado do tipo texto. Tipos disponiveis: `text`, `select`, `date`, `checkbox`.\n\nCria um campo customizado do tipo select com opcoes pre-definidas.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"Empresa\",\n \"key\": \"empresa\",\n \"type\": \"text\",\n \"description\": \"Nome da empresa do contato\",\n \"isRequired\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar campos personalizados", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/custom-fields/{{fieldId}}?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "custom-fields", "{{fieldId}}" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Atualizar campos personalizados", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/custom-fields/{{fieldId}}?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "custom-fields", "{{fieldId}}" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"Empresa (Atualizado)\",\n \"description\": \"Nome da empresa do contato (campo atualizado via API)\",\n \"isRequired\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir campos personalizados", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/custom-fields/{{fieldId}}?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "custom-fields", "{{fieldId}}" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write" }, "response": [] }, { "name": "Criar ou executar filter", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/filter?channel={{channel}}&channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "filter" ], "query": [ { "key": "channel", "value": "{{channel}}", "description": "Valor opcional de channel.", "disabled": true }, { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Filtra contatos por criterios avancados. Suporta multiplos filtros combinados.\n\nFiltra contatos pela presenca de tags/labels.\n\nFiltra contatos por intervalo de data usando o operador `between`.\n\nFiltra contatos por valor de um campo customizado. Use o prefixo `custom.` seguido da chave do campo.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read", "body": { "mode": "raw", "raw": "{\n \"filters\": [\n {\n \"id\": \"filter-1\",\n \"field\": \"name\",\n \"operator\": \"contains\",\n \"value\": \"Postman\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Importar contacts", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/import?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "import" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da credencial compatível usada para importar os contatos neste escopo", "disabled": true } ] }, "description": "Importa contatos em massa a partir de um arquivo CSV ou XLSX. Esta rota continua baseada em `credentialId` como query param.\n\nO sistema detecta automaticamente as colunas pelo nome, com suporte a aliases em PT-BR e EN.\n\nLabels devem ser separadas por `|` na coluna correspondente.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write" }, "response": [] }, { "name": "Criar ou executar etiquetas", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/labels?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "labels" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Adiciona uma label (pelo nome) a um ou mais contatos. A label e criada automaticamente se nao existir.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"contactIds\": [\n \"{{labelContactId}}\"\n ],\n \"label\": \"API Test Label\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir etiquetas", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/labels?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "labels" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Remove uma label (pelo nome) de um ou mais contatos.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"contactIds\": [\n \"{{labelContactId}}\"\n ],\n \"label\": \"API Test Label\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar lookup", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/lookup?credentialId={{credentialId}}&phone={{phone}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "lookup" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "phone", "value": "{{phone}}", "description": "Numero de telefone para busca", "disabled": true } ] }, "description": "Busca um contato pelo numero de telefone. Retorna `exists: true` com dados basicos se encontrado, ou `exists: false`.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Criar ou executar merge", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/merge?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "merge" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Mescla dois contatos. O `contactId` indica o contato que sera atualizado. Campos opcionais `phone` e `name` definem os valores finais.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"contactId\": \"{{mergeContactIdA}}\",\n \"name\": \"Merged Contact Final\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar work queue", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/contacts/work-queue?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}&filters={{filters}}&labelIds={{labelIds}}&page=1&pageSize=20&q={{q}}&sort={{sort}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "contacts", "work-queue" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "filters", "value": "{{filters}}", "description": "Valor opcional de filters.", "disabled": true }, { "key": "labelIds", "value": "{{labelIds}}", "description": "Valor opcional de label ids.", "disabled": true }, { "key": "page", "value": "1", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "pageSize", "value": "20", "description": "Quantidade de itens por página.", "disabled": true }, { "key": "q", "value": "{{q}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "sort", "value": "{{sort}}", "description": "Valor opcional de sort.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Listar negócios", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/deals?contactId={{contactId}}&credentialId={{credentialId}}&dueFrom={{dueFrom}}&dueTo={{dueTo}}&funnelId={{funnelId}}&limit={{limit}}&overdue={{overdue}}&ownerId={{ownerId}}&page={{page}}&priority={{priority}}&q={{q}}&search={{search}}&stageId={{stageId}}&status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "deals" ], "query": [ { "key": "contactId", "value": "{{contactId}}", "description": "Valor opcional de contact.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "dueFrom", "value": "{{dueFrom}}", "description": "Valor opcional de due from.", "disabled": true }, { "key": "dueTo", "value": "{{dueTo}}", "description": "Valor opcional de due to.", "disabled": true }, { "key": "funnelId", "value": "{{funnelId}}", "description": "Valor opcional de funnel.", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "overdue", "value": "{{overdue}}", "description": "Valor opcional de overdue.", "disabled": true }, { "key": "ownerId", "value": "{{ownerId}}", "description": "Valor opcional de owner.", "disabled": true }, { "key": "page", "value": "{{page}}", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "priority", "value": "{{priority}}", "description": "Valor opcional de priority.", "disabled": true }, { "key": "q", "value": "{{q}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "search", "value": "{{search}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "stageId", "value": "{{stageId}}", "description": "Valor opcional de stage.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Aceita lista separada por vírgula: OPEN,WON,LOST", "disabled": true } ] }, "description": "Lista negócios com paginação, filtros por funil, etapa, contato, responsável, status e texto livre.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Criar ou executar negócios", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/deals", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "deals" ] }, "description": "Cria um negócio vinculado a um contato visível no escopo da conta escolhida.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"title\": \"Negócio API - Renovação anual\",\n \"description\": \"Cliente avaliando expansão do contrato.\",\n \"value\": 1499.9,\n \"currency\": \"BRL\",\n \"status\": \"OPEN\",\n \"priority\": \"HIGH\",\n \"stageId\": \"{{stageId}}\",\n \"contactId\": \"{{contactId}}\",\n \"credentialId\": \"{{credentialId}}\",\n \"ownerId\": \"{{ownerId}}\",\n \"dueDate\": \"2026-01-15T14:00:00.000Z\",\n \"closingDate\": \"2026-01-31T18:00:00.000Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar negócios", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/deals", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "deals" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"dealIds\": [\n \"string\"\n ],\n \"credentialId\": {},\n \"stageId\": {},\n \"status\": \"OPEN\",\n \"ownerId\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir negócios", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/deals", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "deals" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"dealIds\": [\n \"string\"\n ],\n \"credentialId\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar negócios", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/deals/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "deals", "{{id}}" ] }, "description": "Retorna um negócio com contato, responsável e etapa associados.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Atualizar negócios", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/deals/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "deals", "{{id}}" ] }, "description": "Atualiza os principais campos do negócio e pode acionar automações associadas.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"title\": \"Negócio API - Proposta enviada\",\n \"status\": \"OPEN\",\n \"priority\": \"MEDIUM\",\n \"description\": \"Proposta enviada e aguardando retorno do cliente.\",\n \"stageId\": \"{{stageId}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir negócios", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/deals/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "deals", "{{id}}" ] }, "description": "Exclui o negócio informado. A resposta esperada é `204 No Content`.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write" }, "response": [] }, { "name": "Listar history", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/deals/{{id}}/history?page={{page}}&pageSize={{pageSize}}&search={{search}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "deals", "{{id}}", "history" ], "query": [ { "key": "page", "value": "{{page}}", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "pageSize", "value": "{{pageSize}}", "description": "Quantidade de itens por página.", "disabled": true }, { "key": "search", "value": "{{search}}", "description": "Texto usado na busca.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Listar pedidos", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/deals/{{id}}/orders?page=1&pageSize=25&source={{source}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "deals", "{{id}}", "orders" ], "query": [ { "key": "page", "value": "1", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "pageSize", "value": "25", "description": "Quantidade de itens por página.", "disabled": true }, { "key": "source", "value": "{{source}}", "description": "Valor opcional de source.", "disabled": true } ] }, "description": "Lista pedidos ligados ao negócio ou ao contato associado a ele.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Listar funis", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/funnels", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "funnels" ] }, "description": "Lista todos os funis com suas etapas ordenadas.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Criar ou executar funis", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/funnels", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "funnels" ] }, "description": "Cria um novo funil com seis etapas padrão automaticamente.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"Funil API\",\n \"description\": \"Funil criado para testes da documentação.\",\n \"isDefault\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar funis", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/funnels/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "funnels", "{{id}}" ] }, "description": "Retorna o funil informado com suas etapas ordenadas.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Atualizar funis", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/funnels/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "funnels", "{{id}}" ] }, "description": "Atualiza o funil e pode torná-lo padrão, desmarcando os demais.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"Funil API Atualizado\",\n \"description\": \"Funil revisado pela API pública.\",\n \"isDefault\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir funis", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/funnels/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "funnels", "{{id}}" ] }, "description": "Exclui o funil informado. A resposta esperada é `204 No Content`.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write" }, "response": [] }, { "name": "Criar ou executar etapas", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/stages", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "stages" ] }, "description": "Cria uma nova etapa em um funil existente.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"Follow-up\",\n \"description\": \"Cliente aguardando retorno comercial.\",\n \"color\": \"#8b5cf6\",\n \"order\": 6,\n \"funnelId\": \"{{funnelId}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar etapas", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/stages", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "stages" ] }, "description": "Reordena etapas em lote. A resposta esperada é `204 No Content`.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"{{stageId}}\",\n \"order\": 0\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar etapas", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/stages/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "stages", "{{id}}" ] }, "description": "Atualiza nome, descrição, cor e ordem de uma etapa.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"Follow-up revisado\",\n \"description\": \"Cliente aguardando revisão comercial.\",\n \"color\": \"#6366f1\",\n \"order\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir etapas", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/stages/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "stages", "{{id}}" ] }, "description": "Exclui a etapa informada. A resposta esperada é `204 No Content`.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write" }, "response": [] }, { "name": "Criar ou executar profile sync", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/profile-sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "profile-sync" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar pedidos", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/orders?limit={{limit}}&page={{page}}&pageSize={{pageSize}}&status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "orders" ], "query": [ { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "page", "value": "{{page}}", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "pageSize", "value": "{{pageSize}}", "description": "Quantidade de itens por página.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Filtro opcional por status do pedido", "disabled": true } ] }, "description": "Lista pedidos usando paginação por página. A resposta traz `orders` e `pagination`.\n\nMantém compatibilidade com consumidores antigos que ainda usam cursor.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Consultar pedidos", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/orders/{{orderId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "orders", "{{orderId}}" ] }, "description": "Retorna o pedido consolidado, incluindo alertas operacionais e possíveis dados mesclados com Nuvemshop.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Atualizar pedidos", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/orders/{{orderId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "orders", "{{orderId}}" ] }, "description": "Atualiza status, rastreio, observações internas e motivo de cancelamento. A rota pode sincronizar automaticamente com a Nuvemshop quando houver vínculo.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"status\": \"CONFIRMED\",\n \"trackingCode\": \"BR123456789\",\n \"internalNotes\": \"Pedido confirmado e em separação.\",\n \"cancelReason\": null\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar enrich products", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/orders/{{orderId}}/enrich-products?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "orders", "{{orderId}}", "enrich-products" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Enriquece os itens do pedido com nomes do catálogo Meta quando disponíveis. Em caso de indisponibilidade do catálogo, retorna fallback com os dados já salvos.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Exportar pedidos", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/orders/{{orderId}}/export-nuvemshop?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "orders", "{{orderId}}", "export-nuvemshop" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Exporta um pedido do WhatsApp para a Nuvemshop. Exige integração ativa e produtos compatíveis já sincronizados.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write" }, "response": [] }, { "name": "Listar settings", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/orders/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "orders", "settings" ] }, "description": "Consulta as configurações de resposta automática por status e o resumo de conflito com automações de integração.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Atualizar settings", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/orders/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "orders", "settings" ] }, "description": "Atualiza os textos de resposta automática por status. Cada mensagem aceita até 2000 caracteres.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"autoReplyEnabled\": true,\n \"autoReplyOnConfirmed\": \"Olá, {customerName}! Seu pedido #{orderId} foi confirmado com sucesso.\",\n \"autoReplyOnShipped\": \"Seu pedido #{orderId} já está a caminho. Código de rastreio: {trackingCode}.\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar stats", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/orders/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "orders", "stats" ] }, "description": "Retorna contagem por status, total de pedidos, pedidos do dia, receita total e pedidos ativos.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Listar organizações", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/organizations?lifecycle={{lifecycle}}&limit={{limit}}&offset={{offset}}&ownerId={{ownerId}}&search={{search}}&segment={{segment}}&sort={{sort}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations" ], "query": [ { "key": "lifecycle", "value": "{{lifecycle}}", "description": "Valor opcional de lifecycle.", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "offset", "value": "{{offset}}", "description": "Valor opcional de offset.", "disabled": true }, { "key": "ownerId", "value": "{{ownerId}}", "description": "Valor opcional de owner.", "disabled": true }, { "key": "search", "value": "{{search}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "segment", "value": "{{segment}}", "description": "Valor opcional de segment.", "disabled": true }, { "key": "sort", "value": "{{sort}}", "description": "Valor opcional de sort.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Criar ou executar organizações", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/organizations", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar organizações", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/organizations/{{organizationId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", "{{organizationId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Atualizar organizações", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/organizations/{{organizationId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", "{{organizationId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir organizações", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/organizations/{{organizationId}}?detach={{detach}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", "{{organizationId}}" ], "query": [ { "key": "detach", "value": "{{detach}}", "description": "Valor opcional de detach.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write" }, "response": [] }, { "name": "Listar 360", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/organizations/{{organizationId}}/360?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", "{{organizationId}}", "360" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Listar resolve by email", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/organizations/resolve-by-email?email={{email}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", "resolve-by-email" ], "query": [ { "key": "email", "value": "{{email}}", "description": "Valor opcional de email.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Listar tags", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/tags?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}&search={{search}}&strictCredential={{strictCredential}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "tags" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "search", "value": "{{search}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "strictCredential", "value": "{{strictCredential}}", "description": "Valor opcional de strict credential.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Criar ou executar tags", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/tags?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "tags" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"color\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar tags", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/tags/{{tagId}}?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "tags", "{{tagId}}" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.\n\nPermissão: contacts:read" }, "response": [] }, { "name": "Atualizar tags", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/tags/{{tagId}}?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "tags", "{{tagId}}" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"color\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir tags", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/tags/{{tagId}}?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "tags", "{{tagId}}" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.\n\nPermissão: contacts:write" }, "response": [] } ] }, { "name": "Conversas", "item": [ { "name": "Criar ou executar quick", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/memories/quick", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "memories", "quick" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar chamadas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/calls?conversationId={{conversationId}}&credentialId={{credentialId}}&direction={{direction}}&page=1&pageSize=20&q={{q}}&status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "calls" ], "query": [ { "key": "conversationId", "value": "{{conversationId}}", "description": "Valor opcional de conversation.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "direction", "value": "{{direction}}", "description": "Valor opcional de direction.", "disabled": true }, { "key": "page", "value": "1", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "pageSize", "value": "20", "description": "Quantidade de itens por página.", "disabled": true }, { "key": "q", "value": "{{q}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Criar ou executar chamadas", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/calls", "host": [ "{{baseUrl}}" ], "path": [ "api", "calls" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar selectable", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/channel-accounts/selectable", "host": [ "{{baseUrl}}" ], "path": [ "api", "channel-accounts", "selectable" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Listar conversas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations?status={{status}}&take={{take}}&unreadOnly={{unreadOnly}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations" ], "query": [ { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true }, { "key": "take", "value": "{{take}}", "description": "Quantidade de resultados (padrao: 20)", "disabled": true }, { "key": "unreadOnly", "value": "{{unreadOnly}}", "description": "Valor opcional de unread only.", "disabled": true } ] }, "description": "Lista conversas com filtros aplicados: apenas ativas e nao lidas.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Excluir conversas", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}" ] }, "description": "Exclui permanentemente uma conversa. Esta acao NAO pode ser desfeita.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write" }, "response": [] }, { "name": "Listar alternatives", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/alternatives", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "alternatives" ] }, "description": "Encontra outras conversas do mesmo contato em canais diferentes (ex: WhatsApp e Instagram).\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Criar ou executar assign", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/assign", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "assign" ] }, "description": "Atribui a conversa a um agente e/ou equipe. Deve conter pelo menos `assignedToId` ou `assignedTeamId`.\n\nAtribui a conversa a uma equipe.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"assignedToId\": \"{{agentUserId}}\",\n \"notes\": \"Atribuido via API\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir assign", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/assign", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "assign" ] }, "description": "Remove todas as atribuicoes (agente e equipe) da conversa.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write" }, "response": [] }, { "name": "Listar contexto comercial", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/business-context", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "business-context" ] }, "description": "Retorna o contexto consolidado da conversa no escopo da conta vinculada, com dados de contato, organizacao, conversas relacionadas, disponibilidade de recursos e sinais operacionais.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Listar chamadas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/calls?cursor={{cursor}}&take=20", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "calls" ], "query": [ { "key": "cursor", "value": "{{cursor}}", "description": "Cursor opaco recebido na página anterior.", "disabled": true }, { "key": "take", "value": "20", "description": "Quantidade (1-50)", "disabled": true } ] }, "description": "Lista historico de chamadas da conversa.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Listar permissions", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/calls/permissions", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "calls", "permissions" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Consultar email attachments", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/email-attachments/{{providerEmailId}}/{{attachmentId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "email-attachments", "{{providerEmailId}}", "{{attachmentId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Exportar conversas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/export?format={{format}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "export" ], "query": [ { "key": "format", "value": "{{format}}", "description": "Valor opcional de format.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Listar conversa interna", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/internal-thread?cursor={{cursor}}&limit={{limit}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "internal-thread" ], "query": [ { "key": "cursor", "value": "{{cursor}}", "description": "Cursor opaco recebido na página anterior.", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Listar base de conhecimento", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/knowledge?catalog={{catalog}}&page={{page}}&pageSize={{pageSize}}&recommendedOnly={{recommendedOnly}}&search={{search}}&type={{type}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "knowledge" ], "query": [ { "key": "catalog", "value": "{{catalog}}", "description": "Valor opcional de catálogo.", "disabled": true }, { "key": "page", "value": "{{page}}", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "pageSize", "value": "{{pageSize}}", "description": "Quantidade de itens por página.", "disabled": true }, { "key": "recommendedOnly", "value": "{{recommendedOnly}}", "description": "Valor opcional de recommended only.", "disabled": true }, { "key": "search", "value": "{{search}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "type", "value": "{{type}}", "description": "Valor opcional de type.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Criar ou executar base de conhecimento", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/knowledge", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "knowledge" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"galleryItemId\": \"string\",\n \"instructions\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar base de conhecimento", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/knowledge/{{scopeId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "knowledge", "{{scopeId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write" }, "response": [] }, { "name": "Atualizar base de conhecimento", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/knowledge/{{scopeId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "knowledge", "{{scopeId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"instructions\": \"string\",\n \"isActive\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir base de conhecimento", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/knowledge/{{scopeId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "knowledge", "{{scopeId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write" }, "response": [] }, { "name": "Criar ou executar upload", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/knowledge/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "knowledge", "upload" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write" }, "response": [] }, { "name": "Listar mídias", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/media?cursor={{cursor}}&take=30&type=media", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "media" ], "query": [ { "key": "cursor", "value": "{{cursor}}", "description": "Cursor opaco recebido na página anterior.", "disabled": true }, { "key": "take", "value": "30", "description": "Quantidade máxima de itens retornados.", "disabled": true }, { "key": "type", "value": "media", "description": "Tipo: media (fotos/videos), links, docs", "disabled": true } ] }, "description": "Lista midias compartilhadas na conversa. Tipos: `media` (fotos/videos), `links`, `docs` (documentos).\n\nLista documentos compartilhados na conversa.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Listar mensagens", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/messages?cursor={{cursor}}&take=30", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "messages" ], "query": [ { "key": "cursor", "value": "{{cursor}}", "description": "Cursor opaco recebido na página anterior.", "disabled": true }, { "key": "take", "value": "30", "description": "Quantidade de mensagens", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `messages:read`.\n\nPermissão: messages:read" }, "response": [] }, { "name": "Listar jump", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/messages/jump?messageId={{messageId}}&metaMessageId={{metaMessageId}}&window=60", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "messages", "jump" ], "query": [ { "key": "messageId", "value": "{{messageId}}", "description": "ID interno da mensagem alvo", "disabled": true }, { "key": "metaMessageId", "value": "{{metaMessageId}}", "description": "Valor opcional de meta message.", "disabled": true }, { "key": "window", "value": "60", "description": "Janela de contexto (1-200 mensagens antes/depois)", "disabled": true } ] }, "description": "Pula para uma mensagem especifica retornando o contexto ao redor (mensagens antes e depois).\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Criar ou executar save", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/messages/save", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "messages", "save" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar saved", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/messages/saved?cursor={{cursor}}&mode=ids&take=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "messages", "saved" ], "query": [ { "key": "cursor", "value": "{{cursor}}", "description": "Cursor opaco recebido na página anterior.", "disabled": true }, { "key": "mode", "value": "ids", "description": "Valor opcional de mode.", "disabled": true }, { "key": "take", "value": "50", "description": "Quantidade máxima de itens retornados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Listar search", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/messages/search?q={{q}}&take=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "messages", "search" ], "query": [ { "key": "q", "value": "{{q}}", "description": "Termo de busca (min 2 chars)", "disabled": true }, { "key": "take", "value": "50", "description": "Quantidade de resultados (1-100)", "disabled": true } ] }, "description": "Busca mensagens dentro de uma conversa especifica. Minimo 2 caracteres no termo de busca.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Listar notas privadas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/private-notes", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "private-notes" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Criar ou executar notas privadas", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/private-notes", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "private-notes" ] }, "description": "Cria uma nota privada na conversa. Use `mentionedUserIds` para mencionar outros agentes.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"content\": \"Nota privada criada via API. Cliente solicitou retorno amanha.\",\n \"mentionedUserIds\": []\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar notas privadas", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/private-notes/{{messageId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "private-notes", "{{messageId}}" ] }, "description": "Atualiza o conteudo de uma nota privada existente.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"content\": \"Nota atualizada via API. Cliente confirmou reuniao para amanha as 14h.\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar read", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/read", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "read" ] }, "description": "Marca a conversa como lida. Quando o canal suportar recibo de leitura, a confirmação também é enviada ao provedor.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write" }, "response": [] }, { "name": "Listar lembretes", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/reminders?all={{all}}&messageId={{messageId}}&status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "reminders" ], "query": [ { "key": "all", "value": "{{all}}", "description": "Valor opcional de all.", "disabled": true }, { "key": "messageId", "value": "{{messageId}}", "description": "Valor opcional de message.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Filtrar por status: PENDING, TRIGGERED, CANCELLED", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Criar ou executar lembretes", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/reminders", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "reminders" ] }, "description": "Cria um lembrete. Tipos: `CONVERSATION` (sobre a conversa) ou `MESSAGE` (sobre mensagem especifica, requer `targetMessageId`).\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"type\": \"CONVERSATION\",\n \"remindAt\": \"{{reminderDate}}\",\n \"note\": \"Lembrete: retornar ao cliente sobre proposta comercial\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar status", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "status" ] }, "description": "Atualiza o status da conversa. Valores: `ACTIVE`, `CLOSED`, `ARCHIVED`.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"status\": \"CLOSED\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar typing", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/typing", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "typing" ] }, "description": "Envia indicador de digitacao. Status: `typing` (digitando) ou `paused` (parou). Rate limit: 20 requisicoes por 10 segundos.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"status\": \"typing\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar unread", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/{{conversationId}}/unread", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "{{conversationId}}", "unread" ] }, "description": "Marca a conversa como não lida apenas no estado interno da plataforma.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write" }, "response": [] }, { "name": "Listar assign", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/assign?conversationId={{conversationId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "assign" ], "query": [ { "key": "conversationId", "value": "{{conversationId}}", "description": "Valor opcional de conversation.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Criar ou executar assign", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/assign", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "assign" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"conversationId\": \"string\",\n \"assignedToId\": {},\n \"assignedTeamId\": {},\n \"notes\": \"string\",\n \"preserveCurrentTeam\": false,\n \"notifyPreviousAssignee\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir assign", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/assign", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "assign" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"conversationId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar bulk", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/bulk", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "bulk" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"action\": \"mark-read\",\n \"conversationIds\": [\n \"string\"\n ],\n \"assignedToId\": \"string\",\n \"assignedTeamId\": \"string\",\n \"tagIds\": [\n \"string\"\n ],\n \"pauseAi\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar mentions", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/mentions?conversationId={{conversationId}}&cursor={{cursor}}&limit={{limit}}&page={{page}}&unreadOnly={{unreadOnly}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "mentions" ], "query": [ { "key": "conversationId", "value": "{{conversationId}}", "description": "Valor opcional de conversation.", "disabled": true }, { "key": "cursor", "value": "{{cursor}}", "description": "Cursor opaco recebido na página anterior.", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "page", "value": "{{page}}", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "unreadOnly", "value": "{{unreadOnly}}", "description": "Mostrar apenas mencoes nao lidas", "disabled": true } ] }, "description": "Lista as menções do usuário autenticado em notas privadas. A resposta é um array no nível raiz.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Criar ou executar mentions", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/mentions", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "mentions" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"conversationId\": \"string\",\n \"messageId\": {},\n \"mentionedUserId\": {},\n \"mentionedUserIds\": [\n {}\n ],\n \"messageContent\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar mentions", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/mentions", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "mentions" ] }, "description": "Marca uma mencao como lida.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"mentionId\": \"{{mentionId}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar contagem de não lidas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/unread-count", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "unread-count" ] }, "description": "Retorna o total de conversas não lidas dentro do escopo visível para a API key.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Listar contagens por conta", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/conversations/unread-counts-by-credential", "host": [ "{{baseUrl}}" ], "path": [ "api", "conversations", "unread-counts-by-credential" ] }, "description": "Retorna a contagem de conversas não lidas agrupada por `credentialId`. Este endpoint ainda segue o agrupamento legado por credencial.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Listar search", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/giphy/search?limit={{limit}}&offset={{offset}}&q={{q}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "giphy", "search" ], "query": [ { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "offset", "value": "{{offset}}", "description": "Valor opcional de offset.", "disabled": true }, { "key": "q", "value": "{{q}}", "description": "Texto usado na busca.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Enviar giphy", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/giphy/send", "host": [ "{{baseUrl}}" ], "path": [ "api", "giphy", "send" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar settings", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/giphy/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "giphy", "settings" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Listar bootstrap", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/inbox/bootstrap", "host": [ "{{baseUrl}}" ], "path": [ "api", "inbox", "bootstrap" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Listar bootstrap", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/inbox/conversations/{{conversationId}}/bootstrap", "host": [ "{{baseUrl}}" ], "path": [ "api", "inbox", "conversations", "{{conversationId}}", "bootstrap" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Listar sidebar", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/inbox/sidebar", "host": [ "{{baseUrl}}" ], "path": [ "api", "inbox", "sidebar" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Listar comments", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/comments?credentialId={{credentialId}}&cursor={{cursor}}&limit={{limit}}&mediaId={{mediaId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "comments" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "cursor", "value": "{{cursor}}", "description": "Cursor opaco recebido na página anterior.", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "mediaId", "value": "{{mediaId}}", "description": "Valor opcional de media.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Criar ou executar comments", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/comments", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "comments" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir comments", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/comments/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "comments", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write" }, "response": [] }, { "name": "Listar proxy", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/media/proxy?fallback={{fallback}}&url={{url}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "media", "proxy" ], "query": [ { "key": "fallback", "value": "{{fallback}}", "description": "Valor opcional de fallback.", "disabled": true }, { "key": "url", "value": "{{url}}", "description": "Valor opcional de url.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Listar upload", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/media/upload?id={{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "media", "upload" ], "query": [ { "key": "id", "value": "{{id}}", "description": "Valor opcional de id.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Criar ou executar upload", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/media/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "media", "upload" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write" }, "response": [] }, { "name": "Criar ou executar mensagens", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "messages" ] }, "description": "Envia uma mensagem de texto simples. Use `previewUrl: true` para gerar preview de links.\n\nEnvia mensagem de texto com preview automatico do link.\n\nEnvia uma resposta citando (quote) uma mensagem anterior usando `contextMessageId`.\n\nEnvia uma imagem com legenda opcional. Formatos: JPEG, PNG. Max 5 MB.\n\nEnvia um video com legenda opcional. Formato: MP4. Max 16 MB.\n\nEnvia um audio. Formato: OGG/OPUS (audio de voz), MP3, AAC. Max 16 MB.\n\nEnvia um documento/arquivo. Formatos: PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, TXT, CSV, ZIP. Max 100 MB.\n\nEnvia uma figurinha. Formato: WebP. Max 100 KB (estatico) / 500 KB (animado).\n\nEnvia uma localizacao geografica com nome e endereco opcionais.\n\nEnvia um ou mais cartoes de contato no formato vCard.\n\nEnvia uma reacao (emoji) a uma mensagem especifica. Envie emoji vazio para remover reacao.\n\nEnvia mensagem com ate 3 botoes de resposta rapida. Cada botao tem `id` (max 256 chars) e `title` (max 20 chars).\n\nEnvia mensagem com menu em lista. Ate 10 secoes com ate 10 itens cada. Titulo do item max 24 chars, descricao max 72 chars.\n\nEnvia mensagem com botao de CTA (Call to Action) que abre uma URL.\n\nEnvia uma enquete com ate 12 opcoes. Use `allow_multiple_answers` para permitir multipla selecao.\n\nSolicita que o contato compartilhe sua localizacao.\n\nEnvia um template simples sem parametros. Ideal para templates de boas-vindas ou notificacoes fixas.\n\nEnvia um template com parametros dinamicos. Os parametros devem corresponder aos placeholders {{1}}, {{2}}, etc. do template aprovado.\n\nEnvia um template com imagem no header e parametros no body.\n\nEnvia quick replies no Instagram Direct. Use uma credencial Instagram ativa e o identificador do destinatário com prefixo `ig:`.\n\nEnvia um e-mail usando a conta de canal informada em `channelAccountId`.\n\nResponde a uma conversa de e-mail reutilizando `contextMessageId`, `inReplyTo` e `references`.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `messages:send`.\n\nPermissão: messages:send", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"{{credentialId}}\",\n \"to\": \"{{recipientPhone}}\",\n \"type\": \"text\",\n \"text\": \"Ola! Esta e uma mensagem enviada via API.\",\n \"previewUrl\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar forward", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/messages/forward", "host": [ "{{baseUrl}}" ], "path": [ "api", "messages", "forward" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `messages:send`.\n\nPermissão: messages:send", "body": { "mode": "raw", "raw": "{\n \"sourceMessageId\": \"string\",\n \"targetConversationIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar notes", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/notes", "host": [ "{{baseUrl}}" ], "path": [ "api", "notes" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Criar ou executar notes", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/notes", "host": [ "{{baseUrl}}" ], "path": [ "api", "notes" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"clientRequestId\": \"string\",\n \"title\": \"string\",\n \"content\": \"string\",\n \"color\": \"string\",\n \"status\": \"string\",\n \"priority\": \"string\",\n \"labels\": [\n \"string\"\n ],\n \"isFavorite\": false,\n \"isHidden\": false,\n \"isMinimized\": false,\n \"posX\": 0,\n \"posY\": {},\n \"width\": {},\n \"height\": {},\n \"zIndex\": 0,\n \"pinnedRoute\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar notes", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/notes", "host": [ "{{baseUrl}}" ], "path": [ "api", "notes" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"clientRequestId\": \"string\",\n \"title\": \"string\",\n \"content\": \"string\",\n \"color\": \"string\",\n \"status\": \"string\",\n \"priority\": \"string\",\n \"labels\": [\n \"string\"\n ],\n \"isFavorite\": false,\n \"isHidden\": false,\n \"isMinimized\": false,\n \"posX\": 0,\n \"posY\": {},\n \"width\": {},\n \"height\": {},\n \"zIndex\": 0,\n \"pinnedRoute\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir notes", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/notes", "host": [ "{{baseUrl}}" ], "path": [ "api", "notes" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"id\": \"string\",\n \"ids\": [\n {}\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar notificações", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/notifications?channelAccountId={{channelAccountId}}&channelAccountIds={{channelAccountIds}}&countOnly={{countOnly}}&credentialId={{credentialId}}&credentialIds={{credentialIds}}&cursor={{cursor}}&from={{from}}&isRead={{isRead}}&limit={{limit}}&q={{q}}&to={{to}}&type={{type}}&types={{types}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "notifications" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "channelAccountIds", "value": "{{channelAccountIds}}", "description": "Valor opcional de channel account ids.", "disabled": true }, { "key": "countOnly", "value": "{{countOnly}}", "description": "Valor opcional de count only.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "credentialIds", "value": "{{credentialIds}}", "description": "Valor opcional de credential ids.", "disabled": true }, { "key": "cursor", "value": "{{cursor}}", "description": "Cursor opaco recebido na página anterior.", "disabled": true }, { "key": "from", "value": "{{from}}", "description": "Início do período.", "disabled": true }, { "key": "isRead", "value": "{{isRead}}", "description": "Valor opcional de is read.", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "q", "value": "{{q}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "to", "value": "{{to}}", "description": "Fim do período.", "disabled": true }, { "key": "type", "value": "{{type}}", "description": "Valor opcional de type.", "disabled": true }, { "key": "types", "value": "{{types}}", "description": "Valor opcional de types.", "disabled": true } ] }, "description": "Lista notificações com paginação por cursor e filtros opcionais.\n\nRetorna somente a contagem de notificações não lidas no escopo informado.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Atualizar notificações", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/notifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "notifications" ] }, "description": "Marca como lidas todas as notificações compatíveis com os filtros informados.\n\nMarca um conjunto específico de notificações como lidas.\n\nMarca um conjunto específico de notificações como não lidas.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"action\": \"markAllRead\",\n \"types\": [\n \"task_assigned\"\n ],\n \"credentialIds\": [\n \"{{credentialId}}\"\n ],\n \"channelAccountIds\": [\n \"{{channelAccountId}}\"\n ],\n \"from\": \"2026-01-01T00:00:00.000Z\",\n \"to\": \"2026-01-31T23:59:59.999Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir notificações", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/notifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "notifications" ] }, "description": "Exclui notificações por lista explícita de IDs.\n\nRemove notificações com base em filtros, incluindo opção para apagar apenas as já lidas.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"{{notificationId}}\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar notificações", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/notifications/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "notifications", "{{id}}" ] }, "description": "Marca uma única notificação como lida.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write" }, "response": [] }, { "name": "Excluir notificações", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/notifications/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "notifications", "{{id}}" ] }, "description": "Exclui uma única notificação e retorna `{ success: true }`.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write" }, "response": [] }, { "name": "Listar action center", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/notifications/action-center?channelAccountId={{channelAccountId}}&channelAccountIds={{channelAccountIds}}&credentialId={{credentialId}}&credentialIds={{credentialIds}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "notifications", "action-center" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "channelAccountIds", "value": "{{channelAccountIds}}", "description": "Valor opcional de channel account ids.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "credentialIds", "value": "{{credentialIds}}", "description": "Valor opcional de credential ids.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Atualizar action center", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/notifications/action-center", "host": [ "{{baseUrl}}" ], "path": [ "api", "notifications", "action-center" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar respostas rápidas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/quick-replies?category={{category}}&credentialId={{credentialId}}&search={{search}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "quick-replies" ], "query": [ { "key": "category", "value": "{{category}}", "description": "Valor opcional de category.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "search", "value": "{{search}}", "description": "Texto usado na busca.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Criar ou executar respostas rápidas", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/quick-replies?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "quick-replies" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"shortcut\": \"string\",\n \"title\": \"string\",\n \"content\": \"string\",\n \"category\": \"string\",\n \"variables\": [\n \"string\"\n ],\n \"isGlobal\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar respostas rápidas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/quick-replies/{{replyId}}?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "quick-replies", "{{replyId}}" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Atualizar respostas rápidas", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/quick-replies/{{replyId}}?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "quick-replies", "{{replyId}}" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"shortcut\": \"string\",\n \"title\": \"string\",\n \"content\": \"string\",\n \"category\": \"string\",\n \"variables\": [\n \"string\"\n ],\n \"isGlobal\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir respostas rápidas", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/quick-replies/{{replyId}}?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "quick-replies", "{{replyId}}" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write" }, "response": [] }, { "name": "Listar lembretes", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/reminders?all={{all}}&conversationId={{conversationId}}&credentialId={{credentialId}}&due={{due}}&page={{page}}&pageSize={{pageSize}}&query={{query}}&status={{status}}&type={{type}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "reminders" ], "query": [ { "key": "all", "value": "{{all}}", "description": "Valor opcional de all.", "disabled": true }, { "key": "conversationId", "value": "{{conversationId}}", "description": "Valor opcional de conversation.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "due", "value": "{{due}}", "description": "Valor opcional de due.", "disabled": true }, { "key": "page", "value": "{{page}}", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "pageSize", "value": "{{pageSize}}", "description": "Quantidade de itens por página.", "disabled": true }, { "key": "query", "value": "{{query}}", "description": "Valor opcional de query.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true }, { "key": "type", "value": "{{type}}", "description": "Valor opcional de type.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Atualizar lembretes", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/reminders/{{reminderId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "reminders", "{{reminderId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir lembretes", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/reminders/{{reminderId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "reminders", "{{reminderId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write" }, "response": [] }, { "name": "Listar mensagens agendadas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/scheduled-messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "scheduled-messages" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.\n\nPermissão: conversations:read" }, "response": [] }, { "name": "Criar ou executar mensagens agendadas", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/scheduled-messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "scheduled-messages" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"channelAccountId\": \"string\",\n \"to\": \"string\",\n \"scheduledFor\": \"string\",\n \"conversationId\": \"string\",\n \"email\": {\n \"subject\": \"string\",\n \"cc\": [\n \"string\"\n ],\n \"bcc\": [\n \"string\"\n ],\n \"replyTo\": \"string\",\n \"fromAlias\": \"string\",\n \"includeSignature\": false,\n \"htmlBody\": \"string\",\n \"inReplyTo\": \"string\",\n \"references\": [\n \"string\"\n ]\n },\n \"type\": \"text\",\n \"text\": \"string\",\n \"previewUrl\": false,\n \"template\": {\n \"name\": \"string\",\n \"language\": \"string\",\n \"components\": [\n {}\n ]\n },\n \"interactive\": {},\n \"media\": {},\n \"image\": {},\n \"video\": {},\n \"audio\": {},\n \"document\": {},\n \"sticker\": {},\n \"location\": {\n \"latitude\": 0,\n \"longitude\": 0,\n \"name\": \"string\",\n \"address\": \"string\"\n },\n \"contacts\": [\n {}\n ],\n \"reaction\": {\n \"message_id\": \"string\",\n \"emoji\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir mensagens agendadas", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/scheduled-messages?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}&id={{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "scheduled-messages" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "id", "value": "{{id}}", "description": "Valor opcional de id.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.\n\nPermissão: conversations:write" }, "response": [] } ] }, { "name": "Disparos", "item": [ { "name": "Listar broadcasts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/broadcasts?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "broadcasts" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Lista as campanhas visíveis no escopo atual.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.\n\nPermissão: broadcasts:read" }, "response": [] }, { "name": "Criar ou executar broadcasts", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/broadcasts?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "broadcasts" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Cria uma campanha com template aprovado. A resposta retorna `broadcast` no nível raiz.\n\nCria uma campanha agendada. Se `sendAt` estiver suficientemente no futuro, o retorno virá com status `SCHEDULED`.\n\nCria uma campanha com quick replies do Instagram. Use uma credencial Instagram ativa.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"{{credentialId}}\",\n \"campaignName\": \"Campanha Promocional Q1 2025\",\n \"messageType\": \"template\",\n \"template\": {\n \"name\": \"hello_world\",\n \"language\": \"pt_BR\"\n },\n \"recipients\": [\n {\n \"waId\": \"5511999990001\"\n },\n {\n \"waId\": \"5511999990002\"\n },\n {\n \"waId\": \"5511999990003\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar broadcasts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/broadcasts/{{id}}?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "broadcasts", "{{id}}" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Retorna os detalhes da campanha, incluindo indicadores agregados de entrega.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.\n\nPermissão: broadcasts:read" }, "response": [] }, { "name": "Cancelar broadcasts", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/broadcasts/{{id}}/cancel?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "broadcasts", "{{id}}", "cancel" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Cancela uma campanha agendada antes do envio.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write" }, "response": [] }, { "name": "Duplicar broadcasts", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/broadcasts/{{id}}/duplicate?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "broadcasts", "{{id}}", "duplicate" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write" }, "response": [] }, { "name": "Listar registros", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/broadcasts/{{id}}/logs?credentialId={{credentialId}}&page={{page}}&pageSize={{pageSize}}&q={{q}}&status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "broadcasts", "{{id}}", "logs" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "page", "value": "{{page}}", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "pageSize", "value": "{{pageSize}}", "description": "Quantidade de itens por página.", "disabled": true }, { "key": "q", "value": "{{q}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true } ] }, "description": "Lista os registros de entrega da campanha com paginação.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.\n\nPermissão: broadcasts:read" }, "response": [] }, { "name": "Exportar registros", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/broadcasts/{{id}}/logs/export?credentialId={{credentialId}}&format=csv&q={{q}}&status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "broadcasts", "{{id}}", "logs", "export" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "format", "value": "csv", "description": "Valor opcional de format.", "disabled": true }, { "key": "q", "value": "{{q}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true } ] }, "description": "Exporta os registros da campanha em JSON. Para CSV, troque `format=json` por `format=csv`.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.\n\nPermissão: broadcasts:read" }, "response": [] }, { "name": "Tentar novamente broadcasts", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/broadcasts/{{id}}/retry-failed?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "broadcasts", "{{id}}", "retry-failed" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write" }, "response": [] }, { "name": "Iniciar broadcasts", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/broadcasts/{{id}}/start-now?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "broadcasts", "{{id}}", "start-now" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Inicia imediatamente uma campanha agendada.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write" }, "response": [] }, { "name": "Interromper broadcasts", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/broadcasts/{{id}}/stop?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "broadcasts", "{{id}}", "stop" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Interrompe uma campanha em andamento ou agendada.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write" }, "response": [] }, { "name": "Criar ou executar eligibility", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/broadcasts/instagram/eligibility?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "broadcasts", "instagram", "eligibility" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.\n\nPermissão: broadcasts:read", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"sendAt\": \"string\",\n \"recipients\": [\n {\n \"waId\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar metrics", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/broadcasts/metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "broadcasts", "metrics" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.\n\nPermissão: broadcasts:read" }, "response": [] }, { "name": "Listar campanhas de e-mail", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/email-campaigns?channelAccountId={{channelAccountId}}&page=1&pageSize=20&q={{q}}&status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "email-campaigns" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "page", "value": "1", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "pageSize", "value": "20", "description": "Quantidade de itens por página.", "disabled": true }, { "key": "q", "value": "{{q}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true } ] }, "description": "Lista as campanhas de e-mail disponíveis no escopo atual.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.\n\nPermissão: broadcasts:read" }, "response": [] }, { "name": "Criar ou executar campanhas de e-mail", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/email-campaigns", "host": [ "{{baseUrl}}" ], "path": [ "api", "email-campaigns" ] }, "description": "Cria uma campanha de e-mail em rascunho usando conteúdo customizado.\n\nCria uma campanha de e-mail agendada.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"Boas-vindas de novos clientes\",\n \"channelAccountId\": \"{{channelAccountId}}\",\n \"topicId\": null,\n \"segmentId\": null,\n \"contentMode\": \"custom\",\n \"subject\": \"Boas-vindas à CloudWhats\",\n \"previewText\": \"Veja como começar mais rápido\",\n \"fromName\": \"Time CloudWhats\",\n \"replyToEmail\": \"suporte@exemplo.com\",\n \"htmlBody\": \"

Olá {{first_name}}

Bem-vindo(a) à CloudWhats.

\",\n \"textBody\": \"Olá! Bem-vindo(a) à CloudWhats.\",\n \"audienceType\": \"manual\",\n \"recipients\": [\n {\n \"email\": \"cliente@example.com\",\n \"name\": \"Cliente Exemplo\",\n \"source\": \"manual\",\n \"variables\": {\n \"first_name\": \"Cliente\"\n }\n }\n ],\n \"action\": \"draft\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar campanhas de e-mail", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/email-campaigns/{{id}}?eventsTake=25&recipientsTake=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "email-campaigns", "{{id}}" ], "query": [ { "key": "eventsTake", "value": "25", "description": "Valor opcional de events take.", "disabled": true }, { "key": "recipientsTake", "value": "50", "description": "Valor opcional de recipients take.", "disabled": true } ] }, "description": "Retorna o detalhe completo da campanha, incluindo conta de envio, destinatários e eventos recentes.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.\n\nPermissão: broadcasts:read" }, "response": [] }, { "name": "Atualizar campanhas de e-mail", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/email-campaigns/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "email-campaigns", "{{id}}" ] }, "description": "Reagenda a campanha para uma nova data futura.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write", "body": { "mode": "raw", "raw": "{\n \"scheduledAt\": \"{{scheduledDate}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Cancelar campanhas de e-mail", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/email-campaigns/{{id}}/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "email-campaigns", "{{id}}", "cancel" ] }, "description": "Cancela a campanha no estado atual e sincroniza o retorno disponível.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write" }, "response": [] }, { "name": "Listar registros", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/email-campaigns/{{id}}/logs?eventsPage=1&eventsPageSize=50&recipientQuery={{recipientQuery}}&recipientStatus={{recipientStatus}}&recipientsPage=1&recipientsPageSize=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "email-campaigns", "{{id}}", "logs" ], "query": [ { "key": "eventsPage", "value": "1", "description": "Valor opcional de events page.", "disabled": true }, { "key": "eventsPageSize", "value": "50", "description": "Valor opcional de events page size.", "disabled": true }, { "key": "recipientQuery", "value": "{{recipientQuery}}", "description": "Valor opcional de recipient query.", "disabled": true }, { "key": "recipientStatus", "value": "{{recipientStatus}}", "description": "Valor opcional de recipient status.", "disabled": true }, { "key": "recipientsPage", "value": "1", "description": "Valor opcional de recipients page.", "disabled": true }, { "key": "recipientsPageSize", "value": "50", "description": "Valor opcional de recipients page size.", "disabled": true } ] }, "description": "Lista destinatários e eventos da campanha com paginação independente para cada grupo.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.\n\nPermissão: broadcasts:read" }, "response": [] }, { "name": "Enviar campanhas de e-mail", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/email-campaigns/{{id}}/send", "host": [ "{{baseUrl}}" ], "path": [ "api", "email-campaigns", "{{id}}", "send" ] }, "description": "Dispara imediatamente uma campanha elegível para envio.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write" }, "response": [] }, { "name": "Listar segments", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/email-marketing/segments?channelAccountId={{channelAccountId}}&includeArchived={{includeArchived}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "email-marketing", "segments" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "includeArchived", "value": "{{includeArchived}}", "description": "Valor opcional de include archived.", "disabled": true } ] }, "description": "Lista os segmentos disponíveis no escopo atual.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.\n\nPermissão: broadcasts:read" }, "response": [] }, { "name": "Criar ou executar segments", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/email-marketing/segments", "host": [ "{{baseUrl}}" ], "path": [ "api", "email-marketing", "segments" ] }, "description": "Cria um segmento de marketing por e-mail. O exemplo usa `filters: []` para evitar dependência de operadores específicos.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"Clientes com e-mail válido\",\n \"description\": \"Segmento criado via API\",\n \"filters\": [],\n \"channelAccountId\": \"{{channelAccountId}}\",\n \"syncNow\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar segments", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/email-marketing/segments/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "email-marketing", "segments", "{{id}}" ] }, "description": "Retorna o detalhe de um segmento de marketing por e-mail no escopo da conta ativa.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.\n\nPermissão: broadcasts:read" }, "response": [] }, { "name": "Atualizar segments", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/email-marketing/segments/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "email-marketing", "segments", "{{id}}" ] }, "description": "Atualiza nome, descrição e filtros do segmento.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"Clientes com e-mail válido - atualizado\",\n \"description\": \"Segmento atualizado via API\",\n \"filters\": [],\n \"syncNow\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir segments", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/email-marketing/segments/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "email-marketing", "segments", "{{id}}" ] }, "description": "Arquiva o segmento no escopo atual da conta de e-mail.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write" }, "response": [] }, { "name": "Visualizar prévia de segments", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/email-marketing/segments/{{id}}/preview", "host": [ "{{baseUrl}}" ], "path": [ "api", "email-marketing", "segments", "{{id}}", "preview" ] }, "description": "Mostra uma prévia dos contatos elegíveis e a contagem total estimada do segmento.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.\n\nPermissão: broadcasts:read" }, "response": [] }, { "name": "Sincronizar segments", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/email-marketing/segments/{{id}}/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "email-marketing", "segments", "{{id}}", "sync" ] }, "description": "Sincroniza o segmento com o provedor de e-mail quando necessário.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write" }, "response": [] }, { "name": "Listar tópicos", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/email-marketing/topics?includeArchived={{includeArchived}}&refresh={{refresh}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "email-marketing", "topics" ], "query": [ { "key": "includeArchived", "value": "{{includeArchived}}", "description": "Valor opcional de include archived.", "disabled": true }, { "key": "refresh", "value": "{{refresh}}", "description": "Valor opcional de refresh.", "disabled": true } ] }, "description": "Lista os tópicos de marketing por e-mail disponíveis para a conta ativa/resolvida.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.\n\nPermissão: broadcasts:read" }, "response": [] }, { "name": "Criar ou executar tópicos", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/email-marketing/topics", "host": [ "{{baseUrl}}" ], "path": [ "api", "email-marketing", "topics" ] }, "description": "Cria um tópico de marketing por e-mail.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"Novidades do produto\",\n \"description\": \"Comunicações sobre lançamentos e melhorias\",\n \"visibility\": \"PRIVATE\",\n \"defaultSubscription\": \"OPT_IN\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar tópicos", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/email-marketing/topics/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "email-marketing", "topics", "{{id}}" ] }, "description": "Atualiza os dados do tópico de marketing por e-mail.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write", "body": { "mode": "raw", "raw": "{\n \"description\": \"Comunicações sobre lançamentos, melhorias e avisos importantes\",\n \"defaultSubscription\": \"OPT_IN\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir tópicos", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/email-marketing/topics/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "email-marketing", "topics", "{{id}}" ] }, "description": "Arquiva o tópico no escopo atual da conta ativa/resolvida.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write" }, "response": [] }, { "name": "Listar content", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/content?credentialId={{credentialId}}&cursor={{cursor}}&limit={{limit}}&status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "content" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "cursor", "value": "{{cursor}}", "description": "Cursor opaco recebido na página anterior.", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.\n\nPermissão: broadcasts:read" }, "response": [] }, { "name": "Criar ou executar content", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/content", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "content" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar content", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/content/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "content", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.\n\nPermissão: broadcasts:read" }, "response": [] }, { "name": "Atualizar content", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/content/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "content", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir content", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/content/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "content", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write" }, "response": [] }, { "name": "Listar native", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/content/native?credentialId={{credentialId}}&limit={{limit}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "content", "native" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.\n\nPermissão: broadcasts:read" }, "response": [] }, { "name": "Sincronizar content", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/content/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "content", "sync" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar upload", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/content/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "content", "upload" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write" }, "response": [] }, { "name": "Listar mídias", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/media?credentialId={{credentialId}}&limit={{limit}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "media" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.\n\nPermissão: broadcasts:read" }, "response": [] }, { "name": "Listar campanhas do widget", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/widget-campaigns?widgetConfigId={{widgetConfigId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "widget-campaigns" ], "query": [ { "key": "widgetConfigId", "value": "{{widgetConfigId}}", "description": "Valor opcional de widget config.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.\n\nPermissão: broadcasts:read" }, "response": [] }, { "name": "Criar ou executar campanhas do widget", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/widget-campaigns", "host": [ "{{baseUrl}}" ], "path": [ "api", "widget-campaigns" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write", "body": { "mode": "raw", "raw": "{\n \"widgetConfigId\": \"string\",\n \"name\": \"string\",\n \"message\": \"string\",\n \"messageType\": \"TEXT\",\n \"interactive\": {\n \"type\": \"buttons\",\n \"header\": {\n \"type\": \"text\",\n \"text\": \"string\",\n \"image\": {\n \"link\": \"string\",\n \"caption\": \"string\"\n },\n \"video\": {\n \"link\": \"string\"\n },\n \"document\": {\n \"link\": \"string\",\n \"filename\": \"string\"\n }\n },\n \"body\": {\n \"text\": \"string\"\n },\n \"footer\": {\n \"text\": \"string\"\n },\n \"action\": {\n \"buttons\": [\n {\n \"reply\": {\n \"id\": \"string\",\n \"title\": \"string\"\n }\n }\n ],\n \"sections\": [\n {\n \"title\": \"string\",\n \"rows\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\"\n }\n ]\n }\n ]\n },\n \"cards\": [\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"imageUrl\": \"string\",\n \"actions\": [\n {\n \"type\": \"link\",\n \"text\": \"string\",\n \"uri\": \"string\",\n \"payload\": \"string\"\n }\n ]\n }\n ]\n },\n \"urlPatterns\": [\n \"string\"\n ],\n \"timeOnPageSeconds\": 0,\n \"sentBy\": \"agent\",\n \"businessHours\": {\n \"enabled\": false,\n \"start\": \"string\",\n \"end\": \"string\",\n \"timezone\": \"string\"\n },\n \"isActive\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar campanhas do widget", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/widget-campaigns/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "widget-campaigns", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.\n\nPermissão: broadcasts:read" }, "response": [] }, { "name": "Atualizar campanhas do widget", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/widget-campaigns/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "widget-campaigns", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write", "body": { "mode": "raw", "raw": "{\n \"widgetConfigId\": \"string\",\n \"name\": \"string\",\n \"message\": \"string\",\n \"messageType\": \"TEXT\",\n \"interactive\": {\n \"type\": \"buttons\",\n \"header\": {\n \"type\": \"text\",\n \"text\": \"string\",\n \"image\": {\n \"link\": \"string\",\n \"caption\": \"string\"\n },\n \"video\": {\n \"link\": \"string\"\n },\n \"document\": {\n \"link\": \"string\",\n \"filename\": \"string\"\n }\n },\n \"body\": {\n \"text\": \"string\"\n },\n \"footer\": {\n \"text\": \"string\"\n },\n \"action\": {\n \"buttons\": [\n {\n \"reply\": {\n \"id\": \"string\",\n \"title\": \"string\"\n }\n }\n ],\n \"sections\": [\n {\n \"title\": \"string\",\n \"rows\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\"\n }\n ]\n }\n ]\n },\n \"cards\": [\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"imageUrl\": \"string\",\n \"actions\": [\n {\n \"type\": \"link\",\n \"text\": \"string\",\n \"uri\": \"string\",\n \"payload\": \"string\"\n }\n ]\n }\n ]\n },\n \"urlPatterns\": [\n \"string\"\n ],\n \"timeOnPageSeconds\": 0,\n \"sentBy\": \"agent\",\n \"businessHours\": {\n \"enabled\": false,\n \"start\": \"string\",\n \"end\": \"string\",\n \"timezone\": \"string\"\n },\n \"isActive\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir campanhas do widget", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/widget-campaigns/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "widget-campaigns", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.\n\nPermissão: broadcasts:write" }, "response": [] } ] }, { "name": "Faturamento", "item": [ { "name": "Cancelar agendamentos", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/billing/guided-support/bookings/{{bookingId}}/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "billing", "guided-support", "bookings", "{{bookingId}}", "cancel" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `billing:write`.\n\nPermissão: billing:write", "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar reschedule", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/billing/guided-support/bookings/{{bookingId}}/reschedule", "host": [ "{{baseUrl}}" ], "path": [ "api", "billing", "guided-support", "bookings", "{{bookingId}}", "reschedule" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `billing:write`.\n\nPermissão: billing:write", "body": { "mode": "raw", "raw": "{\n \"start\": \"string\",\n \"timeZone\": \"string\",\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar agendamentos", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/billing/guided-support/purchases/{{purchaseId}}/bookings", "host": [ "{{baseUrl}}" ], "path": [ "api", "billing", "guided-support", "purchases", "{{purchaseId}}", "bookings" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `billing:write`.\n\nPermissão: billing:write", "body": { "mode": "raw", "raw": "{\n \"start\": \"string\",\n \"timeZone\": \"string\",\n \"emailVerificationCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar slots", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/billing/guided-support/purchases/{{purchaseId}}/slots?bookingId={{bookingId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "billing", "guided-support", "purchases", "{{purchaseId}}", "slots" ], "query": [ { "key": "bookingId", "value": "{{bookingId}}", "description": "Valor opcional de booking.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `billing:read`.\n\nPermissão: billing:read" }, "response": [] } ] }, { "name": "Fluxos e agentes", "item": [ { "name": "Listar agentes de IA", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.\n\nPermissão: flows:read" }, "response": [] }, { "name": "Criar ou executar agentes de IA", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{\n \"providerKeyId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"model\": \"string\",\n \"fallbackModel\": {},\n \"systemPrompt\": \"string\",\n \"temperature\": \"0.7\",\n \"maxTokens\": 0,\n \"topP\": 0,\n \"thinkingEnabled\": false,\n \"autoReply\": false,\n \"triggerKeywords\": [\n \"string\"\n ],\n \"triggerTags\": {},\n \"contactTagMode\": \"all\",\n \"skipAssignedConversations\": false,\n \"businessHours\": {},\n \"fallbackMessage\": \"string\",\n \"assignedToId\": \"string\",\n \"assignedTeamId\": \"string\",\n \"knowledgeUrls\": [\n \"string\"\n ],\n \"knowledgeFiles\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": \"pdf\",\n \"url\": \"string\",\n \"uploadedAt\": \"string\",\n \"content\": \"string\"\n }\n ],\n \"liveModeEnabled\": false,\n \"liveModeMaxMessages\": \"3\",\n \"liveModeTypingDelayMs\": \"1200\",\n \"responseDebounceSeconds\": \"0\",\n \"transcribeAudioMessages\": false,\n \"transcriptionOnly\": false,\n \"analyzeImageMessages\": false,\n \"analyzeVideoMessages\": false,\n \"audioResponseEnabled\": false,\n \"audioResponseFrequency\": \"always\",\n \"audioResponseVoice\": \"string\",\n \"activeChannels\": [\n \"string\"\n ],\n \"autoReplyOnlyNewContacts\": false,\n \"autoImproveEnabled\": false,\n \"autoImproveChannels\": [\n \"string\"\n ],\n \"autoImproveRetentionDays\": \"90\",\n \"autoImproveIncludeCollaborators\": false,\n \"handoffEnabled\": false,\n \"handoffAutoAssign\": false,\n \"handoffInactivityMinutes\": 0,\n \"handoffAllowedUserIds\": [\n \"string\"\n ],\n \"handoffAllowedTeamIds\": [\n \"string\"\n ],\n \"handoffPauseOnAssign\": false,\n \"pauseOnUserMessage\": false,\n \"handoffSystemPrompt\": \"string\",\n \"handoffForwardingMessage\": \"string\",\n \"handoffPrivateNoteEnabled\": false,\n \"handoffPrivateNoteTemplate\": \"string\",\n \"handoffSlaEnabled\": false,\n \"handoffSlaMinutes\": \"15\",\n \"includeOrderHistory\": false,\n \"maxOrdersContext\": \"5\",\n \"includeTasksData\": false,\n \"maxTasksContext\": \"10\",\n \"includeContactCustomFields\": false,\n \"includeTagDescriptions\": false,\n \"includeContactNotes\": false,\n \"includeCrmDeals\": false,\n \"maxCrmDealsContext\": \"5\",\n \"includeReminders\": false,\n \"maxRemindersContext\": \"5\",\n \"includeScheduledMessages\": false,\n \"maxScheduledMessagesContext\": \"5\",\n \"canReadOrders\": false,\n \"canUpdateOrders\": false,\n \"canReadTasks\": false,\n \"canCreateTasks\": false,\n \"canUpdateTasks\": false,\n \"canDeleteTasks\": false,\n \"canReadCrmDeals\": false,\n \"canUpdateCrmDeals\": false,\n \"canCreateCrmDeals\": false,\n \"canDeleteCrmDeals\": false,\n \"canReadReminders\": false,\n \"canCreateReminders\": false,\n \"canDeleteReminders\": false,\n \"canReadScheduledMessages\": false,\n \"canCreateScheduledMessages\": false,\n \"canDeleteScheduledMessages\": false,\n \"canReadCalendarEvents\": false,\n \"canCreateCalendarEvents\": false,\n \"canUpdateContactProfile\": false,\n \"canCreateLinearIssues\": false,\n \"canReadLinearIssues\": false,\n \"canSearchFirecrawlWeb\": false,\n \"canScrapeFirecrawlUrl\": false,\n \"canSearchMetaCatalog\": false,\n \"canSendMetaCatalogProducts\": false,\n \"canCreateStripePaymentLinks\": false,\n \"canReadStripeInvoices\": false,\n \"canReadBitrix24Deals\": false,\n \"canCreateBitrix24Deals\": false,\n \"canReadNuvemshopOrders\": false,\n \"includeGalleryItems\": false,\n \"maxGalleryItemsContext\": \"20\",\n \"galleryTagFilter\": [\n \"string\"\n ],\n \"canSearchGallery\": false,\n \"canSendGalleryItems\": false,\n \"galleryContactTagMatch\": \"off\",\n \"useMcpTools\": false,\n \"mcpServerIds\": [\n \"string\"\n ],\n \"customerDataDisclosure\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar agentes de IA", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.\n\nPermissão: flows:read" }, "response": [] }, { "name": "Atualizar agentes de IA", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{\n \"providerKeyId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"model\": \"string\",\n \"fallbackModel\": {},\n \"systemPrompt\": \"string\",\n \"temperature\": 0,\n \"maxTokens\": 0,\n \"topP\": 0,\n \"thinkingEnabled\": false,\n \"isActive\": false,\n \"autoReply\": false,\n \"triggerKeywords\": [\n \"string\"\n ],\n \"triggerTags\": {},\n \"contactTagMode\": \"all\",\n \"skipAssignedConversations\": false,\n \"businessHours\": {},\n \"fallbackMessage\": \"string\",\n \"assignedToId\": \"string\",\n \"assignedTeamId\": \"string\",\n \"knowledgeUrls\": [\n \"string\"\n ],\n \"knowledgeFiles\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": \"pdf\",\n \"url\": \"string\",\n \"uploadedAt\": \"string\",\n \"content\": \"string\"\n }\n ],\n \"liveModeEnabled\": false,\n \"liveModeMaxMessages\": 0,\n \"liveModeTypingDelayMs\": 0,\n \"responseDebounceSeconds\": 0,\n \"transcribeAudioMessages\": false,\n \"transcriptionOnly\": false,\n \"analyzeImageMessages\": false,\n \"analyzeVideoMessages\": false,\n \"audioResponseEnabled\": false,\n \"audioResponseFrequency\": \"always\",\n \"audioResponseVoice\": \"string\",\n \"activeChannels\": [\n \"string\"\n ],\n \"autoReplyOnlyNewContacts\": false,\n \"autoImproveEnabled\": false,\n \"autoImproveChannels\": [\n \"string\"\n ],\n \"autoImproveRetentionDays\": 0,\n \"autoImproveIncludeCollaborators\": false,\n \"handoffEnabled\": false,\n \"handoffAutoAssign\": false,\n \"handoffInactivityMinutes\": 0,\n \"handoffAllowedUserIds\": [\n \"string\"\n ],\n \"handoffAllowedTeamIds\": [\n \"string\"\n ],\n \"handoffPauseOnAssign\": false,\n \"pauseOnUserMessage\": false,\n \"handoffSystemPrompt\": \"string\",\n \"handoffForwardingMessage\": \"string\",\n \"handoffPrivateNoteEnabled\": false,\n \"handoffPrivateNoteTemplate\": \"string\",\n \"handoffSlaEnabled\": false,\n \"handoffSlaMinutes\": 0,\n \"includeOrderHistory\": false,\n \"maxOrdersContext\": 0,\n \"includeTasksData\": false,\n \"maxTasksContext\": 0,\n \"includeContactCustomFields\": false,\n \"includeTagDescriptions\": false,\n \"includeContactNotes\": false,\n \"includeCrmDeals\": false,\n \"maxCrmDealsContext\": 0,\n \"includeReminders\": false,\n \"maxRemindersContext\": 0,\n \"includeScheduledMessages\": false,\n \"maxScheduledMessagesContext\": 0,\n \"canReadOrders\": false,\n \"canUpdateOrders\": false,\n \"canReadTasks\": false,\n \"canCreateTasks\": false,\n \"canUpdateTasks\": false,\n \"canDeleteTasks\": false,\n \"canReadCrmDeals\": false,\n \"canUpdateCrmDeals\": false,\n \"canCreateCrmDeals\": false,\n \"canDeleteCrmDeals\": false,\n \"canReadReminders\": false,\n \"canCreateReminders\": false,\n \"canDeleteReminders\": false,\n \"canReadScheduledMessages\": false,\n \"canCreateScheduledMessages\": false,\n \"canDeleteScheduledMessages\": false,\n \"canReadCalendarEvents\": false,\n \"canCreateCalendarEvents\": false,\n \"canUpdateContactProfile\": false,\n \"canCreateLinearIssues\": false,\n \"canReadLinearIssues\": false,\n \"canSearchFirecrawlWeb\": false,\n \"canScrapeFirecrawlUrl\": false,\n \"canSearchMetaCatalog\": false,\n \"canSendMetaCatalogProducts\": false,\n \"canCreateStripePaymentLinks\": false,\n \"canReadStripeInvoices\": false,\n \"canReadBitrix24Deals\": false,\n \"canCreateBitrix24Deals\": false,\n \"canReadNuvemshopOrders\": false,\n \"includeGalleryItems\": false,\n \"maxGalleryItemsContext\": 0,\n \"galleryTagFilter\": [\n \"string\"\n ],\n \"canSearchGallery\": false,\n \"canSendGalleryItems\": false,\n \"galleryContactTagMatch\": \"off\",\n \"useMcpTools\": false,\n \"mcpServerIds\": [\n \"string\"\n ],\n \"customerDataDisclosure\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir agentes de IA", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write" }, "response": [] }, { "name": "Duplicar agentes de IA", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}/duplicate", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}", "duplicate" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"targetCredentialId\": \"string\",\n \"activeChannels\": [\n {}\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar contexto CAG", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}/knowledge/cag", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}", "knowledge", "cag" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.\n\nPermissão: flows:read" }, "response": [] }, { "name": "Excluir contexto CAG", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}/knowledge/cag", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}", "knowledge", "cag" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write" }, "response": [] }, { "name": "Criar ou executar arquivos", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}/knowledge/files", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}", "knowledge", "files" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write" }, "response": [] }, { "name": "Excluir arquivos", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}/knowledge/files?fileId={{fileId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}", "knowledge", "files" ], "query": [ { "key": "fileId", "value": "{{fileId}}", "description": "Valor opcional de file.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write" }, "response": [] }, { "name": "Reprocessar base de conhecimento", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}/knowledge/reprocess", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}", "knowledge", "reprocess" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write" }, "response": [] }, { "name": "Criar ou executar fontes", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}/knowledge/sources/{{sourceId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}", "knowledge", "sources", "{{sourceId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write" }, "response": [] }, { "name": "Excluir fontes", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}/knowledge/sources/{{sourceId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}", "knowledge", "sources", "{{sourceId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write" }, "response": [] }, { "name": "Listar status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}/knowledge/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}", "knowledge", "status" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.\n\nPermissão: flows:read" }, "response": [] }, { "name": "Criar ou executar URLs", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}/knowledge/urls", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}", "knowledge", "urls" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{\n \"url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir URLs", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}/knowledge/urls?url={{url}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}", "knowledge", "urls" ], "query": [ { "key": "url", "value": "{{url}}", "description": "Valor opcional de url.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write" }, "response": [] }, { "name": "Criar ou executar teste de mídia", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}/media-test?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}", "media-test" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write" }, "response": [] }, { "name": "Listar memórias", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}/memories?conversationId={{conversationId}}&limit={{limit}}&page={{page}}&scope={{scope}}&search={{search}}&type={{type}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}", "memories" ], "query": [ { "key": "conversationId", "value": "{{conversationId}}", "description": "Valor opcional de conversation.", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "page", "value": "{{page}}", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "scope", "value": "{{scope}}", "description": "Valor opcional de scope.", "disabled": true }, { "key": "search", "value": "{{search}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "type", "value": "{{type}}", "description": "Valor opcional de type.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.\n\nPermissão: flows:read" }, "response": [] }, { "name": "Criar ou executar memórias", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}/memories", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}", "memories" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir memórias", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}/memories", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}", "memories" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Preencher memórias", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}/memories/backfill-embeddings", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}", "memories", "backfill-embeddings" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write" }, "response": [] }, { "name": "Listar conversas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}/preview/conversations?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}&q={{q}}&take={{take}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}", "preview", "conversations" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "q", "value": "{{q}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "take", "value": "{{take}}", "description": "Quantidade máxima de itens retornados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.\n\nPermissão: flows:read" }, "response": [] }, { "name": "Criar ou executar execução", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/{{agentId}}/preview/run?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "{{agentId}}", "preview", "run" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{\n \"conversationId\": \"string\",\n \"sandboxMessages\": [\n {\n \"role\": \"user\",\n \"content\": \"string\"\n }\n ],\n \"message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar opções de conectores", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/connector-options", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "connector-options" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.\n\nPermissão: flows:read" }, "response": [] }, { "name": "Transferir agentes de IA", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/handoff?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "handoff" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{\n \"conversationId\": \"string\",\n \"agentId\": \"string\",\n \"action\": \"AI_TO_HUMAN\",\n \"toUserId\": \"string\",\n \"toTeamId\": \"string\",\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar opções MCP", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/mcp-options", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "mcp-options" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.\n\nPermissão: flows:read" }, "response": [] }, { "name": "Pausar agentes de IA", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/pause?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "pause" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{\n \"conversationId\": \"string\",\n \"agentId\": \"string\",\n \"reason\": \"string\",\n \"resumeAt\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Retomar agentes de IA", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/resume?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "resume" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{\n \"conversationId\": \"string\",\n \"agentId\": \"string\",\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar sessões", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/sessions?agentId={{agentId}}&channelAccountId={{channelAccountId}}&credentialId={{credentialId}}&limit={{limit}}&page={{page}}&search={{search}}&sort={{sort}}&status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "sessions" ], "query": [ { "key": "agentId", "value": "{{agentId}}", "description": "Valor opcional de agent.", "disabled": true }, { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "page", "value": "{{page}}", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "search", "value": "{{search}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "sort", "value": "{{sort}}", "description": "Valor opcional de sort.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.\n\nPermissão: flows:read" }, "response": [] }, { "name": "Criar ou executar ação em massa", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/sessions/bulk-action?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "sessions", "bulk-action" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{\n \"action\": \"pause_selected\",\n \"sessionIds\": [\n \"string\"\n ],\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar stats", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/ai-agents/sessions/stats?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ai-agents", "sessions", "stats" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.\n\nPermissão: flows:read" }, "response": [] }, { "name": "Listar automation templates", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automation-templates?category={{category}}&q={{q}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "automation-templates" ], "query": [ { "key": "category", "value": "{{category}}", "description": "Valor opcional de category.", "disabled": true }, { "key": "q", "value": "{{q}}", "description": "Texto usado na busca.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.\n\nPermissão: flows:read" }, "response": [] }, { "name": "Criar ou executar automation templates", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/automation-templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "automation-templates" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\",\n \"category\": \"WELCOME\",\n \"icon\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"triggerType\": {},\n \"triggerConfig\": {},\n \"nodesData\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"label\": \"string\",\n \"position\": {\n \"x\": 0,\n \"y\": 0\n },\n \"config\": {}\n }\n ],\n \"edgesData\": [\n {\n \"id\": \"string\",\n \"source\": \"string\",\n \"target\": \"string\",\n \"sourceHandle\": \"string\",\n \"targetHandle\": \"string\",\n \"label\": \"string\",\n \"condition\": {}\n }\n ],\n \"variables\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar endpoints de fluxo", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flow-endpoints?flowId={{flowId}}&isActive={{isActive}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "flow-endpoints" ], "query": [ { "key": "flowId", "value": "{{flowId}}", "description": "Valor opcional de flow.", "disabled": true }, { "key": "isActive", "value": "{{isActive}}", "description": "Valor opcional de is active.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.\n\nPermissão: flows:read" }, "response": [] }, { "name": "Criar ou executar endpoints de fluxo", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flow-endpoints", "host": [ "{{baseUrl}}" ], "path": [ "api", "flow-endpoints" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\",\n \"flowId\": \"string\",\n \"automationRules\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar endpoints de fluxo", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flow-endpoints/{{endpointId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "flow-endpoints", "{{endpointId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.\n\nPermissão: flows:read" }, "response": [] }, { "name": "Atualizar endpoints de fluxo", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flow-endpoints/{{endpointId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "flow-endpoints", "{{endpointId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{\n \"endpointId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isActive\": false,\n \"automationRules\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir endpoints de fluxo", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flow-endpoints/{{endpointId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "flow-endpoints", "{{endpointId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write" }, "response": [] }, { "name": "Listar flow responses", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flow-responses?contactId={{contactId}}&flowId={{flowId}}&limit={{limit}}&offset={{offset}}&processed={{processed}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "flow-responses" ], "query": [ { "key": "contactId", "value": "{{contactId}}", "description": "Valor opcional de contact.", "disabled": true }, { "key": "flowId", "value": "{{flowId}}", "description": "Valor opcional de flow.", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "offset", "value": "{{offset}}", "description": "Valor opcional de offset.", "disabled": true }, { "key": "processed", "value": "{{processed}}", "description": "Valor opcional de processed.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.\n\nPermissão: flows:read" }, "response": [] }, { "name": "Criar ou executar flow responses", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flow-responses", "host": [ "{{baseUrl}}" ], "path": [ "api", "flow-responses" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar batch process", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flow-responses/batch-process", "host": [ "{{baseUrl}}" ], "path": [ "api", "flow-responses", "batch-process" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar flows", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flows?credentialId={{credentialId}}&dbOnly={{dbOnly}}&source={{source}}&sync={{sync}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "flows" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "dbOnly", "value": "{{dbOnly}}", "description": "Valor opcional de db only.", "disabled": true }, { "key": "source", "value": "{{source}}", "description": "Valor opcional de source.", "disabled": true }, { "key": "sync", "value": "{{sync}}", "description": "Valor opcional de sync.", "disabled": true } ] }, "description": "Lista os flows disponíveis para a conta informada.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.\n\nPermissão: flows:read" }, "response": [] }, { "name": "Criar ou executar flows", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flows", "host": [ "{{baseUrl}}" ], "path": [ "api", "flows" ] }, "description": "Cria um flow e sincroniza com a Meta.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"{{credentialId}}\",\n \"name\": \"Flow API\",\n \"categories\": [\n \"OTHER\"\n ],\n \"endpointType\": \"CLOUD\",\n \"json_version\": \"7.1\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar flows", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flows/{{flowId}}?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "flows", "{{flowId}}" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Retorna os metadados do flow informado.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.\n\nPermissão: flows:read" }, "response": [] }, { "name": "Atualizar flows", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flows/{{flowId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "flows", "{{flowId}}" ] }, "description": "Atualiza o flow localmente e no provedor.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"Flow API Atualizado\",\n \"categories\": [\n \"OTHER\"\n ],\n \"endpoint_uri\": \"https://example.com/flow-endpoint\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir flows", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flows/{{flowId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "flows", "{{flowId}}" ] }, "description": "Exclui o flow da base local e da Meta.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write" }, "response": [] }, { "name": "Listar assets", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flows/{{flowId}}/assets", "host": [ "{{baseUrl}}" ], "path": [ "api", "flows", "{{flowId}}", "assets" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.\n\nPermissão: flows:read" }, "response": [] }, { "name": "Criar ou executar assets", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flows/{{flowId}}/assets", "host": [ "{{baseUrl}}" ], "path": [ "api", "flows", "{{flowId}}", "assets" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write" }, "response": [] }, { "name": "Descontinuar flows", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flows/{{flowId}}/deprecate", "host": [ "{{baseUrl}}" ], "path": [ "api", "flows", "{{flowId}}", "deprecate" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write" }, "response": [] }, { "name": "Listar json", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flows/{{flowId}}/json", "host": [ "{{baseUrl}}" ], "path": [ "api", "flows", "{{flowId}}", "json" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.\n\nPermissão: flows:read" }, "response": [] }, { "name": "Criar ou executar json", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flows/{{flowId}}/json", "host": [ "{{baseUrl}}" ], "path": [ "api", "flows", "{{flowId}}", "json" ] }, "description": "Atualiza a definição JSON do flow diretamente.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{\n \"json\": {\n \"screens\": [],\n \"routing_model\": {}\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Publicar flows", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flows/{{flowId}}/publish?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "flows", "{{flowId}}", "publish" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Publica o flow na Meta.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write" }, "response": [] }, { "name": "Enviar flows", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flows/send", "host": [ "{{baseUrl}}" ], "path": [ "api", "flows", "send" ] }, "description": "Envia uma mensagem com flow para um contato. O flow precisa estar publicado.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{\n \"to\": \"5511999999999\",\n \"credentialId\": \"{{credentialId}}\",\n \"flowId\": \"{{flowId}}\",\n \"flowCta\": \"Abrir fluxo\",\n \"flowAction\": \"navigate\",\n \"flowActionPayload\": {},\n \"body\": \"Confira este fluxo interativo.\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Sincronizar flows", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/flows/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "flows", "sync" ] }, "description": "Importa e sincroniza flows da Meta para a base local.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.\n\nPermissão: flows:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"{{credentialId}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Jornadas", "item": [ { "name": "Listar journeys", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys?q={{q}}&status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys" ], "query": [ { "key": "q", "value": "{{q}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.\n\nPermissão: journeys:read" }, "response": [] }, { "name": "Criar ou executar journeys", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.\n\nPermissão: journeys:write", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"credentialId\": \"string\",\n \"variables\": {},\n \"activate\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar journeys", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys/{{journeyId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys", "{{journeyId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.\n\nPermissão: journeys:read" }, "response": [] }, { "name": "Atualizar journeys", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys/{{journeyId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys", "{{journeyId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.\n\nPermissão: journeys:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\",\n \"variables\": {},\n \"credentialId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Ativar journeys", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys/{{journeyId}}/activate", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys", "{{journeyId}}", "activate" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.\n\nPermissão: journeys:write" }, "response": [] }, { "name": "Listar análises", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys/{{journeyId}}/analytics", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys", "{{journeyId}}", "analytics" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.\n\nPermissão: journeys:read" }, "response": [] }, { "name": "Arquivar journeys", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys/{{journeyId}}/archive", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys", "{{journeyId}}", "archive" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.\n\nPermissão: journeys:write" }, "response": [] }, { "name": "Listar contacts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys/{{journeyId}}/contacts?q={{q}}&status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys", "{{journeyId}}", "contacts" ], "query": [ { "key": "q", "value": "{{q}}", "description": "Texto usado na busca.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.\n\nPermissão: journeys:read" }, "response": [] }, { "name": "Criar ou executar contacts", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys/{{journeyId}}/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys", "{{journeyId}}", "contacts" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.\n\nPermissão: journeys:write", "body": { "mode": "raw", "raw": "{\n \"contactId\": \"string\",\n \"contactIds\": [\n \"string\"\n ],\n \"labelId\": \"string\",\n \"restartExisting\": false,\n \"reactivateOptedOut\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar contacts", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys/{{journeyId}}/contacts/{{enrollmentId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys", "{{journeyId}}", "contacts", "{{enrollmentId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.\n\nPermissão: journeys:write", "body": { "mode": "raw", "raw": "{\n \"action\": \"pause\",\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Duplicar journeys", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys/{{journeyId}}/duplicate", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys", "{{journeyId}}", "duplicate" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.\n\nPermissão: journeys:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar eventos", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys/{{journeyId}}/events", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys", "{{journeyId}}", "events" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.\n\nPermissão: journeys:read" }, "response": [] }, { "name": "Pausar journeys", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys/{{journeyId}}/pause", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys", "{{journeyId}}", "pause" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.\n\nPermissão: journeys:write" }, "response": [] }, { "name": "Criar ou executar run now", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys/{{journeyId}}/run-now", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys", "{{journeyId}}", "run-now" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.\n\nPermissão: journeys:read", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar runs", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys/{{journeyId}}/runs", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys", "{{journeyId}}", "runs" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.\n\nPermissão: journeys:read" }, "response": [] }, { "name": "Listar contact options", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys/contact-options?contactId={{contactId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys", "contact-options" ], "query": [ { "key": "contactId", "value": "{{contactId}}", "description": "Valor opcional de contact.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.\n\nPermissão: journeys:write" }, "response": [] }, { "name": "Listar templates", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys/templates?custom={{custom}}&includeUnpublished={{includeUnpublished}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys", "templates" ], "query": [ { "key": "custom", "value": "{{custom}}", "description": "Valor opcional de custom.", "disabled": true }, { "key": "includeUnpublished", "value": "{{includeUnpublished}}", "description": "Valor opcional de include unpublished.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.\n\nPermissão: journeys:read" }, "response": [] }, { "name": "Criar ou executar templates", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys", "templates" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.\n\nPermissão: journeys:write", "body": { "mode": "raw", "raw": "{\n \"baseTemplateId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isPublished\": false,\n \"defaultVariables\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar templates", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys/templates/{{templateId}}?includeUnpublished={{includeUnpublished}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys", "templates", "{{templateId}}" ], "query": [ { "key": "includeUnpublished", "value": "{{includeUnpublished}}", "description": "Valor opcional de include unpublished.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.\n\nPermissão: journeys:read" }, "response": [] }, { "name": "Atualizar templates", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys/templates/{{templateId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys", "templates", "{{templateId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.\n\nPermissão: journeys:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\",\n \"isPublished\": false,\n \"defaultVariables\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar simulate", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/journeys/templates/{{templateId}}/simulate", "host": [ "{{baseUrl}}" ], "path": [ "api", "journeys", "templates", "{{templateId}}", "simulate" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.\n\nPermissão: journeys:read", "body": { "mode": "raw", "raw": "{\n \"variables\": {},\n \"credentialId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Relatórios", "item": [ { "name": "Listar whatsapp", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/analytics/whatsapp", "host": [ "{{baseUrl}}" ], "path": [ "api", "analytics", "whatsapp" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Sincronizar whatsapp", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/analytics/whatsapp/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "analytics", "whatsapp", "sync" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:write`.\n\nPermissão: reports:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"rangeStart\": {},\n \"rangeEnd\": {},\n \"conversationRangeStart\": {},\n \"conversationRangeEnd\": {},\n \"granularity\": \"HOUR\",\n \"conversationGranularity\": \"HOUR\",\n \"phoneNumbers\": [\n \"string\"\n ],\n \"countryCodes\": [\n \"string\"\n ],\n \"conversationDirections\": [\n \"string\"\n ],\n \"conversationTypes\": [\n \"string\"\n ],\n \"conversationDimensions\": [\n \"string\"\n ],\n \"dryRun\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar insights", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/instagram/insights?credentialId={{credentialId}}&mediaId={{mediaId}}&since={{since}}&timeframe=last_30_days&type=profile&until={{until}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "instagram", "insights" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "mediaId", "value": "{{mediaId}}", "description": "Valor opcional de media.", "disabled": true }, { "key": "since", "value": "{{since}}", "description": "Valor opcional de since.", "disabled": true }, { "key": "timeframe", "value": "last_30_days", "description": "Valor opcional de timeframe.", "disabled": true }, { "key": "type", "value": "profile", "description": "Valor opcional de type.", "disabled": true }, { "key": "until", "value": "{{until}}", "description": "Valor opcional de until.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Listar reports", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/reports?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}&endDate={{endDate}}&period={{period}}&startDate={{startDate}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "reports" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "endDate", "value": "{{endDate}}", "description": "Valor opcional de end date.", "disabled": true }, { "key": "period", "value": "{{period}}", "description": "Período consolidado do relatório.", "disabled": true }, { "key": "startDate", "value": "{{startDate}}", "description": "Valor opcional de start date.", "disabled": true } ] }, "description": "Retorna o conjunto completo de relatórios: visão geral, conversas, pessoas, equipes, CRM, pedidos, tarefas, chamadas e mais.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Consultar reports", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/reports/{{type}}?aiAgentIds={{aiAgentIds}}&channelAccountId={{channelAccountId}}&credentialId={{credentialId}}&credentialIds={{credentialIds}}&endDate={{endDate}}&labelIds={{labelIds}}&period={{period}}&startDate={{startDate}}&teamIds={{teamIds}}&userIds={{userIds}}&widgetIds={{widgetIds}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "reports", "{{type}}" ], "query": [ { "key": "aiAgentIds", "value": "{{aiAgentIds}}", "description": "Valor opcional de ai agent ids.", "disabled": true }, { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "credentialIds", "value": "{{credentialIds}}", "description": "Valor opcional de credential ids.", "disabled": true }, { "key": "endDate", "value": "{{endDate}}", "description": "Valor opcional de end date.", "disabled": true }, { "key": "labelIds", "value": "{{labelIds}}", "description": "Valor opcional de label ids.", "disabled": true }, { "key": "period", "value": "{{period}}", "description": "Período consolidado do relatório.", "disabled": true }, { "key": "startDate", "value": "{{startDate}}", "description": "Valor opcional de start date.", "disabled": true }, { "key": "teamIds", "value": "{{teamIds}}", "description": "Valor opcional de team ids.", "disabled": true }, { "key": "userIds", "value": "{{userIds}}", "description": "Valor opcional de user ids.", "disabled": true }, { "key": "widgetIds", "value": "{{widgetIds}}", "description": "Valor opcional de widget ids.", "disabled": true } ] }, "description": "Template genérico para testar qualquer tipo listado na variável `reportType`.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Exportar reports", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/reports/export?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "reports", "export" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read", "body": { "mode": "raw", "raw": "{\n \"scope\": \"current\",\n \"reportType\": \"command-center\",\n \"format\": \"xlsx\",\n \"includeCharts\": false,\n \"includeLists\": false,\n \"filters\": {\n \"period\": {},\n \"startDate\": \"string\",\n \"endDate\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar preferences", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/reports/preferences", "host": [ "{{baseUrl}}" ], "path": [ "api", "reports", "preferences" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Atualizar preferences", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/reports/preferences", "host": [ "{{baseUrl}}" ], "path": [ "api", "reports", "preferences" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read", "body": { "mode": "raw", "raw": "{\n \"defaultReportType\": \"string\",\n \"favoriteReportTypes\": [\n {}\n ],\n \"recentReportTypes\": [\n {}\n ],\n \"navigationHidden\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar alerts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/alerts", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "alerts" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Atualizar alerts", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/alerts", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "alerts" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:write`.\n\nPermissão: reports:write", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ],\n \"action\": \"acknowledge\",\n \"channelAccountId\": \"string\",\n \"credentialId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar alerts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/alerts/{{alertId}}?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "alerts", "{{alertId}}" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Atualizar alerts", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/alerts/{{alertId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "alerts", "{{alertId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:write`.\n\nPermissão: reports:write", "body": { "mode": "raw", "raw": "{\n \"action\": \"acknowledge\",\n \"channelAccountId\": \"string\",\n \"credentialId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar linear", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/alerts/{{alertId}}/linear", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "alerts", "{{alertId}}", "linear" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:write`.\n\nPermissão: reports:write", "body": { "mode": "raw", "raw": "{\n \"channelAccountId\": \"string\",\n \"credentialId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar análises", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/analytics", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "analytics" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Listar anomalies", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/anomalies", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "anomalies" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Listar detail", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/anomalies/detail", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "anomalies", "detail" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Criar ou executar backlog analysis", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/backlog-analysis?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "backlog-analysis" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:write`.\n\nPermissão: reports:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar briefing", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/briefing", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "briefing" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Listar configuração", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/config", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "config" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Substituir configuração", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/config", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "config" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:write`.\n\nPermissão: reports:write", "body": { "mode": "raw", "raw": "{\n \"enabled\": false,\n \"churnThreshold\": 0,\n \"revenueSignalEnabled\": false,\n \"patternDetectionEnabled\": false,\n \"copilotEnabled\": false,\n \"predictiveSlaEnabled\": false,\n \"briefingEnabled\": false,\n \"briefingEmail\": {},\n \"briefingTime\": {},\n \"analysisModel\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar conversas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/conversations/{{conversationId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "conversations", "{{conversationId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Listar cross channel", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/cross-channel", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "cross-channel" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Criar ou executar cross channel", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/cross-channel?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "cross-channel" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:write`.\n\nPermissão: reports:write", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar health", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/health", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "health" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Listar overview", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/overview", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "overview" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Listar patterns", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/patterns", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "patterns" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Consultar patterns", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/patterns/{{patternId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "patterns", "{{patternId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Listar predictive sla", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/predictive-sla", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "predictive-sla" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Consultar predictive sla", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/predictive-sla/{{conversationId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "predictive-sla", "{{conversationId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Listar recommendations", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/recommendations", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "recommendations" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] }, { "name": "Atualizar recommendations", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/recommendations/{{recommendationId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "recommendations", "{{recommendationId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:write`.\n\nPermissão: reports:write", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACCEPTED\",\n \"outcome\": \"string\",\n \"execute\": false,\n \"channelAccountId\": \"string\",\n \"credentialId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar scores", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/sentinel/scores", "host": [ "{{baseUrl}}" ], "path": [ "api", "sentinel", "scores" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.\n\nPermissão: reports:read" }, "response": [] } ] }, { "name": "SLA", "item": [ { "name": "Listar sla", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/settings/sla?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "settings", "sla" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `sla:read`.\n\nPermissão: sla:read" }, "response": [] }, { "name": "Criar ou executar sla", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/settings/sla", "host": [ "{{baseUrl}}" ], "path": [ "api", "settings", "sla" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `sla:write`.\n\nPermissão: sla:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"firstResponseEnabled\": false,\n \"firstResponseThreshold\": 0,\n \"resolutionEnabled\": false,\n \"resolutionThreshold\": 0,\n \"warningThresholdPercent\": 0,\n \"isActive\": false,\n \"notifyEmail\": false,\n \"notifyBrowser\": false,\n \"notifyVisual\": false,\n \"notifyAudio\": false,\n \"autoPrivateMessage\": false,\n \"privateMessageTemplate\": \"string\",\n \"emailRecipientUserIds\": [\n \"string\"\n ],\n \"escalationEnabled\": false,\n \"escalationAfterMinutes\": 0,\n \"escalationTargetUserId\": \"string\",\n \"escalationTargetTeamId\": \"string\",\n \"escalationTargetAIAgentId\": \"string\",\n \"escalationAiFallbackAfterMinutes\": 0,\n \"aiEscalationPrompt\": \"string\",\n \"timezone\": \"string\",\n \"contactResponseEnabled\": false,\n \"contactResponseThreshold\": 0,\n \"businessHoursEnabled\": false,\n \"businessHours\": {\n \"days\": {}\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir sla", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/settings/sla", "host": [ "{{baseUrl}}" ], "path": [ "api", "settings", "sla" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `sla:write`.\n\nPermissão: sla:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar eligible ai agents", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/settings/sla/eligible-ai-agents?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "settings", "sla", "eligible-ai-agents" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `sla:read`.\n\nPermissão: sla:read" }, "response": [] } ] }, { "name": "Sugestões", "item": [ { "name": "Listar sugestões de produto", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/feature-requests?category={{category}}&onlyMine={{onlyMine}}&status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "feature-requests" ], "query": [ { "key": "category", "value": "{{category}}", "description": "Valor opcional de category.", "disabled": true }, { "key": "onlyMine", "value": "{{onlyMine}}", "description": "Valor opcional de only mine.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `featureRequests:read`.\n\nPermissão: featureRequests:read" }, "response": [] }, { "name": "Criar ou executar sugestões de produto", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/feature-requests", "host": [ "{{baseUrl}}" ], "path": [ "api", "feature-requests" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `featureRequests:write`.\n\nPermissão: featureRequests:write", "body": { "mode": "raw", "raw": "{\n \"title\": \"string\",\n \"description\": \"string\",\n \"category\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"notifyOnStatusChange\": false,\n \"tenantId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar sugestões de produto", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/feature-requests/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "feature-requests", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `featureRequests:read`.\n\nPermissão: featureRequests:read" }, "response": [] }, { "name": "Atualizar sugestões de produto", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/feature-requests/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "feature-requests", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `featureRequests:write`.\n\nPermissão: featureRequests:write", "body": { "mode": "raw", "raw": "{\n \"title\": \"string\",\n \"description\": \"string\",\n \"status\": \"BACKLOG\",\n \"priority\": \"LOW\",\n \"category\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"assignedToId\": \"string\",\n \"estimatedEffort\": \"string\",\n \"targetVersion\": \"string\",\n \"internalNotes\": \"string\",\n \"rejectionReason\": \"string\",\n \"duplicateOfId\": \"string\",\n \"notifyOnStatusChange\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir sugestões de produto", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/feature-requests/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "feature-requests", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `featureRequests:write`.\n\nPermissão: featureRequests:write" }, "response": [] }, { "name": "Listar comments", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/feature-requests/{{id}}/comments", "host": [ "{{baseUrl}}" ], "path": [ "api", "feature-requests", "{{id}}", "comments" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `featureRequests:read`.\n\nPermissão: featureRequests:read" }, "response": [] }, { "name": "Criar ou executar comments", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/feature-requests/{{id}}/comments", "host": [ "{{baseUrl}}" ], "path": [ "api", "feature-requests", "{{id}}", "comments" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `featureRequests:write`.\n\nPermissão: featureRequests:write", "body": { "mode": "raw", "raw": "{\n \"content\": \"string\",\n \"isInternal\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar vote", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/feature-requests/{{id}}/vote", "host": [ "{{baseUrl}}" ], "path": [ "api", "feature-requests", "{{id}}", "vote" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `featureRequests:write`.\n\nPermissão: featureRequests:write" }, "response": [] }, { "name": "Excluir vote", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/feature-requests/{{id}}/vote", "host": [ "{{baseUrl}}" ], "path": [ "api", "feature-requests", "{{id}}", "vote" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `featureRequests:write`.\n\nPermissão: featureRequests:write" }, "response": [] } ] }, { "name": "Tarefas", "item": [ { "name": "Listar tasks", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/deals/{{id}}/tasks?page={{page}}&pageSize={{pageSize}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "deals", "{{id}}", "tasks" ], "query": [ { "key": "page", "value": "{{page}}", "description": "Página da listagem, iniciando em 1.", "disabled": true }, { "key": "pageSize", "value": "{{pageSize}}", "description": "Quantidade de itens por página.", "disabled": true } ] }, "description": "Lista tarefas ligadas diretamente ao negócio ou ao contato do negócio.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:read`.\n\nPermissão: tasks:read" }, "response": [] }, { "name": "Criar ou executar tasks", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/crm/deals/{{id}}/tasks", "host": [ "{{baseUrl}}" ], "path": [ "api", "crm", "deals", "{{id}}", "tasks" ] }, "description": "Cria uma tarefa vinculada ao negócio. Além do gate de CRM, exige acesso a tarefas.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.\n\nPermissão: tasks:write", "body": { "mode": "raw", "raw": "{\n \"title\": \"Retornar sobre proposta\",\n \"description\": \"Agendar retorno com o cliente sobre a proposta comercial.\",\n \"priority\": \"HIGH\",\n \"dueDate\": \"2026-01-20T14:00:00.000Z\",\n \"assignToSelf\": true,\n \"credentialId\": \"{{credentialId}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar grupos de tarefas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/task-groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "task-groups" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:read`.\n\nPermissão: tasks:read" }, "response": [] }, { "name": "Criar ou executar grupos de tarefas", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/task-groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "task-groups" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.\n\nPermissão: tasks:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"projectId\": \"string\",\n \"order\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar grupos de tarefas", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/task-groups/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "task-groups", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.\n\nPermissão: tasks:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"projectId\": \"string\",\n \"order\": 0,\n \"channelAccountId\": \"string\",\n \"credentialId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir grupos de tarefas", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/task-groups/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "task-groups", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.\n\nPermissão: tasks:write" }, "response": [] }, { "name": "Listar etiquetas de tarefas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/task-labels", "host": [ "{{baseUrl}}" ], "path": [ "api", "task-labels" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:read`.\n\nPermissão: tasks:read" }, "response": [] }, { "name": "Criar ou executar etiquetas de tarefas", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/task-labels", "host": [ "{{baseUrl}}" ], "path": [ "api", "task-labels" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.\n\nPermissão: tasks:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\",\n \"color\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar etiquetas de tarefas", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/task-labels/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "task-labels", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.\n\nPermissão: tasks:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\",\n \"color\": \"string\",\n \"channelAccountId\": \"string\",\n \"credentialId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir etiquetas de tarefas", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/task-labels/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "task-labels", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.\n\nPermissão: tasks:write" }, "response": [] }, { "name": "Listar projetos de tarefas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/task-projects", "host": [ "{{baseUrl}}" ], "path": [ "api", "task-projects" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:read`.\n\nPermissão: tasks:read" }, "response": [] }, { "name": "Criar ou executar projetos de tarefas", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/task-projects", "host": [ "{{baseUrl}}" ], "path": [ "api", "task-projects" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.\n\nPermissão: tasks:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\",\n \"color\": \"string\",\n \"order\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar projetos de tarefas", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/task-projects/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "task-projects", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.\n\nPermissão: tasks:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\",\n \"color\": \"string\",\n \"order\": 0,\n \"channelAccountId\": \"string\",\n \"credentialId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir projetos de tarefas", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/task-projects/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "task-projects", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.\n\nPermissão: tasks:write" }, "response": [] }, { "name": "Listar task schedules", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/task-schedules?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}&status={{status}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "task-schedules" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:read`.\n\nPermissão: tasks:read" }, "response": [] }, { "name": "Criar ou executar task schedules", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/task-schedules", "host": [ "{{baseUrl}}" ], "path": [ "api", "task-schedules" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.\n\nPermissão: tasks:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\",\n \"totalWeeks\": \"4\",\n \"repeatCycle\": false,\n \"cycleDurationMonths\": 0,\n \"startDate\": \"string\",\n \"projectId\": \"string\",\n \"assignedToId\": \"string\",\n \"assignedTeamId\": \"string\",\n \"channelAccountId\": \"string\",\n \"credentialId\": \"string\",\n \"contactId\": \"string\",\n \"contactIds\": [\n \"string\"\n ],\n \"metadata\": {},\n \"entries\": [\n {\n \"weekNumber\": 0,\n \"dayOfWeek\": 0,\n \"timeOfDay\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"priority\": \"LOW\",\n \"labels\": [\n \"string\"\n ],\n \"groupId\": \"string\",\n \"estimatedMinutes\": 0\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar task schedules", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/task-schedules/{{id}}?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "task-schedules", "{{id}}" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:read`.\n\nPermissão: tasks:read" }, "response": [] }, { "name": "Atualizar task schedules", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/task-schedules/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "task-schedules", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.\n\nPermissão: tasks:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\",\n \"totalWeeks\": 0,\n \"repeatCycle\": false,\n \"cycleDurationMonths\": 0,\n \"startDate\": \"string\",\n \"status\": \"ACTIVE\",\n \"projectId\": \"string\",\n \"contactId\": \"string\",\n \"contactIds\": [\n \"string\"\n ],\n \"assignedToId\": \"string\",\n \"assignedTeamId\": \"string\",\n \"metadata\": {},\n \"entries\": [\n {\n \"id\": \"string\",\n \"weekNumber\": 0,\n \"dayOfWeek\": 0,\n \"timeOfDay\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"priority\": \"LOW\",\n \"labels\": [\n \"string\"\n ],\n \"groupId\": \"string\",\n \"estimatedMinutes\": 0\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir task schedules", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/task-schedules/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "task-schedules", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.\n\nPermissão: tasks:write", "body": { "mode": "raw", "raw": "{\n \"generatedTasksAction\": \"keep\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar tasks", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/tasks?credentialId={{credentialId}}&limit={{limit}}&page={{page}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "tasks" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "Conta compatível usada para resolver o escopo", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "page", "value": "{{page}}", "description": "Página da listagem, iniciando em 1.", "disabled": true } ] }, "description": "Lista tarefas com filtros por contato, projeto, grupo, status e texto.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:read`.\n\nPermissão: tasks:read" }, "response": [] }, { "name": "Criar ou executar tasks", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/tasks", "host": [ "{{baseUrl}}" ], "path": [ "api", "tasks" ] }, "description": "Cria uma tarefa no escopo da conta selecionada. Se não houver `contactId`, informe uma forma de atribuição, como `assignToSelf`.\n\nExemplo de criação com evento no Google Calendar. Exige conector ativo e calendário configurado.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.\n\nPermissão: tasks:write", "body": { "mode": "raw", "raw": "{\n \"title\": \"Tarefa criada via API\",\n \"description\": \"Acompanhar cliente e registrar retorno.\",\n \"credentialId\": \"{{credentialId}}\",\n \"projectId\": \"{{projectId}}\",\n \"groupId\": \"{{groupId}}\",\n \"labels\": [],\n \"status\": \"TODO\",\n \"priority\": \"HIGH\",\n \"dueDate\": \"2026-01-20T15:00:00.000Z\",\n \"assignToSelf\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar tasks", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/tasks/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "tasks", "{{id}}" ] }, "description": "Busca uma tarefa específica.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:read`.\n\nPermissão: tasks:read" }, "response": [] }, { "name": "Atualizar tasks", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/tasks/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "tasks", "{{id}}" ] }, "description": "Atualiza os principais campos da tarefa. A rota também pode sincronizar o evento de calendário quando necessário.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.\n\nPermissão: tasks:write", "body": { "mode": "raw", "raw": "{\n \"title\": \"Tarefa atualizada via API\",\n \"description\": \"Cliente respondeu, seguir para próxima etapa.\",\n \"status\": \"IN_PROGRESS\",\n \"priority\": \"URGENT\",\n \"assignedToId\": null,\n \"assignedTeamId\": null\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir tasks", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/tasks/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "tasks", "{{id}}" ] }, "description": "Exclui a tarefa informada e retorna `{ success: true }`.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.\n\nPermissão: tasks:write" }, "response": [] }, { "name": "Listar metadata", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/tasks/metadata?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "tasks", "metadata" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Retorna projetos, etiquetas, grupos e a capacidade de atribuir a outras pessoas no escopo atual.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:read`.\n\nPermissão: tasks:read" }, "response": [] } ] }, { "name": "Tarefas autônomas", "item": [ { "name": "Listar tarefas autônomas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks?lifecycle={{lifecycle}}&limit={{limit}}&offset={{offset}}&q={{q}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks" ], "query": [ { "key": "lifecycle", "value": "{{lifecycle}}", "description": "Valor opcional de lifecycle.", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "offset", "value": "{{offset}}", "description": "Valor opcional de offset.", "disabled": true }, { "key": "q", "value": "{{q}}", "description": "Texto usado na busca.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:read`.\n\nPermissão: autonomousTasks:read" }, "response": [] }, { "name": "Criar ou executar tarefas autônomas", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:write`.\n\nPermissão: autonomousTasks:write", "body": { "mode": "raw", "raw": "{\n \"prompt\": \"string\",\n \"name\": \"string\",\n \"scheduleType\": \"MANUAL\",\n \"scheduleConfig\": {\n \"timeOfDay\": \"string\",\n \"dayOfWeek\": 0,\n \"dayOfMonth\": 0\n },\n \"startAt\": \"string\",\n \"executionPolicy\": \"REQUIRE_APPROVAL\",\n \"credentialId\": \"string\",\n \"channelAccountId\": \"string\",\n \"operationalMode\": \"report\",\n \"connectorSlugs\": [\n \"string\"\n ],\n \"mcpServerIds\": [\n \"string\"\n ],\n \"templateName\": \"string\",\n \"templateLanguage\": \"string\",\n \"templateSelection\": {},\n \"templateVariableMappings\": {},\n \"mission\": {\n \"objective\": \"string\",\n \"specialist\": \"AUTO\",\n \"successCriteria\": [\n \"string\"\n ],\n \"autonomyScope\": {\n \"customerContact\": false,\n \"crmWrites\": false,\n \"taskWrites\": false,\n \"teamNotifications\": false,\n \"externalTools\": false,\n \"internalPlatformActions\": false\n },\n \"guardrails\": {\n \"maxEntities\": \"100\",\n \"maxWriteActions\": \"100\",\n \"maxExternalCalls\": \"25\",\n \"maxStepCount\": \"12\"\n }\n },\n \"previewHash\": \"string\",\n \"previewToken\": \"string\",\n \"maxRunsPerDay\": \"24\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar tarefas autônomas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:read`.\n\nPermissão: autonomousTasks:read" }, "response": [] }, { "name": "Atualizar tarefas autônomas", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:write`.\n\nPermissão: autonomousTasks:write", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIVE\",\n \"name\": \"string\",\n \"executionPolicy\": \"REQUIRE_APPROVAL\",\n \"scheduleType\": \"MANUAL\",\n \"scheduleConfig\": {\n \"timeOfDay\": \"string\",\n \"dayOfWeek\": 0,\n \"dayOfMonth\": 0\n },\n \"startAt\": \"string\",\n \"maxRunsPerDay\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir tarefas autônomas", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "{{id}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:write`.\n\nPermissão: autonomousTasks:write" }, "response": [] }, { "name": "Replanejar tarefas autônomas", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/{{id}}/replan", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "{{id}}", "replan" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:write`.\n\nPermissão: autonomousTasks:write" }, "response": [] }, { "name": "Listar runs", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/{{id}}/runs", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "{{id}}", "runs" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:read`.\n\nPermissão: autonomousTasks:read" }, "response": [] }, { "name": "Criar ou executar runs", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/{{id}}/runs", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "{{id}}", "runs" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:write`.\n\nPermissão: autonomousTasks:write" }, "response": [] }, { "name": "Listar ai config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/ai-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "ai-config" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:read`.\n\nPermissão: autonomousTasks:read" }, "response": [] }, { "name": "Atualizar ai config", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/ai-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "ai-config" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:write`.\n\nPermissão: autonomousTasks:write", "body": { "mode": "raw", "raw": "{\n \"providerKeyId\": \"string\",\n \"model\": \"string\",\n \"thinkingLevel\": \"minimal\",\n \"crossProviderFallbackEnabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar capabilities", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/capabilities?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "capabilities" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:read`.\n\nPermissão: autonomousTasks:read" }, "response": [] }, { "name": "Listar base de conhecimento", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/knowledge", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "knowledge" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:read`.\n\nPermissão: autonomousTasks:read" }, "response": [] }, { "name": "Atualizar base de conhecimento", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/knowledge", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "knowledge" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:write`.\n\nPermissão: autonomousTasks:write", "body": { "mode": "raw", "raw": "{\n \"enabled\": false,\n \"companyContext\": {},\n \"customInstructions\": {},\n \"communicationTone\": {},\n \"policies\": {},\n \"businessHours\": {},\n \"galleryItemIds\": [\n \"string\"\n ],\n \"galleryFolderIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar catálogo", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/knowledge/catalog", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "knowledge", "catalog" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:read`.\n\nPermissão: autonomousTasks:read" }, "response": [] }, { "name": "Listar opções MCP", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/mcp-options", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "mcp-options" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:read`.\n\nPermissão: autonomousTasks:read" }, "response": [] }, { "name": "Listar overview", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/overview?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "overview" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:read`.\n\nPermissão: autonomousTasks:read" }, "response": [] }, { "name": "Visualizar prévia de tarefas autônomas", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/preview", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "preview" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:write`.\n\nPermissão: autonomousTasks:write", "body": { "mode": "raw", "raw": "{\n \"prompt\": \"string\",\n \"name\": \"string\",\n \"scheduleType\": \"MANUAL\",\n \"scheduleConfig\": {\n \"timeOfDay\": \"string\",\n \"dayOfWeek\": 0,\n \"dayOfMonth\": 0\n },\n \"startAt\": \"string\",\n \"executionPolicy\": \"REQUIRE_APPROVAL\",\n \"credentialId\": \"string\",\n \"channelAccountId\": \"string\",\n \"operationalMode\": \"report\",\n \"connectorSlugs\": [\n \"string\"\n ],\n \"mcpServerIds\": [\n \"string\"\n ],\n \"templateName\": \"string\",\n \"templateLanguage\": \"string\",\n \"templateSelection\": {},\n \"templateVariableMappings\": {},\n \"mission\": {\n \"objective\": \"string\",\n \"specialist\": \"AUTO\",\n \"successCriteria\": [\n \"string\"\n ],\n \"autonomyScope\": {\n \"customerContact\": false,\n \"crmWrites\": false,\n \"taskWrites\": false,\n \"teamNotifications\": false,\n \"externalTools\": false,\n \"internalPlatformActions\": false\n },\n \"guardrails\": {\n \"maxEntities\": \"100\",\n \"maxWriteActions\": \"100\",\n \"maxExternalCalls\": \"25\",\n \"maxStepCount\": \"12\"\n }\n },\n \"previewHash\": \"string\",\n \"previewToken\": \"string\",\n \"maxRunsPerDay\": \"24\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar runs", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/runs/{{runId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "runs", "{{runId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:read`.\n\nPermissão: autonomousTasks:read" }, "response": [] }, { "name": "Aprovar runs", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/runs/{{runId}}/approve", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "runs", "{{runId}}", "approve" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:write`.\n\nPermissão: autonomousTasks:write" }, "response": [] }, { "name": "Cancelar runs", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/runs/{{runId}}/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "runs", "{{runId}}", "cancel" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:write`.\n\nPermissão: autonomousTasks:write", "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Rejeitar runs", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/runs/{{runId}}/reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "runs", "{{runId}}", "reject" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:write`.\n\nPermissão: autonomousTasks:write", "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Tentar novamente runs", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/runs/{{runId}}/retry", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "runs", "{{runId}}", "retry" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:write`.\n\nPermissão: autonomousTasks:write" }, "response": [] }, { "name": "Listar templates", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/autonomous-tasks/templates?channelAccountId={{channelAccountId}}&credentialId={{credentialId}}&limit={{limit}}&q={{q}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "autonomous-tasks", "templates" ], "query": [ { "key": "channelAccountId", "value": "{{channelAccountId}}", "description": "Valor opcional de channel account.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "limit", "value": "{{limit}}", "description": "Limite máximo de itens retornados.", "disabled": true }, { "key": "q", "value": "{{q}}", "description": "Texto usado na busca.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `autonomousTasks:read`.\n\nPermissão: autonomousTasks:read" }, "response": [] } ] }, { "name": "Templates", "item": [ { "name": "Listar templates", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates?after={{after}}&credentialId={{credentialId}}&force={{force}}&fullSync={{fullSync}}&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates" ], "query": [ { "key": "after", "value": "{{after}}", "description": "Valor opcional de after.", "disabled": true }, { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "force", "value": "{{force}}", "description": "Valor opcional de force.", "disabled": true }, { "key": "fullSync", "value": "{{fullSync}}", "description": "Valor opcional de full sync.", "disabled": true }, { "key": "limit", "value": "100", "description": "Limite máximo de itens retornados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.\n\nPermissão: templates:read" }, "response": [] }, { "name": "Criar ou executar templates", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"name\": \"string\",\n \"category\": \"MARKETING\",\n \"templateType\": \"STANDARD\",\n \"language\": \"string\",\n \"components\": [\n {}\n ],\n \"allowCategoryChange\": false,\n \"linkedFlowId\": \"string\",\n \"flowButtonText\": \"string\",\n \"flowNavigateScreen\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar templates", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/{{id}}?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "{{id}}" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write", "body": { "mode": "raw", "raw": "{\n \"groupId\": \"string\",\n \"subGroupId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir templates", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/{{id}}?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "{{id}}" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write" }, "response": [] }, { "name": "Limpar templates", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/cleanup-unused", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "cleanup-unused" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.\n\nPermissão: templates:read" }, "response": [] }, { "name": "Limpar templates", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/cleanup-unused", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "cleanup-unused" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write", "body": { "mode": "raw", "raw": "{\n \"inactiveDays\": {},\n \"credentialId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar drafts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/drafts?limit=12", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "drafts" ], "query": [ { "key": "limit", "value": "12", "description": "Limite máximo de itens retornados.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.\n\nPermissão: templates:read" }, "response": [] }, { "name": "Criar ou executar drafts", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/drafts", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "drafts" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write", "body": { "mode": "raw", "raw": "{\n \"payload\": {},\n \"credentialId\": \"string\",\n \"conversationId\": \"string\",\n \"source\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir drafts", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/drafts", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "drafts" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write", "body": { "mode": "raw", "raw": "{\n \"source\": \"string\",\n \"credentialId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar drafts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/drafts/{{draftId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "drafts", "{{draftId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.\n\nPermissão: templates:read" }, "response": [] }, { "name": "Atualizar drafts", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/drafts/{{draftId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "drafts", "{{draftId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write", "body": { "mode": "raw", "raw": "{\n \"payload\": {},\n \"credentialId\": \"string\",\n \"conversationId\": \"string\",\n \"source\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir drafts", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/drafts/{{draftId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "drafts", "{{draftId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write" }, "response": [] }, { "name": "Listar favorites", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/favorites", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "favorites" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.\n\nPermissão: templates:read" }, "response": [] }, { "name": "Criar ou executar favorites", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/favorites", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "favorites" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.\n\nPermissão: templates:read", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir favorites", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/favorites", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "favorites" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.\n\nPermissão: templates:read", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Criar ou executar generate", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/generate", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "generate" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\",\n \"prompt\": \"string\",\n \"presetId\": \"string\",\n \"category\": \"UTILITY\",\n \"language\": \"string\",\n \"consultConversation\": false,\n \"conversationId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar groups", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "groups" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.\n\nPermissão: templates:read" }, "response": [] }, { "name": "Criar ou executar groups", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "groups" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\",\n \"order\": 0,\n \"isActive\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar groups", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/groups/{{groupId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "groups", "{{groupId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\",\n \"order\": 0,\n \"isActive\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir groups", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/groups/{{groupId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "groups", "{{groupId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write" }, "response": [] }, { "name": "Listar link flow", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/link-flow?credentialId={{credentialId}}&flowId={{flowId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "link-flow" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "flowId", "value": "{{flowId}}", "description": "Valor opcional de flow.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.\n\nPermissão: templates:read" }, "response": [] }, { "name": "Criar ou executar link flow", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/link-flow", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "link-flow" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"string\",\n \"flowId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar list", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/list?credentialId={{credentialId}}&favorites={{favorites}}&groupId={{groupId}}&status={{status}}&subGroupId={{subGroupId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "list" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true }, { "key": "favorites", "value": "{{favorites}}", "description": "Valor opcional de favorites.", "disabled": true }, { "key": "groupId", "value": "{{groupId}}", "description": "Valor opcional de group.", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Status usado para filtrar os resultados.", "disabled": true }, { "key": "subGroupId", "value": "{{subGroupId}}", "description": "Valor opcional de sub group.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.\n\nPermissão: templates:read" }, "response": [] }, { "name": "Criar ou executar media handle", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/media-handle", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "media-handle" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write" }, "response": [] }, { "name": "Listar organization plan", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/organization-plan?credentialId={{credentialId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "organization-plan" ], "query": [ { "key": "credentialId", "value": "{{credentialId}}", "description": "ID da conta conectada no escopo da chave.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write" }, "response": [] }, { "name": "Criar ou executar organization plan", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/organization-plan", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "organization-plan" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write", "body": { "mode": "raw", "raw": "{\n \"credentialId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar organization plan", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/organization-plan/{{planId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "organization-plan", "{{planId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write", "body": { "mode": "raw", "raw": "{\n \"action\": \"approve\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Listar subgroups", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/subgroups?groupId={{groupId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "subgroups" ], "query": [ { "key": "groupId", "value": "{{groupId}}", "description": "Valor opcional de group.", "disabled": true } ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.\n\nPermissão: templates:read" }, "response": [] }, { "name": "Criar ou executar subgroups", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/subgroups", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "subgroups" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write", "body": { "mode": "raw", "raw": "{\n \"groupId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"order\": 0,\n \"isActive\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Atualizar subgroups", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/subgroups/{{subGroupId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "subgroups", "{{subGroupId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\",\n \"order\": 0,\n \"isActive\": false,\n \"groupId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Excluir subgroups", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/templates/subgroups/{{subGroupId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "templates", "subgroups", "{{subGroupId}}" ] }, "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.\n\nPermissão: templates:write" }, "response": [] } ] } ], "variable": [ { "key": "baseUrl", "value": "https://cloudwhats.app.br", "type": "string" }, { "key": "apiKey", "value": "wcp_sua_chave_aqui", "type": "string" }, { "key": "agentId", "value": "agentId_aqui", "type": "string" }, { "key": "sourceId", "value": "sourceId_aqui", "type": "string" }, { "key": "id", "value": "id_aqui", "type": "string" }, { "key": "executionId", "value": "executionId_aqui", "type": "string" }, { "key": "sessionId", "value": "sessionId_aqui", "type": "string" }, { "key": "revisionId", "value": "revisionId_aqui", "type": "string" }, { "key": "recipeId", "value": "recipeId_aqui", "type": "string" }, { "key": "runId", "value": "runId_aqui", "type": "string" }, { "key": "bookingId", "value": "bookingId_aqui", "type": "string" }, { "key": "purchaseId", "value": "purchaseId_aqui", "type": "string" }, { "key": "channelAccountId", "value": "channelAccountId_aqui", "type": "string" }, { "key": "jobId", "value": "jobId_aqui", "type": "string" }, { "key": "productSetId", "value": "productSetId_aqui", "type": "string" }, { "key": "productItemId", "value": "productItemId_aqui", "type": "string" }, { "key": "domainId", "value": "domainId_aqui", "type": "string" }, { "key": "templateId", "value": "templateId_aqui", "type": "string" }, { "key": "flowId", "value": "flowId_aqui", "type": "string" }, { "key": "fieldId", "value": "fieldId_aqui", "type": "string" }, { "key": "conversationId", "value": "conversationId_aqui", "type": "string" }, { "key": "providerEmailId", "value": "providerEmailId_aqui", "type": "string" }, { "key": "attachmentId", "value": "attachmentId_aqui", "type": "string" }, { "key": "scopeId", "value": "scopeId_aqui", "type": "string" }, { "key": "messageId", "value": "messageId_aqui", "type": "string" }, { "key": "endpointId", "value": "endpointId_aqui", "type": "string" }, { "key": "itemId", "value": "itemId_aqui", "type": "string" }, { "key": "channelId", "value": "channelId_aqui", "type": "string" }, { "key": "journeyId", "value": "journeyId_aqui", "type": "string" }, { "key": "enrollmentId", "value": "enrollmentId_aqui", "type": "string" }, { "key": "orderId", "value": "orderId_aqui", "type": "string" }, { "key": "organizationId", "value": "organizationId_aqui", "type": "string" }, { "key": "replyId", "value": "replyId_aqui", "type": "string" }, { "key": "reminderId", "value": "reminderId_aqui", "type": "string" }, { "key": "type", "value": "type_aqui", "type": "string" }, { "key": "alertId", "value": "alertId_aqui", "type": "string" }, { "key": "patternId", "value": "patternId_aqui", "type": "string" }, { "key": "recommendationId", "value": "recommendationId_aqui", "type": "string" }, { "key": "tagId", "value": "tagId_aqui", "type": "string" }, { "key": "userId", "value": "userId_aqui", "type": "string" }, { "key": "teamId", "value": "teamId_aqui", "type": "string" }, { "key": "draftId", "value": "draftId_aqui", "type": "string" }, { "key": "groupId", "value": "groupId_aqui", "type": "string" }, { "key": "planId", "value": "planId_aqui", "type": "string" }, { "key": "subGroupId", "value": "subGroupId_aqui", "type": "string" } ] }