Salesforce
Visão geral
Seção intitulada “Visão geral”O Salesforce é a principal plataforma de CRM do mundo, integrando vendas, atendimento, marketing e análise para construir relacionamentos com clientes e impulsionar o crescimento dos negócios. Com a integração no SquadOS, seus agentes podem criar e atualizar registros do CRM, consultar dados via SOQL, registrar atividades, enviar e-mails e automatizar fluxos de trabalho de vendas — sem sair do SquadOS.
- Site oficial: https://www.salesforce.com/
- Documentação na Composio: docs.composio.dev/toolkits/salesforce
Autenticação
Seção intitulada “Autenticação”Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar.
Você vai precisar dos seguintes campos:
| Campo | Obrigatório | Descrição |
|---|---|---|
subdomain | Sim | Subdomínio da sua organização Salesforce (ex.: sua-empresa.my). |
instance_url | Sim | Endpoint da instância Salesforce (ex.: /services/data/v61.0). Se aparecer o erro URL_NOT_RESET, substitua o subdomínio login pelo subdomínio da sua organização. |
Como obter a credencial
Seção intitulada “Como obter a credencial”- Acesse login.salesforce.com e faça login na sua conta.
- Clique no avatar no canto superior direito e selecione Settings (Configurações).
- No menu lateral, vá em My Personal Information → Personal Information para confirmar o subdomínio da sua instância. A URL exibida no navegador no formato
https://SUBDOMÍNIO.my.salesforce.comcontém o valor que você precisa. - Para configurar credenciais OAuth personalizadas no Composio, siga o guia em composio.dev/auth/salesforce.
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
Salesforce. - Clique no card para abrir o modal de detalhes e em Conectar.
- Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso OAuth à sua conta Salesforce.
- Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)
Perguntas frequentes
Seção intitulada “Perguntas frequentes”Como configurar credenciais OAuth personalizadas para o Salesforce?
Seção intitulada “Como configurar credenciais OAuth personalizadas para o Salesforce?”Siga o guia passo a passo em composio.dev/auth/salesforce para criar e configurar suas próprias credenciais OAuth do Salesforce junto ao Composio.
Por que não consigo encontrar itens que criei no Salesforce?
Seção intitulada “Por que não consigo encontrar itens que criei no Salesforce?”Registros recém-criados podem não aparecer em uma determinada visualização do Salesforce. Use a pesquisa para confirmar que o registro existe.
Como consultar relacionamentos como Pricebooks e Opportunities?
Seção intitulada “Como consultar relacionamentos como Pricebooks e Opportunities?”Use subconsultas SOQL para percorrer relacionamentos. Exemplo (Produtos → Pricebooks → Opportunities):
SELECT Id, Name, (SELECT Id, Quantity, UnitPrice, TotalPrice, PricebookEntry.Product2.Name FROM OpportunityLineItems)FROM OpportunityQuais campos são obrigatórios para conectar ao Salesforce?
Seção intitulada “Quais campos são obrigatórios para conectar ao Salesforce?”Você precisa do subdomínio (ex.: sua-empresa.my) e do endpoint da instância /services/data/v61.0. Se aparecer o erro URL_NOT_RESET, substitua o subdomínio login pelo subdomínio da sua organização.
O que acontece com as ferramentas descontinuadas do Salesforce?
Seção intitulada “O que acontece com as ferramentas descontinuadas do Salesforce?”Ferramentas descontinuadas continuam funcionando até serem removidas. Verifique o prefixo DEPRECATED: nas descrições das ações.
Ações disponíveis
Seção intitulada “Ações disponíveis”Criar conta
Seção intitulada “Criar conta”SALESFORCE_CREATE_ACCOUNT
Cria uma nova conta no Salesforce com as informações especificadas. Retorna o ID da conta criada em data.response_data.id.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome da conta (campo obrigatório no Salesforce). |
phone | string | Não | Número de telefone principal. |
website | string | Não | URL do site da empresa. |
industry | string | Não | Setor ao qual a conta pertence. |
type | string | Não | Tipo de conta. |
description | string | Não | Descrição da conta. |
billing_city | string | Não | Cidade do endereço de faturamento. |
billing_state | string | Não | Estado/província do endereço de faturamento. |
billing_country | string | Não | País do endereço de faturamento. |
billing_street | string | Não | Rua do endereço de faturamento. |
billing_postal_code | string | Não | CEP/código postal do endereço de faturamento. |
annual_revenue | number | Não | Receita anual estimada. |
number_of_employees | integer | Não | Número de funcionários. |
parent_id | string | Não | ID da conta pai, caso esta seja uma subsidiária. |
custom_fields | object | Não | Campos personalizados a definir na conta, usando nomes de campo da API do Salesforce (ex.: Level__c). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar contato
Seção intitulada “Criar contato”SALESFORCE_CREATE_CONTACT
Cria um novo contato no Salesforce com as informações especificadas. Escreve diretamente em dados do CRM — obtenha confirmação do usuário antes de executar em fluxos automatizados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
last_name | string | Sim | Sobrenome do contato (campo obrigatório no Salesforce). |
first_name | string | Não | Nome do contato. |
email | string | Não | Endereço de e-mail do contato. |
phone | string | Não | Telefone principal do contato. |
mobile_phone | string | Não | Celular do contato. |
title | string | Não | Cargo do contato. |
department | string | Não | Departamento do contato. |
account_id | string | Não | ID da conta ao qual este contato está associado. |
lead_source | string | Não | Origem do contato. |
mailing_street | string | Não | Rua do endereço de correspondência. |
mailing_city | string | Não | Cidade do endereço de correspondência. |
mailing_state | string | Não | Estado/província do endereço de correspondência. |
mailing_country | string | Não | País do endereço de correspondência. |
mailing_postal_code | string | Não | CEP do endereço de correspondência. |
custom_fields | object | Não | Campos personalizados com nomes de API do Salesforce (ex.: Level__c). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar lead
Seção intitulada “Criar lead”SALESFORCE_CREATE_LEAD
Cria um novo lead no Salesforce. LastName e Company são obrigatórios. Regras de validação do org (ex.: formato de e-mail, campos personalizados obrigatórios) podem rejeitar requisições além desses campos; inspecione o corpo da resposta de erro para identificar o campo que falhou.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
LastName | string | Sim | Sobrenome do lead. Obrigatório. |
Company | string | Sim | Empresa do lead. Obrigatório. |
FirstName | string | Não | Nome do lead. |
Email | string | Não | Endereço de e-mail do lead. |
Phone | string | Não | Telefone do lead. |
Title | string | Não | Cargo do lead. Máximo de 128 caracteres. |
Status | string | Não | Status do lead. |
LeadSource | string | Não | Origem do lead. |
Industry | string | Não | Setor da empresa do lead. |
Street | string | Não | Endereço do lead. |
City | string | Não | Cidade do lead. |
State | string | Não | Estado/província do lead. |
Country | string | Não | País do lead. |
PostalCode | string | Não | CEP do lead. |
AnnualRevenue | number | Não | Receita anual da empresa do lead. |
NumberOfEmployees | integer | Não | Número de funcionários da empresa do lead. |
CustomFields | object | Não | Campos personalizados com nomes de API do Salesforce (ex.: Level__c). |
allow_duplicates | boolean | Não | Quando true, permite criar leads duplicados mesmo que as regras de detecção de duplicatas sejam acionadas. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar oportunidade
Seção intitulada “Criar oportunidade”SALESFORCE_CREATE_OPPORTUNITY
Cria uma nova oportunidade no Salesforce com as informações especificadas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome da oportunidade (campo obrigatório no Salesforce). |
close_date | string | Sim | Data de fechamento esperada no formato YYYY-MM-DD (campo obrigatório no Salesforce). |
stage_name | string | Sim | Estágio atual da oportunidade (campo obrigatório no Salesforce). |
account_id | string | Não | ID da conta associada a esta oportunidade. Omitir deixa a oportunidade órfã, excluída dos relatórios baseados em conta. |
amount | number | Não | Valor total estimado da venda. |
description | string | Não | Descrição da oportunidade. |
lead_source | string | Não | Origem da oportunidade. |
probability | number | Não | Probabilidade percentual de fechamento (0–100). |
next_step | string | Não | Descrição do próximo passo no processo de vendas. |
pricebook2_id | string | Não | ID do catálogo de preços desta oportunidade. |
custom_fields | object | Não | Campos personalizados com nomes de API do Salesforce. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar tarefa
Seção intitulada “Criar tarefa”SALESFORCE_CREATE_TASK
Cria uma nova tarefa no Salesforce para rastrear atividades, pendências e acompanhamentos relacionados a contatos, leads ou outros registros.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
subject | string | Sim | Assunto/título da tarefa. |
who_id | string | Não | ID do contato ou lead associado à tarefa. Aceita apenas IDs de contato (prefixo 003) ou lead (prefixo 00Q). |
what_id | string | Não | ID do registro relacionado (conta, oportunidade, caso, etc.). |
owner_id | string | Não | ID do usuário responsável pela tarefa. Padrão: usuário atual. |
status | string | Não | Status da tarefa. Deve ser um valor válido da lista de seleção. |
priority | string | Não | Prioridade da tarefa. |
description | string | Não | Descrição detalhada ou notas da tarefa. |
activity_date | string | Não | Data de vencimento da tarefa no formato YYYY-MM-DD. |
is_reminder_set | boolean | Não | Se deve definir um lembrete para esta tarefa. |
reminder_date_time | string | Não | Data e hora do lembrete no formato ISO (YYYY-MM-DDTHH:MM:SS). |
custom_fields | object | Não | Campos personalizados com nomes de API do Salesforce. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter conta
Seção intitulada “Obter conta”SALESFORCE_GET_ACCOUNT
Recupera uma conta específica pelo ID no Salesforce, retornando todos os campos disponíveis.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
account_id | string | Sim | ID Salesforce da conta a recuperar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter contato
Seção intitulada “Obter contato”SALESFORCE_GET_CONTACT
Recupera um contato específico pelo ID no Salesforce, retornando todos os campos disponíveis.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
contact_id | string | Sim | ID Salesforce do contato a recuperar. Deve ser um ID válido de 18 caracteres; nomes ou e-mails não são substitutos válidos. |
fields | string | Não | String com os nomes dos campos a recuperar, separados por vírgula. Se omitido, todos os campos são retornados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter lead
Seção intitulada “Obter lead”SALESFORCE_GET_LEAD
Recupera um lead específico pelo ID no Salesforce, retornando todos os campos disponíveis.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
lead_id | string | Sim | ID Salesforce do lead a recuperar. Deve ser um ID de registro Salesforce no formato de 18 caracteres; nomes, e-mails ou códigos externos não são aceitos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter oportunidade
Seção intitulada “Obter oportunidade”SALESFORCE_GET_OPPORTUNITY
Recupera uma oportunidade específica pelo ID no Salesforce, retornando todos os campos disponíveis.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
opportunity_id | string | Sim | ID Salesforce da oportunidade a recuperar. Deve ser um ID alfanumérico válido de 15 ou 18 caracteres. |
fields | string | Não | String com os nomes dos campos a recuperar, separados por vírgula. Se omitido, todos os campos são retornados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter informações do usuário
Seção intitulada “Obter informações do usuário”SALESFORCE_GET_USER_INFO
Recupera informações sobre o usuário atual ou um usuário específico no Salesforce.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
user_id | string | Não | ID do usuário Salesforce a consultar. Se não fornecido, retorna informações do usuário atual. |
include_permissions | boolean | Não | Se deve incluir as permissões do usuário na resposta (requer uma chamada de API adicional). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar contas
Seção intitulada “Listar contas”SALESFORCE_LIST_ACCOUNTS
Lista contas do Salesforce usando uma consulta SOQL, permitindo filtragem, ordenação e seleção de campos flexíveis. Os resultados são paginados via nextRecordsUrl, com até ~2000 linhas por página.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
query | string | Não | Consulta SOQL para buscar contas. Use sintaxe SOQL padrão para filtrar, ordenar e limitar resultados. Sempre inclua cláusulas WHERE e LIMIT para evitar respostas muito grandes. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar contatos
Seção intitulada “Listar contatos”SALESFORCE_LIST_CONTACTS
Lista contatos do Salesforce usando uma consulta SOQL, permitindo filtragem, ordenação e seleção de campos flexíveis. Os resultados são retornados em response_data.records; verifique response_data.done e response_data.totalSize para paginação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
query | string | Não | Consulta SOQL para buscar contatos. Use sintaxe SOQL padrão. Literais de string devem estar entre aspas simples. Use nomes de campo corretos da API e travessia de relacionamento (ex.: Account.Industry). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar leads
Seção intitulada “Listar leads”SALESFORCE_LIST_LEADS
Lista leads do Salesforce usando uma consulta SOQL, permitindo filtragem, ordenação e seleção de campos flexíveis. Os resultados são paginados; siga nextRecordsUrl na resposta para recuperar páginas subsequentes.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
query | string | Não | Consulta SOQL para buscar leads. Use sintaxe SOQL padrão. Os nomes dos campos da API devem ser exatos (ex.: LeadSource, LastModifiedDate); nomes inválidos causam erros MALFORMED_QUERY. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar oportunidades
Seção intitulada “Listar oportunidades”SALESFORCE_LIST_OPPORTUNITIES
Lista oportunidades do Salesforce usando uma consulta SOQL, permitindo filtragem, ordenação e seleção de campos flexíveis. Os resultados são paginados em até ~2000 linhas por lote.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
query | string | Não | Consulta SOQL para buscar oportunidades. Omitir a cláusula WHERE retorna todas as oportunidades, inclusive históricas. Os resultados não têm ordenação padrão; inclua ORDER BY CloseDate DESC para recuperar oportunidades recentes primeiro. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Registrar chamada
Seção intitulada “Registrar chamada”SALESFORCE_LOG_CALL
Registra uma ligação telefônica concluída como tarefa no Salesforce com detalhes específicos de chamada como duração, tipo e resultado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
who_id | string | Não | ID do contato ou lead associado à chamada. |
what_id | string | Não | ID do registro relacionado (conta, oportunidade, caso, etc.). |
subject | string | Não | Assunto do registro de chamada. Padrão: Call. |
comments | string | Não | Notas detalhadas sobre o que foi discutido durante a chamada. |
call_date | string | Não | Data da chamada no formato YYYY-MM-DD. Padrão: hoje. |
call_type | string | Não | Tipo de chamada: Inbound, Outbound ou Internal. |
call_duration_seconds | integer | Não | Duração da chamada em segundos. |
call_disposition | string | Não | Resultado ou desfecho da chamada. Apenas valores configurados no org são aceitos. |
custom_fields | object | Não | Campos personalizados com nomes de API do Salesforce. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Executar consulta SOQL
Seção intitulada “Executar consulta SOQL”SALESFORCE_RUN_SOQL_QUERY
Executa uma consulta SOQL nos dados do Salesforce. Retorna registros correspondentes à consulta com suporte a paginação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
query | string | Sim | Consulta SOQL a executar. Deve começar com SELECT. Os nomes dos campos devem corresponder exatamente ao esquema do objeto. Para alias, não use a palavra-chave AS (ex.: SUM(Amount) TotalSales, não SUM(Amount) AS TotalSales). FIELDS(ALL) e FIELDS(CUSTOM) exigem LIMIT menor ou igual a 200. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Pesquisar contas
Seção intitulada “Pesquisar contas”SALESFORCE_SEARCH_ACCOUNTS
Pesquisa contas do Salesforce por critérios como nome, setor, tipo, localização ou informações de contato. Forneça sempre ao menos um parâmetro de filtro; omitir todos os filtros retorna um conjunto amplo e lento.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | Pesquisar por nome de conta. Suporta correspondências parciais. |
industry | string | Não | Pesquisar por setor. |
type | string | Não | Pesquisar por tipo de conta. |
billing_city | string | Não | Pesquisar por cidade de faturamento. Suporta correspondências parciais. |
billing_state | string | Não | Pesquisar por estado de faturamento. Suporta correspondências parciais. |
billing_country | string | Não | Pesquisar por país de faturamento. Suporta correspondências parciais. |
phone | string | Não | Pesquisar por número de telefone. Suporta correspondências parciais. |
website | string | Não | Pesquisar por site. Suporta correspondências parciais. |
limit | integer | Não | Número máximo de contas a retornar. Limitado a aproximadamente 2000 linhas. |
fields | string | Não | Lista de nomes de campos da conta separados por vírgula a recuperar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Pesquisar contatos
Seção intitulada “Pesquisar contatos”SALESFORCE_SEARCH_CONTACTS
Pesquisa registros de contato do Salesforce (não leads — use SALESFORCE_SEARCH_LEADS para leads) por nome, e-mail, telefone, conta ou cargo. Todos os parâmetros suportam correspondência parcial/fuzzy.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | Pesquisar por nome do contato. Suporta correspondências parciais. |
email | string | Não | Pesquisar por endereço de e-mail. Suporta correspondências parciais. |
phone | string | Não | Pesquisar por número de telefone. Suporta correspondências parciais. |
title | string | Não | Pesquisar por cargo. Suporta correspondências parciais. |
account_name | string | Não | Pesquisar pelo nome da conta associada. Suporta correspondências parciais. |
limit | integer | Não | Número máximo de contatos a retornar. Máximo de 2000. |
fields | string | Não | Lista de campos de contato separados por vírgula a recuperar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Pesquisar leads
Seção intitulada “Pesquisar leads”SALESFORCE_SEARCH_LEADS
Pesquisa leads do Salesforce por critérios como nome, e-mail, telefone, empresa, cargo, status ou origem do lead. Forneça sempre ao menos um critério de pesquisa; omitir todos resulta em uma listagem ampla e lenta.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | Pesquisar por nome do lead. Suporta correspondências parciais. |
email | string | Não | Pesquisar por endereço de e-mail. Suporta correspondências parciais. |
company | string | Não | Pesquisar por nome da empresa. Suporta correspondências parciais. |
phone | string | Não | Pesquisar por número de telefone. Suporta correspondências parciais. |
title | string | Não | Pesquisar por cargo. Suporta correspondências parciais. |
status | string | Não | Pesquisar por status do lead. |
lead_source | string | Não | Pesquisar por origem do lead. |
limit | integer | Não | Número máximo de leads a retornar. Máximo de 2000. |
fields | string | Não | Lista de campos de lead separados por vírgula a recuperar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Pesquisar oportunidades
Seção intitulada “Pesquisar oportunidades”SALESFORCE_SEARCH_OPPORTUNITIES
Pesquisa oportunidades do Salesforce por critérios como nome, conta, estágio, valor, data de fechamento ou status. Aplique ao menos um filtro para evitar conjuntos de resultados amplos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | Pesquisar por nome da oportunidade. Suporta correspondências parciais. |
account_name | string | Não | Pesquisar por nome da conta associada. Suporta correspondências parciais. |
stage_name | string | Não | Pesquisar por estágio da oportunidade. |
is_closed | boolean | Não | Filtrar por status de fechamento. true para oportunidades fechadas, false para abertas. |
is_won | boolean | Não | Filtrar por status de ganho. true para oportunidades ganhas, false para perdidas. |
amount_min | number | Não | Valor mínimo da oportunidade. |
amount_max | number | Não | Valor máximo da oportunidade. |
close_date_from | string | Não | Busca oportunidades com data de fechamento a partir desta data (YYYY-MM-DD). |
close_date_to | string | Não | Busca oportunidades com data de fechamento até esta data (YYYY-MM-DD). |
lead_source | string | Não | Pesquisar por origem do lead. |
limit | integer | Não | Número máximo de oportunidades a retornar. Máximo de 2000. |
fields | string | Não | Lista de campos de oportunidade separados por vírgula a recuperar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Enviar e-mail
Seção intitulada “Enviar e-mail”SALESFORCE_SEND_EMAIL
Envia um e-mail pelo Salesforce com opções de destinatários, anexos e registro de atividade. Pode ter êxito parcial — verifique o status de sucesso/falha por destinatário em vez de tratar a chamada como tudo-ou-nada.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
subject | string | Sim | Assunto do e-mail. |
body | string | Sim | Corpo do e-mail. |
to_addresses | string | Sim | Endereços de e-mail dos destinatários. Pode ser uma string separada por vírgulas ou uma lista. |
is_html | boolean | Não | Se o corpo do e-mail está em formato HTML. |
cc_addresses | string | Não | Endereços em cópia. Pode ser uma string separada por vírgulas ou uma lista. |
bcc_addresses | string | Não | Endereços em cópia oculta. |
recipient_id | string | Não | ID de um lead, contato ou conta pessoal para registro da atividade e campos de mala direta. |
related_record_id | string | Não | ID de um registro relacionado (ex.: conta, oportunidade, caso) para registro e campos de mala direta. |
log_email | boolean | Não | Se deve registrar o e-mail na linha do tempo de atividades do destinatário. |
sender_type | string | Não | Tipo de remetente: CurrentUser ou OrgWideEmailAddress. |
attachment_ids | string | Não | IDs de arquivos a anexar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Enviar e-mail por template
Seção intitulada “Enviar e-mail por template”SALESFORCE_SEND_EMAIL_FROM_TEMPLATE
Envia um e-mail usando um template de e-mail predefinido do Salesforce com suporte a campos de mala direta.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
template_id | string | Sim | ID do template de e-mail a utilizar. |
recipient_id | string | Sim | ID do lead, contato ou conta pessoal para o qual enviar o e-mail. Obrigatório ao usar templates. |
log_email | boolean | Não | Se deve registrar o e-mail na linha do tempo de atividades. Padrão: true para e-mails por template. |
sender_type | string | Não | Tipo de remetente: CurrentUser, DefaultWorkflowUser ou OrgWideEmailAddress. |
related_record_id | string | Não | ID de um registro relacionado (ex.: caso, oportunidade) para preencher campos de mala direta de outro objeto. |
cc_addresses | string | Não | Endereços em cópia. |
bcc_addresses | string | Não | Endereços em cópia oculta. |
attachment_ids | string | Não | IDs de arquivos a anexar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar conta
Seção intitulada “Atualizar conta”SALESFORCE_UPDATE_ACCOUNT
Atualiza uma conta existente no Salesforce com as alterações especificadas. Apenas os campos fornecidos serão atualizados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
account_id | string | Sim | ID Salesforce da conta a atualizar. |
name | string | Não | Nome atualizado da conta. Deixar vazio para não alterar. |
phone | string | Não | Telefone atualizado. Deixar vazio para não alterar. |
website | string | Não | URL do site atualizado. Deixar vazio para não alterar. |
industry | string | Não | Setor atualizado. Deixar vazio para não alterar. |
type | string | Não | Tipo de conta atualizado. Deixar vazio para não alterar. |
description | string | Não | Descrição atualizada. Deixar vazio para não alterar. |
billing_city | string | Não | Cidade de faturamento atualizada. Deixar vazio para não alterar. |
billing_state | string | Não | Estado de faturamento atualizado. |
billing_country | string | Não | País de faturamento atualizado. |
billing_street | string | Não | Rua de faturamento atualizada. |
billing_postal_code | string | Não | CEP de faturamento atualizado. |
annual_revenue | number | Não | Receita anual atualizada. |
number_of_employees | integer | Não | Número de funcionários atualizado. |
custom_fields | object | Não | Campos personalizados com nomes de API do Salesforce. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar contato
Seção intitulada “Atualizar contato”SALESFORCE_UPDATE_CONTACT
Atualiza um contato existente no Salesforce com as alterações especificadas. Apenas os campos fornecidos serão atualizados. Retorna HTTP 204 sem corpo em caso de sucesso; use SALESFORCE_GET_CONTACT para verificar as alterações aplicadas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
contact_id | string | Sim | ID Salesforce do contato a atualizar. Deve ser um ID válido de 18 caracteres. |
first_name | string | Não | Nome atualizado. Deixar vazio para não alterar. |
last_name | string | Não | Sobrenome atualizado. Deixar vazio para não alterar. |
email | string | Não | E-mail atualizado. Deixar vazio para não alterar. |
phone | string | Não | Telefone principal atualizado. Deixar vazio para não alterar. |
mobile_phone | string | Não | Celular atualizado. Deixar vazio para não alterar. |
title | string | Não | Cargo atualizado. Deixar vazio para não alterar. |
department | string | Não | Departamento atualizado. Deixar vazio para não alterar. |
account_id | string | Não | ID da conta associada atualizado. Deixar vazio para não alterar. |
mailing_street | string | Não | Rua do endereço de correspondência atualizada. |
mailing_city | string | Não | Cidade do endereço de correspondência atualizada. |
mailing_state | string | Não | Estado do endereço de correspondência atualizado. |
mailing_country | string | Não | País do endereço de correspondência atualizado. |
mailing_postal_code | string | Não | CEP do endereço de correspondência atualizado. |
custom_fields | object | Não | Campos personalizados com nomes de API do Salesforce. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar lead
Seção intitulada “Atualizar lead”SALESFORCE_UPDATE_LEAD
Atualiza um lead existente no Salesforce com as alterações especificadas. Apenas os campos fornecidos serão atualizados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
lead_id | string | Sim | ID Salesforce do lead a atualizar. |
first_name | string | Não | Nome atualizado. Deixar vazio para não alterar. |
last_name | string | Não | Sobrenome atualizado. Deixar vazio para não alterar. |
email | string | Não | E-mail atualizado. Deixar vazio para não alterar. |
phone | string | Não | Telefone atualizado. Deixar vazio para não alterar. |
company | string | Não | Empresa atualizada. Deixar vazio para não alterar. |
title | string | Não | Cargo atualizado. Deixar vazio para não alterar. |
status | string | Não | Status atualizado. Deve corresponder a um valor válido da lista de seleção. |
rating | string | Não | Classificação atualizada. Deve corresponder a um valor válido da lista de seleção. |
lead_source | string | Não | Origem do lead atualizada. |
industry | string | Não | Setor atualizado. |
annual_revenue | number | Não | Receita anual atualizada. |
number_of_employees | integer | Não | Número de funcionários atualizado. |
city | string | Não | Cidade atualizada. |
state | string | Não | Estado/província atualizado. |
country | string | Não | País atualizado. |
description | string | Não | Descrição atualizada. |
custom_fields | object | Não | Campos personalizados com nomes de API do Salesforce. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar oportunidade
Seção intitulada “Atualizar oportunidade”SALESFORCE_UPDATE_OPPORTUNITY
Atualiza uma oportunidade existente no Salesforce com as alterações especificadas. Apenas os campos fornecidos serão atualizados. Retorna HTTP 204 com corpo vazio em caso de sucesso.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
opportunity_id | string | Sim | ID Salesforce da oportunidade a atualizar. Várias oportunidades podem ter o mesmo nome — aplique filtros adicionais (estágio, responsável, conta) ou confirme com o usuário antes de atualizar. |
name | string | Não | Nome atualizado da oportunidade. Deixar vazio para não alterar. |
stage_name | string | Não | Estágio atualizado. Deve corresponder exatamente a um estágio definido no processo de vendas do org. |
close_date | string | Não | Data de fechamento atualizada no formato YYYY-MM-DD. Deixar vazio para não alterar. |
amount | number | Não | Valor atualizado. |
account_id | string | Não | ID da conta atualizado. |
description | string | Não | Descrição atualizada. |
lead_source | string | Não | Origem do lead atualizada. |
probability | number | Não | Probabilidade percentual atualizada (0–100). |
next_step | string | Não | Próximo passo atualizado. |
type | string | Não | Tipo de oportunidade atualizado. |
custom_fields | object | Não | Campos personalizados com nomes de API do Salesforce. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Consultar contatos por nome
Seção intitulada “Consultar contatos por nome”SALESFORCE_QUERY_CONTACTS_BY_NAME
Consulta contatos do Salesforce por nome usando uma busca SOQL. Útil para localizar rapidamente contatos sem precisar de um ID de registro.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome ou parte do nome do contato a pesquisar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter todos os objetos
Seção intitulada “Obter todos os objetos”SALESFORCE_GET_ALL_CUSTOM_OBJECTS
Recupera todos os objetos do Salesforce (padrão e personalizados) com metadados detalhados. Cada objeto inclui um campo custom para identificar objetos personalizados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | integer | Não | Número da página a recuperar (índice iniciando em 1). Padrão: 1. |
page_size | integer | Não | Número de objetos a retornar por página. Padrão: 50. Máximo: 200. |
custom_only | boolean | Não | Se true, retorna apenas objetos personalizados. Padrão: false. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter todos os campos de um objeto
Seção intitulada “Obter todos os campos de um objeto”SALESFORCE_GET_ALL_FIELDS_FOR_OBJECT
Recupera todos os campos (padrão e personalizados) de um objeto Salesforce com metadados completos, incluindo tipos de campo, restrições, valores de lista de seleção e relacionamentos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
object_name | string | Sim | Nome de API do objeto Salesforce a descrever. Use nomes de objetos padrão (Account, Contact, Lead, Opportunity) ou nomes de API de objetos personalizados terminados em __c. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir conta
Seção intitulada “Excluir conta”SALESFORCE_DELETE_ACCOUNT
Exclui permanentemente uma conta do Salesforce. Esta ação não pode ser desfeita.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
account_id | string | Sim | ID Salesforce da conta a excluir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir contato
Seção intitulada “Excluir contato”SALESFORCE_DELETE_CONTACT
Exclui permanentemente um contato do Salesforce. Esta ação não pode ser desfeita.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
contact_id | string | Sim | ID Salesforce do contato a excluir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |