Jump to Content
Documentação
Tutoriais
Referências de API
Registro de alterações
Fórum de Discussão
🇺🇸
🇪🇸
Discord
Referências de API
🇺🇸
🇪🇸
Discord
Moon (Dark Mode)
Sun (Light Mode)
Documentação
Tutoriais
Referências de API
Registro de alterações
Fórum de Discussão
Widgets
Search
JUMP TO
Referências de API da Kommo
Conta
Parâmetros da Conta
get
OAuth 2.0
Obter/renovar um token de acesso
post
Leads de entrada
Lista de Leads de entrada
get
Obtendo um lead de entrada pelo seu UID
get
Adicionando leads de entrada do tipo SIP (chamada)
post
Adicionando leads de entrada do tipo formulário
post
Aceitando leads de entrada
post
Recusando leads de entrada
delete
Vinculação de leads de entrada
post
Resumo das informações sobre leads de entrada
get
Descrição dos objetos de metadados
Leads
Lista de Leads
get
Obtendo um Lead pelo seu ID
get
Adicionando Leads
post
Atualizando Leads
patch
Atualizando um Lead
patch
Adição complexa de leads com contato e empresa
post
Pipelines e estágios de leads
Lista de pipelines
get
Obtendo um pipeline pelo seu ID
get
Adicionando pipelines
post
Editar um pipeline
patch
Excluindo um pipeline
delete
Lista de etapas do Pipeline
get
Obtendo dados de uma etapa do pipeline pelo seu ID
get
Adicionando Etapas no Pipeline
post
Edição de Etapa do Pipeline
patch
Exclusão de Etapa do Pipeline
delete
Cores de Etapa disponíveis
Contatos
Lista de Contatos
get
Obtendo um contato pelo seu ID
get
Adicionando Contatos
post
Atualizando Contatos
patch
Atualizando um único Contato
patch
Empresas
Lista de Empresas
get
Obter uma Empresa pelo seu ID
get
Adicionar Empresas
post
Atualizando Empresas
patch
Atualizando uma única empresa
patch
Listas
Obter uma lista de listas
get
Obter uma única lista
get
Adicionando Listas
post
Editando Listas
patch
Editando uma única Lista
patch
Obter lista de elementos
get
Obter um único elemento da lista
get
Adicionando elementos de lista
post
Editando elementos da lista
patch
Editando um único elemento da lista
patch
Campos personalizados
Lista de campos personalizados
get
Lista de campos personalizados de uma lista
get
Obtendo um campo de entidade pelo seu ID
get
Obtendo um campo de lista pelo seu ID
get
Adicionando campos personalizados
post
Adicionar um campo personalizado a uma lista
post
Atualizando campos personalizados
patch
Atualizando um único campo personalizado
patch
Atualizando campos personalizados de uma lista
patch
Atualizando um campo personalizado de uma lista
patch
Excluindo um campo personalizado
delete
Usuários e funções
Lista de usuários
get
Obtenção de dados do usuário pelo seu ID
get
Adicionando usuários
post
Lista de funções de usuário
get
Obtendo dados de uma função pelo seu ID
get
Adicionando funções
post
Editando funções
patch
Excluindo uma função
delete
Tarefas
Lista de tarefas
get
Obtendo uma tarefa pelo seu ID
get
Adicionando tarefas
post
Editando tarefas
patch
Editando uma única tarefa
patch
Eventos
Lista de eventos
get
Obtendo um evento pelo seu ID
get
Obtendo tipos de eventos
get
Tipos de evento
Filtragem de eventos
Notas
Obtendo a lista de notas de uma única entidade pelo ID da entidade
get
Lista de notas por tipo de entidade
get
Obter uma nota pelo seu ID
get
Adicionando notas
post
Editando notas
patch
Editando uma única nota
patch
Tipos de notas
Tags
Lista de tags de entidade
get
Adicionando tags para um tipo específico de entidade
post
Atualizando tags
patch
Atualizando tags de uma única entidade
patch
Cores de Tags
Vínculos entre entidades
Lista de entidades vinculadas
get
Vinculando entidades
post
Desvincular entidades
post
Salesbot
Lançar Salesbot
post
Confirmação de execução do bloco do widget SalesBot
post
Fontes
Obter uma lista de fontes
get
Obter uma fonte pelo seu ID
get
Adicionar fontes
post
Atualizar uma única fonte
patch
Atualizar fontes
patch
Excluir uma única fonte
delete
Excluir fontes
delete
Modelos
Obter uma lista de modelos
get
Obter um modelo por ID
get
Adicionar modelos
post
Editar modelos
patch
Enviar um modelo do WhatsApp para moderação
post
Editar o status de um modelo do WhatsApp
post
Excluir modelos
delete
Excluir um único modelo
delete
Webhooks
Lista de webhooks
get
Adicionando um webhook
post
Excluindo um webhook
delete
Eventos de Webhook
Widgets
Lista de widgets
get
Obtendo as informações do widget pelo seu código
get
Instalando o widget na conta
post
Desinstalando o widget
delete
Conversas
Obter uma conversa por ID
get
Fechar uma conversa pelo ID
post
Chamadas
Adicionar chamadas
post
Chats API
Cinco passos para enviar uma mensagem
Etapa 1: Registrar um novo canal
Etapa 2: Conectar canal do chat
post
Etapa 3: Criar novo chat
post
Etapa 4: Vincular chat ao contato
post
Etapa 5: Enviar, receber ou importar mensagens
post
Obter histórico de chat
get
Obter chats de contato
get
Transferir informações de digitação
post
Enviar ou retirar reações
post
Desconectar canal de chat
delete
ID da conta da API de Chat
Recebendo Webhooks de Chat
Files API
Recursos da API de Arquivos
Recursos-chave da API de Arquivos
Métodos da API de Arquivos
Introdução
Obter um arquivo por UUID
get
Obter uma lista de arquivos
get
Criar uma sessão de upload de arquivo
post
Carregar uma parte do arquivo
post
Editar um arquivo
patch
Excluir arquivos
delete
Restaurar arquivos
post
Obter uma versão do arquivo
get
Obter arquivos anexados a uma entidade
get
Anexar arquivos a uma entidade
put
Desanexar arquivos de uma entidade
delete
Obter entidades associadas a um arquivo
get
Powered by
Widgets
Nesta seção, descreveremos os métodos da API para trabalhar com widgets.