Jump to Content
RD Station
App Publisher
App Store
Blog
Suporte
Status
Home
Recipes
API
Changelog
RD Station
App Publisher
App Store
Blog
Suporte
Status
Acesse sua conta
API
Acesse sua conta
Home
Recipes
API
Changelog
Evento de Conversão via API Key
All
Pages
Start typing to search…
JUMP TO
Introdução
Boas vindas
Suporte
Integrações multiproduto
Webhook Service
Criar um webhook
post
Listar todos os webhooks
get
Listar um Webhook
get
Atualizar um Webhook
put
Deletar um Webhook
del
Webhooks CRM payload
Webhooks MKT payload
Retries Logic
Boas Práticas
Exemplos de casos de uso
RD Station Marketing API
Introdução e requisitos
Guia de uso
Bases Legais
Limite de requisições da API
Como migrar a API 1.x para API 2.0 do RD Station Marketing
Mensagens de erro
Enriquecimento de dados
Autenticação
[Vídeo] Como configurar a Autenticação OAuth na sua aplicação e boas práticas
Passo 1: Como criar um aplicativo na App Store e gerar as Credenciais (client_id e client_secret)
Passo 2: Como utilizar as Credenciais para gerar o code
Passo 3: Como obter os tokens (access_token e refresh_token)
post
Passo 4: Como utilizar o refresh_token para atualizar o access_token
post
Como criar um fluxo de verificação e renovação do token
Como utilizar o access_token para autorizar suas requisições
Como revogar o acesso de um token
post
Erros relacionados à Autenticação
FAQ de Autenticação
Contatos
Consultar contato pelo uuid/email
get
Criar contato
post
Atualizar contato pelo uuid/email
patch
Excluir contato pelo uuid/email
del
Criar uma tag para o lead pelo uuid/email
post
Consultar eventos associado ao contato
get
Campos personalizados
Consultar campo personalizado
get
Criar campo personalizado
post
Atualizar campo personalizado
patch
Excluir campo personalizado
del
Funis de Contatos
Consultar pelo UUID/email do contato
get
Atualizar pelo UUID/email do contato
put
Segmentações
Consultar segmentações
get
Consultar contatos de uma segmentação
get
Mais informações
Fluxos de automação
Consultar fluxos de automação
get
Consultar dados de um fluxo a partir de um id
get
Inserir leads em um fluxo
post
Email
Listar todos os emails
get
Buscar email por id
get
Landing Pages
Consultar landing pages
get
Pop-ups
Consultar pop-ups
get
Formulários
Consultar formulários
get
Análise
Consultar Estatísticas de E-mail Marketing
get
Consultar Estatísticas de Email via Fluxo de Automação
get
Consultar Estatísticas do Funil de Vendas
get
Consultar Estatísticas dos Ativos de Conversão
get
Campanhas
Consultar campanhas
get
Consultar detalhes de uma campanha
get
Consultar itens de uma campanha
get
Evento de Conversão Padrão
Evento de conversão padrão
post
Eventos de Qualificação do Contato
Evento de Marcação de Oportunidade
post
Evento de Marcação de Oportunidade Ganha
post
Evento de Marcação de Oportunidade Perdida
post
Eventos de E-commerce
Evento de Checkout Iniciado
post
Evento de Carrinho Abandonado
post
Evento de Pedido Realizado
post
Evento de Pedido Pago
post
Evento de Pedido Cancelado
post
Eventos de Pedido Reembolsado
post
Eventos de Pedido Enviado
post
Evento de Pedido Entregue
post
Eventos de E-commerce (Descontinuados)
Evento de Fechamento de Pedido
post
Evento de Fechamento de Pedido com um Item específico
post
Evento de Abandono de Carrinho
post
Evento de Abandono de um Item do Carrinho
post
Eventos de Chat
Evento de Início da Conversa
post
Evento de Término da Conversa
post
Eventos de Chamada
Evento de Chamada Concluída
post
Eventos de Mídia
Evento de Início do Playback de uma Mídia
post
Evento de Término do Playback de uma Mídia
post
Batch de Eventos
Batch de Eventos
Evento de Conversão via API Key
Segurança da API Key
Autenticação API Key
Conversão via API Key
post
Catálogo de produtos
Listar catálogos
get
Consultar catálogo por id
get
Cadastrar catálogo
post
Atualizar catálogo
patch
Deletar catálogo
del
RD Station CRM API v1
Introdução e requisitos
Guia de uso
Bases legais
Limite de requisições da API
Mensagens de erro
Anotações
Listar anotações
get
Criar anotação
post
Campanhas
Listar campanhas
get
Criar campanha
post
Obter campanha
get
Atualizar campanha
put
Contatos
Listar contatos
get
Criar contato
post
Obter contato
get
Atualizar contato
put
Campos personalizados
Listar campos personalizados
get
Criar campo personalizado
post
Obter campo personalizado
get
Atualizar campo personalizado
put
Deletar campo personalizado
del
Motivos de perda
Listar motivos de perda
get
Criar motivo de perda
post
Obter motivo de perda
get
Atualizar motivo de perda
put
Funis de vendas
Listar funis de vendas
get
Criar funil de vendas
post
Obter funil de vendas
get
Atualizar funil de vendas
put
Produtos na negociação
Listar produtos na negociação
get
Criar produto na negociação
post
Criar produtos na negociação
post
Atualizar produto na negociação
put
Deletar produto na negociação
del
Atualizar produtos na negociação
patch
Deletar produtos na negociação
del
Fontes
Listar fontes
get
Criar fonte
post
Obter fonte
get
Atualizar fonte
put
Etapas do funil de vendas
Listar etapas do funil de vendas
get
Criar etapa do funil de vendas
post
Obter etapa do funil de vendas
get
Atualizar etapa do funil de vendas
put
Negociações
Listar negociações
get
Criar negociação
post
Obter negociação
get
Atualizar negociação
put
Listar contatos da negociação
get
Empresas
Listar empresas
get
Criar empresa
post
Obter empresa
get
Atualizar empresa
put
Listar contatos da empresa
get
Produtos
Listar produtos
get
Criar produto
post
Obter produto
get
Atualizar produto
put
Tarefas
Listar tarefas
get
Criar tarefa
post
Obter tarefa
get
Atualizar tarefa
put
Equipes
Listar equipes
get
Obter equipe
get
Token de autenticação
Obter token
get
Usuários
Listar usuários
get
Obter usuário
get
Webhooks
Listar webhooks
get
Criar webhook
post
Obter webhook
get
Atualizar webhook
put
Deletar webhook
del
RD Station CRM API v2
Introdução
Autenticação
Passo 1: Criar um aplicativo e credenciais
Passo 2: Gerar código de autorização
Passo 3: Obter token de acesso
Passo 4: Renovar token de acesso
Filtrando com RDQL
Bases legais
Casos de uso
Campanhas
Listar campanhas
get
Criar campanha
post
Obter campanha
get
Atualizar campanha
put
Contatos
Listar contatos
get
Criar contato
post
Obter contato
get
Atualizar contato
put
Campos personalizados
Listar campos personalizados
get
Criar campo personalizado
post
Obter campo personalizado
get
Atualizar campo personalizado
put
Deletar campo personalizado
del
Produtos na negociação
Listar produtos na negociação
get
Criar produto na negociação
post
Atualizar produto na negociação
put
Deletar produto na negociação
del
Negociações
Listar negociações
get
Criar negociação
post
Obter negociação
get
Atualizar negociação
put
Anexos
Listar arquivos da negociação
get
Fazer upload de arquivo em uma negociação
post
Deletar arquivo da negociação
del
Motivos de perda
Listar motivos de perda
get
Criar motivo de perda
post
Obter motivo de perda
get
Atualizar motivo de perda
put
Anotações
Listar anotações da negociação
get
Criar anotação na negociação
post
Empresas
Listar empresas
get
Criar empresa
post
Obter empresa
get
Atualizar empresa
put
Funis de vendas
Listar funis de vendas
get
Criar funil de vendas
post
Obter funil de vendas
get
Atualizar funil de vendas
put
Produtos
Listar produtos
get
Criar produto
post
Obter produto
get
Atualizar produto
put
Segmentos
Listar segmentos
get
Criar segmento
post
Obter segmento
get
Atualizar segmento
put
Fontes
Listar fontes
get
Criar fonte
post
Obter fonte
get
Atualizar fonte
put
Etapas do funil de vendas
Listar etapas do funil de vendas
get
Criar etapa do funil de vendas
post
Obter etapa do funil de vendas
get
Atualizar etapa do funil de vendas
put
Tarefas
Listar tarefas
get
Criar tarefa
post
Obter tarefa
get
Atualizar tarefa
put
Equipes
Listar equipes
get
Obter equipe
get
Usuários
Listar usuários
get
Obter usuário
get
Eventos de webhook
Campanha criada
post
Campanha deletada
post
Campanha atualizada
post
Contato criado
post
Contato deletado
post
Contato atualizado
post
Negociação criada
post
Negociação deletada
post
Negociação atualizada
post
Motivo de perda criado
post
Motivo de perda deletado
post
Motivo de perda atualizado
post
Empresa criada
post
Empresa deletada
post
Empresa atualizada
post
Produto criado
post
Produto deletado
post
Produto atualizado
post
Fonte criada
post
Fonte deletada
post
Fonte atualizada
post
Tarefa criada
post
Tarefa deletada
post
Tarefa atualizada
post
Webhooks
Listar webhooks
get
Criar webhook
post
Obter webhook
get
Atualizar webhook
put
Deletar webhook
del
RD Station Conversas API v2
Introdução
Autenticação
Criptografia
Contatos
Criar contato
post
Deletar múltiplos contatos
del
Atualizar contato por telefone
patch
Obter contato por telefone
get
Criar múltiplos contatos
post
Obter contato por CPF
get
Criar contato de WhatsApp Business
post
Atualizar contato de WhatsApp Business
put
Criar contato de WhatsApp Business por Broker
post
Atualizar contato de WhatsApp Business por broker
put
Listar contatos
get
Deletar contatos da carteira
post
Campos personalizados
Listar campos personalizados
get
Criar campo personalizado
post
Obter campo personalizado
get
Atualizar campo personalizado
put
Deletar campo personalizado
del
Funcionários
Listar funcionários
get
Ativar funcionário
put
Desativar funcionário
put
Criar múltiplos funcionários
post
Desativar múltiplos funcionários
patch
Flows
Listar fluxos
get
Reiniciar fluxos
post
Jobs
Obter job
get
Mensagens
Encaminhar para contato
post
Enviar mensagem
post
Enviar mensagem a partir de template preenchido
post
Enviar mensagem a partir de template preenchido via broker
post
Listar histórico de conversas
get
Relatórios
Listar relatórios
get
Templates
Listar template de mensagens
get
Enviar mensagem a partir de template
post
Carteiras
Listar carteiras
get
Adicionar contato na carteira
post
Deletar contato da carteira
patch
WhatsApp
Listar integrações de WhatsApp
get
Listar integrações oficiais de WhatsApp
get
Workflows
Listar workflows
get
Evento de Conversão via API Key
Ask AI
