A API de Parceiros do Bradial Chat permite que empresas e desenvolvedores integrem seus sistemas diretamente ao nosso ecossistema de comunicação. Com essa API, você pode automatizar interações, gerenciar conversas e enviar mensagens em tempo real, melhorarando a experiência do seu atendimento.
\n🔗 Entre em contato com um dos nossos consultores para mais informações e acesso à API!
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"36820202","collectionId":"407e47e9-45bb-4378-b922-5fc446cff428","publishedId":"2sAYk8uNVx","public":true,"customColor":{"top-bar":"3087E9","right-sidebar":"303030","highlight":"3087E9"},"publishDate":"2026-04-15T14:50:08.000Z"},"item":[{"name":"Chat","item":[{"name":"Campanhas","item":[{"name":"Contatos","item":[{"name":"Listar contatos","id":"3b9d64c7-1725-83ed-7f3e-12f3bf796cd2","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.bradial.com.br/chat/v1/campaigns/:campaignId/contacts","description":"Lista os contatos de uma campanha, com status de envio, entrega e respostas, uma página por vez (cursor).
Filtros. deliveryFilter · repliedButton (quem tocou no botão) · reply=free (quem respondeu citando a mensagem, sem tocar em botão). repliedButton e reply não podem ir juntos.
Status do contato. 0 agendado · 1 em andamento · 2 enviado · 3 erro · 4 bloqueado pelo limite de envio.
Entrega. 1 entregue · 2 lida · 3 falhou.
Opcional: delivered (entregues), not_delivered (não entregues), read (lidas), scheduled (aguardando) ou blocked (bloqueados pelo limite de envio).
\n","type":"text/plain"},"key":"deliveryFilter","value":"read"},{"disabled":true,"description":{"content":"Opcional: quem tocou neste botão de resposta rápida (texto exato do botão, até 64 caracteres). Não combina com reply.
\n","type":"text/plain"},"key":"repliedButton","value":"Confirmar"},{"disabled":true,"description":{"content":"Opcional: free traz quem respondeu citando a mensagem da campanha sem tocar em um botão (Outros). Não combina com repliedButton.
\n","type":"text/plain"},"key":"reply","value":"free"},{"disabled":true,"description":{"content":"Opcional. O nextCursor da página anterior.
\n","type":"text/plain"},"key":"cursor","value":""}],"variable":[{"type":"any","key":"campaignId"}]}},"response":[{"id":"110aef43-dc21-2d02-740d-d36fcbe42abf","name":"200 — todos os contatos","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"GET","header":[],"url":"https://api.bradial.com.br/chat/v1/campaigns/01M6JYAYCZ0K8T2B6WQH3RNE4D/contacts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"name\": \"Mariana Albuquerque\",\n \"phone\": \"+5511987650001\",\n \"isGroup\": false,\n \"status\": 2,\n \"deliveryStatus\": 2,\n \"repliedButtons\": [\"Quero o cupom\"],\n \"firstRepliedAt\": \"2026-11-27T12:07:44.210Z\",\n \"freeRepliedAt\": null,\n \"error\": null,\n \"sentAt\": \"2026-11-27T12:00:18.532Z\",\n \"variables\": null\n },\n {\n \"name\": \"João Pedro Ramos\",\n \"phone\": \"+5531991230002\",\n \"isGroup\": false,\n \"status\": 2,\n \"deliveryStatus\": 2,\n \"repliedButtons\": [],\n \"firstRepliedAt\": \"2026-11-27T12:22:05.917Z\",\n \"freeRepliedAt\": \"2026-11-27T12:22:05.917Z\",\n \"error\": null,\n \"sentAt\": \"2026-11-27T12:00:18.740Z\",\n \"variables\": null\n },\n {\n \"name\": \"Ana Beatriz Lima\",\n \"phone\": \"+5521998760003\",\n \"isGroup\": false,\n \"status\": 3,\n \"deliveryStatus\": 3,\n \"repliedButtons\": [],\n \"firstRepliedAt\": null,\n \"freeRepliedAt\": null,\n \"error\": \"131049\",\n \"sentAt\": \"2026-11-27T12:00:19.104Z\",\n \"variables\": null\n }\n ],\n \"items\": 3,\n \"nextCursor\": \"eyJjYW1wYWlnbl9pZCI6IjAxTTZKWUFZQ1owSzhUMkI2V1FIM1JORTREIiwicGhvbmUiOiIrNTUyMTk5ODc2MDAwMyJ9\"\n}"},{"id":"de5bedb7-ca4e-856f-0223-5262c27b6ffc","name":"200 — quem tocou em um botão","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.bradial.com.br/chat/v1/campaigns/01M6JYAYCZ0K8T2B6WQH3RNE4D/contacts?repliedButton=Quero o cupom","host":["https://api.bradial.com.br"],"path":["chat","v1","campaigns","01M6JYAYCZ0K8T2B6WQH3RNE4D","contacts"],"query":[{"key":"repliedButton","value":"Quero o cupom"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"name\": \"Mariana Albuquerque\",\n \"phone\": \"+5511987650001\",\n \"isGroup\": false,\n \"status\": 2,\n \"deliveryStatus\": 2,\n \"repliedButtons\": [\"Quero o cupom\"],\n \"firstRepliedAt\": \"2026-11-27T12:07:44.210Z\",\n \"freeRepliedAt\": null,\n \"error\": null,\n \"sentAt\": \"2026-11-27T12:00:18.532Z\",\n \"variables\": null\n }\n ],\n \"items\": 1,\n \"nextCursor\": null\n}"},{"id":"ee1ffb49-29cc-1f5d-4b80-61eeae062359","name":"200 — quem respondeu citando a mensagem","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.bradial.com.br/chat/v1/campaigns/01M6JYAYCZ0K8T2B6WQH3RNE4D/contacts?reply=free","host":["https://api.bradial.com.br"],"path":["chat","v1","campaigns","01M6JYAYCZ0K8T2B6WQH3RNE4D","contacts"],"query":[{"key":"reply","value":"free"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"name\": \"João Pedro Ramos\",\n \"phone\": \"+5531991230002\",\n \"isGroup\": false,\n \"status\": 2,\n \"deliveryStatus\": 2,\n \"repliedButtons\": [],\n \"firstRepliedAt\": \"2026-11-27T12:22:05.917Z\",\n \"freeRepliedAt\": \"2026-11-27T12:22:05.917Z\",\n \"error\": null,\n \"sentAt\": \"2026-11-27T12:00:18.740Z\",\n \"variables\": null\n }\n ],\n \"items\": 1,\n \"nextCursor\": null\n}"},{"id":"413911ce-0775-087b-9c20-0df50e9dddeb","name":"400 — dois filtros de resposta juntos","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.bradial.com.br/chat/v1/campaigns/01M6JYAYCZ0K8T2B6WQH3RNE4D/contacts?repliedButton=Quero o cupom&reply=free","host":["https://api.bradial.com.br"],"path":["chat","v1","campaigns","01M6JYAYCZ0K8T2B6WQH3RNE4D","contacts"],"query":[{"key":"repliedButton","value":"Quero o cupom"},{"key":"reply","value":"free"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"This audience batch is not valid.\",\n \"statusCode\": 400,\n \"error\": {\n \"code\": \"CAMP006\",\n \"message\": \"This audience batch is not valid.\",\n \"reason\": \"When a batch has more than 100 rows or contact ids, no row with a valid phone, a contact id outside the account or with no number to send to, a label outside the account, or an API key sends the labels shape. A label audience, its preview or the contact picker naming a label id the account does not have answers it too, and so does a contact list filtered by reply=free and by a replied button at once.\"\n }\n}"}],"_postman_id":"3b9d64c7-1725-83ed-7f3e-12f3bf796cd2"},{"name":"Estatísticas","id":"8f65bfaa-5b65-e050-e86b-aef84d39fc9c","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.bradial.com.br/chat/v1/campaigns/:campaignId/contacts/stats","description":"Relatório da campanha: totais por status e por entrega, envios por hora (UTC), respostas por botão (byButton) e respostas que citam a mensagem sem tocar em botão (freeReplied).
replied soma as duas formas de resposta. limit é o limite de contatos da conta para a campanha; null significa sem limite ou indisponível no momento.
Adiciona contatos da conta a uma campanha agendada criada com \"source\": \"manual\". Até 100 ids por chamada; para mais, envie em lotes. Repetir um contato não o duplica.
Limite. 600 requisições por minuto.
\n","urlObject":{"path":["chat","v1","campaigns",":campaignId","contacts"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"campaignId"}]}},"response":[{"id":"8bdbd10e-f939-fa26-cc7d-d87a71efc1f9","name":"200 — contatos adicionados","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contactIds\": [5501, 5502, 5503]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/campaigns/01M6GW1K49ANYD084C3Z1H239Y/contacts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"sent\": 3,\n \"nextAfter\": null\n }\n}"},{"id":"80a10eb7-5c31-2d3a-7ec5-140c0f0542bc","name":"400 — contato de outra conta","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contactIds\": [5501, 990001]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/campaigns/01M6GW1K49ANYD084C3Z1H239Y/contacts"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"This audience batch is not valid.\",\n \"statusCode\": 400,\n \"error\": {\n \"code\": \"CAMP006\",\n \"message\": \"This audience batch is not valid.\",\n \"reason\": \"When a batch has more than 100 rows or contact ids, no row with a valid phone, a contact id outside the account or with no number to send to, a label outside the account, or an API key sends the labels shape. A label audience, its preview or the contact picker naming a label id the account does not have answers it too, and so does a contact list filtered by reply=free and by a replied button at once.\"\n }\n}"},{"id":"9b05e731-48c1-925e-5f51-f2445c0e48e9","name":"400 — campanha de planilha","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contactIds\": [5501, 5502]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/campaigns/01M6PE1JF235X04Y5G8NN3T8SP/contacts"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The audience does not match how this campaign was created.\",\n \"statusCode\": 400,\n \"error\": {\n \"code\": \"CAMP012\",\n \"message\": \"The audience does not match how this campaign was created.\",\n \"reason\": \"When labels or contact ids are sent to a campaign created from a spreadsheet, rows to one created from labels, or more than one shape in one request. A spreadsheet campaign takes no contact from another source.\"\n }\n}"}],"_postman_id":"a1aca0e6-adcb-5995-e77e-7d9225f643f5"},{"name":"Adicionar contatos (planilha)","id":"e2bc3796-e12d-1fd6-56b5-11affa921e07","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"rows\": [\n { \"phone\": \"+5511987654321\", \"name\": \"Maria Souza\", \"columns\": { \"cidade\": \"São Paulo\", \"valor\": \"R$ 120,00\" } },\n { \"phone\": \"+5521998765432\", \"columns\": { \"cidade\": \"Rio\" } }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/campaigns/:campaignId/contacts","description":"Adiciona linhas a uma campanha agendada criada com \"source\": \"import\", mesmo que os números ainda não sejam contatos da conta. Até 100 linhas por chamada.
phone vai com o código do país. columns (até 20) alimentam as variáveis {{import.<coluna>}}. Números repetidos são descartados, e reenviar um lote não duplica contatos.
Remove um contato de uma campanha agendada. :phone é o telefone como aparece em Listar contatos, codificado para URL (+ vira %2B).
Lista as recorrências da conta, ou seja, as campanhas criadas com recurrence.
Status. active (tem envios pela frente) · finished (todas as ocorrências saíram) · ended (encerrada antes do fim).
Retorna uma recorrência com todas as ocorrências. Cada ocorrência é uma campanha comum, que pode ser lida em Obter campanha.
\nO id da recorrência vem em recurrenceId em cada campanha dela.
Encerra uma recorrência: as ocorrências que ainda não saíram são canceladas, e as já enviadas continuam no histórico. Sem corpo.
\n","urlObject":{"path":["chat","v1","campaigns","recurrences",":recurrenceId","cancelled"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"recurrenceId"}]}},"response":[{"id":"c38d8960-21a1-939a-68d1-7bbce78ce1da","name":"204 — recorrência encerrada","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"POST","header":[],"url":"https://api.bradial.com.br/chat/v1/campaigns/recurrences/01M6HC4R6Y5B1M8Q2J7D3P9XKE/cancelled"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"04e46475-6788-8569-bf30-ae2570cab9e6","name":"400 — recorrência já encerrada","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"POST","header":[],"url":"https://api.bradial.com.br/chat/v1/campaigns/recurrences/01M6RAYJX4V5EM4HVA8J38BQR5/cancelled"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"This action is not allowed for the campaign in its current state.\",\n \"statusCode\": 400,\n \"error\": {\n \"code\": \"CAMP003\",\n \"message\": \"This action is not allowed for the campaign in its current state.\",\n \"reason\": \"When campaign-api answered 422 on start, cancel or undoing a skip, or 409 on delete or on ending a series that already ended: a series occurrence cannot be deleted, a campaign that left SCHEDULED cannot be started or deleted, and only a skipped occurrence dated in the future, of a series not ended, can be restored. The BFF also answers it on its own, before any write, when the read behind a cancel finds a campaign that is not IN_PROGRESS and is not, for a user, a scheduled series occurrence: a standalone scheduled campaign, which can only be deleted, or any scheduled campaign for an API key, which has no route to undo a skip.\",\n \"metadata\": { \"status\": 409 }\n }\n}"}],"_postman_id":"c7fc2481-9e40-9cfe-76da-c65f8e6991ea"}],"id":"b3a83e16-492d-4df4-9024-bdf1269634c2","_postman_id":"b3a83e16-492d-4df4-9024-bdf1269634c2","description":""},{"name":"Listar campanhas","id":"fedeb7d6-b5e2-b28d-40e6-2b670757f912","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":"your_api-key"}],"url":"https://api.bradial.com.br/chat/v1/campaigns","description":"Lista as campanhas da conta, da mais recente para a mais antiga, uma página por vez. Para a próxima página, envie o nextCursor da resposta em cursor; null indica a última.
Status. 0 agendada · 1 em andamento · 2 concluída · 3 cancelada.
Limite. 120 requisições por minuto.
\n","urlObject":{"path":["chat","v1","campaigns"],"host":["https://api.bradial.com.br"],"query":[{"disabled":true,"description":{"content":"Opcional. Status separados por vírgula: 0 agendada, 1 em andamento, 2 concluída, 3 cancelada. Sem o parâmetro, traz todas.
\n","type":"text/plain"},"key":"status","value":"0,1"},{"disabled":true,"description":{"content":"Opcional. O nextCursor da página anterior.
\n","type":"text/plain"},"key":"cursor","value":""}],"variable":[]}},"response":[{"id":"9ac404c0-645a-273e-57ad-f2c259dd550a","name":"200 — primeira página","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"GET","header":[],"url":"https://api.bradial.com.br/chat/v1/campaigns"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"01M6GW1K49ANYD084C3Z1H239Y\",\n \"name\": \"Tabela de preços novembro\",\n \"status\": 0,\n \"channel\": \"Bradial\",\n \"source\": \"manual\",\n \"inbox\": { \"id\": 12, \"name\": \"Comercial SP\", \"channelType\": \"Channel::Bradial\" },\n \"creator\": { \"apiKey\": true },\n \"bradial\": {\n \"message\": \"Olá {{contact.name}}! Segue a nossa tabela de preços de novembro.\",\n \"fileName\": \"tabela-precos-novembro.pdf\",\n \"fileUrl\": null\n },\n \"whatsapp\": null,\n \"autoCloseConversation\": false,\n \"recurrenceId\": null,\n \"scheduledAt\": \"2026-11-10T13:00:00.000Z\",\n \"createdAt\": \"2026-11-03T14:12:09.481Z\",\n \"updatedAt\": \"2026-11-03T14:12:09.481Z\"\n },\n {\n \"id\": \"01M6JYAYCYFV4WQT40AFXG3779\",\n \"name\": \"Confirmação de agenda\",\n \"status\": 2,\n \"channel\": \"Whatsapp\",\n \"source\": \"manual\",\n \"inbox\": { \"id\": 34, \"name\": \"WhatsApp Oficial Loja\", \"channelType\": \"Channel::Whatsapp\" },\n \"creator\": { \"id\": 87, \"name\": \"Mariana Costa\" },\n \"bradial\": null,\n \"whatsapp\": {\n \"templateName\": \"confirmacao_agenda\",\n \"parameters\": {\n \"header\": null,\n \"headerMedia\": null,\n \"body\": { \"1\": \"{{contact.name}}\", \"2\": \"11/11 às 14h\" },\n \"buttons\": [null, null]\n }\n },\n \"autoCloseConversation\": false,\n \"recurrenceId\": null,\n \"scheduledAt\": \"2026-11-10T12:00:00.000Z\",\n \"createdAt\": \"2026-11-04T09:30:41.950Z\",\n \"updatedAt\": \"2026-11-10T12:41:07.215Z\"\n }\n ],\n \"items\": 2,\n \"nextCursor\": \"eyJhY2NvdW50X2lkIjoxMiwiaWQiOiIwMU02SllBWUNZRlY0V1FUNDBBRlhHMzc3OSJ9\"\n}"},{"id":"63a8e19a-b442-b6a7-798a-0b1fb7fd545a","name":"200 — só em andamento, última página","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.bradial.com.br/chat/v1/campaigns?status=1","host":["https://api.bradial.com.br"],"path":["chat","v1","campaigns"],"query":[{"key":"status","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"01M6RAYJX3EC7D09784CVFWZC4\",\n \"name\": \"Aviso de entrega — pedidos atrasados\",\n \"status\": 1,\n \"channel\": \"Bradial\",\n \"source\": \"manual\",\n \"inbox\": { \"id\": 52, \"name\": \"Suporte Pós-venda\", \"channelType\": \"Channel::Bradial\" },\n \"creator\": { \"apiKey\": true },\n \"bradial\": {\n \"message\": \"Oi, {{contact.name}}! Seu pedido teve um atraso na transportadora e chega até sexta-feira.\",\n \"fileName\": null,\n \"fileUrl\": null\n },\n \"whatsapp\": null,\n \"autoCloseConversation\": true,\n \"recurrenceId\": null,\n \"scheduledAt\": \"2026-11-06T14:00:00.000Z\",\n \"createdAt\": \"2026-11-06T11:47:20.611Z\",\n \"updatedAt\": \"2026-11-06T14:00:03.882Z\"\n }\n ],\n \"items\": 1,\n \"nextCursor\": null\n}"},{"id":"98fa6ab7-6ea8-d77e-cafa-431dde302586","name":"400 — cursor inválido","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.bradial.com.br/chat/v1/campaigns?cursor=abc","host":["https://api.bradial.com.br"],"path":["chat","v1","campaigns"],"query":[{"key":"cursor","value":"abc"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The campaign list changed since this page was loaded.\",\n \"statusCode\": 400,\n \"error\": {\n \"code\": \"CAMP009\",\n \"message\": \"The campaign list changed since this page was loaded.\",\n \"reason\": \"When campaign-api answered 422 on a campaign or contact page: the cursor the client sent is malformed or no longer valid. Only the two cursor-paged reads name it, so a 422 on a write is never read as a stale page.\",\n \"metadata\": { \"status\": 422 }\n }\n}"}],"_postman_id":"fedeb7d6-b5e2-b28d-40e6-2b670757f912"},{"name":"Obter campanha","id":"4d2469dc-e037-c3ac-58c8-78c0b3fa94af","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.bradial.com.br/chat/v1/campaigns/:campaignId","description":"Retorna uma campanha. :campaignId (aba Params) é o id da campanha.
O anexo salvo vem pronto para abrir em bradial.fileUrl (WhatsApp - API Web) ou em whatsapp.parameters.headerMedia.url (WhatsApp - API Oficial).
Cria uma campanha agendada em uma caixa de WhatsApp - API Web. Depois de criar, adicione o público em Contatos › Adicionar contatos.
\ninboxId. O id da caixa de entrada vem de V2 › Inboxes › FindAll.
Limites. name até 255 caracteres · bradial.message até 1024 · scheduledAt no futuro · recorrência mensal só até o dia 28 (UTC).
Variáveis. {{contact.name}} e {{contact.phone}} na mensagem.
Anexo. bradial.file.key vem de Arquivos › 3. Concluir upload.
Atenção ao 503. Um 503 com metadata.delivery: \"unknown\" significa que a campanha pode ter sido criada: confira em Listar campanhas antes de tentar de novo.
Cria uma campanha agendada em uma caixa de WhatsApp - API Oficial, a partir de um template aprovado. Depois de criar, adicione o público em Contatos › Adicionar contatos.
\ninboxId e templateName. O id da caixa de entrada vem de V2 › Inboxes › FindAll, e o nome do template, de V2 › Inboxes › WhatsApp - API Oficial › Templates › FindAll.
Parâmetros do template. header, body e footer levam as variáveis de cada componente. buttons segue a ordem dos botões do template, com null para botão sem parâmetro. Para cabeçalho de mídia, use { type, media_key, filename }, com media_key de Arquivos › 3. Concluir upload.
Planilha. Com \"source\": \"import\", o público entra por Adicionar contatos (planilha) e as variáveis podem usar {{import.<coluna>}}.
Limites. scheduledAt no futuro · até 10 botões · variáveis até 1024 caracteres · recorrência mensal só até o dia 28 (UTC).
Atenção ao 503. Como em Criar campanha (WhatsApp - API Web): confira a lista antes de tentar de novo.
\n","urlObject":{"path":["chat","v1","campaigns"],"host":["https://api.bradial.com.br"],"query":[],"variable":[]}},"response":[{"id":"8cd744a3-c580-e8cf-7337-83684b2c1e7b","name":"201 — template com variáveis e botões","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Confirmação de agenda\",\n \"inboxId\": 34,\n \"scheduledAt\": \"2026-11-10T12:00:00.000Z\",\n \"whatsapp\": {\n \"templateName\": \"confirmacao_agenda\",\n \"parameters\": {\n \"body\": { \"1\": \"{{contact.name}}\", \"2\": \"11/11 às 14h\" },\n \"buttons\": [null, null]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/campaigns"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"01M6JYAYCYFV4WQT40AFXG3779\",\n \"name\": \"Confirmação de agenda\",\n \"status\": 0,\n \"channel\": \"Whatsapp\",\n \"source\": \"manual\",\n \"inbox\": { \"id\": 34, \"name\": \"WhatsApp Oficial Loja\", \"channelType\": \"Channel::Whatsapp\" },\n \"creator\": { \"apiKey\": true },\n \"bradial\": null,\n \"whatsapp\": {\n \"templateName\": \"confirmacao_agenda\",\n \"parameters\": {\n \"header\": null,\n \"headerMedia\": null,\n \"body\": { \"1\": \"{{contact.name}}\", \"2\": \"11/11 às 14h\" },\n \"buttons\": [null, null]\n }\n },\n \"autoCloseConversation\": false,\n \"recurrenceId\": null,\n \"scheduledAt\": \"2026-11-10T12:00:00.000Z\",\n \"createdAt\": \"2026-11-04T09:30:41.950Z\",\n \"updatedAt\": \"2026-11-04T09:30:41.950Z\"\n }\n}"},{"id":"026dfa3e-1596-b515-2efb-7e0782227c56","name":"201 — cabeçalho de imagem","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Black Friday — Clientes VIP\",\n \"inboxId\": 34,\n \"scheduledAt\": \"2026-11-27T12:00:00.000Z\",\n \"whatsapp\": {\n \"templateName\": \"promo_black_friday_2026\",\n \"parameters\": {\n \"header\": { \"type\": \"image\", \"media_key\": \"temp/9a4d7e12-5c3b-4f8a-8e61-2b7c9d0f4a56\", \"filename\": \"black-friday-vip.jpg\" },\n \"body\": { \"1\": \"{{contact.name}}\", \"2\": \"30%\" },\n \"buttons\": [null, null]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/campaigns"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"01M6JYAYCZ0K8T2B6WQH3RNE4D\",\n \"name\": \"Black Friday — Clientes VIP\",\n \"status\": 0,\n \"channel\": \"Whatsapp\",\n \"source\": \"manual\",\n \"inbox\": { \"id\": 34, \"name\": \"WhatsApp Oficial Loja\", \"channelType\": \"Channel::Whatsapp\" },\n \"creator\": { \"apiKey\": true },\n \"bradial\": null,\n \"whatsapp\": {\n \"templateName\": \"promo_black_friday_2026\",\n \"parameters\": {\n \"header\": null,\n \"headerMedia\": { \"type\": \"image\", \"filename\": \"black-friday-vip.jpg\", \"url\": null },\n \"body\": { \"1\": \"{{contact.name}}\", \"2\": \"30%\" },\n \"buttons\": [null, null]\n }\n },\n \"autoCloseConversation\": false,\n \"recurrenceId\": null,\n \"scheduledAt\": \"2026-11-27T12:00:00.000Z\",\n \"createdAt\": \"2026-11-04T09:31:02.118Z\",\n \"updatedAt\": \"2026-11-04T09:31:02.118Z\"\n }\n}"},{"id":"0d90932f-283f-1af9-5920-49e7f991a641","name":"201 — campanha de planilha","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Cobrança novembro\",\n \"inboxId\": 34,\n \"source\": \"import\",\n \"scheduledAt\": \"2026-11-12T13:00:00.000Z\",\n \"whatsapp\": {\n \"templateName\": \"cobranca_valor\",\n \"parameters\": {\n \"body\": { \"1\": \"{{contact.name}}\", \"2\": \"{{import.valor}}\", \"3\": \"{{import.vencimento}}\" }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/campaigns"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"01M6PE1JF235X04Y5G8NN3T8SP\",\n \"name\": \"Cobrança novembro\",\n \"status\": 0,\n \"channel\": \"Whatsapp\",\n \"source\": \"import\",\n \"inbox\": { \"id\": 34, \"name\": \"WhatsApp Oficial Loja\", \"channelType\": \"Channel::Whatsapp\" },\n \"creator\": { \"apiKey\": true },\n \"bradial\": null,\n \"whatsapp\": {\n \"templateName\": \"cobranca_valor\",\n \"parameters\": {\n \"header\": null,\n \"headerMedia\": null,\n \"body\": { \"1\": \"{{contact.name}}\", \"2\": \"{{import.valor}}\", \"3\": \"{{import.vencimento}}\" },\n \"buttons\": []\n }\n },\n \"autoCloseConversation\": false,\n \"recurrenceId\": null,\n \"scheduledAt\": \"2026-11-12T13:00:00.000Z\",\n \"createdAt\": \"2026-11-05T18:02:55.330Z\",\n \"updatedAt\": \"2026-11-05T18:02:55.330Z\"\n }\n}"},{"id":"a3eec45b-c90c-65fb-0a61-4db2a0c89196","name":"400 — conteúdo não corresponde ao canal","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Confirmação de agenda\",\n \"inboxId\": 12,\n \"scheduledAt\": \"2026-11-10T12:00:00.000Z\",\n \"whatsapp\": { \"templateName\": \"confirmacao_agenda\" }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/campaigns"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The campaign content does not match the inbox channel.\",\n \"statusCode\": 400,\n \"error\": {\n \"code\": \"CAMP010\",\n \"message\": \"The campaign content does not match the inbox channel.\",\n \"reason\": \"When a Bradial inbox is sent without a bradial block or with a whatsapp one, or a WhatsApp inbox the other way round. The channel is read from the inbox, never from the client.\"\n }\n}"},{"id":"f7cba1d6-6418-ac90-97f8-0f759f80261a","name":"422 — campos inválidos","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Confirmação de agenda\",\n \"inboxId\": 34,\n \"scheduledAt\": \"10/11/2026 12:00\",\n \"whatsapp\": { \"templateName\": \"\" },\n \"foo\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/campaigns"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n \"scheduledAt must be a valid ISO 8601 date string\",\n \"whatsapp.templateName should not be empty\",\n \"property foo should not exist\"\n ],\n \"error\": \"Unprocessable Entity\",\n \"statusCode\": 422\n}"}],"_postman_id":"4b9c270b-fbe5-32c8-069e-f44cbc99f742"},{"name":"Atualizar campanha","id":"9bba3921-d96e-3f06-0ed6-05a30458f768","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Promo Novembro (adiada)\",\n \"scheduledAt\": \"2026-11-05T13:00:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/campaigns/:campaignId","description":"Altera uma campanha agendada. Envie só os campos que mudam.
\nbradial.file: null remove o anexo; sem file, o anexo atual é mantido. Uma campanha de planilha muda só o nome e a data.
Cria uma cópia de uma campanha, de qualquer status, com os mesmos contatos. scheduledAt é obrigatório.
Sem conteúdo no corpo, a cópia mantém a mensagem e o anexo da original. A cópia de uma campanha de planilha muda só o nome e a data.
\n","urlObject":{"path":["chat","v1","campaigns",":campaignId","duplicate"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"campaignId"}]}},"response":[{"id":"1e44b60e-6e00-e16d-94d6-5a629b0c4936","name":"201 — mesma mensagem, nova data","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Tabela de preços dezembro\",\n \"scheduledAt\": \"2026-12-01T13:00:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/campaigns/01M6GW1K49ANYD084C3Z1H239Y/duplicate"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"01M6RAYJA41CQVFDHW1C1P1GAE\",\n \"name\": \"Tabela de preços dezembro\",\n \"status\": 0,\n \"channel\": \"Bradial\",\n \"source\": \"manual\",\n \"inbox\": { \"id\": 12, \"name\": \"Comercial SP\", \"channelType\": \"Channel::Bradial\" },\n \"creator\": { \"apiKey\": true },\n \"bradial\": {\n \"message\": \"Olá {{contact.name}}! Segue a nossa tabela de preços de novembro.\",\n \"fileName\": \"tabela-precos-novembro.pdf\",\n \"fileUrl\": null\n },\n \"whatsapp\": null,\n \"autoCloseConversation\": false,\n \"recurrenceId\": null,\n \"scheduledAt\": \"2026-12-01T13:00:00.000Z\",\n \"createdAt\": \"2026-11-06T11:47:20.004Z\",\n \"updatedAt\": \"2026-11-06T11:47:20.004Z\"\n }\n}"},{"id":"531db846-97ae-8034-de6f-0d3cf1ccda42","name":"400 — cópia de planilha mudando a caixa","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scheduledAt\": \"2026-12-12T13:00:00.000Z\",\n \"inboxId\": 41\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/campaigns/01M6PE1JF235X04Y5G8NN3T8SP/duplicate"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"A copy of a spreadsheet campaign changes only its name and date.\",\n \"statusCode\": 400,\n \"error\": {\n \"code\": \"CAMP017\",\n \"message\": \"A copy of a spreadsheet campaign changes only its name and date.\",\n \"reason\": \"When campaign-api answered 409 on a duplicate: the original came from a spreadsheet and the copy names another inbox, channel, autoCloseConversation or recurrence than the original's. A copy may be made from any status, so this is the only 409 a duplicate gets.\",\n \"metadata\": { \"status\": 409 }\n }\n}"}],"_postman_id":"c1f207b4-b387-bcc7-095d-f27a59b27037"},{"name":"Iniciar campanha","id":"8cee5780-a1ce-2db5-e505-61e68b3dfcb0","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.bradial.com.br/chat/v1/campaigns/:campaignId/in-progress","description":"Começa a enviar agora uma campanha agendada, sem esperar o horário. Sem corpo.
\n","urlObject":{"path":["chat","v1","campaigns",":campaignId","in-progress"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"campaignId"}]}},"response":[{"id":"a4ec43c5-1c3b-5ce8-a11e-5013e63ea612","name":"204 — envio iniciado","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"POST","header":[],"url":"https://api.bradial.com.br/chat/v1/campaigns/01M6GW1K49ANYD084C3Z1H239Y/in-progress"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"1f5cd05f-0d2f-b257-422a-8a761d5d41df","name":"400 — campanha não está agendada","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"POST","header":[],"url":"https://api.bradial.com.br/chat/v1/campaigns/01M6JYAYCYFV4WQT40AFXG3779/in-progress"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"This action is not allowed for the campaign in its current state.\",\n \"statusCode\": 400,\n \"error\": {\n \"code\": \"CAMP003\",\n \"message\": \"This action is not allowed for the campaign in its current state.\",\n \"reason\": \"When campaign-api answered 422 on start, cancel or undoing a skip, or 409 on delete or on ending a series that already ended: a series occurrence cannot be deleted, a campaign that left SCHEDULED cannot be started or deleted, and only a skipped occurrence dated in the future, of a series not ended, can be restored. The BFF also answers it on its own, before any write, when the read behind a cancel finds a campaign that is not IN_PROGRESS and is not, for a user, a scheduled series occurrence: a standalone scheduled campaign, which can only be deleted, or any scheduled campaign for an API key, which has no route to undo a skip.\",\n \"metadata\": { \"status\": 422 }\n }\n}"}],"_postman_id":"8cee5780-a1ce-2db5-e505-61e68b3dfcb0"},{"name":"Cancelar campanha","id":"4b52d45e-33c6-b968-8237-fb7fa23462ea","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.bradial.com.br/chat/v1/campaigns/:campaignId/cancelled","description":"Interrompe uma campanha em andamento: quem ainda não recebeu deixa de receber. Sem corpo.
\nPara uma campanha agendada que ainda não começou, use Remover campanha.
\n","urlObject":{"path":["chat","v1","campaigns",":campaignId","cancelled"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"campaignId"}]}},"response":[{"id":"07128924-b01c-3c58-bcbd-b5691a06283b","name":"204 — envio interrompido","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"POST","header":[],"url":"https://api.bradial.com.br/chat/v1/campaigns/01M6RAYJX3EC7D09784CVFWZC4/cancelled"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"c9a84411-bd2b-a8eb-2c24-352782ad7cf2","name":"400 — campanha ainda agendada","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"POST","header":[],"url":"https://api.bradial.com.br/chat/v1/campaigns/01M6GW1K49ANYD084C3Z1H239Y/cancelled"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"This action is not allowed for the campaign in its current state.\",\n \"statusCode\": 400,\n \"error\": {\n \"code\": \"CAMP003\",\n \"message\": \"This action is not allowed for the campaign in its current state.\",\n \"reason\": \"When campaign-api answered 422 on start, cancel or undoing a skip, or 409 on delete or on ending a series that already ended: a series occurrence cannot be deleted, a campaign that left SCHEDULED cannot be started or deleted, and only a skipped occurrence dated in the future, of a series not ended, can be restored. The BFF also answers it on its own, before any write, when the read behind a cancel finds a campaign that is not IN_PROGRESS and is not, for a user, a scheduled series occurrence: a standalone scheduled campaign, which can only be deleted, or any scheduled campaign for an API key, which has no route to undo a skip.\"\n }\n}"}],"_postman_id":"4b52d45e-33c6-b968-8237-fb7fa23462ea"},{"name":"Remover campanha","id":"ee9373e5-34c3-0a60-7c6d-739a9c9a4fc7","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.bradial.com.br/chat/v1/campaigns/:campaignId","description":"Remove uma campanha agendada.
\nOcorrências de uma recorrência não são removidas uma a uma: use Recorrências › Encerrar recorrência.
\n","urlObject":{"path":["chat","v1","campaigns",":campaignId"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"campaignId"}]}},"response":[{"id":"ee5f0593-532a-5116-a3fc-3dae6d731ff0","name":"204 — campanha removida","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"DELETE","header":[],"url":"https://api.bradial.com.br/chat/v1/campaigns/01M6RAYJA41CQVFDHW1C1P1GAE"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"d26f4383-2479-cbe0-11a6-aca30404b273","name":"400 — ocorrência de recorrência","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"DELETE","header":[],"url":"https://api.bradial.com.br/chat/v1/campaigns/01M6HC4R7N2V8XQ3K5T9WB1ZDA"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"This action is not allowed for the campaign in its current state.\",\n \"statusCode\": 400,\n \"error\": {\n \"code\": \"CAMP003\",\n \"message\": \"This action is not allowed for the campaign in its current state.\",\n \"reason\": \"When campaign-api answered 422 on start, cancel or undoing a skip, or 409 on delete or on ending a series that already ended: a series occurrence cannot be deleted, a campaign that left SCHEDULED cannot be started or deleted, and only a skipped occurrence dated in the future, of a series not ended, can be restored. The BFF also answers it on its own, before any write, when the read behind a cancel finds a campaign that is not IN_PROGRESS and is not, for a user, a scheduled series occurrence: a standalone scheduled campaign, which can only be deleted, or any scheduled campaign for an API key, which has no route to undo a skip.\",\n \"metadata\": { \"status\": 409 }\n }\n}"}],"_postman_id":"ee9373e5-34c3-0a60-7c6d-739a9c9a4fc7"}],"id":"1b595bb6-f2ab-4ceb-8566-df4adb319cc8","_postman_id":"1b595bb6-f2ab-4ceb-8566-df4adb319cc8","description":""},{"name":"Assistentes","item":[{"name":"Base de Conhecimento","item":[{"name":"Enviar arquivo","id":"70654509-05fb-ffd0-e7df-f56aa7c9da8b","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","description":"O arquivo. Máximo 5 MB. PDF, DOC, DOCX ou TXT.
\n","type":"file","value":null}]},"url":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/knowledge-base/files","description":"Envia um arquivo para a base de conhecimento do assistente.
\nmultipart/form-data, um arquivo por requisição, no campo file.
Limites, validados no BFF antes de subir
\napplication/pdf (.pdf)application/msword (.doc)application/vnd.openxmlformats-officedocument.wordprocessingml.document (.docx)text/plain (.txt)Não defina Content-Type à mão — deixe o Postman montar o boundary do multipart.
Resposta
\ndata.id é o identificador usado em Remover arquivo.
Remove um arquivo da base de conhecimento do assistente.
\nParâmetros de caminho
\nassistantId (ULID)fileId — o data.id devolvido por Enviar arquivo.Responde 204 sem corpo.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId","knowledge-base","files",":fileId"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"},{"type":"any","key":"fileId"}]}},"response":[{"id":"b64cfc2c-636c-23b8-e33e-9880ed393702","name":"204 No Content","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/knowledge-base/files/:fileId","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","knowledge-base","files",":fileId"],"variable":[{"key":"assistantId"},{"key":"fileId"}]},"description":"Remove um arquivo da base de conhecimento do assistente.\n\n**Parâmetros de caminho**\n\n- `assistantId` (ULID)\n- `fileId` — o `data.id` devolvido por **Enviar arquivo**.\n\nResponde **204 sem corpo**."},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"12844f9d-98bf-74ed-332c-7ec9ae51a18a"},{"name":"Adicionar site","id":"d8d98544-a9fc-89c7-3fd2-dd0c58a9e154","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://bradial.com.br/precos\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/knowledge-base/websites","description":"Registra um site como fonte da base de conhecimento. O upstream rastreia as páginas do domínio.
\nCorpo
\nurl (string, obrigatório) — não pode ser vazia.Resposta
\ndata.domain é o valor que vai no caminho de Remover site — repare que é o domínio, não a URL que você enviou.
Remove um domínio da base de conhecimento do assistente.
\nParâmetros de caminho
\ndomain — exatamente o data.domain devolvido por Adicionar site. Pode mandar o domínio cru: o BFF faz o percent-encoding do segmento.Responde 204 sem corpo.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId","knowledge-base","websites",":domain"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"},{"type":"any","key":"domain"}]}},"response":[{"id":"2b721838-325c-baa0-a29f-c6522945b206","name":"204 No Content","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/knowledge-base/websites/:domain","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","knowledge-base","websites",":domain"],"variable":[{"key":"assistantId"},{"key":"domain"}]},"description":"Remove um domínio da base de conhecimento do assistente.\n\n**Parâmetros de caminho**\n\n- `domain` — exatamente o `data.domain` devolvido por **Adicionar site**. Pode mandar o domínio cru: o BFF faz o percent-encoding do segmento.\n\nResponde **204 sem corpo**."},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7d27dc35-8c17-222b-0eec-5cd60a118b07"}],"id":"5390804a-f2d2-4bba-b531-32c58eba8668","_postman_id":"5390804a-f2d2-4bba-b531-32c58eba8668","description":""},{"name":"Ferramentas","item":[{"name":"Listar ferramentas","id":"50bde5cd-fb0e-9c45-c115-9e9f47d61ada","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/tools","description":"Lista as ferramentas HTTP do assistente — as chamadas que ele pode disparar contra a sua API durante o atendimento.
\nResposta
\ndata[].auth.secretSet — booleano. O segredo nunca é devolvido; este campo só diz se existe um gravado.items — total de ferramentas.Cria uma ferramenta HTTP no assistente.
\nCorpo
\nname (string, obrigatório) — até 64 caracteres, no padrão ^[a-z][a-zA-Z0-9]*$: começa com minúscula, só letras e números, sem _ e sem -. Não pode começar com native, prefixo reservado.description (string, obrigatório) — até 500 caracteres. É por ela que o modelo decide quando chamar a ferramenta, então descreva a situação de uso, não a implementação.parameters (objeto, obrigatório)properties (objeto) — no máximo 10 parâmetros.required (array de strings)api (objeto, obrigatório)method — GET, POST, PUT, PATCH ou DELETE.url — obrigatoriamente https, até 2048 caracteres.headers (objeto, opcional) — se vier, não pode ser vazio.body (objeto, opcional) — se vier, não pode ser vazio.auth (objeto, opcional)type — none, bearer, apiKey ou basic.headerName — obrigatório quando type é apiKey. Até 64 caracteres.username — até 128 caracteres.secret — até 4096 caracteres. Enviado só na escrita; nunca volta na leitura.errorMessage (string, obrigatório) — até 500 caracteres. É o que o assistente diz ao cliente quando a chamada falha.enabled (booleano, opcional)Interpolação
\nUse {{nomeDoParametro}} na url, nos headers e no body para injetar os argumentos que o modelo preencher.
Substitui a definição de uma ferramenta.
\nÉ um PUT: mande o objeto inteiro, não só os campos alterados. O que você omitir é perdido.
\nMesmos campos e limites de Criar ferramenta, menos name — o nome vem do caminho e não pode ser trocado. Para renomear, crie outra e remova esta.
secret omitido mantém o segredo já gravado.
Responde 204 sem corpo.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId","tools",":toolName"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"},{"type":"any","key":"toolName"}]}},"response":[{"id":"89e47f48-72e7-501c-8ce9-73ad4366e8e9","name":"204 No Content","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"PUT","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n \"description\": \"Consulta a situação de um pedido pelo número, incluindo o código de rastreio.\",\n \"parameters\": {\n \"properties\": {\n \"numeroPedido\": {\n \"type\": \"string\",\n \"description\": \"Número do pedido, só dígitos\"\n }\n },\n \"required\": [\"numeroPedido\"]\n },\n \"api\": {\n \"method\": \"GET\",\n \"url\": \"https://api.cliente.com.br/v2/pedidos/{{numeroPedido}}\",\n \"headers\": { \"Accept\": \"application/json\" }\n },\n \"auth\": { \"type\": \"bearer\" },\n \"errorMessage\": \"Não consegui consultar o pedido agora. Tente de novo em instantes.\",\n \"enabled\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/tools/:toolName","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","tools",":toolName"],"variable":[{"key":"assistantId"},{"key":"toolName"}]},"description":"Substitui a definição de uma ferramenta.\n\n**É um PUT: mande o objeto inteiro**, não só os campos alterados. O que você omitir é perdido.\n\nMesmos campos e limites de **Criar ferramenta**, **menos `name`** — o nome vem do caminho e não pode ser trocado. Para renomear, crie outra e remova esta.\n\n`secret` omitido **mantém** o segredo já gravado.\n\nResponde **204 sem corpo**."},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7e8fb1fe-9432-9497-c86f-2a6a531707be"},{"name":"Remover ferramenta","id":"06fdbb57-e88a-3be8-039a-8ddc7f0b4d3a","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/tools/:toolName","description":"Remove a ferramenta do assistente.
\nParâmetros de caminho
\ntoolName — o name da ferramenta, como aparece em Listar ferramentas.Responde 204 sem corpo.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId","tools",":toolName"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"},{"type":"any","key":"toolName"}]}},"response":[{"id":"3959ca5d-8da9-0a9c-1854-7a1968ff0198","name":"204 No Content","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/tools/:toolName","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","tools",":toolName"],"variable":[{"key":"assistantId"},{"key":"toolName"}]},"description":"Remove a ferramenta do assistente.\n\n**Parâmetros de caminho**\n\n- `toolName` — o `name` da ferramenta, como aparece em **Listar ferramentas**.\n\nResponde **204 sem corpo**."},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"06fdbb57-e88a-3be8-039a-8ddc7f0b4d3a"},{"name":"Ativar ou desativar ferramenta","id":"f9911c65-d6a2-e50f-49cf-010320783250","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"PATCH","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n \"enabled\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/tools/:toolName/enabled","description":"Liga ou desliga a ferramenta sem apagar a configuração. Desligada, ela continua gravada mas o assistente não a enxerga.
\nCorpo
\nenabled (booleano, obrigatório). Precisa estar presente: ausente ou null dá 400.Responde 204 sem corpo.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId","tools",":toolName","enabled"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"},{"type":"any","key":"toolName"}]}},"response":[{"id":"4d2529b5-40af-2a77-eed0-ce97841f2305","name":"204 No Content","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"PATCH","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n \"enabled\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/tools/:toolName/enabled","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","tools",":toolName","enabled"],"variable":[{"key":"assistantId"},{"key":"toolName"}]},"description":"Liga ou desliga a ferramenta sem apagar a configuração. Desligada, ela continua gravada mas o assistente não a enxerga.\n\n**Corpo**\n\n- `enabled` (booleano, **obrigatório**). Precisa estar presente: ausente ou `null` dá `400`.\n\nResponde **204 sem corpo**."},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f9911c65-d6a2-e50f-49cf-010320783250"},{"name":"Testar ferramenta","id":"bdd3af0d-a3b7-84f9-2726-f8760532b42d","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"POST","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n \"toolName\": \"consultarPedido\",\n \"arguments\": {\n \"numeroPedido\": \"998877\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/tools/test","description":"Dispara a ferramenta de verdade contra a sua API e devolve o que voltou. Serve para validar a configuração antes de liberar para o assistente.
\nResponde 200, não 201.
\nCorpo — duas formas, escolha uma:
\ntoolName.tool com o objeto completo (mesmos campos de Criar ferramenta). É obrigatório quando toolName não vem.E, em qualquer um dos casos:
\narguments (objeto, opcional) — os valores dos parâmetros, como o modelo os passaria.context (objeto, opcional) — pares string/string disponíveis para interpolação.Resposta
\nstatus — o HTTP que a sua API devolveu, ou null se a chamada nem completou.durationMs — quanto demorou.body — o corpo da resposta, como texto.bytes e truncated — a resposta é cortada quando passa do limite.error — a falha de transporte (DNS, TLS, timeout), ou null.Um status 500 com error: null quer dizer que a sua API respondeu e respondeu erro — a ferramenta está configurada certo.
Lista os servidores MCP ligados ao assistente.
\nResposta
\ndata[].secretSet — booleano. O segredo nunca é devolvido; este campo só diz se existe um gravado.data[].allowedTools — as ferramentas do servidor que o assistente pode usar. O servidor pode anunciar mais do que isso; só as listadas aqui ficam disponíveis.Conecta no servidor MCP e devolve as ferramentas que ele anuncia.
\nUse antes de criar, para saber o que colocar em allowedTools. Não grava nada. Responde 200, não 201.
Corpo
\nserverUrl (string, obrigatório) — https, sem usuário e senha embutidos na URL, sem placeholders.secret (string, opcional) — até 4096 caracteres.headerName (string, opcional) — o header em que o segredo viaja.Resposta
\nserverName — como o servidor se identifica.tools[] — name e description de cada ferramenta anunciada.error — a falha de conexão, ou null. Um error preenchido com tools vazio quer dizer que o servidor não respondeu.Liga um servidor MCP ao assistente.
\nCorpo
\nlabel (string, obrigatório) — até 64 caracteres, no padrão ^[a-z][a-z0-9_]*$: minúsculas, dígitos e _, começando por letra. Repare que é diferente do padrão de name das ferramentas, que não aceita _.serverUrl (string, obrigatório) — https, até 2048 caracteres, sem credenciais embutidas e sem placeholders.description (string, opcional) — até 500 caracteres.secret (string, opcional) — até 4096 caracteres. Nunca volta na leitura.headerName (string, opcional) — até 64 caracteres, o header que carrega o segredo.allowedTools (array de strings, obrigatório) — de 1 a 32 nomes, sem repetição, cada um com até 128 caracteres. Use Sondar servidor MCP para descobrir os nomes válidos.enabled (booleano, opcional)Substitui a configuração do servidor MCP.
\nÉ um PUT: mande o objeto inteiro. O que você omitir é perdido.
\nMesmos campos e limites de Criar servidor MCP, menos label — o rótulo vem do registro e não pode ser trocado.
secret omitido mantém o segredo já gravado.
Responde 204 sem corpo.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId","mcp-servers",":mcpServerId"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"},{"type":"any","key":"mcpServerId"}]}},"response":[{"id":"dfdd15b5-f2f8-fb26-4540-ba27d50da0a7","name":"204 No Content","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"serverUrl\": \"https://mcp.cliente.com.br/sse\",\n \"description\": \"CRM interno do cliente (produção)\",\n \"headerName\": \"X-Api-Key\",\n \"allowedTools\": [\"buscarCliente\", \"criarOportunidade\", \"listarPropostas\"],\n \"enabled\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/mcp-servers/:mcpServerId","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","mcp-servers",":mcpServerId"],"variable":[{"key":"assistantId"},{"key":"mcpServerId"}]},"description":"Substitui a configuração do servidor MCP.\n\n**É um PUT: mande o objeto inteiro.** O que você omitir é perdido.\n\nMesmos campos e limites de **Criar servidor MCP**, **menos `label`** — o rótulo vem do registro e não pode ser trocado.\n\n`secret` omitido **mantém** o segredo já gravado.\n\nResponde **204 sem corpo**."},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8b433c63-5aa5-b1cf-3fb7-ba6824bf5f3c"},{"name":"Remover servidor MCP","id":"44a04cd0-ce2e-5a10-4c77-45843e3d09f6","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/mcp-servers/:mcpServerId","description":"Desliga e remove o servidor MCP do assistente.
\nParâmetros de caminho
\nmcpServerId — o id devolvido por Listar servidores MCP ou Criar servidor MCP.Responde 204 sem corpo.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId","mcp-servers",":mcpServerId"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"},{"type":"any","key":"mcpServerId"}]}},"response":[{"id":"be0e8492-4895-b6bd-dcf3-95256daea7ba","name":"204 No Content","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/mcp-servers/:mcpServerId","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","mcp-servers",":mcpServerId"],"variable":[{"key":"assistantId"},{"key":"mcpServerId"}]},"description":"Desliga e remove o servidor MCP do assistente.\n\n**Parâmetros de caminho**\n\n- `mcpServerId` — o `id` devolvido por **Listar servidores MCP** ou **Criar servidor MCP**.\n\nResponde **204 sem corpo**."},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"44a04cd0-ce2e-5a10-4c77-45843e3d09f6"},{"name":"Ativar ou desativar servidor MCP","id":"4059725f-13cd-d83b-715f-4cc20161f382","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"PATCH","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n \"enabled\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/mcp-servers/:mcpServerId/enabled","description":"Liga ou desliga o servidor MCP sem apagar a configuração. Desligado, o segredo e a lista de ferramentas permanecem gravados.
\nCorpo
\nenabled (booleano, obrigatório). Ausente ou null dá 400.Responde 204 sem corpo.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId","mcp-servers",":mcpServerId","enabled"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"},{"type":"any","key":"mcpServerId"}]}},"response":[{"id":"3c5d84a4-b7ad-39ec-e1ad-5e7441fb26cd","name":"204 No Content","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"PATCH","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n \"enabled\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/mcp-servers/:mcpServerId/enabled","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","mcp-servers",":mcpServerId","enabled"],"variable":[{"key":"assistantId"},{"key":"mcpServerId"}]},"description":"Liga ou desliga o servidor MCP sem apagar a configuração. Desligado, o segredo e a lista de ferramentas permanecem gravados.\n\n**Corpo**\n\n- `enabled` (booleano, **obrigatório**). Ausente ou `null` dá `400`.\n\nResponde **204 sem corpo**."},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4059725f-13cd-d83b-715f-4cc20161f382"}],"id":"d26161bc-4a46-41c4-aefd-85d922d63bb8","_postman_id":"d26161bc-4a46-41c4-aefd-85d922d63bb8","description":""},{"name":"Sub-agentes","item":[{"name":"Base de Conhecimento","item":[{"name":"Enviar arquivo (sub-agente)","id":"0d03d8ad-38da-a972-74a8-14fc75086761","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"O arquivo. Máximo 5 MB. PDF, DOC, DOCX ou TXT.
\n","key":"file","type":"file","value":null}]},"url":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId/knowledge-base/files","description":"Envia um arquivo para a base de conhecimento do sub-agente, que é separada da do assistente.
\nmultipart/form-data, um arquivo por requisição, no campo file.
Limites — iguais aos do assistente:
\napplication/pdf, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/plain.Não defina Content-Type à mão — deixe o Postman montar o boundary.
Remove um arquivo da base de conhecimento do sub-agente.
\nParâmetros de caminho
\nfileId — o data.id devolvido por Enviar arquivo (sub-agente).Responde 204 sem corpo.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId","knowledge-base","files",":fileId"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"},{"type":"any","key":"subAgentId"},{"type":"any","key":"fileId"}]}},"response":[{"id":"806d3a19-c99f-8683-7ed4-beee283d1530","name":"204 No Content","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId/knowledge-base/files/:fileId","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId","knowledge-base","files",":fileId"],"variable":[{"key":"assistantId"},{"key":"subAgentId"},{"key":"fileId"}]},"description":"Remove um arquivo da base de conhecimento do sub-agente.\n\n**Parâmetros de caminho**\n\n- `fileId` — o `data.id` devolvido por **Enviar arquivo (sub-agente)**.\n\nResponde **204 sem corpo**."},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d0afd5c3-ab81-6e8f-1945-688202aa6aef"},{"name":"Adicionar site (sub-agente)","id":"2096d184-e997-f8a6-3d2e-fbb5361d83b8","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"POST","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://bradial.com.br/ajuda/agendamento\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId/knowledge-base/websites","description":"Registra um site como fonte da base de conhecimento do sub-agente.
\nCorpo
\nurl (string, obrigatório) — não pode ser vazia.Resposta
\ndata.domain é o valor que vai no caminho de Remover site (sub-agente).
Remove um domínio da base de conhecimento do sub-agente.
\nParâmetros de caminho
\ndomain — exatamente o data.domain devolvido por Adicionar site (sub-agente). Pode mandar cru: o BFF faz o percent-encoding.Responde 204 sem corpo.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId","knowledge-base","websites",":domain"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"},{"type":"any","key":"subAgentId"},{"type":"any","key":"domain"}]}},"response":[{"id":"dde3644c-2bc0-88c7-f6c6-4a16361d94e6","name":"204 No Content","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId/knowledge-base/websites/:domain","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId","knowledge-base","websites",":domain"],"variable":[{"key":"assistantId"},{"key":"subAgentId"},{"key":"domain"}]},"description":"Remove um domínio da base de conhecimento do sub-agente.\n\n**Parâmetros de caminho**\n\n- `domain` — exatamente o `data.domain` devolvido por **Adicionar site (sub-agente)**. Pode mandar cru: o BFF faz o percent-encoding.\n\nResponde **204 sem corpo**."},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"bac17c59-4094-444e-d6dd-4748a85d6a85"}],"id":"b20bdf0a-cfbc-415a-9972-66c27ca80c37","_postman_id":"b20bdf0a-cfbc-415a-9972-66c27ca80c37","description":""},{"name":"Ferramentas","item":[{"name":"Listar ferramentas (sub-agente)","id":"636f2401-0fc8-c09b-0871-6ad03a61d4a0","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId/tools","description":"Lista as ferramentas HTTP do sub-agente.
\nSão independentes das do assistente principal: o sub-agente só enxerga as próprias, e o assistente não enxerga estas.
\nauth.secretSet diz se há segredo gravado; o segredo nunca é devolvido.
Cria uma ferramenta HTTP no sub-agente.
\nMesmos campos e limites de Assistentes › Ferramentas › Criar ferramenta:
\nname até 64 caracteres, padrão ^[a-z][a-zA-Z0-9]*$, sem o prefixo reservado native.description e errorMessage até 500 caracteres cada.parameters.properties.api.url obrigatoriamente https, até 2048 caracteres.auth.type em none, bearer, apiKey ou basic, com headerName obrigatório quando for apiKey.Use {{nomeDoParametro}} na url, nos headers e no body para interpolar os argumentos.
Substitui a definição da ferramenta do sub-agente.
\nÉ um PUT: mande o objeto inteiro. O que você omitir é perdido.
\nname não entra no corpo — vem do caminho e não pode ser trocado.
secret omitido mantém o segredo já gravado.
Responde 204 sem corpo.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId","tools",":toolName"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"},{"type":"any","key":"subAgentId"},{"type":"any","key":"toolName"}]}},"response":[{"id":"1e317cd5-b903-9d7c-668a-cc86143fc29b","name":"204 No Content","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"PUT","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n \"description\": \"Consulta os horários livres de uma data, já descontando os bloqueios.\",\n \"parameters\": {\n \"properties\": {\n \"data\": {\n \"type\": \"string\",\n \"description\": \"Data no formato AAAA-MM-DD\"\n }\n },\n \"required\": [\"data\"]\n },\n \"api\": {\n \"method\": \"GET\",\n \"url\": \"https://api.cliente.com.br/v2/agenda?data={{data}}\",\n \"headers\": { \"Accept\": \"application/json\" }\n },\n \"auth\": { \"type\": \"none\" },\n \"errorMessage\": \"Não consegui ver a agenda agora. Tente de novo em instantes.\",\n \"enabled\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId/tools/:toolName","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId","tools",":toolName"],"variable":[{"key":"assistantId"},{"key":"subAgentId"},{"key":"toolName"}]},"description":"Substitui a definição da ferramenta do sub-agente.\n\n**É um PUT: mande o objeto inteiro.** O que você omitir é perdido.\n\n`name` não entra no corpo — vem do caminho e não pode ser trocado.\n\n`secret` omitido **mantém** o segredo já gravado.\n\nResponde **204 sem corpo**."},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d88240e8-7591-76ad-90a1-de97c603dcb1"},{"name":"Remover ferramenta (sub-agente)","id":"a4e47188-d975-b2d5-fe03-99d5e2434402","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId/tools/:toolName","description":"Remove a ferramenta do sub-agente.
\nParâmetros de caminho
\ntoolName — o name da ferramenta, como aparece em Listar ferramentas (sub-agente).Responde 204 sem corpo.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId","tools",":toolName"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"},{"type":"any","key":"subAgentId"},{"type":"any","key":"toolName"}]}},"response":[{"id":"27cbd8d5-e75c-136a-f8e8-900ecb18aa09","name":"204 No Content","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId/tools/:toolName","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId","tools",":toolName"],"variable":[{"key":"assistantId"},{"key":"subAgentId"},{"key":"toolName"}]},"description":"Remove a ferramenta do sub-agente.\n\n**Parâmetros de caminho**\n\n- `toolName` — o `name` da ferramenta, como aparece em **Listar ferramentas (sub-agente)**.\n\nResponde **204 sem corpo**."},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a4e47188-d975-b2d5-fe03-99d5e2434402"},{"name":"Ativar ou desativar ferramenta (sub-agente)","id":"e846b15e-fb47-87bd-7b87-db6d3762d604","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"PATCH","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n \"enabled\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId/tools/:toolName/enabled","description":"Liga ou desliga a ferramenta do sub-agente sem apagar a configuração.
\nCorpo
\nenabled (booleano, obrigatório). Ausente ou null dá 400.Responde 204 sem corpo.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId","tools",":toolName","enabled"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"},{"type":"any","key":"subAgentId"},{"type":"any","key":"toolName"}]}},"response":[{"id":"1e2cd230-1f98-8841-170f-b19cc8612623","name":"204 No Content","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"PATCH","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n \"enabled\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId/tools/:toolName/enabled","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId","tools",":toolName","enabled"],"variable":[{"key":"assistantId"},{"key":"subAgentId"},{"key":"toolName"}]},"description":"Liga ou desliga a ferramenta do sub-agente sem apagar a configuração.\n\n**Corpo**\n\n- `enabled` (booleano, **obrigatório**). Ausente ou `null` dá `400`.\n\nResponde **204 sem corpo**."},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e846b15e-fb47-87bd-7b87-db6d3762d604"},{"name":"Testar ferramenta (sub-agente)","id":"0ccc1cf2-c354-be48-e4ad-542ae2f01300","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"toolName\": \"consultarDisponibilidade\",\n \"arguments\": {\n \"data\": \"2026-10-05\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId/tools/test","description":"Dispara a ferramenta do sub-agente de verdade contra a sua API e devolve o resultado.
\nResponde 200, não 201.
\nCorpo — mande toolName (ferramenta já salva) ou tool (definição completa ainda não salva, com os mesmos campos de Criar ferramenta (sub-agente)). arguments e context são opcionais.
Resposta
\nstatus — o HTTP que a sua API devolveu, ou null se a chamada nem completou.durationMs, bytes, truncated — a resposta é cortada quando passa do limite.error — a falha de transporte, ou null.Lista os servidores MCP ligados ao sub-agente, independentes dos do assistente principal.
\nsecretSet diz se há segredo gravado; o segredo nunca é devolvido.
Conecta no servidor MCP e devolve as ferramentas anunciadas, para você saber o que colocar em allowedTools.
Não grava nada. Responde 200, não 201.
\nCorpo
\nserverUrl (string, obrigatório) — https, sem credenciais embutidas, sem placeholders.secret (string, opcional)headerName (string, opcional)Resposta
\ntools[] com name e description, serverName, e error (null quando deu certo).Liga um servidor MCP ao sub-agente.
\nMesmos campos e limites de Assistentes › MCP Servers › Criar servidor MCP:
\nlabel até 64 caracteres, padrão ^[a-z][a-z0-9_]*$.serverUrl https, até 2048 caracteres, sem credenciais embutidas e sem placeholders.description até 500, secret até 4096, headerName até 64.allowedTools com 1 a 32 nomes únicos, cada um até 128 caracteres. Use Sondar servidor MCP (sub-agente) para descobri-los.Substitui a configuração do servidor MCP do sub-agente.
\nÉ um PUT: mande o objeto inteiro. label não entra no corpo.
secret omitido mantém o segredo já gravado.
⚠️ Repare que aqui o parâmetro de caminho chama-se :id, e não :mcpServerId como na rota equivalente do assistente. O valor é o mesmo id que a listagem devolve.
Responde 204 sem corpo.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId","mcp-servers",":id"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"},{"type":"any","key":"subAgentId"},{"type":"any","key":"id"}]}},"response":[{"id":"f557eaa6-12f6-f8f2-2d2b-d68681e91506","name":"204 No Content","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"serverUrl\": \"https://mcp.cliente.com.br/agenda\",\n \"description\": \"Agenda do cliente (produção)\",\n \"headerName\": \"X-Api-Key\",\n \"allowedTools\": [\"listarEventos\", \"criarEvento\", \"cancelarEvento\"],\n \"enabled\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId/mcp-servers/:id","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId","mcp-servers",":id"],"variable":[{"key":"assistantId"},{"key":"subAgentId"},{"key":"id"}]},"description":"Substitui a configuração do servidor MCP do sub-agente.\n\n**É um PUT: mande o objeto inteiro.** `label` não entra no corpo.\n\n`secret` omitido **mantém** o segredo já gravado.\n\n⚠️ Repare que aqui o parâmetro de caminho chama-se **`:id`**, e não `:mcpServerId` como na rota equivalente do assistente. O valor é o mesmo `id` que a listagem devolve.\n\nResponde **204 sem corpo**."},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"947b5dca-24fd-725c-6802-21f102cd77fc"},{"name":"Remover servidor MCP (sub-agente)","id":"bb7e9aed-9c42-b6c0-3a63-2abc3ddafe24","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId/mcp-servers/:id","description":"Desliga e remove o servidor MCP do sub-agente.
\n⚠️ O parâmetro de caminho chama-se :id, e não :mcpServerId. O valor é o id devolvido por Listar servidores MCP (sub-agente).
Responde 204 sem corpo.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId","mcp-servers",":id"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"},{"type":"any","key":"subAgentId"},{"type":"any","key":"id"}]}},"response":[{"id":"e7020960-053e-a568-0cba-5949d57f97c0","name":"204 No Content","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId/mcp-servers/:id","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId","mcp-servers",":id"],"variable":[{"key":"assistantId"},{"key":"subAgentId"},{"key":"id"}]},"description":"Desliga e remove o servidor MCP do sub-agente.\n\n⚠️ O parâmetro de caminho chama-se **`:id`**, e não `:mcpServerId`. O valor é o `id` devolvido por **Listar servidores MCP (sub-agente)**.\n\nResponde **204 sem corpo**."},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"bb7e9aed-9c42-b6c0-3a63-2abc3ddafe24"},{"name":"Ativar ou desativar servidor MCP (sub-agente)","id":"f1427d67-f3b9-280e-4cee-a86d5e6d347c","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"PATCH","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n \"enabled\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId/mcp-servers/:id/enabled","description":"Liga ou desliga o servidor MCP do sub-agente sem apagar a configuração.
\nCorpo
\nenabled (booleano, obrigatório). Ausente ou null dá 400.⚠️ O parâmetro de caminho chama-se :id, e não :mcpServerId.
Responde 204 sem corpo.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId","mcp-servers",":id","enabled"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"},{"type":"any","key":"subAgentId"},{"type":"any","key":"id"}]}},"response":[{"id":"a568f428-64ac-7b10-0811-fdfef25450d1","name":"204 No Content","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"PATCH","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n \"enabled\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId/mcp-servers/:id/enabled","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId","mcp-servers",":id","enabled"],"variable":[{"key":"assistantId"},{"key":"subAgentId"},{"key":"id"}]},"description":"Liga ou desliga o servidor MCP do sub-agente sem apagar a configuração.\n\n**Corpo**\n\n- `enabled` (booleano, **obrigatório**). Ausente ou `null` dá `400`.\n\n⚠️ O parâmetro de caminho chama-se **`:id`**, e não `:mcpServerId`.\n\nResponde **204 sem corpo**."},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f1427d67-f3b9-280e-4cee-a86d5e6d347c"}],"id":"913640cd-cfe4-401c-b6b3-ef25138bc89e","_postman_id":"913640cd-cfe4-401c-b6b3-ef25138bc89e","description":""},{"name":"Listar sub-agentes","id":"e969ea3d-4cfd-51ac-8fc3-21990b431fee","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents","description":"Lista os sub-agentes do assistente.
\nSub-agente é um especialista para o qual o assistente principal transfere a conversa quando o assunto se encaixa no handoffDescription dele.
Resposta
\nA lista é enxuta de propósito: só id, name, handoffDescription, model, enabled e as datas. Para description, temperature, base de conhecimento, agenda e servidores MCP, use Obter sub-agente.
Devolve um sub-agente com a configuração completa: instruções, base de conhecimento, agenda e servidores MCP.
\nResposta
\ncalendar — null quando o sub-agente não tem agenda configurada.knowledgeBase — arquivos e sites próprios do sub-agente, separados dos do assistente.mcpServers — os servidores ligados a este sub-agente.Cria um sub-agente no assistente.
\nCorpo
\nname (string, obrigatório) — até 256 caracteres.handoffDescription (string, obrigatório) — até 1.024 caracteres. É por este texto que o assistente principal decide transferir, então descreva os assuntos que o sub-agente resolve, não o sub-agente em si.description (string, obrigatório) — até 156.000 caracteres. As instruções do sub-agente.model (string, opcional) — um dos id de Modelos disponíveis.temperature (número, opcional) — de 0 a 2, no máximo 2 casas decimais.calendar (objeto, opcional) — agenda. Quando vier, exige enabled (booleano), resources (array), rules, event e operations (objetos).Atualiza o sub-agente. É parcial: mande só os campos que quer mudar.
\nTodos os campos de Criar sub-agente são aceitos, e aqui todos são opcionais. Os mesmos limites valem: name até 256, handoffDescription até 1.024, description até 156.000, temperature de 0 a 2 com até 2 casas.
Nulo não passa
\nUm campo enviado como null é rejeitado com 400 — a validação checa presença, não ausência. Para não mexer num campo, omita-o; não mande null.
Responde 204 sem corpo.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"},{"type":"any","key":"subAgentId"}]}},"response":[{"id":"2af75987-c7dc-c8cc-361c-f299ef9f8c7f","name":"204 No Content","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"handoffDescription\": \"Assuntos de marcar, remarcar ou cancelar horário.\",\n \"temperature\": 0.5\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId"],"variable":[{"key":"assistantId"},{"key":"subAgentId"}]},"description":"Atualiza o sub-agente. É parcial: mande só os campos que quer mudar.\n\nTodos os campos de **Criar sub-agente** são aceitos, e aqui todos são opcionais. Os mesmos limites valem: `name` até 256, `handoffDescription` até 1.024, `description` até 156.000, `temperature` de 0 a 2 com até 2 casas.\n\n**Nulo não passa**\n\nUm campo enviado como `null` é rejeitado com `400` — a validação checa presença, não ausência. Para não mexer num campo, **omita-o**; não mande `null`.\n\nResponde **204 sem corpo**."},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""},{"id":"f1234ccc-9c6e-ebd4-6485-79738f39d8c9","name":"400 Bad Request — campo enviado como null","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"handoffDescription\": \"Assuntos de marcar, remarcar ou cancelar horário.\",\n \"temperature\": 0.5\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId"],"variable":[{"key":"assistantId"},{"key":"subAgentId"}]},"description":"Atualiza o sub-agente. É parcial: mande só os campos que quer mudar.\n\nTodos os campos de **Criar sub-agente** são aceitos, e aqui todos são opcionais. Os mesmos limites valem: `name` até 256, `handoffDescription` até 1.024, `description` até 156.000, `temperature` de 0 a 2 com até 2 casas.\n\n**Nulo não passa**\n\nUm campo enviado como `null` é rejeitado com `400` — a validação checa presença, não ausência. Para não mexer num campo, **omita-o**; não mande `null`.\n\nResponde **204 sem corpo**."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 400,\n \"message\": [\n \"temperature must be a number conforming to the specified constraints\"\n ],\n \"error\": \"Bad Request\"\n}"}],"_postman_id":"66eb2731-5085-b5a9-8a2d-bce6eb10e4e8"},{"name":"Remover sub-agente","id":"c0ab23e2-142d-4ebd-a0af-28aff59a41ac","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId","description":"Remove o sub-agente, junto com a base de conhecimento, as ferramentas e os servidores MCP próprios dele.
\nO assistente principal para de transferir para este assunto.
\nResponde 204 sem corpo.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"},{"type":"any","key":"subAgentId"}]}},"response":[{"id":"5dcf4481-3d40-6435-2490-23e2e43506f3","name":"204 No Content","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId"],"variable":[{"key":"assistantId"},{"key":"subAgentId"}]},"description":"Remove o sub-agente, junto com a base de conhecimento, as ferramentas e os servidores MCP próprios dele.\n\nO assistente principal para de transferir para este assunto.\n\nResponde **204 sem corpo**."},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c0ab23e2-142d-4ebd-a0af-28aff59a41ac"},{"name":"Ativar ou desativar sub-agente","id":"1391c0fd-469d-24a9-e72e-611c7dbe24d8","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"enabled\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId/enabled","description":"Liga ou desliga o sub-agente. Desligado, o assistente principal deixa de transferir para ele, mas toda a configuração permanece.
\nCorpo
\nenabled (booleano, obrigatório). Ausente ou null dá 400.Responde 204 sem corpo.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId","enabled"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"},{"type":"any","key":"subAgentId"}]}},"response":[{"id":"640c71ad-b31d-985c-5f91-9ae2385cbca7","name":"204 No Content","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"enabled\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId/sub-agents/:subAgentId/enabled","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId","sub-agents",":subAgentId","enabled"],"variable":[{"key":"assistantId"},{"key":"subAgentId"}]},"description":"Liga ou desliga o sub-agente. Desligado, o assistente principal deixa de transferir para ele, mas toda a configuração permanece.\n\n**Corpo**\n\n- `enabled` (booleano, **obrigatório**). Ausente ou `null` dá `400`.\n\nResponde **204 sem corpo**."},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1391c0fd-469d-24a9-e72e-611c7dbe24d8"}],"id":"a1a37596-8bfb-45ab-a40b-e89913c5f99d","_postman_id":"a1a37596-8bfb-45ab-a40b-e89913c5f99d","description":""},{"name":"Listar assistentes","id":"b2b36db1-15ee-07d1-0ceb-f7380bed5407","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.bradial.com.br/chat/v1/assistants","description":"Lista todos os assistentes da conta, junto com o consumo de tokens do plano.
\nO caminho não carrega accountId: o API Gateway resolve a conta a partir da sua x-api-key e injeta na chamada.
Resposta
\ndata[] — um item por assistente, com id, name, model, createdAt, updatedAt.data[].meta.inboxIds — as caixas de entrada em que o assistente atende. Vazio quer dizer que ele não está vinculado a nenhuma.data[].meta.ignoreContactLabels — etiquetas de contato que fazem o assistente não responder.metrics — consumo de tokens da conta, ou null quando o upstream não devolve.O id do assistente é um ULID e é ele que vai no caminho de todas as demais rotas.
Lista os modelos de linguagem que a marca pode usar em model, tanto no assistente quanto nos sub-agentes.
A lista é por marca, não por conta: duas contas da mesma marca veem exatamente os mesmos modelos.
\nResposta
\ndata[] — repassado do upstream sem reescrita. Use o campo id de cada item como valor de model em Atualizar assistente e em Criar sub-agente.Gera uma sugestão de prompt (as instruções do assistente) a partir de três frases curtas.
\nNão cria nem altera nada — só devolve o texto, para você revisar e mandar depois em description no PATCH do assistente.
Corpo — os três campos são obrigatórios e nenhum pode ser string vazia:
\nassistant (string) — o papel do assistente. Ex.: \"atendente comercial\".company (string) — o que a empresa faz.service (string) — o que o assistente deve resolver.Erros
\n400 — algum dos três ausente, vazio ou não-string.Cria um assistente na conta da chave de API.
\nEle nasce sem vínculo com nenhuma caixa de entrada — ou seja, não atende ninguém ainda. O vínculo é feito depois, com inboxIds em Atualizar assistente.
Corpo — todos os campos são opcionais:
\nname (string) — nome de exibição.description (string) — as instruções do assistente (o prompt). Use Gerar prompt se quiser um ponto de partida.businessHours (objeto) — horário de atendimento. Formato livre, repassado ao upstream sem validação de shape.Resposta
\nO assistente criado, com meta.inboxIds e meta.ignoreContactLabels sempre vazios.
Devolve um assistente com a configuração completa.
\nParâmetro de caminho
\nassistantId (ULID) — o id devolvido por Listar assistentes ou Criar assistente.Resposta
\nO payload do upstream acrescido de meta, que é o que o Bradial Chat guarda do seu lado: inboxIds (as caixas em que ele atende) e ignoreContactLabels.
Erros
\n403 — o assistente não pertence à conta da chave de API. O BFF resolve o assistente pela conta antes de chamar o upstream, então um id de outra conta nunca chega lá.Atualiza o assistente. É parcial: mande só os campos que quer mudar.
\nCorpo — todos opcionais:
\nname (string)description (string) — as instruções do assistente.model (string) — um dos id de Modelos disponíveis.temperature (número)followUp (objeto) — configuração de retomada. Formato livre.businessHours (objeto) — horário de atendimento. Formato livre.inboxIds (array de inteiros) — substitui o conjunto de caixas de entrada, não soma. Mande [] para desvincular de todas. Omitir deixa como está.ignoreContactLabels (array de inteiros) — mesma semântica de substituição.Atenção com inboxIds
Cada id é conferido contra a conta antes da escrita, com as linhas travadas. Um id de caixa de outra conta derruba a requisição inteira com ASST003 e nada é gravado — não há gravação parcial.
Nulo não passa
\ninboxIds: null e ignoreContactLabels: null são rejeitados com 400. Para limpar, use []; para não mexer, omita o campo.
Remove o assistente, junto com seus sub-agentes, ferramentas, servidores MCP e base de conhecimento.
\nAs caixas de entrada que apontavam para ele ficam sem assistente — as conversas passam a cair direto para os atendentes humanos.
\nOperação irreversível.
\n","urlObject":{"path":["chat","v1","assistants",":assistantId"],"host":["https://api.bradial.com.br"],"query":[],"variable":[{"type":"any","key":"assistantId"}]}},"response":[{"id":"d2ab34eb-9ff1-b5de-9382-3967d6c4c471","name":"200 OK","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.bradial.com.br/chat/v1/assistants/:assistantId","host":["https://api.bradial.com.br"],"path":["chat","v1","assistants",":assistantId"],"variable":[{"key":"assistantId"}]},"description":"Remove o assistente, junto com seus sub-agentes, ferramentas, servidores MCP e base de conhecimento.\n\nAs caixas de entrada que apontavam para ele ficam **sem assistente** — as conversas passam a cair direto para os atendentes humanos.\n\nOperação irreversível."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"3b511f00-4145-6325-e19f-0c8e326c3aa0"}],"id":"c89e7fbf-79df-4cf1-a85b-274638516d2a","_postman_id":"c89e7fbf-79df-4cf1-a85b-274638516d2a","description":""},{"name":"Relatórios","item":[{"name":"Atendimentos - Visão geral","id":"89be9973-37c5-2ebc-7c32-4602ddbf2b33","request":{"method":"GET","header":[{"key":"x-api-key","description":"Chave da conta. Identifica quem chama e a qual conta os dados pertencem.
\n","value":"your_api-key"}],"url":"https://api.bradial.com.br/chat/v1/reports/conversations/overview","description":"Indicadores consolidados de atendimentos no período: totais, curvas e comparação com o período anterior.
\nAutenticação. Envie a chave no header x-api-key. A chave já identifica a conta, então não existe id de conta na URL — o gateway resolve a conta a partir da própria chave. O header Authorization é ignorado; a chave é a única credencial.
Período. since e until são dias no formato AAAA-MM-DD, e until não pode ser anterior a since. Um período de um único dia é agrupado por hora; acima disso, por dia.
Filtros. Os nomes dos parâmetros são técnicos. Entre parênteses, como o campo aparece no produto: agentId (Usuário), teamId (Departamento), inboxId (Caixa de entrada), labelId (Etiqueta).
Obrigatório. Primeiro dia do período, no formato AAAA-MM-DD.
\n","type":"text/plain"},"key":"since","value":"2026-08-01"},{"description":{"content":"Obrigatório. Último dia do período, no formato AAAA-MM-DD. Não pode ser anterior a since.
\n","type":"text/plain"},"key":"until","value":"2026-08-31"},{"disabled":true,"description":{"content":"Opcional. Restringe ao usuário informado (campo Usuário no produto).
\n","type":"text/plain"},"key":"agentId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe ao departamento informado.
\n","type":"text/plain"},"key":"teamId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à caixa de entrada informada.
\n","type":"text/plain"},"key":"inboxId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à etiqueta informada.
\n","type":"text/plain"},"key":"labelId","value":""}],"variable":[]}},"response":[{"id":"a7cdde3e-edc6-c668-08ca-c60855db029a","name":"200 - Uma semana, agrupada por dia","originalRequest":{"method":"GET","header":[{"key":"x-api-key","description":"Chave da conta. Identifica quem chama e a qual conta os dados pertencem.","value":"your_api-key"}],"url":{"raw":"https://api.bradial.com.br/chat/v1/reports/conversations/overview","host":["https://api.bradial.com.br"],"path":["chat","v1","reports","conversations","overview"],"query":[{"key":"since","description":"Obrigatório. Primeiro dia do período, no formato AAAA-MM-DD.","value":"2026-08-01"},{"key":"until","description":"Obrigatório. Último dia do período, no formato AAAA-MM-DD. Não pode ser anterior a since.","value":"2026-08-31"},{"key":"agentId","description":"Opcional. Restringe ao usuário informado (campo Usuário no produto).","value":"","disabled":true},{"key":"teamId","description":"Opcional. Restringe ao departamento informado.","value":"","disabled":true},{"key":"inboxId","description":"Opcional. Restringe à caixa de entrada informada.","value":"","disabled":true},{"key":"labelId","description":"Opcional. Restringe à etiqueta informada.","value":"","disabled":true}]},"description":"Indicadores consolidados de atendimentos no período: totais, curvas e comparação com o período anterior.\n\n**Autenticação.** Envie a chave no header `x-api-key`. A chave já identifica a conta, então **não existe id de conta na URL** — o gateway resolve a conta a partir da própria chave. O header `Authorization` é ignorado; a chave é a única credencial.\n\n**Período.** `since` e `until` são dias no formato `AAAA-MM-DD`, e `until` não pode ser anterior a `since`. Um período de um único dia é agrupado por hora; acima disso, por dia.\n\n**Filtros.** Os nomes dos parâmetros são técnicos. Entre parênteses, como o campo aparece no produto: `agentId` (Usuário), `teamId` (Departamento), `inboxId` (Caixa de entrada), `labelId` (Etiqueta)."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"section\": \"conversations\",\n \"grain\": \"day\",\n \"range\": { \"since\": \"2026-08-01\", \"until\": \"2026-08-07\" },\n \"previousRange\": { \"since\": \"2026-07-25\", \"until\": \"2026-07-31\" },\n \"kpis\": [\n { \"id\": \"conversations\", \"value\": 1840, \"previousValue\": 1712, \"spark\": [240, 268, 301, 255, 262, 259, 255] },\n { \"id\": \"newConversations\", \"value\": 967, \"previousValue\": 903, \"spark\": [128, 141, 158, 134, 138, 136, 132] },\n { \"id\": \"newContacts\", \"value\": 412, \"previousValue\": 388, \"spark\": [55, 61, 68, 57, 58, 57, 56] },\n { \"id\": \"outboundConversations\", \"value\": 318, \"previousValue\": 276, \"spark\": [41, 46, 52, 44, 45, 45, 45] },\n { \"id\": \"incomingMessages\", \"value\": 9420, \"previousValue\": 8871, \"spark\": [1230, 1372, 1541, 1305, 1341, 1327, 1304] },\n { \"id\": \"outgoingMessages\", \"value\": 11208, \"previousValue\": 10502, \"spark\": [1463, 1632, 1833, 1553, 1595, 1579, 1553] },\n { \"id\": \"resolutions\", \"value\": 1602, \"previousValue\": 1498, \"spark\": [209, 233, 262, 222, 228, 226, 222] },\n { \"id\": \"resolutionRate\", \"value\": 87.1, \"previousValue\": 87.5, \"spark\": [87, 87, 87, 87, 87, 87, 87] },\n { \"id\": \"firstResponseTime\", \"value\": 142, \"previousValue\": 168, \"spark\": [151, 148, 139, 144, 140, 138, 134] },\n { \"id\": \"resolutionTime\", \"value\": 4380, \"previousValue\": 4712, \"spark\": [4500, 4420, 4310, 4390, 4360, 4340, 4320] }\n ],\n \"series\": {\n \"keys\": [\"conversations\", \"resolutions\"],\n \"points\": [\n { \"at\": \"2026-08-01\", \"values\": { \"conversations\": 240, \"resolutions\": 209 } },\n { \"at\": \"2026-08-02\", \"values\": { \"conversations\": 268, \"resolutions\": 233 } },\n { \"at\": \"2026-08-03\", \"values\": { \"conversations\": 301, \"resolutions\": 262 } }\n ]\n },\n \"accountConversations\": null\n}"}],"_postman_id":"89be9973-37c5-2ebc-7c32-4602ddbf2b33"},{"name":"Atendimentos - Download","id":"8ab92653-20e3-b277-7e57-85a608458e7a","request":{"method":"GET","header":[{"value":"your_api-key","description":"Chave da conta. Identifica quem chama e a qual conta os dados pertencem.
\n","key":"x-api-key"}],"url":"https://api.bradial.com.br/chat/v1/reports/conversations/download","description":"Planilha CSV com uma linha por atendimento do período. A resposta é text/csv, não JSON.
Autenticação. Header x-api-key. A chave identifica a conta — não há id de conta na URL, e o header Authorization é ignorado.
Período. since e until no formato AAAA-MM-DD; until não pode ser anterior a since.
Fuso. As datas dentro do arquivo são escritas no fuso que timezoneOffsetHours indicar. Sem ele, saem em UTC.
Filtros. agentId (Usuário), teamId (Departamento), inboxId (Caixa de entrada), labelId (Etiqueta).
Obrigatório. Primeiro dia do período, no formato AAAA-MM-DD.
\n","type":"text/plain"},"key":"since","value":"2026-08-01"},{"description":{"content":"Obrigatório. Último dia do período, no formato AAAA-MM-DD. Não pode ser anterior a since.
\n","type":"text/plain"},"key":"until","value":"2026-08-31"},{"disabled":true,"description":{"content":"Opcional. Fuso em que as datas do arquivo são escritas, de -12 a 14. Padrão 0 (UTC); use -3 para o horário de Brasília.
\n","type":"text/plain"},"key":"timezoneOffsetHours","value":"-3"},{"disabled":true,"description":{"content":"Opcional. Restringe ao usuário informado (campo Usuário no produto).
\n","type":"text/plain"},"key":"agentId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe ao departamento informado.
\n","type":"text/plain"},"key":"teamId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à caixa de entrada informada.
\n","type":"text/plain"},"key":"inboxId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à etiqueta informada.
\n","type":"text/plain"},"key":"labelId","value":""}],"variable":[]}},"response":[],"_postman_id":"8ab92653-20e3-b277-7e57-85a608458e7a"},{"name":"Usuários - Visão geral","id":"4d302c28-2f11-16ae-846b-67b48c32ca1f","request":{"method":"GET","header":[{"description":"Chave da conta. Identifica quem chama e a qual conta os dados pertencem.
\n","key":"x-api-key","value":"your_api-key"}],"url":"https://api.bradial.com.br/chat/v1/reports/agents/overview","description":"Indicadores de desempenho por usuário no período.
\nAutenticação. Header x-api-key. A chave identifica a conta — não há id de conta na URL, e o header Authorization é ignorado.
Período. since e until no formato AAAA-MM-DD; until não pode ser anterior a since.
Escopo. Sem agentId, a resposta traz os números da conta inteira. Informe agentId para os de um usuário — é o que a tela do produto faz.
Filtros. agentId (Usuário), teamId (Departamento), inboxId (Caixa de entrada), labelId (Etiqueta).
Obrigatório. Primeiro dia do período, no formato AAAA-MM-DD.
\n","type":"text/plain"},"key":"since","value":"2026-08-01"},{"description":{"content":"Obrigatório. Último dia do período, no formato AAAA-MM-DD. Não pode ser anterior a since.
\n","type":"text/plain"},"key":"until","value":"2026-08-31"},{"disabled":true,"description":{"content":"Opcional. Restringe ao usuário informado (campo Usuário no produto). Sem ele, a resposta é da conta inteira.
\n","type":"text/plain"},"key":"agentId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe ao departamento informado.
\n","type":"text/plain"},"key":"teamId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à caixa de entrada informada.
\n","type":"text/plain"},"key":"inboxId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à etiqueta informada.
\n","type":"text/plain"},"key":"labelId","value":""}],"variable":[]}},"response":[{"id":"7d3b60f7-3f8e-0730-1087-e41c316b18b9","name":"200 - Uma semana, agrupada por dia","originalRequest":{"method":"GET","header":[{"description":"Chave da conta. Identifica quem chama e a qual conta os dados pertencem.","key":"x-api-key","value":"your_api-key"}],"url":{"raw":"https://api.bradial.com.br/chat/v1/reports/agents/overview","host":["https://api.bradial.com.br"],"path":["chat","v1","reports","agents","overview"],"query":[{"description":"Obrigatório. Primeiro dia do período, no formato AAAA-MM-DD.","key":"since","value":"2026-08-01"},{"description":"Obrigatório. Último dia do período, no formato AAAA-MM-DD. Não pode ser anterior a since.","key":"until","value":"2026-08-31"},{"description":"Opcional. Restringe ao usuário informado (campo Usuário no produto). Sem ele, a resposta é da conta inteira.","key":"agentId","value":"","disabled":true},{"description":"Opcional. Restringe ao departamento informado.","key":"teamId","value":"","disabled":true},{"description":"Opcional. Restringe à caixa de entrada informada.","key":"inboxId","value":"","disabled":true},{"description":"Opcional. Restringe à etiqueta informada.","key":"labelId","value":"","disabled":true}]},"description":"Indicadores de desempenho por usuário no período.\n\n**Autenticação.** Header `x-api-key`. A chave identifica a conta — não há id de conta na URL, e o header `Authorization` é ignorado.\n\n**Período.** `since` e `until` no formato `AAAA-MM-DD`; `until` não pode ser anterior a `since`.\n\n**Escopo.** Sem `agentId`, a resposta traz os números da conta inteira. Informe `agentId` para os de um usuário — é o que a tela do produto faz.\n\n**Filtros.** `agentId` (Usuário), `teamId` (Departamento), `inboxId` (Caixa de entrada), `labelId` (Etiqueta)."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"section\": \"agents\",\n \"grain\": \"day\",\n \"range\": { \"since\": \"2026-08-01\", \"until\": \"2026-08-07\" },\n \"previousRange\": { \"since\": \"2026-07-25\", \"until\": \"2026-07-31\" },\n \"kpis\": [\n { \"id\": \"conversations\", \"value\": 1840, \"previousValue\": 1712, \"spark\": [240, 268, 301, 255, 262, 259, 255] },\n { \"id\": \"incomingMessages\", \"value\": 9420, \"previousValue\": 8871, \"spark\": [1230, 1372, 1541, 1305, 1341, 1327, 1304] },\n { \"id\": \"outgoingMessages\", \"value\": 11208, \"previousValue\": 10502, \"spark\": [1463, 1632, 1833, 1553, 1595, 1579, 1553] },\n { \"id\": \"resolutions\", \"value\": 1602, \"previousValue\": 1498, \"spark\": [209, 233, 262, 222, 228, 226, 222] },\n { \"id\": \"resolutionRate\", \"value\": 87.1, \"previousValue\": 87.5, \"spark\": [87, 87, 87, 87, 87, 87, 87] },\n { \"id\": \"firstResponseTime\", \"value\": 142, \"previousValue\": 168, \"spark\": [151, 148, 139, 144, 140, 138, 134] },\n { \"id\": \"resolutionTime\", \"value\": 4380, \"previousValue\": 4712, \"spark\": [4500, 4420, 4310, 4390, 4360, 4340, 4320] },\n { \"id\": \"outboundConversations\", \"value\": 318, \"previousValue\": 276, \"spark\": [41, 46, 52, 44, 45, 45, 45] }\n ],\n \"series\": {\n \"keys\": [\"conversations\", \"resolutions\"],\n \"points\": [\n { \"at\": \"2026-08-01\", \"values\": { \"conversations\": 240, \"resolutions\": 209 } },\n { \"at\": \"2026-08-02\", \"values\": { \"conversations\": 268, \"resolutions\": 233 } },\n { \"at\": \"2026-08-03\", \"values\": { \"conversations\": 301, \"resolutions\": 262 } }\n ]\n },\n \"accountConversations\": 1840\n}"}],"_postman_id":"4d302c28-2f11-16ae-846b-67b48c32ca1f"},{"name":"CSAT - Visão geral","id":"3bc77d2d-1239-1f2a-b2ee-46972fd6fe9e","request":{"method":"GET","header":[{"description":"Chave da conta. Identifica quem chama e a qual conta os dados pertencem.
\n","key":"x-api-key","value":"your_api-key"}],"url":"https://api.bradial.com.br/chat/v1/reports/csat/overview","description":"Satisfação do cliente no período: score, taxa de resposta e distribuição por nota.
\nAutenticação. Header x-api-key. A chave identifica a conta — não há id de conta na URL, e o header Authorization é ignorado.
Período. since e until no formato AAAA-MM-DD; until não pode ser anterior a since.
Sobre o score. É a proporção de respostas positivas — notas 4 e 5 sobre o total de respostas — e não a média das notas. É o mesmo cálculo que a tela do produto mostra.
\nDistribuição. Vem só com as notas que tiveram resposta. Uma nota sem nenhuma resposta no período é omitida em vez de aparecer com zero.
\nFiltros. agentId (Usuário), teamId (Departamento), inboxId (Caixa de entrada), labelId (Etiqueta).
Obrigatório. Primeiro dia do período, no formato AAAA-MM-DD.
\n","type":"text/plain"},"key":"since","value":"2026-08-01"},{"description":{"content":"Obrigatório. Último dia do período, no formato AAAA-MM-DD. Não pode ser anterior a since.
\n","type":"text/plain"},"key":"until","value":"2026-08-31"},{"disabled":true,"description":{"content":"Opcional. Restringe ao usuário informado (campo Usuário no produto).
\n","type":"text/plain"},"key":"agentId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe ao departamento informado.
\n","type":"text/plain"},"key":"teamId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à caixa de entrada informada.
\n","type":"text/plain"},"key":"inboxId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à etiqueta informada.
\n","type":"text/plain"},"key":"labelId","value":""}],"variable":[]}},"response":[{"id":"192b7f81-8ce1-ddb8-4564-b0cc0dce9433","name":"200 - Uma semana, com a distribuição por nota","originalRequest":{"method":"GET","header":[{"description":"Chave da conta. Identifica quem chama e a qual conta os dados pertencem.","key":"x-api-key","value":"your_api-key"}],"url":{"raw":"https://api.bradial.com.br/chat/v1/reports/csat/overview","host":["https://api.bradial.com.br"],"path":["chat","v1","reports","csat","overview"],"query":[{"description":"Obrigatório. Primeiro dia do período, no formato AAAA-MM-DD.","key":"since","value":"2026-08-01"},{"description":"Obrigatório. Último dia do período, no formato AAAA-MM-DD. Não pode ser anterior a since.","key":"until","value":"2026-08-31"},{"description":"Opcional. Restringe ao usuário informado (campo Usuário no produto).","key":"agentId","value":"","disabled":true},{"description":"Opcional. Restringe ao departamento informado.","key":"teamId","value":"","disabled":true},{"description":"Opcional. Restringe à caixa de entrada informada.","key":"inboxId","value":"","disabled":true},{"description":"Opcional. Restringe à etiqueta informada.","key":"labelId","value":"","disabled":true}]},"description":"Satisfação do cliente no período: score, taxa de resposta e distribuição por nota.\n\n**Autenticação.** Header `x-api-key`. A chave identifica a conta — não há id de conta na URL, e o header `Authorization` é ignorado.\n\n**Período.** `since` e `until` no formato `AAAA-MM-DD`; `until` não pode ser anterior a `since`.\n\n**Sobre o score.** É a **proporção de respostas positivas** — notas 4 e 5 sobre o total de respostas — e não a média das notas. É o mesmo cálculo que a tela do produto mostra.\n\n**Distribuição.** Vem só com as notas que tiveram resposta. Uma nota sem nenhuma resposta no período é omitida em vez de aparecer com zero.\n\n**Filtros.** `agentId` (Usuário), `teamId` (Departamento), `inboxId` (Caixa de entrada), `labelId` (Etiqueta)."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"section\": \"csat\",\n \"grain\": \"day\",\n \"range\": { \"since\": \"2026-08-01\", \"until\": \"2026-08-07\" },\n \"previousRange\": { \"since\": \"2026-07-25\", \"until\": \"2026-07-31\" },\n \"kpis\": [\n { \"id\": \"csatScore\", \"value\": 92.4, \"previousValue\": 90.8, \"spark\": [92, 93, 92, 91, 93, 92, 93] },\n { \"id\": \"csatResponses\", \"value\": 298, \"previousValue\": 271, \"spark\": [39, 43, 48, 41, 42, 42, 43] },\n { \"id\": \"csatResponseRate\", \"value\": 18.6, \"previousValue\": 18.1, \"spark\": [18, 19, 18, 19, 18, 19, 19] },\n { \"id\": \"resolutions\", \"value\": 1602, \"previousValue\": 1498, \"spark\": [209, 233, 262, 222, 228, 226, 222] }\n ],\n \"series\": {\n \"keys\": [\"conversations\", \"resolutions\"],\n \"points\": [\n { \"at\": \"2026-08-01\", \"values\": { \"conversations\": 240, \"resolutions\": 209 } },\n { \"at\": \"2026-08-02\", \"values\": { \"conversations\": 268, \"resolutions\": 233 } },\n { \"at\": \"2026-08-03\", \"values\": { \"conversations\": 301, \"resolutions\": 262 } }\n ]\n },\n \"accountConversations\": 1840,\n \"positiveResponses\": 275,\n \"distribution\": [\n { \"rating\": 5, \"count\": 214 },\n { \"rating\": 4, \"count\": 61 },\n { \"rating\": 3, \"count\": 12 },\n { \"rating\": 1, \"count\": 11 }\n ]\n}"}],"_postman_id":"3bc77d2d-1239-1f2a-b2ee-46972fd6fe9e"},{"name":"CSAT - Respostas","id":"9d86ef21-cec6-e944-6398-8eb078f3e947","request":{"method":"GET","header":[{"description":"Chave da conta. Identifica quem chama e a qual conta os dados pertencem.
\n","value":"your_api-key","key":"x-api-key"}],"url":"https://api.bradial.com.br/chat/v1/reports/csat/responses","description":"Lista paginada das respostas de CSAT do período, uma linha por resposta.
\nAutenticação. Header x-api-key. A chave identifica a conta — não há id de conta na URL, e o header Authorization é ignorado.
Período. since e until no formato AAAA-MM-DD; until não pode ser anterior a since.
Paginação. page começa em 1. O total vem na resposta, para você saber quantas páginas existem.
Nota. rating aceita 1 a 5 e é o único endpoint de CSAT que aceita esse filtro: nas demais rotas ele seria um número errado, porque um score calculado só sobre as notas 5 daria sempre 100%.
Filtros. agentId (Usuário), teamId (Departamento), inboxId (Caixa de entrada), labelId (Etiqueta).
Obrigatório. Primeiro dia do período, no formato AAAA-MM-DD.
\n","type":"text/plain"},"key":"since","value":"2026-08-01"},{"description":{"content":"Obrigatório. Último dia do período, no formato AAAA-MM-DD. Não pode ser anterior a since.
\n","type":"text/plain"},"key":"until","value":"2026-08-31"},{"description":{"content":"Opcional. Página da listagem, começando em 1. Padrão 1.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Opcional. Restringe a uma nota, de 1 a 5.
\n","type":"text/plain"},"key":"rating","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe ao usuário informado (campo Usuário no produto).
\n","type":"text/plain"},"key":"agentId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe ao departamento informado.
\n","type":"text/plain"},"key":"teamId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à caixa de entrada informada.
\n","type":"text/plain"},"key":"inboxId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à etiqueta informada.
\n","type":"text/plain"},"key":"labelId","value":""}],"variable":[]}},"response":[{"id":"f8bc63d4-1815-9024-a642-e2adc183273f","name":"200 - Primeira página","originalRequest":{"method":"GET","header":[{"description":"Chave da conta. Identifica quem chama e a qual conta os dados pertencem.","value":"your_api-key","key":"x-api-key"}],"url":{"raw":"https://api.bradial.com.br/chat/v1/reports/csat/responses","host":["https://api.bradial.com.br"],"path":["chat","v1","reports","csat","responses"],"query":[{"description":"Obrigatório. Primeiro dia do período, no formato AAAA-MM-DD.","value":"2026-08-01","key":"since"},{"description":"Obrigatório. Último dia do período, no formato AAAA-MM-DD. Não pode ser anterior a since.","value":"2026-08-31","key":"until"},{"description":"Opcional. Página da listagem, começando em 1. Padrão 1.","value":"1","key":"page"},{"description":"Opcional. Restringe a uma nota, de 1 a 5.","value":"","key":"rating","disabled":true},{"description":"Opcional. Restringe ao usuário informado (campo Usuário no produto).","value":"","key":"agentId","disabled":true},{"description":"Opcional. Restringe ao departamento informado.","value":"","key":"teamId","disabled":true},{"description":"Opcional. Restringe à caixa de entrada informada.","value":"","key":"inboxId","disabled":true},{"description":"Opcional. Restringe à etiqueta informada.","value":"","key":"labelId","disabled":true}]},"description":"Lista paginada das respostas de CSAT do período, uma linha por resposta.\n\n**Autenticação.** Header `x-api-key`. A chave identifica a conta — não há id de conta na URL, e o header `Authorization` é ignorado.\n\n**Período.** `since` e `until` no formato `AAAA-MM-DD`; `until` não pode ser anterior a `since`.\n\n**Paginação.** `page` começa em 1. O total vem na resposta, para você saber quantas páginas existem.\n\n**Nota.** `rating` aceita 1 a 5 e é o único endpoint de CSAT que aceita esse filtro: nas demais rotas ele seria um número errado, porque um score calculado só sobre as notas 5 daria sempre 100%.\n\n**Filtros.** `agentId` (Usuário), `teamId` (Departamento), `inboxId` (Caixa de entrada), `labelId` (Etiqueta)."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"conversationId\": 88214,\n \"contactName\": \"Ana Souza\",\n \"isGroup\": false,\n \"respondentName\": \"Ana Souza\",\n \"agentName\": \"Carlos Lima\",\n \"rating\": 5,\n \"feedbackMessage\": \"Atendimento rápido, obrigada!\",\n \"createdAt\": \"2026-08-03T14:22:10.000Z\"\n },\n {\n \"conversationId\": 88190,\n \"contactName\": \"Grupo Condomínio Aurora\",\n \"isGroup\": true,\n \"respondentName\": \"Marcos Dias\",\n \"agentName\": \"Beatriz Nunes\",\n \"rating\": 4,\n \"feedbackMessage\": null,\n \"createdAt\": \"2026-08-03T11:05:47.000Z\"\n }\n ],\n \"items\": 298,\n \"page\": 1\n}"}],"_postman_id":"9d86ef21-cec6-e944-6398-8eb078f3e947"},{"name":"CSAT - Download","id":"51faab5a-26ad-bb14-46a9-3853623075b4","request":{"method":"GET","header":[{"description":"Chave da conta. Identifica quem chama e a qual conta os dados pertencem.
\n","key":"x-api-key","value":"your_api-key"}],"url":"https://api.bradial.com.br/chat/v1/reports/csat/download","description":"Planilha CSV com uma linha por resposta de CSAT do período. A resposta é text/csv, não JSON.
Autenticação. Header x-api-key. A chave identifica a conta — não há id de conta na URL, e o header Authorization é ignorado.
Período. since e until no formato AAAA-MM-DD; until não pode ser anterior a since.
Fuso. As datas dentro do arquivo são escritas no fuso que timezoneOffsetHours indicar. Sem ele, saem em UTC.
Filtros. agentId (Usuário), teamId (Departamento), inboxId (Caixa de entrada), labelId (Etiqueta).
Obrigatório. Primeiro dia do período, no formato AAAA-MM-DD.
\n","type":"text/plain"},"key":"since","value":"2026-08-01"},{"description":{"content":"Obrigatório. Último dia do período, no formato AAAA-MM-DD. Não pode ser anterior a since.
\n","type":"text/plain"},"key":"until","value":"2026-08-31"},{"disabled":true,"description":{"content":"Opcional. Fuso em que as datas do arquivo são escritas, de -12 a 14. Padrão 0 (UTC); use -3 para o horário de Brasília.
\n","type":"text/plain"},"key":"timezoneOffsetHours","value":"-3"},{"disabled":true,"description":{"content":"Opcional. Restringe ao usuário informado (campo Usuário no produto).
\n","type":"text/plain"},"key":"agentId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe ao departamento informado.
\n","type":"text/plain"},"key":"teamId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à caixa de entrada informada.
\n","type":"text/plain"},"key":"inboxId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à etiqueta informada.
\n","type":"text/plain"},"key":"labelId","value":""}],"variable":[]}},"response":[],"_postman_id":"51faab5a-26ad-bb14-46a9-3853623075b4"},{"name":"Caixas de Entrada - Visão geral","id":"fb1c9309-5209-859b-25b4-78527d2f7436","request":{"method":"GET","header":[{"description":"Chave da conta. Identifica quem chama e a qual conta os dados pertencem.
\n","value":"your_api-key","key":"x-api-key"}],"url":"https://api.bradial.com.br/chat/v1/reports/inboxes/overview","description":"Indicadores por caixa de entrada no período.
\nAutenticação. Header x-api-key. A chave identifica a conta — não há id de conta na URL, e o header Authorization é ignorado.
Período. since e until no formato AAAA-MM-DD; until não pode ser anterior a since.
Escopo. Sem inboxId, a resposta traz os números da conta inteira. Informe inboxId para os de uma caixa — é o que a tela do produto faz.
Canais. O chat interno não entra em nenhum relatório. Uma caixa desse tipo não aparece aqui nem responde por filtro.
\nFiltros. agentId (Usuário), teamId (Departamento), inboxId (Caixa de entrada), labelId (Etiqueta).
Obrigatório. Primeiro dia do período, no formato AAAA-MM-DD.
\n","type":"text/plain"},"key":"since","value":"2026-08-01"},{"description":{"content":"Obrigatório. Último dia do período, no formato AAAA-MM-DD. Não pode ser anterior a since.
\n","type":"text/plain"},"key":"until","value":"2026-08-31"},{"disabled":true,"description":{"content":"Opcional. Restringe à caixa de entrada informada. Sem ele, a resposta é da conta inteira.
\n","type":"text/plain"},"key":"inboxId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe ao usuário informado (campo Usuário no produto).
\n","type":"text/plain"},"key":"agentId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe ao departamento informado.
\n","type":"text/plain"},"key":"teamId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à etiqueta informada.
\n","type":"text/plain"},"key":"labelId","value":""}],"variable":[]}},"response":[{"id":"1ddecf4e-c412-5f61-ec82-cc1c1f369c46","name":"200 - Uma semana, agrupada por dia","originalRequest":{"method":"GET","header":[{"description":"Chave da conta. Identifica quem chama e a qual conta os dados pertencem.","value":"your_api-key","key":"x-api-key"}],"url":{"raw":"https://api.bradial.com.br/chat/v1/reports/inboxes/overview","host":["https://api.bradial.com.br"],"path":["chat","v1","reports","inboxes","overview"],"query":[{"description":"Obrigatório. Primeiro dia do período, no formato AAAA-MM-DD.","value":"2026-08-01","key":"since"},{"description":"Obrigatório. Último dia do período, no formato AAAA-MM-DD. Não pode ser anterior a since.","value":"2026-08-31","key":"until"},{"description":"Opcional. Restringe à caixa de entrada informada. Sem ele, a resposta é da conta inteira.","value":"","key":"inboxId","disabled":true},{"description":"Opcional. Restringe ao usuário informado (campo Usuário no produto).","value":"","key":"agentId","disabled":true},{"description":"Opcional. Restringe ao departamento informado.","value":"","key":"teamId","disabled":true},{"description":"Opcional. Restringe à etiqueta informada.","value":"","key":"labelId","disabled":true}]},"description":"Indicadores por caixa de entrada no período.\n\n**Autenticação.** Header `x-api-key`. A chave identifica a conta — não há id de conta na URL, e o header `Authorization` é ignorado.\n\n**Período.** `since` e `until` no formato `AAAA-MM-DD`; `until` não pode ser anterior a `since`.\n\n**Escopo.** Sem `inboxId`, a resposta traz os números da conta inteira. Informe `inboxId` para os de uma caixa — é o que a tela do produto faz.\n\n**Canais.** O chat interno não entra em nenhum relatório. Uma caixa desse tipo não aparece aqui nem responde por filtro.\n\n**Filtros.** `agentId` (Usuário), `teamId` (Departamento), `inboxId` (Caixa de entrada), `labelId` (Etiqueta)."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"section\": \"inboxes\",\n \"grain\": \"day\",\n \"range\": { \"since\": \"2026-08-01\", \"until\": \"2026-08-07\" },\n \"previousRange\": { \"since\": \"2026-07-25\", \"until\": \"2026-07-31\" },\n \"kpis\": [\n { \"id\": \"conversations\", \"value\": 1840, \"previousValue\": 1712, \"spark\": [240, 268, 301, 255, 262, 259, 255] },\n { \"id\": \"incomingMessages\", \"value\": 9420, \"previousValue\": 8871, \"spark\": [1230, 1372, 1541, 1305, 1341, 1327, 1304] },\n { \"id\": \"outgoingMessages\", \"value\": 11208, \"previousValue\": 10502, \"spark\": [1463, 1632, 1833, 1553, 1595, 1579, 1553] },\n { \"id\": \"resolutions\", \"value\": 1602, \"previousValue\": 1498, \"spark\": [209, 233, 262, 222, 228, 226, 222] },\n { \"id\": \"resolutionRate\", \"value\": 87.1, \"previousValue\": 87.5, \"spark\": [87, 87, 87, 87, 87, 87, 87] },\n { \"id\": \"firstResponseTime\", \"value\": 142, \"previousValue\": 168, \"spark\": [151, 148, 139, 144, 140, 138, 134] },\n { \"id\": \"resolutionTime\", \"value\": 4380, \"previousValue\": 4712, \"spark\": [4500, 4420, 4310, 4390, 4360, 4340, 4320] },\n { \"id\": \"outboundConversations\", \"value\": 318, \"previousValue\": 276, \"spark\": [41, 46, 52, 44, 45, 45, 45] }\n ],\n \"series\": {\n \"keys\": [\"conversations\", \"resolutions\"],\n \"points\": [\n { \"at\": \"2026-08-01\", \"values\": { \"conversations\": 240, \"resolutions\": 209 } },\n { \"at\": \"2026-08-02\", \"values\": { \"conversations\": 268, \"resolutions\": 233 } },\n { \"at\": \"2026-08-03\", \"values\": { \"conversations\": 301, \"resolutions\": 262 } }\n ]\n },\n \"accountConversations\": 1840\n}"}],"_postman_id":"fb1c9309-5209-859b-25b4-78527d2f7436"},{"name":"Caixas de Entrada - Download","id":"3ecd67db-4d4b-41b7-7e7e-be279df880bc","request":{"method":"GET","header":[{"key":"x-api-key","value":"your_api-key","description":"Chave da conta. Identifica quem chama e a qual conta os dados pertencem.
\n"}],"url":"https://api.bradial.com.br/chat/v1/reports/inboxes/download","description":"Planilha CSV com os indicadores por caixa de entrada no período. A resposta é text/csv, não JSON.
Autenticação. Header x-api-key. A chave identifica a conta — não há id de conta na URL, e o header Authorization é ignorado.
Período. since e until no formato AAAA-MM-DD; until não pode ser anterior a since.
Fuso. As datas dentro do arquivo são escritas no fuso que timezoneOffsetHours indicar. Sem ele, saem em UTC.
Filtros. agentId (Usuário), teamId (Departamento), inboxId (Caixa de entrada), labelId (Etiqueta).
Obrigatório. Primeiro dia do período, no formato AAAA-MM-DD.
\n","type":"text/plain"},"key":"since","value":"2026-08-01"},{"description":{"content":"Obrigatório. Último dia do período, no formato AAAA-MM-DD. Não pode ser anterior a since.
\n","type":"text/plain"},"key":"until","value":"2026-08-31"},{"disabled":true,"description":{"content":"Opcional. Fuso em que as datas do arquivo são escritas, de -12 a 14. Padrão 0 (UTC); use -3 para o horário de Brasília.
\n","type":"text/plain"},"key":"timezoneOffsetHours","value":"-3"},{"disabled":true,"description":{"content":"Opcional. Restringe à caixa de entrada informada.
\n","type":"text/plain"},"key":"inboxId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe ao usuário informado (campo Usuário no produto).
\n","type":"text/plain"},"key":"agentId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe ao departamento informado.
\n","type":"text/plain"},"key":"teamId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à etiqueta informada.
\n","type":"text/plain"},"key":"labelId","value":""}],"variable":[]}},"response":[],"_postman_id":"3ecd67db-4d4b-41b7-7e7e-be279df880bc"},{"name":"Etiquetas - Visão geral","id":"9191b9eb-3f94-8982-6fbc-8496f445f91c","request":{"method":"GET","header":[{"description":"Chave da conta. Identifica quem chama e a qual conta os dados pertencem.
\n","key":"x-api-key","value":"your_api-key"}],"url":"https://api.bradial.com.br/chat/v1/reports/labels/overview","description":"Indicadores por etiqueta no período, incluindo o ranking das mais aplicadas.
\nAutenticação. Header x-api-key. A chave identifica a conta — não há id de conta na URL, e o header Authorization é ignorado.
Período. since e until no formato AAAA-MM-DD; until não pode ser anterior a since.
Escopo. Sem labelId, a resposta traz os números da conta inteira. Informe labelId para os de uma etiqueta — é o que a tela do produto faz.
Filtros. agentId (Usuário), teamId (Departamento), inboxId (Caixa de entrada), labelId (Etiqueta).
Obrigatório. Primeiro dia do período, no formato AAAA-MM-DD.
\n","type":"text/plain"},"key":"since","value":"2026-08-01"},{"description":{"content":"Obrigatório. Último dia do período, no formato AAAA-MM-DD. Não pode ser anterior a since.
\n","type":"text/plain"},"key":"until","value":"2026-08-31"},{"disabled":true,"description":{"content":"Opcional. Restringe à etiqueta informada. Sem ele, a resposta é da conta inteira.
\n","type":"text/plain"},"key":"labelId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe ao usuário informado (campo Usuário no produto).
\n","type":"text/plain"},"key":"agentId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe ao departamento informado.
\n","type":"text/plain"},"key":"teamId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à caixa de entrada informada.
\n","type":"text/plain"},"key":"inboxId","value":""}],"variable":[]}},"response":[{"id":"717ef2db-f71a-021d-4b85-6b3dee21879f","name":"200 - Uma semana, com o ranking de etiquetas","originalRequest":{"method":"GET","header":[{"description":"Chave da conta. Identifica quem chama e a qual conta os dados pertencem.","key":"x-api-key","value":"your_api-key"}],"url":{"raw":"https://api.bradial.com.br/chat/v1/reports/labels/overview","host":["https://api.bradial.com.br"],"path":["chat","v1","reports","labels","overview"],"query":[{"key":"since","description":"Obrigatório. Primeiro dia do período, no formato AAAA-MM-DD.","value":"2026-08-01"},{"key":"until","description":"Obrigatório. Último dia do período, no formato AAAA-MM-DD. Não pode ser anterior a since.","value":"2026-08-31"},{"key":"labelId","description":"Opcional. Restringe à etiqueta informada. Sem ele, a resposta é da conta inteira.","value":"","disabled":true},{"key":"agentId","description":"Opcional. Restringe ao usuário informado (campo Usuário no produto).","value":"","disabled":true},{"key":"teamId","description":"Opcional. Restringe ao departamento informado.","value":"","disabled":true},{"key":"inboxId","description":"Opcional. Restringe à caixa de entrada informada.","value":"","disabled":true}]},"description":"Indicadores por etiqueta no período, incluindo o ranking das mais aplicadas.\n\n**Autenticação.** Header `x-api-key`. A chave identifica a conta — não há id de conta na URL, e o header `Authorization` é ignorado.\n\n**Período.** `since` e `until` no formato `AAAA-MM-DD`; `until` não pode ser anterior a `since`.\n\n**Escopo.** Sem `labelId`, a resposta traz os números da conta inteira. Informe `labelId` para os de uma etiqueta — é o que a tela do produto faz.\n\n**Filtros.** `agentId` (Usuário), `teamId` (Departamento), `inboxId` (Caixa de entrada), `labelId` (Etiqueta)."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"section\": \"labels\",\n \"grain\": \"day\",\n \"range\": { \"since\": \"2026-08-01\", \"until\": \"2026-08-07\" },\n \"previousRange\": { \"since\": \"2026-07-25\", \"until\": \"2026-07-31\" },\n \"kpis\": [\n { \"id\": \"conversations\", \"value\": 1840, \"previousValue\": 1712, \"spark\": [240, 268, 301, 255, 262, 259, 255] },\n { \"id\": \"incomingMessages\", \"value\": 9420, \"previousValue\": 8871, \"spark\": [1230, 1372, 1541, 1305, 1341, 1327, 1304] },\n { \"id\": \"outgoingMessages\", \"value\": 11208, \"previousValue\": 10502, \"spark\": [1463, 1632, 1833, 1553, 1595, 1579, 1553] },\n { \"id\": \"resolutions\", \"value\": 1602, \"previousValue\": 1498, \"spark\": [209, 233, 262, 222, 228, 226, 222] },\n { \"id\": \"resolutionRate\", \"value\": 87.1, \"previousValue\": 87.5, \"spark\": [87, 87, 87, 87, 87, 87, 87] },\n { \"id\": \"firstResponseTime\", \"value\": 142, \"previousValue\": 168, \"spark\": [151, 148, 139, 144, 140, 138, 134] },\n { \"id\": \"resolutionTime\", \"value\": 4380, \"previousValue\": 4712, \"spark\": [4500, 4420, 4310, 4390, 4360, 4340, 4320] }\n ],\n \"series\": {\n \"keys\": [\"conversations\", \"resolutions\"],\n \"points\": [\n { \"at\": \"2026-08-01\", \"values\": { \"conversations\": 240, \"resolutions\": 209 } },\n { \"at\": \"2026-08-02\", \"values\": { \"conversations\": 268, \"resolutions\": 233 } },\n { \"at\": \"2026-08-03\", \"values\": { \"conversations\": 301, \"resolutions\": 262 } }\n ]\n },\n \"accountConversations\": 1840,\n \"ranking\": [\n { \"id\": 30, \"name\": \"Segunda via\", \"value\": 412 },\n { \"id\": 31, \"name\": \"Cancelamento\", \"value\": 268 },\n { \"id\": 32, \"name\": \"Elogio\", \"value\": 97 }\n ]\n}"}],"_postman_id":"9191b9eb-3f94-8982-6fbc-8496f445f91c"},{"name":"Etiquetas - Download","id":"e1fe12f8-1482-6b11-3d7a-9572e7768a11","request":{"method":"GET","header":[{"key":"x-api-key","description":"Chave da conta. Identifica quem chama e a qual conta os dados pertencem.
\n","value":"your_api-key"}],"url":"https://api.bradial.com.br/chat/v1/reports/labels/download","description":"Planilha CSV com os indicadores por etiqueta no período. A resposta é text/csv, não JSON.
Autenticação. Header x-api-key. A chave identifica a conta — não há id de conta na URL, e o header Authorization é ignorado.
Período. since e until no formato AAAA-MM-DD; until não pode ser anterior a since.
Fuso. As datas dentro do arquivo são escritas no fuso que timezoneOffsetHours indicar. Sem ele, saem em UTC.
Filtros. agentId (Usuário), teamId (Departamento), inboxId (Caixa de entrada), labelId (Etiqueta).
Obrigatório. Primeiro dia do período, no formato AAAA-MM-DD.
\n","type":"text/plain"},"key":"since","value":"2026-08-01"},{"description":{"content":"Obrigatório. Último dia do período, no formato AAAA-MM-DD. Não pode ser anterior a since.
\n","type":"text/plain"},"key":"until","value":"2026-08-31"},{"disabled":true,"description":{"content":"Opcional. Fuso em que as datas do arquivo são escritas, de -12 a 14. Padrão 0 (UTC); use -3 para o horário de Brasília.
\n","type":"text/plain"},"key":"timezoneOffsetHours","value":"-3"},{"disabled":true,"description":{"content":"Opcional. Restringe à etiqueta informada.
\n","type":"text/plain"},"key":"labelId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe ao usuário informado (campo Usuário no produto).
\n","type":"text/plain"},"key":"agentId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe ao departamento informado.
\n","type":"text/plain"},"key":"teamId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à caixa de entrada informada.
\n","type":"text/plain"},"key":"inboxId","value":""}],"variable":[]}},"response":[],"_postman_id":"e1fe12f8-1482-6b11-3d7a-9572e7768a11"},{"name":"Departamentos - Visão geral","id":"442ed1a5-4d3a-7492-0d33-611c4f3d9af0","request":{"method":"GET","header":[{"key":"x-api-key","description":"Chave da conta. Identifica quem chama e a qual conta os dados pertencem.
\n","value":"your_api-key"}],"url":"https://api.bradial.com.br/chat/v1/reports/teams/overview","description":"Indicadores por departamento no período.
\nAutenticação. Header x-api-key. A chave identifica a conta — não há id de conta na URL, e o header Authorization é ignorado.
Período. since e until no formato AAAA-MM-DD; until não pode ser anterior a since.
Escopo. Sem teamId, a resposta traz os números da conta inteira. Informe teamId para os de um departamento — é o que a tela do produto faz.
Nome do parâmetro. O campo se chama teamId na API e Departamento no produto; são a mesma coisa.
Filtros. agentId (Usuário), teamId (Departamento), inboxId (Caixa de entrada), labelId (Etiqueta).
Obrigatório. Primeiro dia do período, no formato AAAA-MM-DD.
\n","type":"text/plain"},"key":"since","value":"2026-08-01"},{"description":{"content":"Obrigatório. Último dia do período, no formato AAAA-MM-DD. Não pode ser anterior a since.
\n","type":"text/plain"},"key":"until","value":"2026-08-31"},{"disabled":true,"description":{"content":"Opcional. Restringe ao departamento informado. Sem ele, a resposta é da conta inteira.
\n","type":"text/plain"},"key":"teamId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe ao usuário informado (campo Usuário no produto).
\n","type":"text/plain"},"key":"agentId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à caixa de entrada informada.
\n","type":"text/plain"},"key":"inboxId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à etiqueta informada.
\n","type":"text/plain"},"key":"labelId","value":""}],"variable":[]}},"response":[{"id":"5dbfdb0d-adcb-6317-0931-d0d988d43bb8","name":"200 - Uma semana, com o detalhamento por departamento","originalRequest":{"method":"GET","header":[{"key":"x-api-key","description":"Chave da conta. Identifica quem chama e a qual conta os dados pertencem.","value":"your_api-key"}],"url":{"raw":"https://api.bradial.com.br/chat/v1/reports/teams/overview","host":["https://api.bradial.com.br"],"path":["chat","v1","reports","teams","overview"],"query":[{"key":"since","description":"Obrigatório. Primeiro dia do período, no formato AAAA-MM-DD.","value":"2026-08-01"},{"key":"until","description":"Obrigatório. Último dia do período, no formato AAAA-MM-DD. Não pode ser anterior a since.","value":"2026-08-31"},{"key":"teamId","description":"Opcional. Restringe ao departamento informado. Sem ele, a resposta é da conta inteira.","value":"","disabled":true},{"key":"agentId","description":"Opcional. Restringe ao usuário informado (campo Usuário no produto).","value":"","disabled":true},{"key":"inboxId","description":"Opcional. Restringe à caixa de entrada informada.","value":"","disabled":true},{"key":"labelId","description":"Opcional. Restringe à etiqueta informada.","value":"","disabled":true}]},"description":"Indicadores por departamento no período.\n\n**Autenticação.** Header `x-api-key`. A chave identifica a conta — não há id de conta na URL, e o header `Authorization` é ignorado.\n\n**Período.** `since` e `until` no formato `AAAA-MM-DD`; `until` não pode ser anterior a `since`.\n\n**Escopo.** Sem `teamId`, a resposta traz os números da conta inteira. Informe `teamId` para os de um departamento — é o que a tela do produto faz.\n\n**Nome do parâmetro.** O campo se chama `teamId` na API e **Departamento** no produto; são a mesma coisa.\n\n**Filtros.** `agentId` (Usuário), `teamId` (Departamento), `inboxId` (Caixa de entrada), `labelId` (Etiqueta)."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"section\": \"teams\",\n \"grain\": \"day\",\n \"range\": { \"since\": \"2026-08-01\", \"until\": \"2026-08-07\" },\n \"previousRange\": { \"since\": \"2026-07-25\", \"until\": \"2026-07-31\" },\n \"kpis\": [\n { \"id\": \"conversations\", \"value\": 1840, \"previousValue\": 1712, \"spark\": [240, 268, 301, 255, 262, 259, 255] },\n { \"id\": \"incomingMessages\", \"value\": 9420, \"previousValue\": 8871, \"spark\": [1230, 1372, 1541, 1305, 1341, 1327, 1304] },\n { \"id\": \"outgoingMessages\", \"value\": 11208, \"previousValue\": 10502, \"spark\": [1463, 1632, 1833, 1553, 1595, 1579, 1553] },\n { \"id\": \"resolutions\", \"value\": 1602, \"previousValue\": 1498, \"spark\": [209, 233, 262, 222, 228, 226, 222] },\n { \"id\": \"resolutionRate\", \"value\": 87.1, \"previousValue\": 87.5, \"spark\": [87, 87, 87, 87, 87, 87, 87] },\n { \"id\": \"firstResponseTime\", \"value\": 142, \"previousValue\": 168, \"spark\": [151, 148, 139, 144, 140, 138, 134] },\n { \"id\": \"resolutionTime\", \"value\": 4380, \"previousValue\": 4712, \"spark\": [4500, 4420, 4310, 4390, 4360, 4340, 4320] }\n ],\n \"series\": {\n \"keys\": [\"conversations\", \"resolutions\"],\n \"points\": [\n { \"at\": \"2026-08-01\", \"values\": { \"conversations\": 240, \"resolutions\": 209 } },\n { \"at\": \"2026-08-02\", \"values\": { \"conversations\": 268, \"resolutions\": 233 } },\n { \"at\": \"2026-08-03\", \"values\": { \"conversations\": 301, \"resolutions\": 262 } }\n ]\n },\n \"accountConversations\": 1840,\n \"breakdown\": [\n { \"id\": 12, \"name\": \"Suporte\", \"conversationsCount\": 980, \"resolutionsCount\": 861, \"share\": 53.3, \"firstResponseTime\": 128, \"resolutionTime\": 4110, \"spark\": [130, 142, 158, 136, 139, 138, 137] },\n { \"id\": 13, \"name\": \"Financeiro\", \"conversationsCount\": 512, \"resolutionsCount\": 441, \"share\": 27.8, \"firstResponseTime\": 165, \"resolutionTime\": 5020, \"spark\": [68, 74, 82, 70, 73, 72, 73] }\n ]\n}"}],"_postman_id":"442ed1a5-4d3a-7492-0d33-611c4f3d9af0"},{"name":"Departamentos - Download","id":"81da9064-52a0-c74f-6773-a812cb57f86c","request":{"method":"GET","header":[{"value":"your_api-key","key":"x-api-key","description":"Chave da conta. Identifica quem chama e a qual conta os dados pertencem.
\n"}],"url":"https://api.bradial.com.br/chat/v1/reports/teams/download","description":"Planilha CSV com os indicadores por departamento no período. A resposta é text/csv, não JSON.
Autenticação. Header x-api-key. A chave identifica a conta — não há id de conta na URL, e o header Authorization é ignorado.
Período. since e until no formato AAAA-MM-DD; until não pode ser anterior a since.
Fuso. As datas dentro do arquivo são escritas no fuso que timezoneOffsetHours indicar. Sem ele, saem em UTC.
Filtros. agentId (Usuário), teamId (Departamento), inboxId (Caixa de entrada), labelId (Etiqueta).
Obrigatório. Primeiro dia do período, no formato AAAA-MM-DD.
\n","type":"text/plain"},"key":"since","value":"2026-08-01"},{"description":{"content":"Obrigatório. Último dia do período, no formato AAAA-MM-DD. Não pode ser anterior a since.
\n","type":"text/plain"},"key":"until","value":"2026-08-31"},{"disabled":true,"description":{"content":"Opcional. Fuso em que as datas do arquivo são escritas, de -12 a 14. Padrão 0 (UTC); use -3 para o horário de Brasília.
\n","type":"text/plain"},"key":"timezoneOffsetHours","value":"-3"},{"disabled":true,"description":{"content":"Opcional. Restringe ao departamento informado.
\n","type":"text/plain"},"key":"teamId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe ao usuário informado (campo Usuário no produto).
\n","type":"text/plain"},"key":"agentId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à caixa de entrada informada.
\n","type":"text/plain"},"key":"inboxId","value":""},{"disabled":true,"description":{"content":"Opcional. Restringe à etiqueta informada.
\n","type":"text/plain"},"key":"labelId","value":""}],"variable":[]}},"response":[],"_postman_id":"81da9064-52a0-c74f-6773-a812cb57f86c"}],"id":"6cff7acb-d542-451d-b3e1-0249ec17d919","description":"Indicadores de atendimento do Bradial Chat. São doze endpoints GET: uma visão geral em JSON por seção e um download em CSV, mais a listagem paginada de respostas de CSAT.
Envie a chave no header x-api-key. Ela identifica quem chama e a qual conta os dados pertencem — por isso não existe id de conta na URL, diferente dos endpoints da pasta V2. O header Authorization é ignorado: a chave é a única credencial aceita aqui.
since e until são obrigatórios em todas as rotas, no formato AAAA-MM-DD, e until não pode ser anterior a since. Um período de um único dia é agrupado por hora; acima disso, por dia.
Todos opcionais e combináveis. O nome do parâmetro é técnico e nem sempre igual ao rótulo que aparece no produto:
\nSem nenhum filtro de dimensão, a resposta é da conta inteira. As telas do produto sempre aplicam um.
\nAs rotas /download respondem text/csv, não JSON. Elas aceitam timezoneOffsetHours, de -12 a 14, que define o fuso em que as datas são escritas dentro do arquivo; sem ele, saem em UTC. Para o horário de Brasília, use -3.
O chat interno é excluído de todos os relatórios. Uma caixa de entrada desse tipo não aparece nos números nem responde como filtro.
\n","_postman_id":"6cff7acb-d542-451d-b3e1-0249ec17d919"},{"name":"Arquivos","item":[{"name":"1. Iniciar upload","id":"3cd49092-640e-ed4c-162f-c4ed93b502d5","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"POST","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n \"name\": \"folder.pdf\",\n \"size\": 2483019,\n \"contentType\": \"application/pdf\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/files/uploads","description":"Passo 1 de 3. Prepara o envio de um arquivo e devolve as URLs para mandar os bytes.
\nkey, uploadId e uma URL por parte em parts.parts, faça um PUT com os bytes daquela parte na url. Guarde o ETag de cada resposta.key, uploadId e a lista de { partNumber, eTag }. A resposta confirma a key do arquivo.Depois, use a key ao criar a campanha: em bradial.file.key (WhatsApp - API Web) ou em media_key no cabeçalho de mídia (WhatsApp - API Oficial).
Se algo falhar no meio, chame Cancelar upload.
\nname: nome do arquivo, até 255 caracteres.size: tamanho exato em bytes, até 100 MB (104857600).contentType: tipo do arquivo. Aceitos: imagens (exceto SVG), áudio, vídeo, PDF, CSV, TXT, RTF, JSON, ZIP, 7z, RAR, TAR e documentos do Office.Cada parte tem 5 MB (partSize). Arquivos de até 5 MB têm uma parte só: o fluxo inteiro são 3 chamadas.
Passo 3 de 3. Fecha o envio depois que todas as partes foram enviadas em 2. Enviar parte.
\nCorpo.
\nkey e uploadId: os valores devolvidos em 1. Iniciar upload.parts: um item { partNumber, eTag } por parte, na ordem, com o ETag exatamente como veio no header da resposta, aspas incluídas.Resposta. { data: { key, name } }. A key é o que vai na campanha: bradial.file.key (WhatsApp - API Web) ou media_key no cabeçalho de mídia (WhatsApp - API Oficial).
Validade. O arquivo fica em uma área temporária até ser usado em uma campanha. Crie a campanha logo depois de concluir o envio.
\n","urlObject":{"path":["chat","v1","files","uploads","complete"],"host":["https://api.bradial.com.br"],"query":[],"variable":[]}},"response":[{"id":"a197f673-5026-27cf-e640-b38c4099ae6c","name":"200 — arquivo pequeno (1 parte)","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"key\": \"temp/3f1c2a9e-8b7d-4e21-9c55-0a1b2c3d4e5f\",\n \"uploadId\": \"2~kJ8vQm3XrT5nW7bYc1ZpLd9HfGs0AeUoVi4NtRyMqBx6Kw\",\n \"parts\": [\n { \"partNumber\": 1, \"eTag\": \"\\\"9b2cf535f27731c974343645a3985328\\\"\" }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/files/uploads/complete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"key\": \"temp/3f1c2a9e-8b7d-4e21-9c55-0a1b2c3d4e5f\",\n \"name\": \"tabela-precos-novembro.pdf\"\n }\n}"},{"id":"d04595fd-a31e-5a11-ef42-fc8ac50aff5b","name":"200 — arquivo grande (3 partes)","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"key\": \"temp/8c2e4f61-1a3b-4d5c-9e7f-0b2d4f6a8c10\",\n \"uploadId\": \"2~Wq4Lr9TzX2nB7cVd1KmP5sJ8hF3yGeUoAi6NtRxMqZb0Kw\",\n \"parts\": [\n { \"partNumber\": 1, \"eTag\": \"\\\"7f3a1c9e5b2d8f4a6c0e1b3d5f7a9c2e\\\"\" },\n { \"partNumber\": 2, \"eTag\": \"\\\"4b8d2f6a0c4e8b2d6f0a4c8e2b6d0f4a\\\"\" },\n { \"partNumber\": 3, \"eTag\": \"\\\"c1e5a9d3f7b1e5c9a3d7f1b5e9c3a7d1\\\"\" }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/files/uploads/complete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"key\": \"temp/8c2e4f61-1a3b-4d5c-9e7f-0b2d4f6a8c10\",\n \"name\": \"video-lancamento.mp4\"\n }\n}"},{"id":"95faf849-21e9-b9db-c65d-0af2969e1136","name":"400 — envio inválido ou de outra conta","originalRequest":{"auth":{"type":"apikey","apikey":{"key":"x-api-key","value":"your_api-key","in":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"key\": \"temp/3f1c2a9e-8b7d-4e21-9c55-0a1b2c3d4e5f\",\n \"uploadId\": \"2~kJ8vQm3XrT5nW7bYc1ZpLd9HfGs0AeUoVi4NtRyMqBx6Kw\",\n \"parts\": [\n { \"partNumber\": 1, \"eTag\": \"\\\"00000000000000000000000000000000\\\"\" }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/files/uploads/complete"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The uploaded file is not valid.\",\n \"statusCode\": 400,\n \"error\": {\n \"code\": \"FILE001\",\n \"message\": \"The uploaded file is not valid.\",\n \"reason\": \"When a completed upload is larger than 100 MB, names an upload, parts or a file S3 does not have, as on a retried complete once the file has already been completed, or was started by another brand or account.\"\n }\n}"}],"_postman_id":"7e56fe70-af20-6136-45e3-ea91e8b8dc64"},{"name":"Cancelar upload","id":"ed5d6855-ca6f-fcd3-9499-0e15ab7a8903","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"POST","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n \"key\": \"temp/3f1c2a9e-8b7d-4e21-9c55-0a1b2c3d4e5f\",\n \"uploadId\": \"2~abcDEF123\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/chat/v1/files/uploads/abort","description":"Cancela um envio que não será concluído, por exemplo quando uma parte falhou ou o arquivo foi trocado. Libera as partes já enviadas.
\nUse quando o fluxo 1 → 2 → 3 for interrompido no meio. Depois de 3. Concluir upload, não é preciso cancelar.
\nCorpo. key e uploadId devolvidos em 1. Iniciar upload. Cancelar um envio que já não existe também responde 200.
Passo 2 de 3. Envia os bytes de uma parte do arquivo direto para o armazenamento.
\nURL. Cole aqui a url de um item de parts devolvido em 1. Iniciar upload, no lugar de {{part_url}}. A URL já vem assinada e vale por 1 hora.
Corpo. Os bytes da parte, em binário (aba Body › binary). Cada parte tem partSize bytes (5 MB), e a última leva o que sobrou. Exemplo para um arquivo de 12 MB: parte 1 = bytes 0 a 5.242.879; parte 2 = 5.242.880 a 10.485.759; parte 3 = o restante.
Sem x-api-key. Esta chamada não passa pela API da Bradial. Não envie a chave nem o header Authorization, porque a assinatura vai na própria URL.
Resposta. 200 sem corpo. Guarde o header ETag de cada parte, com as aspas: ele é obrigatório em 3. Concluir upload.
Arquivos de até 5 MB têm uma parte só, então este passo roda uma vez.
\n","urlObject":{"host":["{{part_url}}"],"query":[],"variable":[]}},"response":[{"id":"57ca0e59-c830-ae07-6459-882faa66e1c1","name":"200 — parte enviada (guarde o ETag)","originalRequest":{"auth":{"type":"noauth"},"method":"PUT","header":[],"body":{"mode":"file","file":{}},"url":{"raw":"https://bradial-api-prod-us-east.s3.us-east-1.amazonaws.com/temp/3f1c2a9e-8b7d-4e21-9c55-0a1b2c3d4e5f?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAEXAMPLE%2F20261103%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20261103T130112Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&partNumber=1&uploadId=2~kJ8vQm3XrT5nW7bYc1ZpLd9HfGs0AeUoVi4NtRyMqBx6Kw&x-id=UploadPart&X-Amz-Signature=5d1c0e9f7a2b4c6d8e0f1a3b5c7d9e1f3a5b7c9d1e3f5a7b9c1d3e5f7a9b1c3d","protocol":"https","host":["bradial-api-prod-us-east","s3","us-east-1","amazonaws","com"],"path":["temp","3f1c2a9e-8b7d-4e21-9c55-0a1b2c3d4e5f"],"query":[{"key":"X-Amz-Algorithm","value":"AWS4-HMAC-SHA256"},{"key":"X-Amz-Credential","value":"AKIAEXAMPLE%2F20261103%2Fus-east-1%2Fs3%2Faws4_request"},{"key":"X-Amz-Date","value":"20261103T130112Z"},{"key":"X-Amz-Expires","value":"3600"},{"key":"X-Amz-SignedHeaders","value":"host"},{"key":"partNumber","value":"1"},{"key":"uploadId","value":"2~kJ8vQm3XrT5nW7bYc1ZpLd9HfGs0AeUoVi4NtRyMqBx6Kw"},{"key":"x-id","value":"UploadPart"},{"key":"X-Amz-Signature","value":"5d1c0e9f7a2b4c6d8e0f1a3b5c7d9e1f3a5b7c9d1e3f5a7b9c1d3e5f7a9b1c3d"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"ETag","value":"\"9b2cf535f27731c974343645a3985328\""},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":""},{"id":"3ce62fdd-0ff8-0438-9e1b-001618746ae9","name":"403 — URL vencida (mais de 1 hora)","originalRequest":{"auth":{"type":"noauth"},"method":"PUT","header":[],"body":{"mode":"file","file":{}},"url":{"raw":"https://bradial-api-prod-us-east.s3.us-east-1.amazonaws.com/temp/3f1c2a9e-8b7d-4e21-9c55-0a1b2c3d4e5f?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAEXAMPLE%2F20261103%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20261103T130112Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&partNumber=1&uploadId=2~kJ8vQm3XrT5nW7bYc1ZpLd9HfGs0AeUoVi4NtRyMqBx6Kw&x-id=UploadPart&X-Amz-Signature=5d1c0e9f7a2b4c6d8e0f1a3b5c7d9e1f3a5b7c9d1e3f5a7b9c1d3e5f7a9b1c3d","protocol":"https","host":["bradial-api-prod-us-east","s3","us-east-1","amazonaws","com"],"path":["temp","3f1c2a9e-8b7d-4e21-9c55-0a1b2c3d4e5f"],"query":[{"key":"X-Amz-Algorithm","value":"AWS4-HMAC-SHA256"},{"key":"X-Amz-Credential","value":"AKIAEXAMPLE%2F20261103%2Fus-east-1%2Fs3%2Faws4_request"},{"key":"X-Amz-Date","value":"20261103T130112Z"},{"key":"X-Amz-Expires","value":"3600"},{"key":"X-Amz-SignedHeaders","value":"host"},{"key":"partNumber","value":"1"},{"key":"uploadId","value":"2~kJ8vQm3XrT5nW7bYc1ZpLd9HfGs0AeUoVi4NtRyMqBx6Kw"},{"key":"x-id","value":"UploadPart"},{"key":"X-Amz-Signature","value":"5d1c0e9f7a2b4c6d8e0f1a3b5c7d9e1f3a5b7c9d1e3f5a7b9c1d3e5f7a9b1c3d"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"}],"cookie":[],"responseTime":null,"body":"\nAccessDenied\n Este endpoint permite listar todos os seus agentes.
\n","urlObject":{"path":["v2","public-api","v1","agents"],"host":["https://api.bradial.com.br"],"query":[{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"f271ef64-072e-4e9a-8735-bcf5fc19d645","name":"List","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":{"raw":"https://api.bradial.com.br/v2/public-api/v1/agents?page=1","host":["https://api.bradial.com.br"],"path":["v2","public-api","v1","agents"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"email\": \"alice.santos@example.com\",\n \"name\": \"Alice Santos\",\n \"role\": \"administrator\",\n \"extension\": \"3001\",\n \"canSpyTickets\": false,\n \"canAcceptPreassignTickets\": true,\n \"seeAllPreviousConversation\": true\n },\n {\n \"id\": 2,\n \"email\": \"bruno.madeira@example.com\",\n \"name\": \"Bruno Madeira\",\n \"role\": \"agent\",\n \"extension\": null,\n \"canSpyTickets\": false,\n \"canAcceptPreassignTickets\": false,\n \"seeAllPreviousConversation\": false\n },\n {\n \"id\": 3,\n \"email\": \"carla.oliveira@example.com\",\n \"name\": \"Carla Oliveira\",\n \"role\": \"supervisor\",\n \"extension\": \"1188\",\n \"canSpyTickets\": true,\n \"canAcceptPreassignTickets\": true,\n \"seeAllPreviousConversation\": false\n },\n {\n \"id\": 4,\n \"email\": \"diego.silva@example.com\",\n \"name\": \"Diego Silva\",\n \"role\": \"administrator\",\n \"extension\": null,\n \"canSpyTickets\": false,\n \"canAcceptPreassignTickets\": true,\n \"seeAllPreviousConversation\": true\n },\n {\n \"id\": 5,\n \"email\": \"erika.monteiro@example.com\",\n \"name\": \"Érika Monteiro\",\n \"role\": \"agent\",\n \"extension\": \"912\",\n \"canSpyTickets\": false,\n \"canAcceptPreassignTickets\": true,\n \"seeAllPreviousConversation\": false\n }\n ],\n \"items\": 5\n}"}],"_postman_id":"a090271e-416e-400c-a46d-7833fd32bb82"},{"name":"FindAll Copy","id":"d19f0450-e6e9-49f3-ad8c-501b14530b62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":"https://api.bradial.com.br/v2/public-api/v1/agents?page=1","description":"Este endpoint permite listar todos os seus agentes.
\n","urlObject":{"path":["v2","public-api","v1","agents"],"host":["https://api.bradial.com.br"],"query":[{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"fb7e1763-12ad-4999-842f-734efbb6fcab","name":"List","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":{"raw":"https://api.bradial.com.br/v2/public-api/v1/agents?page=1","host":["https://api.bradial.com.br"],"path":["v2","public-api","v1","agents"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"email\": \"alice.santos@example.com\",\n \"name\": \"Alice Santos\",\n \"role\": \"administrator\",\n \"extension\": \"3001\",\n \"canSpyTickets\": false,\n \"canAcceptPreassignTickets\": true,\n \"seeAllPreviousConversation\": true\n },\n {\n \"id\": 2,\n \"email\": \"bruno.madeira@example.com\",\n \"name\": \"Bruno Madeira\",\n \"role\": \"agent\",\n \"extension\": null,\n \"canSpyTickets\": false,\n \"canAcceptPreassignTickets\": false,\n \"seeAllPreviousConversation\": false\n },\n {\n \"id\": 3,\n \"email\": \"carla.oliveira@example.com\",\n \"name\": \"Carla Oliveira\",\n \"role\": \"supervisor\",\n \"extension\": \"1188\",\n \"canSpyTickets\": true,\n \"canAcceptPreassignTickets\": true,\n \"seeAllPreviousConversation\": false\n },\n {\n \"id\": 4,\n \"email\": \"diego.silva@example.com\",\n \"name\": \"Diego Silva\",\n \"role\": \"administrator\",\n \"extension\": null,\n \"canSpyTickets\": false,\n \"canAcceptPreassignTickets\": true,\n \"seeAllPreviousConversation\": true\n },\n {\n \"id\": 5,\n \"email\": \"erika.monteiro@example.com\",\n \"name\": \"Érika Monteiro\",\n \"role\": \"agent\",\n \"extension\": \"912\",\n \"canSpyTickets\": false,\n \"canAcceptPreassignTickets\": true,\n \"seeAllPreviousConversation\": false\n }\n ],\n \"items\": 5\n}"}],"_postman_id":"d19f0450-e6e9-49f3-ad8c-501b14530b62"},{"name":"FindOne","id":"4ea4a8c6-59bb-40ce-bdfa-a42bbd665ee7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":"https://api.bradial.com.br/v2/public-api/v1/agents/your_agent_id","description":"Este endpoint permite buscar um agente específico utilizando o ID.
\n","urlObject":{"path":["v2","public-api","v1","agents","your_agent_id"],"host":["https://api.bradial.com.br"],"query":[],"variable":[]}},"response":[{"id":"fd155406-9e36-43bc-adf8-870caeaa8e4a","name":"FindOne","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":"https://api.bradial.com.br/v2/public-api/v1/agents/your_agent_id"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": 1,\n \"email\": \"alice.santos@example.com\",\n \"name\": \"Alice Santos\",\n \"role\": \"administrator\",\n \"extension\": \"3001\",\n \"canSpyTickets\": false,\n \"canAcceptPreassignTickets\": true,\n \"seeAllPreviousConversation\": true\n}"}],"_postman_id":"4ea4a8c6-59bb-40ce-bdfa-a42bbd665ee7"},{"name":"Create","id":"9bdf2c71-c3bd-4bbd-a8c9-fe5277bcff48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"alice.santos@example.com\",\n \"name\": \"Alice Santos\",\n \"role\": \"administrator\",\n \"extension\": \"3001\",\n \"canSpyTickets\": false,\n \"canAcceptPreassignTickets\": true,\n \"seeAllPreviousConversation\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/v2/public-api/v1/agents","description":"Este endpoint permite criar um novo agente.
\n","urlObject":{"path":["v2","public-api","v1","agents"],"host":["https://api.bradial.com.br"],"query":[],"variable":[]}},"response":[{"id":"fa967734-a043-4c0c-a255-ed1b53905ec2","name":"Create","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"alice.santos@example.com\",\n \"name\": \"Alice Santos\",\n \"role\": \"administrator\",\n \"extension\": \"3001\",\n \"canSpyTickets\": false,\n \"canAcceptPreassignTickets\": true,\n \"seeAllPreviousConversation\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/v2/public-api/v1/agents"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": 1,\n \"email\": \"alice.santos@example.com\",\n \"name\": \"Alice Santos\",\n \"role\": \"administrator\",\n \"extension\": \"3001\",\n \"canSpyTickets\": false,\n \"canAcceptPreassignTickets\": true,\n \"seeAllPreviousConversation\": true\n}"}],"_postman_id":"9bdf2c71-c3bd-4bbd-a8c9-fe5277bcff48"},{"name":"SSO","id":"00e959ca-15e7-4a99-9da6-94a37c0ee8d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":"https://api.bradial.com.br/v2/public-api/v1/agents/your_agent_id/sso","description":"Este endpoint permite realizar login sem o uso de senha, a partir do padrão SSO.
\n","urlObject":{"path":["v2","public-api","v1","agents","your_agent_id","sso"],"host":["https://api.bradial.com.br"],"query":[],"variable":[]}},"response":[{"id":"4e09a9f1-023d-44b7-acfc-1baf4b9ddba4","name":"SSO","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":"https://api.bradial.com.br/v2/public-api/v1/agents/your_agent_id/sso"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"email\": \"alice.santos@example.com\",\n \"token\": \"17032812ff2ac4d865229591ec5241372ef2f9d3dd30484fec1e4896202c04f2\"\n}"}],"_postman_id":"00e959ca-15e7-4a99-9da6-94a37c0ee8d0"},{"name":"Update","id":"621777f2-615e-4eb4-bfcc-2b8d770c52b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"extension\": \"3003\",\n \"canSpyTickets\": false,\n \"canAcceptPreassignTickets\": false,\n \"seeAllPreviousConversation\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/v2/public-api/v1/agents/your_agent_id","description":"Este endpoint permite atualizar um agente já existente.
\n","urlObject":{"path":["v2","public-api","v1","agents","your_agent_id"],"host":["https://api.bradial.com.br"],"query":[],"variable":[]}},"response":[{"id":"dc8f561f-6e3a-479e-9397-b7fcb0c0b2f6","name":"Update","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"extension\": \"3003\",\n \"canSpyTickets\": false,\n \"canAcceptPreassignTickets\": false,\n \"seeAllPreviousConversation\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/v2/public-api/v1/agents/your_agent_id"},"status":"No Content","code":204,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"621777f2-615e-4eb4-bfcc-2b8d770c52b9"},{"name":"Remove","id":"304c3da4-83f6-43d4-b237-10ffbe5580c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":"https://api.bradial.com.br/v2/public-api/v1/agents/your_agent_id","description":"Este endpoint permite deletar um agente já existente.
\n","urlObject":{"path":["v2","public-api","v1","agents","your_agent_id"],"host":["https://api.bradial.com.br"],"query":[],"variable":[]}},"response":[{"id":"9d5568e5-fe3a-4963-883d-5872df18b0bb","name":"Remove","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":"https://api.bradial.com.br/v2/public-api/v1/agents/your_agent_id"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"304c3da4-83f6-43d4-b237-10ffbe5580c8"}],"id":"b395aa47-3e26-482c-ace6-0197465deda2","description":"Este recurso permite executar ações no domínio de Agentes no Chat.
\n","_postman_id":"b395aa47-3e26-482c-ace6-0197465deda2"},{"name":"Contacts","item":[{"name":"FindAll","id":"b85a35e2-4798-496d-a64a-79f4aaaf2256","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":"https://api.bradial.com.br/v2/public-api/v1/contacts?page=1","description":"Este endpoint permite listar todos os seus contatos.
\n","urlObject":{"path":["v2","public-api","v1","contacts"],"host":["https://api.bradial.com.br"],"query":[{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"91bc3a91-990e-7c69-71cd-e0894ff17abb","name":"List","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":{"raw":"https://api.bradial.com.br/v2/public-api/v1/contacts?page=1","host":["https://api.bradial.com.br"],"path":["v2","public-api","v1","contacts"],"query":[{"key":"page","value":"1"}]},"description":"Este endpoint permite listar todos os seus contatos."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 101,\n \"name\": \"Alice Peroni\",\n \"email\": \"alice.peroni@example.com\",\n \"phoneNumber\": \"+351912345678\",\n \"description\": \"Cliente desde 2023, prefere contato por WhatsApp.\",\n \"labels\": [\"new\"]\n },\n {\n \"id\": 102,\n \"name\": \"Bruno Teixeira\",\n \"email\": \"bruno.tx@example.net\",\n \"phoneNumber\": \"+351987654321\",\n \"description\": \"Conta corporativa, falar com o financeiro.\",\n \"labels\": [\"vip\", \"priority\"]\n },\n {\n \"id\": 103,\n \"name\": \"Carla Mendonça\",\n \"email\": \"carla.mendonca@example.org\",\n \"phoneNumber\": \"+351673829102\",\n \"labels\": [\"inactive\"]\n },\n {\n \"id\": 104,\n \"name\": \"Daniel Farias\",\n \"email\": \"daniel.farias@example.com\",\n \"phoneNumber\": \"+351627384756\",\n \"labels\": [\"new\", \"lead\"]\n },\n {\n \"id\": 105,\n \"name\": \"Érika Ramos\",\n \"email\": \"erika.ramos@example.io\",\n \"phoneNumber\": \"+351697483920\",\n \"labels\": []\n }\n ],\n \"items\": 5\n}"}],"_postman_id":"b85a35e2-4798-496d-a64a-79f4aaaf2256"},{"name":"FindOne","id":"0c5ae597-fe1f-4284-88da-4fe602c0660d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":"https://api.bradial.com.br/v2/public-api/v1/contacts/your_contact_id","description":"Este endpoint permite buscar um contato específico utilizando o ID.
\n","urlObject":{"path":["v2","public-api","v1","contacts","your_contact_id"],"host":["https://api.bradial.com.br"],"query":[],"variable":[]}},"response":[{"id":"2f5f1b1b-5d27-a0f5-ac59-28b41bd5ce3b","name":"Show","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":"https://api.bradial.com.br/v2/public-api/v1/contacts/your_contact_id","description":"Este endpoint permite buscar um contato específico utilizando o ID."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 101,\n \"name\": \"Alice Peroni\",\n \"email\": \"alice.peroni@example.com\",\n \"phoneNumber\": \"+351912345678\",\n \"description\": \"Cliente desde 2023, prefere contato por WhatsApp.\",\n \"labels\": [\"new\"]\n}"}],"_postman_id":"0c5ae597-fe1f-4284-88da-4fe602c0660d"},{"name":"Create","id":"f98468a1-c157-43d9-81e7-6c152fe89926","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Alice Peroni\",\n \"email\": \"alice.peroni@example.com\",\n \"phoneNumber\": \"+351912345678\",\n \"description\": \"Cliente desde 2023, prefere contato por WhatsApp.\",\n \"labels\": [\n \"new\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/v2/public-api/v1/contacts","description":"Este endpoint permite criar um novo contato.
\n","urlObject":{"path":["v2","public-api","v1","contacts"],"host":["https://api.bradial.com.br"],"query":[],"variable":[]}},"response":[{"id":"a7bd5a40-ac04-70f4-ebac-f91aefa15c2e","name":"Create","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Alice Peroni\",\n \"email\": \"alice.peroni@example.com\",\n \"phoneNumber\": \"+351912345678\",\n \"description\": \"Cliente desde 2023, prefere contato por WhatsApp.\",\n \"labels\": [\n \"new\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/v2/public-api/v1/contacts","description":"Este endpoint permite criar um novo contato."},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Alice Peroni\",\n \"email\": \"alice.peroni@example.com\",\n \"phoneNumber\": \"+351912345678\",\n \"description\": \"Cliente desde 2023, prefere contato por WhatsApp.\",\n \"labels\": [\n \"new\"\n ]\n}"}],"_postman_id":"f98468a1-c157-43d9-81e7-6c152fe89926"},{"name":"Update","id":"e2bb05d4-d952-4a73-b22d-1b3a0cb9a073","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"description\": \"Cliente desde 2023, prefere contato por WhatsApp.\",\n \"labels\": [\n \"new\",\n \"more\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/v2/public-api/v1/contacts/your_contact_id","description":"Este endpoint permite atualizar um contato já existente.
\n","urlObject":{"path":["v2","public-api","v1","contacts","your_contact_id"],"host":["https://api.bradial.com.br"],"query":[],"variable":[]}},"response":[{"id":"3c510dd5-b3ae-4711-a016-6893c103e87e","name":"Update","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"your_api-key","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"labels\": [\n \"new\",\n \"more\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/v2/public-api/v1/contacts/your_client-id"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"e2bb05d4-d952-4a73-b22d-1b3a0cb9a073"},{"name":"Remove","id":"6518c75b-720c-4f9b-8476-aac8c9ad492b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":"https://api.bradial.com.br/v2/public-api/v1/contacts/your_contact_id","description":"Este endpoint permite deletar um contato já existente.
\n","urlObject":{"path":["v2","public-api","v1","contacts","your_contact_id"],"host":["https://api.bradial.com.br"],"query":[],"variable":[]}},"response":[{"id":"b441fd09-4098-4173-ac7d-b04752a93ee6","name":"Remove","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"your_api-key","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.bradial.com.br/v2/public-api/v1/contacts/your_client-id"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"6518c75b-720c-4f9b-8476-aac8c9ad492b"}],"id":"e725fa39-cd3f-4cba-ba30-00e7b5e94ba0","description":"Este recurso permite executar ações no domínio de Contatos no Chat.
\n","_postman_id":"e725fa39-cd3f-4cba-ba30-00e7b5e94ba0"},{"name":"Inboxes","item":[{"name":"WhatsApp - API Web","item":[{"name":"Send Text","id":"cadab88e-e031-4e34-91b8-081972711f06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"your_api-key","type":"text"},{"key":"integration-token","value":"your_integration-token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone\": \"phone_number\", // Add country code. ex: +55\n \"content\": \"Hello\",\n \"status\": 0,\n \"isGroup\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/v2/public-api/v1/messages/whatsapp/text","description":"Este endpoint permite que você envie mensagens de texto para um contato específico ou para um grupo. Além disso, você pode definir uma opção de status:
\nstatus (somente aplicável para novos atendimentos)
0: Manter o atendimento em aberto.
\n1: Fechar o atendimento. após a mensagem ser enviada.
\nAdd country code. ex: +55
\n","type":"text"},{"key":"isGroup","value":"false","type":"text"},{"key":"file","type":"file","src":"/Users/gustavoorsoli/Downloads/Respostas Rápidas.txt"},{"key":"status","value":"0","description":"optional
\n","type":"text","disabled":true},{"key":"caption","value":"","description":"optional
\n","type":"text","disabled":true}]},"url":"https://api.bradial.com.br/v2/public-api/v1/messages/whatsapp/media","description":"Este endpoint permite que você envie mensagens de mídia, como imagens, vídeos ou áudios, para um contato específico ou para um grupo. Além disso, você pode definir uma opção de status:
\nstatus (somente aplicável para novos atendimentos)
0: Manter o atendimento em aberto.
\n1: Fechar o atendimento. após a mensagem ser enviada.
\nEste recurso permite executar ações no domínio do WhatsApp Não Oficial.
\n","_postman_id":"d62e0d37-fdd0-4629-95c5-7c603972347d"},{"name":"WhatsApp - API Oficial","item":[{"name":"Templates","item":[{"name":"FindAll","id":"d9ec5b8c-fb3c-4a3d-8bfa-ee8142e7ff1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.bradial.com.br/v2/meta-api/inboxes/your_inbox_id/whatsapp/templates","description":"Este endpoint permite listar todos os seus modelos.
\n","urlObject":{"path":["v2","meta-api","inboxes","your_inbox_id","whatsapp","templates"],"host":["https://api.bradial.com.br"],"query":[],"variable":[]}},"response":[{"id":"72bd72e2-cc0d-442b-8e1b-6157b4d093d4","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":"https://api.bradial.com.br/v2/meta-api/inboxes/your_inbox_id/whatsapp/templates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"664496330009637\",\n \"name\": \"test_text_02\",\n \"status\": \"APPROVED\",\n \"category\": \"UTILITY\",\n \"language\": \"en\",\n \"components\": [\n {\n \"text\": \"Reminder: Our technician will visit your location on {{1}} at {{2}} for your broadband installation. Please be available.\",\n \"type\": \"BODY\",\n \"example\": {\n \"body_text\": [\n [\n \"2025-08-27\",\n \"10:00\"\n ]\n ]\n }\n }\n ],\n \"sub_category\": \"CUSTOM\",\n \"parameter_format\": \"POSITIONAL\"\n }\n]"}],"_postman_id":"d9ec5b8c-fb3c-4a3d-8bfa-ee8142e7ff1a"},{"name":"FindOne","id":"7ea83310-fd08-44b8-837c-b2b894b7c7f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.bradial.com.br/v2/meta-api/inboxes/your_inbox_id/whatsapp/templates/your_template_name","description":"Este endpoint permite buscar um modelo específico utilizando o nome como identificador único.
\n","urlObject":{"path":["v2","meta-api","inboxes","your_inbox_id","whatsapp","templates","your_template_name"],"host":["https://api.bradial.com.br"],"query":[],"variable":[]}},"response":[{"id":"a003b283-91ad-46c0-959c-ef08582db240","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":"https://api.bradial.com.br/v2/meta-api/inboxes/your_inbox_id/whatsapp/templates/your_template_name"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"664496330009637\",\n \"name\": \"test_text_02\",\n \"status\": \"APPROVED\",\n \"category\": \"UTILITY\",\n \"language\": \"en\",\n \"components\": [\n {\n \"text\": \"Reminder: Our technician will visit your location on {{1}} at {{2}} for your broadband installation. Please be available.\",\n \"type\": \"BODY\",\n \"example\": {\n \"body_text\": [\n [\n \"2025-08-27\",\n \"10:00\"\n ]\n ]\n }\n }\n ],\n \"sub_category\": \"CUSTOM\",\n \"parameter_format\": \"POSITIONAL\"\n}"},{"id":"5792f9ff-5cc2-4e49-af0f-a9b86453f313","name":"Fail","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":"https://api.bradial.com.br/v2/meta-api/inboxes/your_inbox_id/whatsapp/templates/your_template_name-n"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Template with name your_template_name not found\",\n \"error\": \"Not Found\",\n \"statusCode\": 404\n}"}],"_postman_id":"7ea83310-fd08-44b8-837c-b2b894b7c7f7"},{"name":"Sync","id":"b5dfd9e2-6a05-4a0a-81ef-641e53183ae6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.bradial.com.br/v2/meta-api/inboxes/your_inbox_id/whatsapp/templates/sync","description":"Este endpoint permite sincronizar os modelos locais com a API da Meta Cloud.
\n","urlObject":{"path":["v2","meta-api","inboxes","your_inbox_id","whatsapp","templates","sync"],"host":["https://api.bradial.com.br"],"query":[],"variable":[]}},"response":[{"id":"3d10d6cc-f2e4-4a98-bb59-a2f0f1a75c35","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":"https://api.bradial.com.br/v2/meta-api/inboxes/your_inbox_id/whatsapp/templates/sync"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b5dfd9e2-6a05-4a0a-81ef-641e53183ae6"}],"id":"6e198a9e-a5f2-4f5b-b5d4-dc8191faae3c","description":"Este subrecurso permite o gerenciamento dos templates registrados.
\n","_postman_id":"6e198a9e-a5f2-4f5b-b5d4-dc8191faae3c"},{"name":"Messages","item":[{"name":"Send Template Message","id":"dcb036da-1434-45d4-90d7-48f2722532e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your_api-key"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"phone\": \"phone_number\",\n \"template\": \"your_template_name\",\n \"params\": {\n \"body\": {\n \"customer_name\": \"João da Silva\",\n \"insurer_name\": \"Porto Seguro\",\n \"plate\": \"ABC-1234\",\n \"inspection_link\": \"https://app.realizavistorias.com.br/vistoria/12345\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/v2/meta-api/inboxes/your_inbox_id/whatsapp/messages/template","description":"Este endpoint permite o envio de mensagens a partir de templates pré-aprovados. O objeto parameters deve ser preenchido apenas quando o template contiver variáveis; caso não haja, este campo pode ser removido.
As mensagens são refletidas no Chat por padrão. Para desativar esse comportamento, utilize echo: false na raiz da requisição.
Este endpoint permite o envio de mensagens mais flexíveis, desde que a última interação do cliente tenha ocorrido nas últimas 24 horas. Caso a janela de 24 horas seja excedida, é necessário utilizar mensagens baseadas em templates e aguardar uma nova interação do cliente para então voltar a usar este recurso.
\nOs formatos disponíveis são: áudio, documento, imagem, botão, reação, texto e vídeo.
\nPara responder a uma mensagem anterior, utilize o campo replyToMessageId, informando o ID da mensagem original. Este parâmetro não é válido para mensagens dos tipos botão e reação.
As mensagens são refletidas no Chat por padrão. Para desativar esse comportamento, utilize echo: false na raiz da requisição.
Este endpoint permite marcar uma mensagem como lida.
\n","urlObject":{"path":["v2","meta-api","inboxes","your_inbox_id","whatsapp","messages","mark-as-read"],"host":["https://api.bradial.com.br"],"query":[],"variable":[]}},"response":[{"id":"67292214-de81-49b1-823b-1a5d274b4a9c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messageId\": \"Este recurso permite o envio de mensagens através da API do WhatsApp.
\n","_postman_id":"257d6e8e-2c2f-458f-8b4a-5c9572b6b047"}],"id":"a1f98408-04bf-47fd-a216-0d86626e2fab","description":"Este recurso permite executar ações no domínio do WhatsApp Oficial.
\n","_postman_id":"a1f98408-04bf-47fd-a216-0d86626e2fab"},{"name":"FindAll","id":"46ee0f07-2c8d-4988-af5e-862f0a490574","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":"https://api.bradial.com.br/v2/public-api/v1/inboxes?page=1","description":"Este endpoint permite listar todas as suas caixas de entrada.
\n","urlObject":{"path":["v2","public-api","v1","inboxes"],"host":["https://api.bradial.com.br"],"query":[{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"780318bf-1798-4921-b338-418609ff20c6","name":"List","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":{"raw":"https://api.bradial.com.br/v2/public-api/v1/inboxes?page=1","host":["https://api.bradial.com.br"],"path":["v2","public-api","v1","inboxes"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Loja 1\",\n \"isDefault\": true\n },\n {\n \"id\": 2,\n \"name\": \"Loja 2\",\n \"isDefault\": false\n }\n ],\n \"items\": 2\n}"}],"_postman_id":"46ee0f07-2c8d-4988-af5e-862f0a490574"}],"id":"b18a4195-0438-4ef0-a203-fe9478f3b6dd","_postman_id":"b18a4195-0438-4ef0-a203-fe9478f3b6dd","description":""},{"name":"Conversations","item":[{"name":"Private Message","id":"ff31819a-417f-4299-aa9e-7e5081f2005d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Private message for others agents.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.bradial.com.br/v2/public-api/v1/conversations//messages/private","description":"Este endpoint permite salvar mensagens privadas na conversa.
\n","urlObject":{"path":["v2","public-api","v1","conversations","","messages","private"],"host":["https://api.bradial.com.br"],"query":[],"variable":[]}},"response":[{"id":"6db5d7f0-a915-490f-a86a-02e25ce9920a","name":"Create","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api-key","type":"text"}],"url":"https://api.bradial.com.br/v2/public-api/v1/conversations//messages/private"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"ff31819a-417f-4299-aa9e-7e5081f2005d"}],"id":"1aa774b3-d431-42e7-b549-7b8c0e74db33","description":"Este recurso permite executar ações no domínio de Conversas no Chat.
\n","_postman_id":"1aa774b3-d431-42e7-b549-7b8c0e74db33"}],"id":"b060d695-6809-470f-a009-173514ad813c","event":[{"listen":"prerequest","script":{"id":"5bf5b893-7289-4e62-b785-7a97c05da6a6","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"10b47821-179f-4351-be36-261044dbc9a6","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"b060d695-6809-470f-a009-173514ad813c","description":""},{"name":"Webhook","item":[{"name":"Agent","item":[],"id":"3854c416-7b86-42d3-b9e0-f97598a0e1b7","description":"Este evento será acionado quando um novo agente for criado na conta.
\n{\n \"event\": \"agent_added\"\n // <...Agent Attributes>\n}\n\nEste evento será acionado quando um agente for atualizado na conta.
\n{\n \"event\": \"agent_updated\",\n \"changed_attributes\": [\n {\n \"<attribute_name>\": {\n \"current_value\": \"\",\n \"previous_value\": \"\"\n }\n }\n ]\n // <...Agent Attributes>\n}\n\nEste evento será acionado quando um agente for removido da conta.
\n{\n \"event\": \"agent_removed\"\n // <...Agent Attributes>\n}\n\nEste evento será acionado quando uma nova conversa for criada na conta. O payload do evento é o seguinte:
\n{\n \"event\": \"conversation_created\"\n // <...Conversation Attributes>\n}\n\nEste evento será acionado quando houver uma mudança em qualquer um dos atributos da conversa.
\n{\n \"event\": \"conversation_updated\",\n \"changed_attributes\": [\n {\n \"<attribute_name>\": {\n \"current_value\": \"\",\n \"previous_value\": \"\"\n }\n }\n ]\n // <...Conversation Attributes>\n}\n\nEste evento será acionado quando o status da conversa for alterado.
\n{\n \"event\": \"conversation_status_changed\"\n // <...Conversation Attributes>\n}\n\nEste evento será acionado quando uma mensagem for criada em uma conversa. O payload do evento é o seguinte:
\n{\n \"event\": \"message_created\"\n // <...Message Attributes>\n}\n\nEste evento será acionado quando uma mensagem for atualizada em uma conversa. O payload do evento é o seguinte:
\n{\n \"event\": \"message_updated\"\n // <...Message Attributes>\n}\n\nEste evento será acionado quando um contato for criado. O payload do evento é o seguinte:
\n{\n \"event\": \"contact_created\"\n // <...Message Attributes>\n}\n\nEste evento será acionado quando um contato for atualizado. O payload do evento é o seguinte:
\n{\n \"event\": \"contact_updated\"\n // <...Message Attributes>\n}\n\nUm payload de evento pode incluir qualquer um dos seguintes objetos. Os vários tipos de objetos suportados pelo Bradial Chat estão listados abaixo.
\n{\n \"id\": \"integer\",\n \"name\": \"string\"\n}\n\n{\n \"id\": \"integer\",\n \"name\": \"string\"\n}\n\n{\n \"id\": \"integer\",\n \"name\": \"string\",\n \"avatar\": \"string\",\n \"type\": \"contact\",\n \"phone_number\": \"string\",\n \"custom_attributes\": \"object\",\n \"labels\": [\"Array of label objects\"]\n \"account\": {\n // <...Account Object>\n }\n}\n\n{\n \"id\": \"integer\",\n \"name\": \"string\",\n \"email\": \"string\",\n \"type\": \"user\"\n}\n\n{\n \"additional_attributes\": {\n \"browser\": {\n \"device_name\": \"string\",\n \"browser_name\": \"string\",\n \"platform_name\": \"string\",\n \"browser_version\": \"string\",\n \"platform_version\": \"string\"\n },\n \"referer\": \"string\",\n \"initiated_at\": {\n \"timestamp\": \"iso-datetime\"\n }\n },\n \"can_reply\": \"boolean\",\n \"channel\": \"string\",\n \"id\": \"integer\",\n \"inbox_id\": \"integer\",\n \"contact_inbox\": {\n \"id\": \"integer\",\n \"contact_id\": \"integer\",\n \"inbox_id\": \"integer\",\n \"source_id\": \"string\",\n \"created_at\": \"datetime\",\n \"updated_at\": \"datetime\",\n \"hmac_verified\": \"boolean\"\n },\n \"messages\": [\"Array of message objects\"],\n \"meta\": {\n \"sender\": {\n // Contact Object\n },\n \"assignee\": {\n // User Object\n }\n },\n \"status\": \"string\",\n \"unread_count\": \"integer\",\n \"agent_last_seen_at\": \"unix-timestamp\",\n \"contact_last_seen_at\": \"unix-timestamp\",\n \"timestamp\": \"unix-timestamp\",\n \"account_id\": \"integer\"\n}\n\n{\n \"id\": \"integer\",\n \"content\": \"string\",\n \"message_type\": \"integer\",\n \"created_at\": \"unix-timestamp\",\n \"private\": \"boolean\",\n \"source_id\": \"string / null\",\n \"content_type\": \"string\",\n \"content_attributes\": \"object\",\n \"sender\": {\n \"type\": \"string - contact/user\"\n // User or Contact Object\n },\n \"account\": {\n // Account Object\n },\n \"conversation\": {\n // Conversation Object\n },\n \"inbox\": {\n // Inbox Object\n },\n \"attachments\": [\n {\n // Attachment Object\n }\n ],\n \"transcript\": {\n \"id\": \"integer\",\n \"content\": \"string / null\"\n }\n}\n\n{\n \"id\": \"integer\",\n \"title\": \"string\",\n \"description\": \"string\"\n}\n\n{\n \"id\": \"integer\",\n \"email\": \"string\",\n \"name\": \"string\",\n \"role\": \"string\",\n \"extension\": \"string\",\n \"can_spy_tickets\": \"boolean\",\n \"can_accept_preassign_tickets\": \"boolean\",\n \"see_all_previous_conversation\": \"boolean\",\n \"account\": {\n // Account Object\n }\n}\n\n{\n \"id\": \"integer\",\n \"email\": \"string\",\n \"account\": {\n // Account Object\n }\n}\n\nOs endpoints do Bradial Chat — a plataforma de atendimento — organizados em três blocos.
\nRelatórios entrega os indicadores de atendimento em JSON e em planilhas CSV, autenticado por x-api-key. É a superfície mais nova e a que não pede id de conta na URL: a chave já identifica a conta.
V2 reúne os endpoints operacionais: usuários, contatos, caixas de entrada e envio de mensagens.
\nWebhook documenta o caminho inverso — os eventos que o Bradial envia para o seu sistema quando algo acontece em um atendimento.
\n🔗 Fale com um dos nossos consultores para obter acesso e as credenciais.
\n","_postman_id":"3b45ba15-eb3f-4be8-96fb-264c8d1b35aa"},{"name":"CRM","item":[],"id":"2d3107d9-fecc-4d13-b035-94137192f1de","description":"🚧 Em desenvolvimento. Os endpoints de CRM ainda não estão disponíveis. Esta seção existe para sinalizar o que vem a seguir.
\nNada aqui deve ser integrado por enquanto: enquanto a seção estiver assim, não há contrato publicado, e caminhos, parâmetros e formatos de resposta podem mudar sem aviso.
\n🔗 Fale com um dos nossos consultores para acompanhar a liberação ou participar dos primeiros testes.
\n","_postman_id":"2d3107d9-fecc-4d13-b035-94137192f1de"}],"event":[{"listen":"prerequest","script":{"id":"e753230f-ed6b-4ead-93b6-23955f6b9518","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"f361075a-9b7e-42e7-9e98-cf32083c3dcd","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"api","value":"https://api.bradial.com.br"},{"key":"client-id","value":"your_client-id"},{"key":"client-secret","value":"your_client-secret"},{"key":"api-key","value":"your_api-key"},{"key":"integration-token","value":"your_integration-token"},{"key":"inbox_id","value":"your_inbox_id"},{"key":"template_name","value":"your_template_name"},{"key":"phone_number","value":"phone_number"},{"key":"agent_id","value":"your_agent_id"},{"key":"contact_id","value":"your_contact_id"},{"key":"display_id","value":""}]}