# ChatClean Docs - [Início](https://docs.chatclean.com.br/index.md): Documentação do ChatClean: atenda clientes de todos os canais e acompanhe as vendas no mesmo lugar. - [Primeiros passos](https://docs.chatclean.com.br/getting-started/quickstart.md): Entre na sua conta, conecte o primeiro canal e responda a primeira conversa. - [Conceitos](https://docs.chatclean.com.br/getting-started/conceitos.md): Os termos que aparecem em todo o ChatClean: conversa, contato, canal, agente, time, etiqueta, status e atribuição. - [Conversas](https://docs.chatclean.com.br/atendimento/conversas.md): A lista de conversas: abas, visões, busca, filtros, pastas, ordenação e ações em várias conversas de uma vez. - [Atender uma conversa](https://docs.chatclean.com.br/atendimento/responder.md): Responda, escreva notas privadas, use respostas prontas e anexos, atribua, adie, resolva e consulte o histórico do contato. - [Ao vivo](https://docs.chatclean.com.br/atendimento/ao-vivo.md): Acompanhe em tempo real a fila e as conversas de cada atendente, veja quem está esperando demais e redistribua conversas. - [Caixa de Entrada](https://docs.chatclean.com.br/atendimento/caixa-de-entrada.md): As suas notificações: menções, conversas atribuídas a você e mensagens novas nas conversas que você acompanha. - [Contatos](https://docs.chatclean.com.br/atendimento/contatos.md): Encontre, filtre, organize e edite os contatos, salve segmentos, importe e exporte listas, arquive e mescle contatos. - [Funil de vendas](https://docs.chatclean.com.br/vendas/funil.md): Crie pipelines, monte as etapas, defina o que cada etapa exige e acompanhe os negócios no quadro. - [Negócios](https://docs.chatclean.com.br/vendas/negocios.md): Crie negócios, mova entre etapas, registre valor, produtos, atividades e arquivos, e marque como ganho ou perdido. - [Entrada de leads](https://docs.chatclean.com.br/vendas/entrada-de-leads.md): Transforme cada conversa nova em um negócio no pipeline padrão, com filtros por canal, origem e fonte. - [Impulsos e campanhas](https://docs.chatclean.com.br/vendas/impulsos-e-campanhas.md): Envie mensagens automáticas quando um negócio entra numa etapa, ou dispare uma mensagem para todos que estão nela agora. - [IA do pipeline](https://docs.chatclean.com.br/vendas/ia-do-pipeline.md): Deixe a IA sugerir o próximo passo, preencher campos ao mover e explicar a temperatura de cada negócio, com teto de gasto mensal. - [Empresas](https://docs.chatclean.com.br/vendas/empresas.md): Agrupe contatos por empresa, veja as conversas e notas de cada conta e ligue empresas aos negócios. - [Produtos](https://docs.chatclean.com.br/vendas/produtos.md): Cadastre o que a empresa vende e use o catálogo nos negócios, no valor e nos relatórios. - [Campanhas](https://docs.chatclean.com.br/campanhas/visao-geral.md): Envie mensagens proativas: no chat do site para quem visita uma página, por SMS ou por modelo aprovado do WhatsApp para um público por etiqueta. - [Regras de automação](https://docs.chatclean.com.br/automacao/regras.md): Crie regras que agem sozinhas nas conversas: um evento dispara a regra, as condições filtram e as ações são executadas. - [Robôs](https://docs.chatclean.com.br/automacao/robos.md): Conecte um robô próprio a uma caixa de entrada por webhook para fazer o primeiro atendimento e passar a conversa para um agente. - [Macros](https://docs.chatclean.com.br/automacao/macros.md): Salve uma sequência de ações e execute tudo de uma vez numa conversa, com um clique. - [Respostas Prontas](https://docs.chatclean.com.br/automacao/respostas-prontas.md): Salve mensagens que você usa sempre e insira na conversa digitando / e o atalho. - [Visão geral](https://docs.chatclean.com.br/relatorios/visao-geral.md): Resumo de atendimento e vendas do período: conversas, vendas ganhas, conversão, canais, pipeline e desempenho por atendente. - [Vendas & Pipeline](https://docs.chatclean.com.br/relatorios/vendas.md): Pipeline, receita, perdas e ritmo da equipe: indicadores, conversão entre etapas, ranking, origens, produtos, motivos e estagnação. - [Relatórios de atendimento](https://docs.chatclean.com.br/relatorios/atendimento.md): Acompanhe volume de conversas, tempos de resposta e resolução por agente, time, etiqueta e caixa de entrada, além da satisfação dos clientes (CSAT) e do desempenho dos robôs. - [Canais](https://docs.chatclean.com.br/canais/visao-geral.md): Conecte WhatsApp, Instagram, Facebook, chat do site, e-mail e outros canais, e ajuste agentes, horário de atendimento, saudação e pesquisa de satisfação de cada um. - [WhatsApp](https://docs.chatclean.com.br/canais/whatsapp.md): Conecte o número do WhatsApp Business da sua empresa pela API oficial da Meta, com o cadastro incorporado. - [Instagram](https://docs.chatclean.com.br/canais/instagram.md): Conecte uma conta profissional do Instagram pelo login do Instagram e responda as mensagens diretas no ChatClean. - [Facebook](https://docs.chatclean.com.br/canais/facebook.md): Conecte uma página do Facebook e responda as mensagens do Messenger no ChatClean. - [Chat do site](https://docs.chatclean.com.br/canais/site.md): Crie o chat ao vivo (widget) do seu site, instale o script e ajuste aparência, formulário pré-chat e segurança. - [E-mail](https://docs.chatclean.com.br/canais/email.md): Conecte uma caixa de e-mail do Gmail, do Outlook ou de outro provedor e atenda os e-mails como conversas. - [Telegram](https://docs.chatclean.com.br/canais/telegram.md): Conecte um bot do Telegram ao ChatClean usando o token do bot. - [SMS](https://docs.chatclean.com.br/canais/sms.md): Conecte um número de SMS da Twilio ou da Bandwidth e atenda os SMS como conversas. - [Canal API](https://docs.chatclean.com.br/canais/api.md): Crie um canal próprio para ligar o seu sistema ao ChatClean: mensagens entram pela API e saem pelo webhook. - [Conta](https://docs.chatclean.com.br/configuracoes/conta.md): Altere o nome e o idioma da conta e encontre o ID da conta para integrações pela API. - [Agentes](https://docs.chatclean.com.br/configuracoes/agentes.md): Convide pessoas para a conta, defina a função de cada uma (Administrador ou Agente) e acompanhe a disponibilidade. - [Times](https://docs.chatclean.com.br/configuracoes/times.md): Agrupe agentes por área, como Vendas ou Suporte, atribua conversas ao time e deixe o ChatClean distribuir entre os membros. - [Etiquetas](https://docs.chatclean.com.br/configuracoes/etiquetas.md): Crie etiquetas para organizar conversas e contatos e use-as em filtros, automações e relatórios. - [Atributos Personalizados](https://docs.chatclean.com.br/configuracoes/atributos-personalizados.md): Crie campos próprios para conversas, contatos, empresas e negócios do funil, como plano contratado, CPF ou data da primeira compra. - [Modelos do WhatsApp](https://docs.chatclean.com.br/configuracoes/modelos-whatsapp.md): Veja os modelos de mensagem aprovados pela Meta nas suas caixas de entrada do WhatsApp, sincronize e entenda as categorias Marketing e Utilidade. - [Integrações](https://docs.chatclean.com.br/configuracoes/integracoes.md): Envie eventos da conta para os seus sistemas por webhook, mostre aplicativos próprios dentro das conversas e conecte ferramentas externas. - [Perfil](https://docs.chatclean.com.br/configuracoes/perfil.md): Ajuste seu nome, foto, senha, idioma, assinatura de mensagem, alertas e notificações, e copie o token de acesso à API. - [Suporte](https://docs.chatclean.com.br/support.md): Fale com o suporte do ChatClean - [Introdução](https://docs.chatclean.com.br/api-reference/introduction.md): Autentique com o seu token de acesso e chame a API REST do ChatClean: URL base, identificador da conta, tipos de token e erros. - [Enviar mensagens](https://docs.chatclean.com.br/api-reference/guides/enviar-mensagens.md): Crie um contato, abra uma conversa num canal e envie mensagens pela API, inclusive modelos aprovados do WhatsApp. - [Webhooks](https://docs.chatclean.com.br/api-reference/guides/webhooks.md): Receba os eventos da sua conta do ChatClean numa URL sua: eventos disponíveis, formato e verificação da assinatura. - [Create a contact](https://docs.chatclean.com.br/api-reference/contacts-api/create-a-contact.md): Create a contact - [Get a contact](https://docs.chatclean.com.br/api-reference/contacts-api/get-a-contact.md): Get the details of a contact - [Update a contact](https://docs.chatclean.com.br/api-reference/contacts-api/update-a-contact.md): Update a contact's attributes - [List all conversations](https://docs.chatclean.com.br/api-reference/conversations-api/list-all-conversations.md): List all conversations for the contact - [Create a conversation](https://docs.chatclean.com.br/api-reference/conversations-api/create-a-conversation.md): Create a conversation - [Get a single conversation](https://docs.chatclean.com.br/api-reference/conversations-api/get-a-single-conversation.md): Retrieves the details of a specific conversation - [Resolve a conversation](https://docs.chatclean.com.br/api-reference/conversations-api/resolve-a-conversation.md): Marks a conversation as resolved - [Toggle typing status](https://docs.chatclean.com.br/api-reference/conversations-api/toggle-typing-status.md): Toggles the typing status in a conversation - [Update last seen and mark messages read](https://docs.chatclean.com.br/api-reference/conversations-api/update-last-seen-and-mark-messages-read.md): Updates the contact's last seen time for the conversation and marks agent messages sent before that time as read. Use this to send read receipts from a custom client built on the API channel, so agents can see when the contact has read their messages. - [List all messages](https://docs.chatclean.com.br/api-reference/messages-api/list-all-messages.md): List all messages in the conversation - [Create a message](https://docs.chatclean.com.br/api-reference/messages-api/create-a-message.md): Create a message - [Update a message](https://docs.chatclean.com.br/api-reference/messages-api/update-a-message.md): Update a message - [Get account details](https://docs.chatclean.com.br/api-reference/account/get-account-details.md): Get the details of the current account - [Update account](https://docs.chatclean.com.br/api-reference/account/update-account.md): Update account details, settings, and custom attributes - [List all AgentBots](https://docs.chatclean.com.br/api-reference/account-agentbots/list-all-agentbots.md): List all agent bots available for the current account - [Create an Agent Bot](https://docs.chatclean.com.br/api-reference/account-agentbots/create-an-agent-bot.md): Create an agent bot in the account - [Get an agent bot details](https://docs.chatclean.com.br/api-reference/account-agentbots/get-an-agent-bot-details.md): Get the details of an agent bot in the account - [Delete an AgentBot](https://docs.chatclean.com.br/api-reference/account-agentbots/delete-an-agentbot.md): Delete an AgentBot from the account - [Update an agent bot](https://docs.chatclean.com.br/api-reference/account-agentbots/update-an-agent-bot.md): Update an agent bot's attributes - [List Agents in Account](https://docs.chatclean.com.br/api-reference/agents/list-agents-in-account.md): Get Details of Agents in an Account - [Add a New Agent](https://docs.chatclean.com.br/api-reference/agents/add-a-new-agent.md): Add a new Agent to Account - [Remove an Agent from Account](https://docs.chatclean.com.br/api-reference/agents/remove-an-agent-from-account.md): Remove an Agent from Account - [Update Agent in Account](https://docs.chatclean.com.br/api-reference/agents/update-agent-in-account.md): Update an Agent in Account - [List all Canned Responses in an Account](https://docs.chatclean.com.br/api-reference/canned-responses/list-all-canned-responses-in-an-account.md): Get Details of Canned Responses in an Account - [Add a New Canned Response](https://docs.chatclean.com.br/api-reference/canned-responses/add-a-new-canned-response.md): Add a new Canned Response to Account - [Remove a Canned Response from Account](https://docs.chatclean.com.br/api-reference/canned-responses/remove-a-canned-response-from-account.md): Remove a Canned Response from Account - [Update Canned Response in Account](https://docs.chatclean.com.br/api-reference/canned-responses/update-canned-response-in-account.md): Update a Canned Response in Account - [List all custom attributes in an account](https://docs.chatclean.com.br/api-reference/custom-attributes/list-all-custom-attributes-in-an-account.md): Get details of custom attributes in an Account - [Add a new custom attribute](https://docs.chatclean.com.br/api-reference/custom-attributes/add-a-new-custom-attribute.md): Add a new custom attribute to account - [Get a custom attribute details](https://docs.chatclean.com.br/api-reference/custom-attributes/get-a-custom-attribute-details.md): Get the details of a custom attribute in the account - [Remove a custom attribute from account](https://docs.chatclean.com.br/api-reference/custom-attributes/remove-a-custom-attribute-from-account.md): Remove a custom attribute from account - [Update custom attribute in Account](https://docs.chatclean.com.br/api-reference/custom-attributes/update-custom-attribute-in-account.md): Update a custom attribute in account - [List Contacts](https://docs.chatclean.com.br/api-reference/contacts/list-contacts.md): Listing all the resolved contacts with pagination (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number - [Create Contact](https://docs.chatclean.com.br/api-reference/contacts/create-contact.md): Create a new Contact - [Show Contact](https://docs.chatclean.com.br/api-reference/contacts/show-contact.md): Get a contact belonging to the account using ID - [Update Contact](https://docs.chatclean.com.br/api-reference/contacts/update-contact.md): Update a contact belonging to the account using ID - [Delete Contact](https://docs.chatclean.com.br/api-reference/contacts/delete-contact.md): Delete a contact belonging to the account using ID - [Contact Conversations](https://docs.chatclean.com.br/api-reference/contacts/contact-conversations.md): Get conversations associated with that contact - [Search Contacts](https://docs.chatclean.com.br/api-reference/contacts/search-contacts.md): Search the resolved contacts using a search key, currently supports email search (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number - [Contact Filter](https://docs.chatclean.com.br/api-reference/contacts/contact-filter.md): Filter contacts with custom filter options and pagination - [Create contact inbox](https://docs.chatclean.com.br/api-reference/contacts/create-contact-inbox.md): Create a contact inbox record for an inbox - [Get Contactable Inboxes](https://docs.chatclean.com.br/api-reference/contacts/get-contactable-inboxes.md): Get List of contactable Inboxes - [Merge Contacts](https://docs.chatclean.com.br/api-reference/contacts/merge-contacts.md): Merge two contacts into a single contact. The base contact remains and receives all data from the mergee contact. After the merge, the mergee contact is permanently deleted. - [List Labels](https://docs.chatclean.com.br/api-reference/contact-labels/list-labels.md): Lists all the labels of a contact - [Add Labels](https://docs.chatclean.com.br/api-reference/contact-labels/add-labels.md): Add labels to a contact. Note that this API would overwrite the existing list of labels associated to the conversation. - [List all automation rules in an account](https://docs.chatclean.com.br/api-reference/automation-rule/list-all-automation-rules-in-an-account.md): Get details of automation rules in an Account - [Add a new automation rule](https://docs.chatclean.com.br/api-reference/automation-rule/add-a-new-automation-rule.md): Add a new automation rule to account - [Get a automation rule details](https://docs.chatclean.com.br/api-reference/automation-rule/get-a-automation-rule-details.md): Get the details of a automation rule in the account - [Remove a automation rule from account](https://docs.chatclean.com.br/api-reference/automation-rule/remove-a-automation-rule-from-account.md): Remove a automation rule from account - [Update automation rule in Account](https://docs.chatclean.com.br/api-reference/automation-rule/update-automation-rule-in-account.md): Update a automation rule in account - [List all portals in an account](https://docs.chatclean.com.br/api-reference/help-center/list-all-portals-in-an-account.md): Get details of portals in an Account - [Add a new portal](https://docs.chatclean.com.br/api-reference/help-center/add-a-new-portal.md): Add a new portal to account - [Get a portal details](https://docs.chatclean.com.br/api-reference/help-center/get-a-portal-details.md): Get the details of a portal in the account - [Update a portal](https://docs.chatclean.com.br/api-reference/help-center/update-a-portal.md): Update a portal to account - [Add a new category](https://docs.chatclean.com.br/api-reference/help-center/add-a-new-category.md): Add a new category to portal - [Add a new article](https://docs.chatclean.com.br/api-reference/help-center/add-a-new-article.md): Add a new article to portal - [Get Conversation Counts](https://docs.chatclean.com.br/api-reference/conversations/get-conversation-counts.md): Get open, unassigned and all Conversation counts - [Conversations List](https://docs.chatclean.com.br/api-reference/conversations/conversations-list.md): List all the conversations with pagination - [Create New Conversation](https://docs.chatclean.com.br/api-reference/conversations/create-new-conversation.md): Creating a conversation in ChatClean requires a source id. - [Conversations Filter](https://docs.chatclean.com.br/api-reference/conversations/conversations-filter.md): Filter conversations with custom filter options and pagination - [Conversation Details](https://docs.chatclean.com.br/api-reference/conversations/conversation-details.md): Get all details regarding a conversation with all messages in the conversation - [Update Conversation](https://docs.chatclean.com.br/api-reference/conversations/update-conversation.md): Update Conversation Attributes - [Toggle Status](https://docs.chatclean.com.br/api-reference/conversations/toggle-status.md): Toggle the status of a conversation. Pass `status` to explicitly set the conversation state. Use `snoozed` along with `snoozed_until` to snooze a conversation until a specific time. If `snoozed_until` is omitted, the conversation is snoozed until the next reply from the contact. Regardless of the va… - [Toggle Priority](https://docs.chatclean.com.br/api-reference/conversations/toggle-priority.md): Toggles the priority of conversation - [Toggle Typing Status](https://docs.chatclean.com.br/api-reference/conversations/toggle-typing-status.md): Toggles the typing status for a conversation. - [Update Last Seen](https://docs.chatclean.com.br/api-reference/conversations/update-last-seen.md): Updates the last seen of the conversation so that conversations will have the bubbles in the agents screen - [Update Custom Attributes](https://docs.chatclean.com.br/api-reference/conversations/update-custom-attributes.md): Updates the custom attributes of a conversation - [Destroy Custom Attributes](https://docs.chatclean.com.br/api-reference/conversations/destroy-custom-attributes.md): Removes the given custom attribute keys from a conversation - [List Labels](https://docs.chatclean.com.br/api-reference/conversations/list-labels.md): Lists all the labels of a conversation - [Add Labels](https://docs.chatclean.com.br/api-reference/conversations/add-labels.md): Add labels to a conversation. Note that this API would overwrite the existing list of labels associated to the conversation. - [Conversation Reporting Events](https://docs.chatclean.com.br/api-reference/conversations/conversation-reporting-events.md): Get reporting events for a specific conversation. This endpoint returns events such as first response time, resolution time, and other metrics for the conversation, sorted by creation time in ascending order. - [Assign Conversation](https://docs.chatclean.com.br/api-reference/conversation-assignments/assign-conversation.md): Assign a conversation to an agent or a team - [Get account branded email layout](https://docs.chatclean.com.br/api-reference/inboxes/get-account-branded-email-layout.md): Get the account-scoped Liquid HTML layout used as the fallback for branded email replies. - [Update account branded email layout](https://docs.chatclean.com.br/api-reference/inboxes/update-account-branded-email-layout.md): Update or clear the account-scoped Liquid HTML layout used as the fallback for branded email replies. - [List all inboxes](https://docs.chatclean.com.br/api-reference/inboxes/list-all-inboxes.md): List all inboxes available in the current account - [Create an inbox](https://docs.chatclean.com.br/api-reference/inboxes/create-an-inbox.md): You can create more than one website inbox in each account - [Get an inbox](https://docs.chatclean.com.br/api-reference/inboxes/get-an-inbox.md): Get an inbox available in the current account - [Update Inbox](https://docs.chatclean.com.br/api-reference/inboxes/update-inbox.md): Update an existing inbox - [List WhatsApp message templates](https://docs.chatclean.com.br/api-reference/inboxes/list-whatsapp-message-templates.md): List the cached message templates available for a native or Twilio WhatsApp inbox - [Show Inbox Agent Bot](https://docs.chatclean.com.br/api-reference/inboxes/show-inbox-agent-bot.md): See if an agent bot is associated to the Inbox - [Add or remove agent bot](https://docs.chatclean.com.br/api-reference/inboxes/add-or-remove-agent-bot.md): To add an agent bot pass agent_bot id, to remove agent bot from an inbox pass null - [List Agents in Inbox](https://docs.chatclean.com.br/api-reference/inboxes/list-agents-in-inbox.md): Get Details of Agents in an Inbox - [Add a New Agent](https://docs.chatclean.com.br/api-reference/inboxes/add-a-new-agent.md): Add a new Agent to Inbox - [Remove an Agent from Inbox](https://docs.chatclean.com.br/api-reference/inboxes/remove-an-agent-from-inbox.md): Remove an Agent from Inbox - [Update Agents in Inbox](https://docs.chatclean.com.br/api-reference/inboxes/update-agents-in-inbox.md): All agents except the one passed in params will be removed - [List all labels](https://docs.chatclean.com.br/api-reference/labels/list-all-labels.md): List all labels available in the current account - [Create a label](https://docs.chatclean.com.br/api-reference/labels/create-a-label.md): Create a label in the account - [Get a label](https://docs.chatclean.com.br/api-reference/labels/get-a-label.md): Get the details of a label in the account - [Delete a label](https://docs.chatclean.com.br/api-reference/labels/delete-a-label.md): Delete a label from the account - [Update a label](https://docs.chatclean.com.br/api-reference/labels/update-a-label.md): Update a label's attributes - [Get messages](https://docs.chatclean.com.br/api-reference/messages/get-messages.md): List all messages of a conversation - [Create New Message](https://docs.chatclean.com.br/api-reference/messages/create-new-message.md): Create a new message in the conversation. - [Delete a message](https://docs.chatclean.com.br/api-reference/messages/delete-a-message.md): Delete a message and it's attachments from the conversation. - [Update message status](https://docs.chatclean.com.br/api-reference/messages/update-message-status.md): Updates the delivery status of a single message. Available only for messages in API channel inboxes, where your own system is responsible for delivering messages and reporting what happened. Use this to push `sent`, `delivered`, and `read` receipts into ChatClean, for example, to mark an agent's mes… - [List all the Integrations](https://docs.chatclean.com.br/api-reference/integrations/list-all-the-integrations.md): Get the details of all Integrations available for the account - [Create an integration hook](https://docs.chatclean.com.br/api-reference/integrations/create-an-integration-hook.md): Create an integration hook - [Delete an Integration Hook](https://docs.chatclean.com.br/api-reference/integrations/delete-an-integration-hook.md): Delete an Integration Hook - [Update an Integration Hook](https://docs.chatclean.com.br/api-reference/integrations/update-an-integration-hook.md): Update an Integration Hook - [Fetch user profile](https://docs.chatclean.com.br/api-reference/profile/fetch-user-profile.md): Get the user profile details - [Update user profile](https://docs.chatclean.com.br/api-reference/profile/update-user-profile.md): Update the user profile details - [List all teams](https://docs.chatclean.com.br/api-reference/teams/list-all-teams.md): List all teams available in the current account - [Create a team](https://docs.chatclean.com.br/api-reference/teams/create-a-team.md): Create a team in the account - [Get a team details](https://docs.chatclean.com.br/api-reference/teams/get-a-team-details.md): Get the details of a team in the account - [Delete a team](https://docs.chatclean.com.br/api-reference/teams/delete-a-team.md): Delete a team from the account - [Update a team](https://docs.chatclean.com.br/api-reference/teams/update-a-team.md): Update a team's attributes - [List Agents in Team](https://docs.chatclean.com.br/api-reference/teams/list-agents-in-team.md): Get Details of Agents in an Team - [Add a New Agent](https://docs.chatclean.com.br/api-reference/teams/add-a-new-agent.md): Add a new Agent to Team - [Remove an Agent from Team](https://docs.chatclean.com.br/api-reference/teams/remove-an-agent-from-team.md): Remove an Agent from Team - [Update Agents in Team](https://docs.chatclean.com.br/api-reference/teams/update-agents-in-team.md): All agents except the one passed in params will be removed - [List all custom filters](https://docs.chatclean.com.br/api-reference/custom-filters/list-all-custom-filters.md): List all custom filters in a category of a user - [Create a custom filter](https://docs.chatclean.com.br/api-reference/custom-filters/create-a-custom-filter.md): Create a custom filter in the account - [Get a custom filter details](https://docs.chatclean.com.br/api-reference/custom-filters/get-a-custom-filter-details.md): Get the details of a custom filter in the account - [Delete a custom filter](https://docs.chatclean.com.br/api-reference/custom-filters/delete-a-custom-filter.md): Delete a custom filter from the account - [Update a custom filter](https://docs.chatclean.com.br/api-reference/custom-filters/update-a-custom-filter.md): Update a custom filter's attributes - [List all webhooks](https://docs.chatclean.com.br/api-reference/webhooks/list-all-webhooks.md): List all webhooks in the account - [Add a webhook](https://docs.chatclean.com.br/api-reference/webhooks/add-a-webhook.md): Add a webhook subscription to the account - [Delete a webhook](https://docs.chatclean.com.br/api-reference/webhooks/delete-a-webhook.md): Delete a webhook from the account - [Update a webhook object](https://docs.chatclean.com.br/api-reference/webhooks/update-a-webhook-object.md): Update a webhook object in the account - [Account Reporting Events](https://docs.chatclean.com.br/api-reference/reports/account-reporting-events.md): Get paginated reporting events for the account. This endpoint returns reporting events such as first response time, resolution time, and other metrics. Only administrators can access this endpoint. Results are paginated with 25 items per page. - [Get Account reports](https://docs.chatclean.com.br/api-reference/reports/get-account-reports.md): Get Account reports for a specific type, metric and date range - [Get Account reports summary](https://docs.chatclean.com.br/api-reference/reports/get-account-reports-summary.md): Get Account reports summary for a specific type and date range - [Account Conversation Metrics](https://docs.chatclean.com.br/api-reference/reports/account-conversation-metrics.md): Get conversation metrics for Account - [Agent Conversation Metrics](https://docs.chatclean.com.br/api-reference/reports/agent-conversation-metrics.md): Get conversation metrics for Agent - [Get conversation statistics grouped by channel type](https://docs.chatclean.com.br/api-reference/reports/get-conversation-statistics-grouped-by-channel-type.md): Get conversation counts grouped by channel type and status for a given date range. Returns statistics for each channel type including open, resolved, pending, snoozed, and total conversation counts. - [Get conversation statistics grouped by inbox](https://docs.chatclean.com.br/api-reference/reports/get-conversation-statistics-grouped-by-inbox.md): Get conversation statistics grouped by inbox for a given date range. Returns metrics for each inbox including conversation counts, resolution counts, average first response time, average resolution time, and average reply time. - [Get conversation statistics grouped by agent](https://docs.chatclean.com.br/api-reference/reports/get-conversation-statistics-grouped-by-agent.md): Get conversation statistics grouped by agent for a given date range. Returns metrics for each agent including conversation counts, resolution counts, average first response time, average resolution time, and average reply time. - [Get conversation statistics grouped by team](https://docs.chatclean.com.br/api-reference/reports/get-conversation-statistics-grouped-by-team.md): Get conversation statistics grouped by team for a given date range. Returns metrics for each team including conversation counts, resolution counts, average first response time, average resolution time, and average reply time. - [Get first response time distribution by channel](https://docs.chatclean.com.br/api-reference/reports/get-first-response-time-distribution-by-channel.md): Get the distribution of first response times grouped by channel type. Returns conversation counts in different time buckets (0-1h, 1-4h, 4-8h, 8-24h, 24h+) for each channel type. - [Get inbox-label matrix report](https://docs.chatclean.com.br/api-reference/reports/get-inbox-label-matrix-report.md): Get a matrix showing the count of conversations for each inbox-label combination. Returns a list of inboxes, labels, and a 2D matrix where each cell contains the count of conversations in a specific inbox that have a specific label applied. - [Get outgoing messages count grouped by entity](https://docs.chatclean.com.br/api-reference/reports/get-outgoing-messages-count-grouped-by-entity.md): Get the count of outgoing messages grouped by a specified entity (agent, team, inbox, or label). When grouped by agent, messages sent by bots (AgentBot, Captain::Assistant) are excluded. - [List campaigns](https://docs.chatclean.com.br/api-reference/campaigns/list-campaigns.md): List all campaigns in the account. The response is an unpaginated array. Requires an account administrator and API access enabled for the account. - [Create a campaign](https://docs.chatclean.com.br/api-reference/campaigns/create-a-campaign.md): Create a campaign. For a supported messaging inbox, provide scheduled_at to schedule a one-off campaign; omitting it makes the campaign eligible for the next scheduler run. Website campaigns use trigger_rules instead. Channel-specific campaign availability and requirements still apply. One-off campa… - [Get a campaign](https://docs.chatclean.com.br/api-reference/campaigns/get-a-campaign.md): Retrieve a campaign using its account-scoped ID. Requires an account administrator and API access enabled for the account. - [Delete a campaign](https://docs.chatclean.com.br/api-reference/campaigns/delete-a-campaign.md): Delete a campaign from the account. Requires an account administrator and API access enabled for the account. - [Update a campaign](https://docs.chatclean.com.br/api-reference/campaigns/update-a-campaign.md): Update campaign fields, including scheduled_at to reschedule an active one-off campaign. Completed campaigns cannot be updated. Requires an account administrator and API access enabled for the account. ## OpenAPI Specs - [openapi](/openapi.json) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.