Pular para o conteúdo

Salesforce

Salesforce

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.

Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar.

Você vai precisar dos seguintes campos:

CampoObrigatórioDescrição
subdomainSimSubdomínio da sua organização Salesforce (ex.: sua-empresa.my).
instance_urlSimEndpoint 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.
  1. Acesse login.salesforce.com e faça login na sua conta.
  2. Clique no avatar no canto superior direito e selecione Settings (Configurações).
  3. 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.com contém o valor que você precisa.
  4. Para configurar credenciais OAuth personalizadas no Composio, siga o guia em composio.dev/auth/salesforce.
  1. Acesse Ferramentas no menu lateral (/admin/tools).
  2. Abra a aba Disponíveis e procure por Salesforce.
  3. Clique no card para abrir o modal de detalhes e em Conectar.
  4. Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso OAuth à sua conta Salesforce.
  5. 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.)

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 Opportunity

Quais 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.

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.

NomeTipoObrigatórioDescrição
namestringSimNome da conta (campo obrigatório no Salesforce).
phonestringNãoNúmero de telefone principal.
websitestringNãoURL do site da empresa.
industrystringNãoSetor ao qual a conta pertence.
typestringNãoTipo de conta.
descriptionstringNãoDescrição da conta.
billing_citystringNãoCidade do endereço de faturamento.
billing_statestringNãoEstado/província do endereço de faturamento.
billing_countrystringNãoPaís do endereço de faturamento.
billing_streetstringNãoRua do endereço de faturamento.
billing_postal_codestringNãoCEP/código postal do endereço de faturamento.
annual_revenuenumberNãoReceita anual estimada.
number_of_employeesintegerNãoNúmero de funcionários.
parent_idstringNãoID da conta pai, caso esta seja uma subsidiária.
custom_fieldsobjectNãoCampos personalizados a definir na conta, usando nomes de campo da API do Salesforce (ex.: Level__c).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
last_namestringSimSobrenome do contato (campo obrigatório no Salesforce).
first_namestringNãoNome do contato.
emailstringNãoEndereço de e-mail do contato.
phonestringNãoTelefone principal do contato.
mobile_phonestringNãoCelular do contato.
titlestringNãoCargo do contato.
departmentstringNãoDepartamento do contato.
account_idstringNãoID da conta ao qual este contato está associado.
lead_sourcestringNãoOrigem do contato.
mailing_streetstringNãoRua do endereço de correspondência.
mailing_citystringNãoCidade do endereço de correspondência.
mailing_statestringNãoEstado/província do endereço de correspondência.
mailing_countrystringNãoPaís do endereço de correspondência.
mailing_postal_codestringNãoCEP do endereço de correspondência.
custom_fieldsobjectNãoCampos personalizados com nomes de API do Salesforce (ex.: Level__c).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
LastNamestringSimSobrenome do lead. Obrigatório.
CompanystringSimEmpresa do lead. Obrigatório.
FirstNamestringNãoNome do lead.
EmailstringNãoEndereço de e-mail do lead.
PhonestringNãoTelefone do lead.
TitlestringNãoCargo do lead. Máximo de 128 caracteres.
StatusstringNãoStatus do lead.
LeadSourcestringNãoOrigem do lead.
IndustrystringNãoSetor da empresa do lead.
StreetstringNãoEndereço do lead.
CitystringNãoCidade do lead.
StatestringNãoEstado/província do lead.
CountrystringNãoPaís do lead.
PostalCodestringNãoCEP do lead.
AnnualRevenuenumberNãoReceita anual da empresa do lead.
NumberOfEmployeesintegerNãoNúmero de funcionários da empresa do lead.
CustomFieldsobjectNãoCampos personalizados com nomes de API do Salesforce (ex.: Level__c).
allow_duplicatesbooleanNãoQuando true, permite criar leads duplicados mesmo que as regras de detecção de duplicatas sejam acionadas.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SALESFORCE_CREATE_OPPORTUNITY

Cria uma nova oportunidade no Salesforce com as informações especificadas.

NomeTipoObrigatórioDescrição
namestringSimNome da oportunidade (campo obrigatório no Salesforce).
close_datestringSimData de fechamento esperada no formato YYYY-MM-DD (campo obrigatório no Salesforce).
stage_namestringSimEstágio atual da oportunidade (campo obrigatório no Salesforce).
account_idstringNãoID da conta associada a esta oportunidade. Omitir deixa a oportunidade órfã, excluída dos relatórios baseados em conta.
amountnumberNãoValor total estimado da venda.
descriptionstringNãoDescrição da oportunidade.
lead_sourcestringNãoOrigem da oportunidade.
probabilitynumberNãoProbabilidade percentual de fechamento (0–100).
next_stepstringNãoDescrição do próximo passo no processo de vendas.
pricebook2_idstringNãoID do catálogo de preços desta oportunidade.
custom_fieldsobjectNãoCampos personalizados com nomes de API do Salesforce.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SALESFORCE_CREATE_TASK

Cria uma nova tarefa no Salesforce para rastrear atividades, pendências e acompanhamentos relacionados a contatos, leads ou outros registros.

NomeTipoObrigatórioDescrição
subjectstringSimAssunto/título da tarefa.
who_idstringNãoID do contato ou lead associado à tarefa. Aceita apenas IDs de contato (prefixo 003) ou lead (prefixo 00Q).
what_idstringNãoID do registro relacionado (conta, oportunidade, caso, etc.).
owner_idstringNãoID do usuário responsável pela tarefa. Padrão: usuário atual.
statusstringNãoStatus da tarefa. Deve ser um valor válido da lista de seleção.
prioritystringNãoPrioridade da tarefa.
descriptionstringNãoDescrição detalhada ou notas da tarefa.
activity_datestringNãoData de vencimento da tarefa no formato YYYY-MM-DD.
is_reminder_setbooleanNãoSe deve definir um lembrete para esta tarefa.
reminder_date_timestringNãoData e hora do lembrete no formato ISO (YYYY-MM-DDTHH:MM:SS).
custom_fieldsobjectNãoCampos personalizados com nomes de API do Salesforce.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SALESFORCE_GET_ACCOUNT

Recupera uma conta específica pelo ID no Salesforce, retornando todos os campos disponíveis.

NomeTipoObrigatórioDescrição
account_idstringSimID Salesforce da conta a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SALESFORCE_GET_CONTACT

Recupera um contato específico pelo ID no Salesforce, retornando todos os campos disponíveis.

NomeTipoObrigatórioDescrição
contact_idstringSimID 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.
fieldsstringNãoString com os nomes dos campos a recuperar, separados por vírgula. Se omitido, todos os campos são retornados.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SALESFORCE_GET_LEAD

Recupera um lead específico pelo ID no Salesforce, retornando todos os campos disponíveis.

NomeTipoObrigatórioDescrição
lead_idstringSimID 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.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SALESFORCE_GET_OPPORTUNITY

Recupera uma oportunidade específica pelo ID no Salesforce, retornando todos os campos disponíveis.

NomeTipoObrigatórioDescrição
opportunity_idstringSimID Salesforce da oportunidade a recuperar. Deve ser um ID alfanumérico válido de 15 ou 18 caracteres.
fieldsstringNãoString com os nomes dos campos a recuperar, separados por vírgula. Se omitido, todos os campos são retornados.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SALESFORCE_GET_USER_INFO

Recupera informações sobre o usuário atual ou um usuário específico no Salesforce.

NomeTipoObrigatórioDescrição
user_idstringNãoID do usuário Salesforce a consultar. Se não fornecido, retorna informações do usuário atual.
include_permissionsbooleanNãoSe deve incluir as permissões do usuário na resposta (requer uma chamada de API adicional).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
querystringNãoConsulta 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.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
querystringNãoConsulta 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).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
querystringNãoConsulta 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.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
querystringNãoConsulta 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.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
who_idstringNãoID do contato ou lead associado à chamada.
what_idstringNãoID do registro relacionado (conta, oportunidade, caso, etc.).
subjectstringNãoAssunto do registro de chamada. Padrão: Call.
commentsstringNãoNotas detalhadas sobre o que foi discutido durante a chamada.
call_datestringNãoData da chamada no formato YYYY-MM-DD. Padrão: hoje.
call_typestringNãoTipo de chamada: Inbound, Outbound ou Internal.
call_duration_secondsintegerNãoDuração da chamada em segundos.
call_dispositionstringNãoResultado ou desfecho da chamada. Apenas valores configurados no org são aceitos.
custom_fieldsobjectNãoCampos personalizados com nomes de API do Salesforce.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SALESFORCE_RUN_SOQL_QUERY

Executa uma consulta SOQL nos dados do Salesforce. Retorna registros correspondentes à consulta com suporte a paginação.

NomeTipoObrigatórioDescrição
querystringSimConsulta 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.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
namestringNãoPesquisar por nome de conta. Suporta correspondências parciais.
industrystringNãoPesquisar por setor.
typestringNãoPesquisar por tipo de conta.
billing_citystringNãoPesquisar por cidade de faturamento. Suporta correspondências parciais.
billing_statestringNãoPesquisar por estado de faturamento. Suporta correspondências parciais.
billing_countrystringNãoPesquisar por país de faturamento. Suporta correspondências parciais.
phonestringNãoPesquisar por número de telefone. Suporta correspondências parciais.
websitestringNãoPesquisar por site. Suporta correspondências parciais.
limitintegerNãoNúmero máximo de contas a retornar. Limitado a aproximadamente 2000 linhas.
fieldsstringNãoLista de nomes de campos da conta separados por vírgula a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
namestringNãoPesquisar por nome do contato. Suporta correspondências parciais.
emailstringNãoPesquisar por endereço de e-mail. Suporta correspondências parciais.
phonestringNãoPesquisar por número de telefone. Suporta correspondências parciais.
titlestringNãoPesquisar por cargo. Suporta correspondências parciais.
account_namestringNãoPesquisar pelo nome da conta associada. Suporta correspondências parciais.
limitintegerNãoNúmero máximo de contatos a retornar. Máximo de 2000.
fieldsstringNãoLista de campos de contato separados por vírgula a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
namestringNãoPesquisar por nome do lead. Suporta correspondências parciais.
emailstringNãoPesquisar por endereço de e-mail. Suporta correspondências parciais.
companystringNãoPesquisar por nome da empresa. Suporta correspondências parciais.
phonestringNãoPesquisar por número de telefone. Suporta correspondências parciais.
titlestringNãoPesquisar por cargo. Suporta correspondências parciais.
statusstringNãoPesquisar por status do lead.
lead_sourcestringNãoPesquisar por origem do lead.
limitintegerNãoNúmero máximo de leads a retornar. Máximo de 2000.
fieldsstringNãoLista de campos de lead separados por vírgula a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
namestringNãoPesquisar por nome da oportunidade. Suporta correspondências parciais.
account_namestringNãoPesquisar por nome da conta associada. Suporta correspondências parciais.
stage_namestringNãoPesquisar por estágio da oportunidade.
is_closedbooleanNãoFiltrar por status de fechamento. true para oportunidades fechadas, false para abertas.
is_wonbooleanNãoFiltrar por status de ganho. true para oportunidades ganhas, false para perdidas.
amount_minnumberNãoValor mínimo da oportunidade.
amount_maxnumberNãoValor máximo da oportunidade.
close_date_fromstringNãoBusca oportunidades com data de fechamento a partir desta data (YYYY-MM-DD).
close_date_tostringNãoBusca oportunidades com data de fechamento até esta data (YYYY-MM-DD).
lead_sourcestringNãoPesquisar por origem do lead.
limitintegerNãoNúmero máximo de oportunidades a retornar. Máximo de 2000.
fieldsstringNãoLista de campos de oportunidade separados por vírgula a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
subjectstringSimAssunto do e-mail.
bodystringSimCorpo do e-mail.
to_addressesstringSimEndereços de e-mail dos destinatários. Pode ser uma string separada por vírgulas ou uma lista.
is_htmlbooleanNãoSe o corpo do e-mail está em formato HTML.
cc_addressesstringNãoEndereços em cópia. Pode ser uma string separada por vírgulas ou uma lista.
bcc_addressesstringNãoEndereços em cópia oculta.
recipient_idstringNãoID de um lead, contato ou conta pessoal para registro da atividade e campos de mala direta.
related_record_idstringNãoID de um registro relacionado (ex.: conta, oportunidade, caso) para registro e campos de mala direta.
log_emailbooleanNãoSe deve registrar o e-mail na linha do tempo de atividades do destinatário.
sender_typestringNãoTipo de remetente: CurrentUser ou OrgWideEmailAddress.
attachment_idsstringNãoIDs de arquivos a anexar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
template_idstringSimID do template de e-mail a utilizar.
recipient_idstringSimID do lead, contato ou conta pessoal para o qual enviar o e-mail. Obrigatório ao usar templates.
log_emailbooleanNãoSe deve registrar o e-mail na linha do tempo de atividades. Padrão: true para e-mails por template.
sender_typestringNãoTipo de remetente: CurrentUser, DefaultWorkflowUser ou OrgWideEmailAddress.
related_record_idstringNãoID de um registro relacionado (ex.: caso, oportunidade) para preencher campos de mala direta de outro objeto.
cc_addressesstringNãoEndereços em cópia.
bcc_addressesstringNãoEndereços em cópia oculta.
attachment_idsstringNãoIDs de arquivos a anexar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SALESFORCE_UPDATE_ACCOUNT

Atualiza uma conta existente no Salesforce com as alterações especificadas. Apenas os campos fornecidos serão atualizados.

