O recurso de integração do Verdesk CRM foi projetado para ser o elo central de toda a sua captação de leads e gerenciamento de contatos, promovendo a unificação automática de cadastros em uma base de dados centralizada. Essa funcionalidade é ideal para criar conexões fluídas e diretas entre o Verdesk e uma ampla gama de plataformas e canais digitais. Isso inclui seu site institucional, diversas landing pages de campanhas específicas, suas redes sociais (como formulários de leads nativos), sistemas de automação de marketing e outras ferramentas empresariais que geram contatos.
Endpoint para autenticação. Utilize Basic Auth com usuário e senha fornecidos. Retorna um token Bearer válido por 1 hora.
| grant_type | string Default: "client_credentials" |
{- "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI...",
- "token_type": "bearer",
- "expires_in": 3600
}Esta requisição tem como objetivo filtrar e retornar apenas os registros de contato que contenham, em seus dados cadastrais, a informação de e-mail ou de telefone devidamente preenchida.
string Example: email=contato@prontuarioverde.com.br E-mail do contato. Deve conter "@" e ".com", pelo menos. | |
| telefone | string Example: telefone=5551997378043 Deve estar no formato DDI + DDD. Sem traços ou parênteses. |
{- "id_contato": 123456,
- "nome": "João da Silva",
- "emails": [
- "contato@prontuarioverde.com.br"
], - "etiquetas": [
- "Paciente Modelo",
- "Homem +20 anos"
], - "telefones": [
- "5551997378043"
]
}Esta requisição cria um novo registro de contato na base de dados associada à sua conta no Verdesk.
| nome required | string O nome completo do contato. |
| email required | string <email> O e-mail do contato. |
| telefone required | string O telefone/celular do contato. Deve estar no formato DDI + DDD. Sem traços ou parênteses. |
{- "nome": "João da Silva",
- "email": [
- "contato@prontuarioverde.com.br"
], - "telefone": [
- "5551997378043"
]
}{- "sucesso": true,
- "id_contato": 123456
}A solicitação realiza a consulta e exibe os detalhes completos do contato, com base no parâmetro {id_contato} informado no caminho (path) da requisição.
| id_contato required | number^[^/]+$ O número de identificação do contato. |
{- "items": {
- "nome": "João da Silva",
- "emails": [
- "contato@prontuarioverde.com.br"
], - "telefones": [
- "5551997378043"
], - "etiquetas": [
- "Paciente Modelo",
- "Homem +20 anos"
], - "campos_adicionais": {
- "Possui alergia?": "Sim"
}
}
}Esta requisição permite a criação de um novo campo adicional ou a atualização de um campo já existente, conforme a necessidade do usuário que está integrando a funcionalidade.
| id_contato required | number^[^/]+$ O número de identificação do contato. |
object Campos adicionais referentes ao contato. |
{- "campos_adicionais": {
- "Possui alergia?": ""
}
}{- "sucesso": true,
- "id_contato": 123456
}Esta requisição tem como objetivo inserir um novo número de telefone no registro de dados cadastrais do contato especificado.
| id_contato required | number^[^/]+$ O número de identificação do contato. |
| telefone required | string^[^/]+$ Example: 5551997378043 Deve estar no formato DDI + DDD. Sem traços ou parênteses. |
{- "sucesso": true,
- "id_contato": 123456
}Esta requisição tem como objetivo remover um número de telefone específico do registro de dados do contato associado.
| id_contato required | number^[^/]+$ O número de identificação do contato. |
| telefone required | string^[^/]+$ Example: 5551997378043 Deve estar no formato DDI + DDD. Sem traços ou parênteses. |
{- "sucesso": true,
- "id_contato": 123456
}Esta requisição tem a finalidade de incluir um novo endereço eletrônico (e-mail) ao registro de dados do contato especificado.
| email required | string^[^/]+$ O e-mail do contato. |
| id_contato required | number^[^/]+$ O número de identificação do contato. |
{- "sucesso": true,
- "id_contato": 123456
}Esta requisição tem por finalidade excluir o endereço eletrônico (e-mail) especificado do registro de dados do contato associado.
| email required | string^[^/]+$ O e-mail do contato. |
| id_contato required | number^[^/]+$ O número de identificação do contato. |
{- "sucesso": true,
- "id_contato": 123456
}Esta requisição tem a finalidade de incluir uma nova etiqueta no registro do contato, permitindo a classificação e segmentação do mesmo.
| id_contato required | number^[^/]+$ O número de identificação do contato. |
| etiquetas | string As etiquetas do contato. |
{- "etiquetas": [
- "Convênio Mais Saúde",
- "Cliente desde 2024"
]
}{- "sucesso": true,
- "id_contato": 123456
}Esta requisição tem por objetivo remover por completo todas as etiquetas associadas ao registro do contato especificado.
| id_contato required | number^[^/]+$ O número de identificação do contato. |
{- "sucesso": true,
- "id_contato": 123456
}A operação realiza a listagem integral de todos os canais disponíveis.
{- "items": [
- {
- "id_canal": 12345,
- "tipo": "WA",
- "nome": "Comercial",
- "canal": 5551997378043
}, - {
- "id_canal": 67890,
- "tipo": "WA",
- "nome": "Suporte",
- "canal": 5551999954897
}
]
}Retorna uma lista completa das oportunidades de negócio associadas ao contato especificado. Esta operação é utilizada para rastrear o histórico de engajamento do contato com a empresa, mostrando todas as chances de venda que já foram criadas para ele no CRM.
| id_contato required | number^[^/]+$ O número de identificação do contato. |
{- "items": [
- {
- "assunto": "Remarcação de consultas canceladas pelo paciente",
- "atribuido": "Glória Soares",
- "data": "2025-10-01 09:30",
- "etapa_nome": "Tratativas de Agendamento",
- "etapa_ordem": 3,
- "funil_nome": "Consultas canceladas pelo paciente",
- "id_etapa": 43801,
- "id_funil": 10984,
- "id_motivo_resolucao": 40028,
- "id_tipo_resolucao": 92212,
- "tipo_resolucao": "Sem Sucesso",
- "motivo_resolucao": "Cliente não reagendou",
- "sit_nome": "Aberto",
- "id_oportunidade": 33,
- "nome_contato": "Paulo Santos"
}, - {
- "assunto": "Cobrança relacionada a consulta cancelada em cima da hora",
- "atribuido": "Glória Soares",
- "data": "2025-10-02 10:30",
- "etapa_nome": "Negociação de Pagamento",
- "etapa_ordem": 3,
- "funil_nome": "Inadimplência",
- "id_etapa": 43809,
- "id_funil": 11000,
- "id_motivo_resolucao": 40045,
- "id_tipo_resolucao": 92211,
- "tipo_resolucao": "Sucesso",
- "motivo_resolucao": "Cliente realizou o pagamento",
- "sit_nome": "Aberto",
- "id_oportunidade": 40,
- "nome_contato": "Paulo Santos"
}
]
}Esta requisição tem por objetivo gerar um novo registro de oportunidade no sistema.
string O e-mail do contato. | |
| nome required | string O nome completo do contato. |
| telefone required | string O telefone/celular do contato. Deve estar no formato DDI + DDD. Sem traços ou parênteses. |
object | |
| etiquetas | string As etiquetas do contato. |
| utm_source | string Origem da campanha. |
| utm_medium | string Meio da campanha . |
| utm_campaign | string Nome da campanha. |
| utm_term | string Termo de busca ou segmentação. |
| utm_content | string Criativo ou anúncio. |
| facebook_lead_id | number O número de identificação do lead no Facebook Ads. |
| evento_conversao | string Evento de conversão. |
| id_funil | number O número de identificação do funil. |
| observacao_interna | string Observação interna feita pela equipe. |
{- "email": "contato@prontuarioverde.com.br",
- "nome": "João da Silva",
- "telefone": "5551997378043",
- "campos_adicionais": {
- "autoriza contato": "Sim",
- "utiliza_outro_software": "Não"
}, - "etiquetas": [
- "Paciente Modelo",
- "Cliente desde 2024"
], - "utm_source": "ig",
- "utm_medium": "social",
- "utm_campaign": "[V4] [FORM NATIVO] [ODONTO] [VIDEOS] [INSTA]",
- "utm_term": "AD1 — Cópia",
- "utm_content": "AADVANTAGE INSTA SOMENTE",
- "facebook_lead_id": 2134880493690987,
- "evento_conversao": "FORM NATIVO META",
- "id_funil": 10984,
- "observacao_interna": "Campanha Instagram"
}{- "sucesso": true,
- "id_oportunidade": 33
}Esta requisição tem por objetivo modificar o status da oportunidade especificada, resultando na sua finalização no funil.
| id_oportunidade required | number^[^/]+$ O número de identificação da oportunidade. |
| id_tipo_resolucao required | number O número de identificação do tipo de resolução. |
| id_motivo_resolucao | number O número de identificação do motivo da resolução. |
| id_usuario | number O número de identificação do usuário. |
| observacoes | string As observações. |
[- {
- "id_tipo_resolucao": 21896,
- "id_motivo_resolucao": 13642,
- "id_usuario": 67454,
- "observacoes": "O cliente não pôde continuar a conversa e solicitou contato no dia seguinte."
}
]{- "sucesso": true,
- "id_oportunidade": 33
}Esta requisição tem por objetivo atualizar a posição da oportunidade, realizando sua movimentação entre etapas ou funis. Caso o destino não seja especificado, a oportunidade será automaticamente reposicionada para a etapa inicial do funil de origem.
| id_oportunidade required | number^[^/]+$ O número de identificação da oportunidade. |
| id_funil required | number O número de identificação do funil. |
| id_etapa_funil | number O número de identificação da etapa. |
[- {
- "id_funil": 10984,
- "id_etapa_funil": 43801
}
]{- "sucesso": true,
- "id_oportunidade": 33
}Lista as etapas de um funil
| id_funil required | number^[^/]+$ O número de identificação do funil. |
{- "items": [
- {
- "id_etapa_funil": 45838,
- "etapa_funil_nome": "Tentativa de contato"
}, - {
- "id_etapa_funil": 45839,
- "etapa_funil_nome": "Contato inicial"
}
]
}Lista os tipos de resolução de um funil.
| id_funil required | string^[^/]+$ O número de identificação do funil. |
{- "items": [
- {
- "id_tipo_resolucao": 92212,
- "tipo_resolucao": "Sem sucesso"
}
]
}Lista os motivos de resolução disponíveis para um tipos de resolução de um funil
| id_funil required | number^[^/]+$ O número de identificação do funil. |
| id_tipo_resolucao required | number^[^/]+$ O número de identificação do tipo de resolução. |
{- "items": [
- {
- "motivo_resolucao": "Falta de resposta",
- "id_motivo_resolucao": 16428
}, - {
- "motivo_resolucao": "Outros",
- "id_motivo_resolucao": 16714
}
]
}Retorna uma lista das oportunidades de negócio ativas associadas ao funil especificado.
| id_funil required | number^[^/]+$ O número de identificação do funil. |
{- "items": [
- {
- "assunto": "Remarcação de consultas canceladas pelo paciente",
- "atribuido": "Glória Soares",
- "data": "2025-10-01 09:30",
- "etapa_nome": "Tratativas de Agendamento",
- "etapa_ordem": 3,
- "funil_nome": "Consultas canceladas pelo paciente",
- "id_etapa": 43801,
- "id_funil": 10984,
- "id_motivo_resolucao": 40028,
- "id_tipo_resolucao": 92212,
- "tipo_resolucao": "Sem Sucesso",
- "motivo_resolucao": "Cliente não reagendou",
- "sit_nome": "Aberto",
- "id_oportunidade": 33,
- "nome_contato": "Paulo Santos"
}, - {
- "assunto": "Cobrança relacionada a consulta cancelada em cima da hora",
- "atribuido": "Glória Soares",
- "data": "2025-10-02 10:30",
- "etapa_nome": "Negociação de Pagamento",
- "etapa_ordem": 3,
- "funil_nome": "Inadimplência",
- "id_etapa": 43809,
- "id_funil": 11000,
- "id_motivo_resolucao": 40045,
- "id_tipo_resolucao": 92211,
- "tipo_resolucao": "Sucesso",
- "motivo_resolucao": "Cliente realizou o pagamento",
- "sit_nome": "Aberto",
- "id_oportunidade": 40,
- "nome_contato": "Paulo Santos"
}
]
}O endpoint possibilita a consulta de todo o inventário de templates (mensagens padrão) existentes na base de dados.
{- "items": [
- {
- "id_mensagem_padrao": 10318,
- "mensagem": "_Liberamos seu acesso ao teste rápido do Prontuário Verde._ Para continuar é bem simples: basta clicar no botão abaixo para definir uma senha e você conseguirá acessar o software. Bons testes! Pode me chamar a qualquer momento.",
- "nome": "LIBERAÇÃO TESTE LINK"
}, - {
- "id_mensagem_padrao": 10317,
- "mensagem": "Olá [#[PRIMEIRO_NOME_CLIENTE]], tudo bem com você? Continuando nossa conversa, [#[TEXTO_LIVRE_01]]",
- "nome": "CURINGA GERAL"
}
]
}Esta requisição é designada para o recebimento e o processamento de uma mensagem externa, registrando-a no sistema.
| nome required | string O nome completo do contato. |
| telefone required | string O telefone/celular do contato. Deve estar no formato DDI + DDD. Sem traços ou parênteses. |
| utm_source | string Origem da campanha. |
| utm_medium | string Meio da campanha. |
| utm_campaign | string Nome da campanha. |
| utm_term | string Termo de busca ou segmentação. |
| utm_content | string Criativo ou anúncio. |
| facebook_lead_id | number O número de identificação do lead no Facebook Ads. |
| evento_conversao | string Evento de conversão. |
| canal required | string O canal de recebimento da mensagem. |
| mensagem required | string O texto incluso na mensagem. |
| id_funil | number O número de identificação do funil. |
| data required | string A data de criação da oportunidade. |
{- "nome": "João da Silva",
- "telefone": "5551997378043",
- "utm_source": "ig",
- "utm_medium": "social",
- "utm_campaign": "[V4] [FORM NATIVO] [ODONTO] [VIDEOS] [INSTA]",
- "utm_term": "AD1 — Cópia",
- "utm_content": "AADVANTAGE INSTA SOMENTE",
- "facebook_lead_id": 2134880493690987,
- "evento_conversao": "FORM NATIVO META",
- "canal": "5551999954897",
- "mensagem": "Bom dia, tudo bem?",
- "id_funil": 10984,
- "data": "2025-09-26 16:59"
}{- "sucesso": true,
- "id_oportunidade": 34
}Esta requisição é responsável por efetuar a transmissão de uma mensagem, garantindo que a comunicação seja vinculada e devidamente registrada na oportunidade específica em que a ação foi disparada.
| id_oportunidade required | number^[^/]+$ O número de identificação da oportunidade. |
| telefone required | string O telefone/celular do contato. Deve estar no formato DDI + DDD. Sem traços ou parênteses. |
| canal required | string O canal de recebimento da mensagem |
| mensagem required | string O texto incluso na mensagem. |
[- {
- "telefone": "5551997378043",
- "canal": "5551999954897",
- "mensagem": "Mensagem teste com\\nquebra de linha e emoji 😉"
}
]{- "sucesso": true,
- "id_oportunidade": 33
}Esta requisição é responsável por efetuar o envio de um template de comunicação (mensagem padrão), utilizando o conteúdo que foi pré-configurado e direcionando-a à oportunidade especificada.
| id_oportunidade required | number^[^/]+$ O número de identificação da oportunidade. |
| telefone required | string O telefone/celular do contato. Deve estar no formato DDI + DDD. Sem traços ou parênteses. |
| canal required | string O canal de recebimento da mensagem. |
| id_mensagem_padrao required | number O número de identificação da mensagem padrão. |
| id_usuario | number O número de identificação do usuário. |
[- {
- "telefone": "5551997378043",
- "canal": "5551999954897",
- "id_mensagem_padrao": 10318,
- "id_usuario": 67454
}
]{- "sucesso": true,
- "id_oportunidade": 33
}Esta requisição é designada para o recebimento e o processamento de uma mensagem, efetuando seu registro e vinculação a uma oportunidade específica.
| id_oportunidade required | number^[^/]+$ O número de identificação da oportunidade. |
| nome required | string O nome completo do contato. |
| telefone required | string O telefone/celular do contato. Deve estar no formato DDI + DDD. Sem traços ou parênteses. |
| utm_source | string Origem da campanha. |
| utm_medium | string Meio da campanha. |
| utm_campaign | string Nome da campanha. |
| utm_term | string Termo de busca ou segmentação. |
| utm_content | string Criativo ou anúncio. |
| facebook_lead_id | number O número de identificação do lead via Facebook Ads. |
| evento_conversao | string Evento de conversão. |
| canal required | string O canal de recebimento da mensagem. |
| mensagem required | string O texto incluso na mensagem. |
| id_funil | number O número de identificação do funil. |
| data required | string A data de criação da oportunidade. |
{- "nome": "João da Silva",
- "telefone": "5551997378043",
- "utm_source": "ig",
- "utm_medium": "social",
- "utm_campaign": "[V4] [FORM NATIVO] [ODONTO] [VIDEOS] [INSTA]",
- "utm_term": "AD1 — Cópia",
- "utm_content": "AADVANTAGE INSTA SOMENTE",
- "facebook_lead_id": 2134880493690987,
- "evento_conversao": "FORM NATIVO META",
- "canal": "5551999954897",
- "mensagem": "Bom dia, tudo bem?",
- "id_funil": 10984,
- "data": "2025-10-01 07:02"
}{- "sucesso": true,
- "id_oportunidade": 33
}A operação realiza a listagem integral de todos os usuários registrados na plataforma.
{- "items": [
- {
- "email": "contato@prontuarioverde.com.br",
- "id_usuario": 1404268,
- "nome": "Glória Soares"
}, - {
- "email": "contato@prontuarioverde.com.br",
- "id_usuario": 1414197,
- "nome": "Laura Alves"
}
]
}