NomeTipoObrigatórioDescrição
account_idstringSimID Salesforce da conta a atualizar.
namestringNãoNome atualizado da conta. Deixar vazio para não alterar.
phonestringNãoTelefone atualizado. Deixar vazio para não alterar.
websitestringNãoURL do site atualizado. Deixar vazio para não alterar.
industrystringNãoSetor atualizado. Deixar vazio para não alterar.
typestringNãoTipo de conta atualizado. Deixar vazio para não alterar.
descriptionstringNãoDescrição atualizada. Deixar vazio para não alterar.
billing_citystringNãoCidade de faturamento atualizada. Deixar vazio para não alterar.
billing_statestringNãoEstado de faturamento atualizado.
billing_countrystringNãoPaís de faturamento atualizado.
billing_streetstringNãoRua de faturamento atualizada.
billing_postal_codestringNãoCEP de faturamento atualizado.
annual_revenuenumberNãoReceita anual atualizada.
number_of_employeesintegerNãoNúmero de funcionários atualizado.
custom_fieldsobjectNãoCampos personalizados com nomes de API do Salesforce.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
contact_idstringSimID Salesforce do contato a atualizar. Deve ser um ID válido de 18 caracteres.
first_namestringNãoNome atualizado. Deixar vazio para não alterar.
last_namestringNãoSobrenome atualizado. Deixar vazio para não alterar.
emailstringNãoE-mail atualizado. Deixar vazio para não alterar.
phonestringNãoTelefone principal atualizado. Deixar vazio para não alterar.
mobile_phonestringNãoCelular atualizado. Deixar vazio para não alterar.
titlestringNãoCargo atualizado. Deixar vazio para não alterar.
departmentstringNãoDepartamento atualizado. Deixar vazio para não alterar.
account_idstringNãoID da conta associada atualizado. Deixar vazio para não alterar.
mailing_streetstringNãoRua do endereço de correspondência atualizada.
mailing_citystringNãoCidade do endereço de correspondência atualizada.
mailing_statestringNãoEstado do endereço de correspondência atualizado.
mailing_countrystringNãoPaís do endereço de correspondência atualizado.
mailing_postal_codestringNãoCEP do endereço de correspondência atualizado.
custom_fieldsobjectNãoCampos personalizados com nomes de API do Salesforce.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SALESFORCE_UPDATE_LEAD

Atualiza um lead existente no Salesforce com as alterações especificadas. Apenas os campos fornecidos serão atualizados.

NomeTipoObrigatórioDescrição
lead_idstringSimID Salesforce do lead a atualizar.
first_namestringNãoNome atualizado. Deixar vazio para não alterar.
last_namestringNãoSobrenome atualizado. Deixar vazio para não alterar.
emailstringNãoE-mail atualizado. Deixar vazio para não alterar.
phonestringNãoTelefone atualizado. Deixar vazio para não alterar.
companystringNãoEmpresa atualizada. Deixar vazio para não alterar.
titlestringNãoCargo atualizado. Deixar vazio para não alterar.
statusstringNãoStatus atualizado. Deve corresponder a um valor válido da lista de seleção.
ratingstringNãoClassificação atualizada. Deve corresponder a um valor válido da lista de seleção.
lead_sourcestringNãoOrigem do lead atualizada.
industrystringNãoSetor atualizado.
annual_revenuenumberNãoReceita anual atualizada.
number_of_employeesintegerNãoNúmero de funcionários atualizado.
citystringNãoCidade atualizada.
statestringNãoEstado/província atualizado.
countrystringNãoPaís atualizado.
descriptionstringNãoDescrição atualizada.
custom_fieldsobjectNãoCampos personalizados com nomes de API do Salesforce.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
opportunity_idstringSimID 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.
namestringNãoNome atualizado da oportunidade. Deixar vazio para não alterar.
stage_namestringNãoEstágio atualizado. Deve corresponder exatamente a um estágio definido no processo de vendas do org.
close_datestringNãoData de fechamento atualizada no formato YYYY-MM-DD. Deixar vazio para não alterar.
amountnumberNãoValor atualizado.
account_idstringNãoID da conta atualizado.
descriptionstringNãoDescrição atualizada.
lead_sourcestringNãoOrigem do lead atualizada.
probabilitynumberNãoProbabilidade percentual atualizada (0–100).
next_stepstringNãoPróximo passo atualizado.
typestringNãoTipo de oportunidade atualizado.
custom_fieldsobjectNãoCampos personalizados com nomes de API do Salesforce.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
namestringSimNome ou parte do nome do contato a pesquisar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
pageintegerNãoNúmero da página a recuperar (índice iniciando em 1). Padrão: 1.
page_sizeintegerNãoNúmero de objetos a retornar por página. Padrão: 50. Máximo: 200.
custom_onlybooleanNãoSe true, retorna apenas objetos personalizados. Padrão: false.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
object_namestringSimNome 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.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SALESFORCE_DELETE_ACCOUNT

Exclui permanentemente uma conta do Salesforce. Esta ação não pode ser desfeita.

NomeTipoObrigatórioDescrição
account_idstringSimID Salesforce da conta a excluir.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

SALESFORCE_DELETE_CONTACT

Exclui permanentemente um contato do Salesforce. Esta ação não pode ser desfeita.

NomeTipoObrigatórioDescrição
contact_idstringSimID Salesforce do contato a excluir.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.