Softone Web CRM (versão prévia)

Aumente as vendas e fortaleça as relações do cliente com o SOFTONE WEB CRM controlado por IA. Trabalhe em qualquer lugar com 100% web e plataforma nativa de nuvem, automatize tarefas repetitivas e acelere os processos para economizar tempo e esforço.

Esse conector está disponível nos seguintes produtos e regiões:

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Automatizar suas vendas com o SOFTONE WEB CRM
URL	https://webcrm.softone.gr
Email	support@shopranos.eu

Metadados do conector
Publicador	Tecnologias softone
Website	https://webcrm.softone.gr
Política de privacidade	https://webcrm.softone.gr/privacy-policy
Categorias	Vendas e CRM

Conector do Softone Web CRM Power Automate

Bem-vindo ao Softone Web CRM Power Automate Connector! Esse conector integra perfeitamente o sistema ERP da sua empresa com operações de CRM de Vendas, capacitando você a automatizar tarefas críticas e simplificar os fluxos de trabalho.

Publicador: Softone Technologies S.A.

Pré-requisitos

Uma assinatura válida do Softone Web CRM.

Como obter credenciais

Para acessar os dados da sua empresa usando o conector do Softone Web CRM, siga estas etapas:

Visite a página de logon do Softone Web CRM em crm.shopranos.eu.
Depois de fazer logon, navegue até o menu e selecione "Chaves de API do Usuário".
Gere uma nova chave de API com base nas opções fornecidas.
Utilize essa chave de API recém-gerada no conector do Softone Web CRM para obter acesso aos dados da sua empresa.

Introdução ao conector

Para começar a usar o Conector do Power Automate do Softone Web CRM, siga estas etapas:

Instalação: instale o conector em seu ambiente do Power Automate.
Configuração: insira sua Chave de API para se conectar ao Softone Web CRM.
Uso: comece a automatizar tarefas e fluxos de trabalho perfeitamente.

Erros e soluções comuns

Erro 1: Chave de API inválida

Sintoma: ao configurar o conector, você recebe um erro indicando que a chave de API é inválida. Remédio: verifique se você gerou uma chave de API válida em sua conta do Softone Web CRM. Verifique se não há espaços à esquerda ou à direita na chave de API ao inseri-la na configuração do conector.

Erro 2: Não é possível se conectar

Sintoma: não é possível estabelecer uma conexão com o Softone Web CRM ao configurar o conector. Remediar: verifique se você configurou corretamente o conector com a chave de API. Verifique se o Softone Web CRM (crm.shopranos.eu) está acessível e não está enfrentando tempo de inatividade. Verifique as configurações de rede para confirmar se não há restrições que impeçam o conector de se conectar a serviços externos.

Erro 3: Permissões ausentes

Sintoma: você encontra erros relacionados à permissão ao tentar executar determinadas ações usando o conector. Remediar: verifique se a chave de API gerada tem as permissões necessárias para acessar os recursos específicos ou executar as ações que você está tentando automatizar. Examine a documentação do Softone Web CRM para entender as permissões necessárias para várias operações.

Erro 4: Problemas de instalação do conector

Sintoma: você enfrenta dificuldades durante a instalação do conector em seu ambiente do Power Automate. Remediar: siga cuidadosamente as instruções de instalação fornecidas para o conector do Softone Web CRM. Verifique se há restrições ou políticas no ambiente do Power Automate que possam estar afetando o processo de instalação. Se o problema persistir, entre em contato com o suporte do Power Automate para obter assistência.

Erro 5: Comportamento inesperado

Sintoma: o conector não está se comportando conforme o esperado ou você encontra erros inexplicáveis durante a execução do fluxo de trabalho. Remediar: examine a configuração do fluxo de trabalho e verifique se as entradas e saídas estão mapeadas corretamente. Verifique se há alterações ou atualizações na API do Softone Web CRM ou na documentação do conector que possam afetar seu fluxo de trabalho. Se o problema persistir, entre em contato com o suporte do Softone Web CRM enviando emails para support@shopranos.eu.

Erro 6: Desempenho lento

Sintoma: o conector ou os fluxos de trabalho estão apresentando um desempenho lento. Remediar: verifique sua conexão de rede e verifique se sua conta do Softone Web CRM não está enfrentando problemas de desempenho. Além disso, examine o design do fluxo de trabalho para otimize-o para obter eficiência. Se o problema persistir, considere entrar em contato com o suporte do Softone Web CRM para obter assistência. Esses erros comuns e seus remédios correspondentes devem ajudar os usuários a solucionar problemas ao usar o Conector do Power Automate do Softone Web CRM. Se você encontrar outros erros ou problemas específicos, não hesite em entrar em contato com o suporte do Softone Web CRM para obter assistência personalizada.

perguntas frequentes

Como posso obter suporte se encontro problemas ou tenho dúvidas?

R: Se você encontrar algum problema ou tiver dúvidas, entre em contato com nossa equipe de suporte em support@shopranos.eu. Estamos aqui para ajudá-lo a aproveitar ao máximo o Softone Web CRM para simplificar seus processos de negócios e aumentar a eficiência.

Quais são os principais benefícios do uso do Softone Web CRM?

O Softone Web CRM oferece vários benefícios importantes, incluindo:

Integração sem esforço: conecte perfeitamente seu sistema ERP ao SALES CRM, aprimorando o fluxo de dados e a eficiência operacional. Event-Driven Automação: responda a eventos críticos, como criação de tarefa ou cliente potencial. Dispare notificações instantâneas e automatize os processos de aprovação com facilidade. Integração do Microsoft Power Automate: aproveite o poder do Microsoft Power Automate para desbloquear uma ampla gama de possibilidades de automação. Envie mensagens importantes, direcione fluxos de trabalho de aprovação e simplifique processos complexos.

Instruções de implantação

Como o Softone Web CRM opera como uma PaaS (Plataforma como Serviço), não há nenhum processo de implantação manual necessário. A plataforma lida com todos os aspectos do gerenciamento de implantação e infraestrutura, permitindo que os usuários se concentrem diretamente na utilização de seus serviços e recursos para seus aplicativos.

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:


Default	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
Chave de API	secureString	A chave de API para esta api	Verdade

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Atualizar um cliente potencial por ID	Atualiza os detalhes de um cliente potencial existente, como informações da empresa, detalhes do contato, status ou origem. Somente os clientes potenciais acessíveis ao usuário podem ser atualizados.
Atualizar um contato existente	Atualiza os detalhes do contato especificado na empresa fornecida. As permissões de usuário e o contexto da empresa são validados durante esta operação.
Atualizar um evento existente por ID	Use essa ação para modificar detalhes de um evento existente, como título, descrição, participantes ou hora agendada. Somente eventos acessíveis ao usuário atual podem ser atualizados.
Atualizar uma anotação existente por ID	Use essa ação para modificar detalhes de uma nota existente, como conteúdo ou referências relacionadas. Somente as notas acessíveis ao usuário atual podem ser atualizadas.
Atualizar uma chamada por ID	Use essa ação para modificar detalhes de uma chamada existente, como assunto, participantes, hora agendada ou status. Somente chamadas acessíveis ao usuário atual podem ser atualizadas.
Atualizar uma conta existente	Atualiza os detalhes da conta especificada na empresa fornecida. As permissões de usuário e o contexto da empresa são validados durante esta operação. Somente usuários autorizados com dados válidos podem executar a atualização.
Atualizar uma oportunidade existente por ID	Aplica alterações aos campos da oportunidade especificada, como nome, estágio, valor ou link de conta. Acessível somente se o usuário tiver permissões de gravação.
Atualizar uma tarefa existente por ID	Use essa ação para modificar detalhes de uma tarefa existente, como assunto, descrição, data de conclusão, prioridade ou usuário atribuído. Somente tarefas acessíveis ao usuário atual podem ser atualizadas.
Criar um novo cliente potencial	Use essa ação para criar um novo cliente potencial, incluindo detalhes da empresa, informações de contato e fonte. O lead criado pode ser enriquecido, pontuado, convertido ou atualizado posteriormente.
Criar um novo contato	Cria um novo contato na empresa especificada. O usuário que está fazendo a solicitação deve ter o relevante `x-permissions` para executar essa ação.
Criar um novo evento	Use essa ação para agendar ou registrar um novo evento em log. Forneça detalhes como título, descrição, participantes e data/hora agendada. O evento criado pode ser atualizado, recuperado ou vinculado a outras atividades posteriormente.
Criar uma nova anotação	Use essa ação para adicionar uma anotação a uma atividade ou entidade específica. Forneça detalhes como título, conteúdo e referências relacionadas. A nota criada pode ser recuperada, atualizada ou excluída posteriormente.
Criar uma nova chamada	Use essa ação para criar uma nova atividade de chamada, incluindo assunto, participantes, hora agendada e status. A chamada criada pode ser recuperada, atualizada ou excluída posteriormente.
Criar uma nova conta	Cria uma nova conta na empresa especificada. O usuário que está fazendo a solicitação deve ter o relevante `x-permissions` para executar essa ação e os detalhes da conta devem ser válidos.
Criar uma nova oportunidade	Use essa ação para criar uma nova oportunidade no pipeline de vendas. Uma oportunidade normalmente representa um possível acordo com uma conta, vinculada a um cliente potencial ou criada de forma independente.
Criar uma nova tarefa	Use essa ação para adicionar uma nova tarefa ao seu sistema. Forneça detalhes como assunto, descrição, data de conclusão, prioridade e usuário atribuído. A tarefa criada pode ser recuperada, atualizada ou excluída posteriormente.
Excluir um cliente potencial por ID	Exclui permanentemente um cliente potencial do sistema. Verifique se o cliente potencial não é necessário para processamento ou conversão adicional antes da exclusão.
Excluir um contato	Exclui o contato especificado da empresa determinada. O acesso é determinado pelo contexto da empresa fornecido no `x-companyid` cabeçalho.
Excluir um evento por ID	Remove permanentemente o evento especificado do sistema. Verifique se o evento não está vinculado a outros processos antes da exclusão. Somente eventos acessíveis ao usuário atual podem ser excluídos.
Excluir uma anotação por ID	Remove permanentemente a nota especificada do sistema. Verifique se a anotação não está vinculada a outros processos antes da exclusão. Somente anotações acessíveis ao usuário atual podem ser excluídas.
Excluir uma chamada por ID	Remove permanentemente a chamada especificada do sistema. Somente chamadas acessíveis ao usuário atual podem ser excluídas. Verifique se a chamada não está vinculada a outros processos antes da exclusão.
Excluir uma conta	Exclui a conta especificada para a empresa determinada. A solicitação deve incluir permissões válidas `x-companyid` e apropriadas para prosseguir.
Excluir uma oportunidade por ID	Remove permanentemente uma oportunidade do sistema. Verifique se a oportunidade não é mais necessária antes da exclusão, pois a ação não pode ser desfeita.
Excluir uma tarefa por ID	Remove permanentemente a tarefa especificada do sistema. Verifique se a tarefa não está vinculada a outros processos antes da exclusão. Somente tarefas acessíveis ao usuário atual podem ser excluídas.
Recuperar todas as anotações acessíveis ao usuário	Lista todas as anotações acessíveis ao usuário atual. Você pode filtrar os resultados usando critérios de pesquisa, como criador, entidade relacionada ou intervalo de datas. Útil para relatórios, dashboards ou automações que processam várias anotações.
Recuperar todas as chamadas	Lista todas as atividades de chamada acessíveis ao usuário atual. Você pode filtrar os resultados usando critérios de pesquisa, como usuário atribuído, status ou intervalo de datas. Útil para relatórios, dashboards ou automações que processam várias chamadas.
Recuperar todas as contas de uma empresa	Retorna uma lista de todas as contas pertencentes à empresa especificada. O usuário que está fazendo a solicitação deve ter permissões apropriadas, definidas nos cabeçalhos de solicitação. Os filtros podem ser aplicados usando parâmetros de cadeia de caracteres de consulta.
Recuperar todas as oportunidades com paginação	Lista oportunidades acessíveis ao usuário, com base no escopo (Eu, Equipe ou Todos). Dá suporte à filtragem, pesquisa e paginação. Útil para dashboards, relatórios e integrações que exigem acesso em lote.
Recuperar todas as tarefas acessíveis ao usuário	Lista todas as tarefas acessíveis ao usuário atual. Você pode filtrar os resultados usando critérios de pesquisa, como usuário atribuído, status ou intervalo de datas. Útil para relatórios, dashboards ou automações que processam várias tarefas.
Recuperar todos os clientes potenciais com paginação	Lista todos os clientes potenciais acessíveis ao usuário atual. Dá suporte à paginação e à filtragem por meio de parâmetros de consulta. Útil para dashboards, relatórios ou integrações que exigem processamento em lote de clientes potenciais.
Recuperar todos os contatos de uma empresa	Retorna uma lista de todos os contatos pertencentes à empresa especificada. O usuário que está fazendo a solicitação deve ter permissões apropriadas, conforme determinado pelos cabeçalhos. Os filtros podem ser aplicados usando parâmetros de solicitação.
Recuperar todos os eventos acessíveis ao usuário	Lista todos os eventos acessíveis ao usuário atual. Você pode filtrar os resultados usando critérios de pesquisa, como intervalo de datas, usuário atribuído ou status. Útil para relatórios, dashboards ou automações que processam vários eventos.
Recuperar um cliente potencial por ID	Retorna informações detalhadas para o cliente potencial especificado, incluindo detalhes da empresa, informações de contato, origem e status. Use essa ação para exibir ou atualizar um cliente potencial específico.
Recuperar um contato por ID	Retorna detalhes do contato especificado, fornecendo informações e dados específicos da empresa. O acesso é determinado pelo contexto da empresa fornecido no cabeçalho da solicitação `x-companyid` .
Recuperar um evento por ID	Retorna informações detalhadas para o evento especificado, incluindo título, participantes, hora agendada e status. Use essa ação para exibir ou referenciar um evento específico em sua automação.
Recuperar um usuário de retirada por ID	Retorna detalhes completos do usuário especificado, incluindo informações de função dentro da empresa determinada. O acesso é determinado pelo contexto da empresa fornecido no cabeçalho da solicitação.
Recuperar uma anotação por ID	Retorna informações detalhadas para a nota especificada, incluindo conteúdo, criador e entidade relacionada. Use essa ação para exibir ou fazer referência a uma observação específica em sua automação.
Recuperar uma conta por ID	Retorna detalhes da conta especificada, incluindo dados específicos da empresa. O acesso é determinado pelo contexto da empresa fornecido no cabeçalho da solicitação `x-companyid` .
Recuperar uma equipe por seu identificador exclusivo	Retorna detalhes completos da equipe especificada.
Recuperar uma oportunidade por ID	Retorna detalhes completos da oportunidade especificada, incluindo o proprietário e a conta vinculada. O acesso é restrito com base nas permissões do usuário.
Recuperar uma tarefa de chamada por ID	Retorna informações detalhadas para a chamada especificada, incluindo assunto, participantes, hora agendada e status. Use essa ação para exibir ou fazer referência a uma chamada específica em sua automação.
Recuperar uma tarefa por ID	Retorna informações detalhadas para a tarefa especificada, incluindo assunto, descrição, data de conclusão, prioridade e usuário atribuído. Use essa ação para exibir ou fazer referência a uma tarefa específica em sua automação.

Atualizar um cliente potencial por ID

ID da operação:: Lead_Update

Atualiza os detalhes de um cliente potencial existente, como informações da empresa, detalhes do contato, status ou origem. Somente os clientes potenciais acessíveis ao usuário podem ser atualizados.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo do cliente potencial a ser atualizado.
cargo	jobTitle		string
ID de status do cliente potencial	leadStatusId		string
nome próprio	firstName	True	string
apelido	lastName		string
Nome do meio	middleName		string
ID de saudação	salutationId		string
sufixo	suffix		string
email	email		string
phone	phone		string
telefone celular	mobilePhone		string
endereço eletrônico	emailAddress		string
tipo	type		string
recusar	optOut		boolean
Número de telefone	phoneNumber		string
tipo	type		string
recusar	optOut		boolean
chamar Opt Out	callOptOut		boolean
e-mail Recusar	emailOptOut		boolean
ID de classificação	ratingId		string
ID do proprietário	ownerId		string
Tipo de proprietário	ownerType		string
site	website		string
empresa	company		string
ID da indústria	industryId		string
nenhum funcionário	noOfEmployees		integer
ID do tipo de origem da conta	accountSourceTypeId		string
endereço1	address1		string
endereço2	address2		string
city	city		string
estado	state		string
country	country		string
código postal	postalCode		string
descrição	description		string
receita anual	annualRevenue		double
data da última transferência	lastTransferDate		date-time
ID de gênero	genderId		string
ID de pronunciamento	pronounceId		string
status	status		string
última modificação por	lastModifiedBy		string
Campos extras	extraFields		object

Retornos

Corpo: SalesPipeline.Api.Features.Lead.LeadDto

Atualizar um contato existente

ID da operação:: Contact_Update

Atualiza os detalhes do contato especificado na empresa fornecida.
As permissões de usuário e o contexto da empresa são validados durante esta operação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de contato	contactId	True	string	O identificador exclusivo do contato a ser atualizado.
OwnerId	ownerId		string
AccountIds	accountIds		array of string
SourceId	sourceId		string
SourceOwnerId	sourceOwnerId		string
SourceAccountIds	sourceAccountIds		array of string
Primeiro Nome	firstName		string
LastName	lastName		string
MiddleName	middleName		string
SalutationId	salutationId		string
Sufixo	suffix		string
Email	email		string
Telefone	phone		string
MobilePhone	mobilePhone		string
Fac-símile	fax		string
CallOptOut	callOptOut		boolean
EmailOptOut	emailOptOut		boolean
Endereço de Email	emailAddress		string
Tipo	type		string
OptOut	optOut		boolean
Número de telefone	phoneNumber		string
Tipo	type		string
OptOut	optOut		boolean
Título do Cargo	jobTitle		string
GenderId	genderId		string
PronounceId	pronounceId		string
Address1	address1		string
Address2	address2		string
City	city		string
Estado	state		string
Latitude	latitude		string
Longtitude	longtitude		string
País	country		string
Código do País	countryCode		string
Código Postal	postalCode		string
Primeiro Nome	firstName		string
LastName	lastName		string
Número de telefone	phoneNumber		string
Email	email		string
CreatedBy	createdBy		string
LastModifiedBy	lastModifiedBy		string
Departamento	department		string
ReportsTo	reportsTo		string
Assistente	assistant		string
AssistantPhone	assistantPhone		string
Birthday	birthday		date-time
Description	description		string
LastStayInTouchReportedDate	lastStayInTouchReportedDate		date-time
LastStayInTouchSaveDate	lastStayInTouchSaveDate		date-time
AccountSourceTypeId	accountSourceTypeId		string
ExtraFields	extraFields		object
AssignedTeams	assignedTeams		array of string

Retornos

Corpo: Customer.Api.Features.Contacts.ContactDTO

Atualizar um evento existente por ID

ID da operação:: Event_Update

Use essa ação para modificar detalhes de um evento existente, como título, descrição, participantes ou hora agendada.
Somente eventos acessíveis ao usuário atual podem ser atualizados.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo do evento a ser atualizado.
data de atualização	updateDate		date-time
assunto	subject		string
Tipo de tarefa	taskType		string
atribuído ao tipo	assignedToType		string
atribuído à ID	assignedToId		string
relacionado ao tipo	relatedToType		string
relacionado à ID	relatedToId		string
Tipo de contato	contactType		string
IDs de contato	contactIds		array of string
descrição	description		string
corpo do editor	editorBody		string
ID de prioridade	priorityId		string
longitude	longitude		string
latitude	latitude		string
Data de início	startDate		date-time
Data de término	endDate		date-time
Conjunto de lembretes	reminderSet		boolean
criado por	createdBy		string
última modificação por	lastModifiedBy		string
posição	position		integer
ID pai	parentId		string
repeat	repeat		string
Status do evento	eventStatus		string
ID do resultado do evento	eventResultId		string
Intervalo de recorrência	recurrenceInterval		string
ID de origem	sourceId		string
origem atribuída à ID	sourceAssignedToId		string
origem relacionada à ID	sourceRelatedToId		string
IDs de contato de origem	sourceContactIds		array of string
Membros da equipe	teamMembers		array of string

Retornos

Corpo: Task.Api.Features.Events.EventDTO

Atualizar uma anotação existente por ID

ID da operação:: Note_Update

Use essa ação para modificar detalhes de uma nota existente, como conteúdo ou referências relacionadas.
Somente as notas acessíveis ao usuário atual podem ser atualizadas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo da nota a ser atualizada.
relacionado ao tipo	relatedToType		string
relacionado à ID	relatedToId		string
assunto	subject		string
body	body		string
corpo do editor	editorBody		string
última modificação por	lastModifiedBy		string
IDs de contato	contactIds		array of string
Tipo de contato	contactType		string

Retornos

Corpo: Task.Api.Features.Notes.NoteDTO

Atualizar uma chamada por ID

ID da operação:: Call_Update

Use essa ação para modificar detalhes de uma chamada existente, como assunto, participantes, hora agendada ou status.
Somente chamadas acessíveis ao usuário atual podem ser atualizadas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo da chamada a ser atualizada.
Tipo de tarefa	taskType		string
Data de conclusão	dueDate		date-time
assunto	subject		string
atribuído ao tipo	assignedToType		string
atribuído à ID	assignedToId		string
relacionado ao tipo	relatedToType		string
relacionado à ID	relatedToId		string
Tipo de contato	contactType		string
IDs de contato	contactIds		array of string
status	status		string
Duração da chamada	callDuration		date-span
ID do resultado da chamada	callResultId		string
comments	comments		string
corpo do editor	editorBody		string
ID de prioridade	priorityId		string
posição	position		integer
ID pai	parentId		string
Conjunto de lembretes	reminderSet		boolean
última modificação por	lastModifiedBy		string
Classificar Data	sortDate		date-time
ID de origem	sourceId		string
origem atribuída à ID	sourceAssignedToId		string
origem relacionada à ID	sourceRelatedToId		string
IDs de contato de origem	sourceContactIds		array of string
direção da chamada	callDirection		string

Retornos

Corpo: Task.Api.Features.Calls.CallDTO

Atualizar uma conta existente

ID da operação:: Account_Update

Atualiza os detalhes da conta especificada na empresa fornecida.
As permissões de usuário e o contexto da empresa são validados durante esta operação.
Somente usuários autorizados com dados válidos podem executar a atualização.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da conta	accountId	True	string	O identificador exclusivo da conta a ser atualizada.
Nome	name		string
Telefone	phone		string
Estanho	tin		string
Code	code		string
Email	email		string
SourceId	sourceId		string
SourceParentId	sourceParentId		string
SourceOwnerId	sourceOwnerId		string
PrimaryContactIds	primaryContactIds		array of string
Identificação da conta dos pais	parentAccountId		string
OwnerId	ownerId		string
Address1	address1		string
Address2	address2		string
City	city		string
Estado	state		string
Latitude	latitude		string
Longtitude	longtitude		string
País	country		string
Código do País	countryCode		string
Código Postal	postalCode		string
Primeiro Nome	firstName		string
LastName	lastName		string
Número de telefone	phoneNumber		string
Email	email		string
AccountSourceTypeId	accountSourceTypeId		string
IndustryId	industryId		string
TierId	tierId		string
Website	website		string
AccountDescription	accountDescription		string
NoOfEmployees	noOfEmployees		integer
AnnualRevenue	annualRevenue		double
CreatedBy	createdBy		string
LastModifiedBy	lastModifiedBy		string
Fac-símile	fax		string
OwnershipId	ownershipId		string
RatingId	ratingId		string
ClassificationId	classificationId		string
ExtraFields	extraFields		object
AssignedTeams	assignedTeams		array of string

Retornos

Corpo: Customer.Api.Features.Accounts.AccountDTO

Atualizar uma oportunidade existente por ID

ID da operação:: Opportunity_Update

Aplica alterações aos campos da oportunidade especificada, como nome, estágio, valor ou link de conta.
Acessível somente se o usuário tiver permissões de gravação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo da oportunidade de atualização.
ID do tipo	typeId		string
ID do proprietário	ownerId		string
ID da conta	accountId		string
nome	name		string
quantidade	amount		double
ID da categoria de previsão	forecastCategoryId		string
Data de fechamento	closeDate		date-time
probabilidade	probability		integer
pontuação	score		integer
descrição	description		string
ID do pipeline de vendas	salesPipelineId		string
ID da cotação	quoteId		string
ID de status da oportunidade	opportunityStatusId		string
status	status		string
ID do tipo de origem da conta	accountSourceTypeId		string
próxima etapa	nextStep		string
orçamento confirmado	budgetConfirmed		boolean
descoberta concluída	discoveryCompleted		boolean
Receita esperada	expectedRevenue		double
ID do motivo da perda	lossReasonId		string
particular	private		boolean
última modificação por	lastModifiedBy		string
Campos extras	extraFields		object

Retornos

Corpo: SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Atualizar uma tarefa existente por ID

ID da operação:: Task_Update

Use essa ação para modificar detalhes de uma tarefa existente, como assunto, descrição, data de conclusão, prioridade ou usuário atribuído.
Somente tarefas acessíveis ao usuário atual podem ser atualizadas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo da tarefa a ser atualizada.
Tipo de tarefa	taskType		string
assunto	subject		string
Data de conclusão	dueDate		date-time
Data concluída	completedDate		date-time
status	status		string
ID de prioridade	priorityId		string
atribuído à ID	assignedToId		string
atribuído ao tipo	assignedToType		string
IDs de contato	contactIds		array of string
Tipo de contato	contactType		string
relacionado à ID	relatedToId		string
relacionado ao tipo	relatedToType		string
ID do sub-tipo da tarefa	taskSubTypeId		string
comments	comments		string
corpo do editor	editorBody		string
Conjunto de lembretes	reminderSet		boolean
posição	position		integer
ID pai	parentId		string
última modificação por	lastModifiedBy		string

Retornos

Corpo: Task.Api.Features.Tasks.TaskDTO

Criar um novo cliente potencial

ID da operação:: Lead_Create

Use essa ação para criar um novo cliente potencial, incluindo detalhes da empresa, informações de contato e fonte. O lead criado pode ser enriquecido, pontuado, convertido ou atualizado posteriormente.

Parâmetros

Nome	Chave	Obrigatório	Tipo
cargo	jobTitle		string
ID de status do cliente potencial	leadStatusId		string
nome próprio	firstName	True	string
apelido	lastName		string
Nome do meio	middleName		string
ID de saudação	salutationId		string
sufixo	suffix		string
email	email		string
phone	phone		string
telefone celular	mobilePhone		string
endereço eletrônico	emailAddress		string
tipo	type		string
recusar	optOut		boolean
Número de telefone	phoneNumber		string
tipo	type		string
recusar	optOut		boolean
chamar Opt Out	callOptOut		boolean
e-mail Recusar	emailOptOut		boolean
ID de classificação	ratingId		string
ID do proprietário	ownerId		string
Tipo de proprietário	ownerType		string
site	website		string
empresa	company		string
ID da indústria	industryId		string
nenhum funcionário	noOfEmployees		integer
ID do tipo de origem da conta	accountSourceTypeId		string
endereço1	address1		string
endereço2	address2		string
city	city		string
estado	state		string
country	country		string
código postal	postalCode		string
descrição	description		string
receita anual	annualRevenue		double
data da última transferência	lastTransferDate		date-time
ID de gênero	genderId		string
ID de pronunciamento	pronounceId		string
status	status		string
Campos extras	extraFields		object

Retornos

Corpo: SalesPipeline.Api.Features.Lead.LeadDto

Criar um novo contato

ID da operação:: Contact_Create

Cria um novo contato na empresa especificada.
O usuário que está fazendo a solicitação deve ter o relevante x-permissions para executar essa ação.

Parâmetros

Nome	Chave	Tipo
ID	id	string
CompanyId	companyId	string
OwnerId	ownerId	string
AccountIds	accountIds	array of string
SourceId	sourceId	string
SourceOwnerId	sourceOwnerId	string
SourceAccountIds	sourceAccountIds	array of string
Primeiro Nome	firstName	string
LastName	lastName	string
MiddleName	middleName	string
SalutationId	salutationId	string
Sufixo	suffix	string
Email	email	string
Telefone	phone	string
MobilePhone	mobilePhone	string
Fac-símile	fax	string
CallOptOut	callOptOut	boolean
EmailOptOut	emailOptOut	boolean
Endereço de Email	emailAddress	string
Tipo	type	string
OptOut	optOut	boolean
Número de telefone	phoneNumber	string
Tipo	type	string
OptOut	optOut	boolean
Título do Cargo	jobTitle	string
GenderId	genderId	string
PronounceId	pronounceId	string
Address1	address1	string
Address2	address2	string
City	city	string
Estado	state	string
Latitude	latitude	string
Longtitude	longtitude	string
País	country	string
Código do País	countryCode	string
Código Postal	postalCode	string
Primeiro Nome	firstName	string
LastName	lastName	string
Número de telefone	phoneNumber	string
Email	email	string
InsertDate	insertDate	date-time
UpdateDate	updateDate	date-time
CreatedBy	createdBy	string
LastModifiedBy	lastModifiedBy	string
Departamento	department	string
ReportsTo	reportsTo	string
Assistente	assistant	string
AssistantPhone	assistantPhone	string
Birthday	birthday	date-time
Description	description	string
LastStayInTouchReportedDate	lastStayInTouchReportedDate	date-time
LastStayInTouchSaveDate	lastStayInTouchSaveDate	date-time
AccountSourceTypeId	accountSourceTypeId	string
Nome Completo	fullName	string
ExtraFields	extraFields	object
AssignedTeams	assignedTeams	array of string

Retornos

Corpo: Customer.Api.Features.Contacts.ContactDTO

Criar um novo evento

ID da operação:: Event_Create

Use essa ação para agendar ou registrar um novo evento em log.
Forneça detalhes como título, descrição, participantes e data/hora agendada.
O evento criado pode ser atualizado, recuperado ou vinculado a outras atividades posteriormente.

Parâmetros

Nome	Chave	Tipo
data de atualização	updateDate	date-time
assunto	subject	string
Tipo de tarefa	taskType	string
atribuído ao tipo	assignedToType	string
atribuído à ID	assignedToId	string
relacionado ao tipo	relatedToType	string
relacionado à ID	relatedToId	string
Tipo de contato	contactType	string
IDs de contato	contactIds	array of string
descrição	description	string
corpo do editor	editorBody	string
ID de prioridade	priorityId	string
longitude	longitude	string
latitude	latitude	string
Data de início	startDate	date-time
Data de término	endDate	date-time
Conjunto de lembretes	reminderSet	boolean
criado por	createdBy	string
última modificação por	lastModifiedBy	string
posição	position	integer
ID pai	parentId	string
repeat	repeat	string
Status do evento	eventStatus	string
ID do resultado do evento	eventResultId	string
Intervalo de recorrência	recurrenceInterval	string
ID de origem	sourceId	string
origem atribuída à ID	sourceAssignedToId	string
origem relacionada à ID	sourceRelatedToId	string
IDs de contato de origem	sourceContactIds	array of string
Membros da equipe	teamMembers	array of string

Retornos

Corpo: Task.Api.Features.Events.EventDTO

Criar uma nova anotação

ID da operação:: Note_Create

Use essa ação para adicionar uma anotação a uma atividade ou entidade específica.
Forneça detalhes como título, conteúdo e referências relacionadas.
A nota criada pode ser recuperada, atualizada ou excluída posteriormente.

Parâmetros

Nome	Chave	Obrigatório	Tipo
Tipo de tarefa	taskType		string
relacionado ao tipo	relatedToType		string
Tipo de contato	contactType		string
relacionado à ID	relatedToId		string
assunto	subject	True	string
body	body		string
corpo do editor	editorBody		string
IDs de contato	contactIds		array of string

Retornos

Corpo: Task.Api.Features.Notes.NoteDTO

Criar uma nova chamada

ID da operação:: Call_Create

Use essa ação para criar uma nova atividade de chamada, incluindo assunto, participantes, hora agendada e status.
A chamada criada pode ser recuperada, atualizada ou excluída posteriormente.

Parâmetros

Nome	Chave	Tipo
Data de conclusão	dueDate	date-time
assunto	subject	string
atribuído ao tipo	assignedToType	string
atribuído à ID	assignedToId	string
relacionado ao tipo	relatedToType	string
relacionado à ID	relatedToId	string
Tipo de contato	contactType	string
IDs de contato	contactIds	array of string
status	status	string
Duração da chamada	callDuration	date-span
ID do resultado da chamada	callResultId	string
comments	comments	string
corpo do editor	editorBody	string
ID de prioridade	priorityId	string
posição	position	integer
ID pai	parentId	string
Conjunto de lembretes	reminderSet	boolean
Classificar Data	sortDate	date-time
ID de origem	sourceId	string
origem atribuída à ID	sourceAssignedToId	string
origem relacionada à ID	sourceRelatedToId	string
IDs de contato de origem	sourceContactIds	array of string
direção da chamada	callDirection	string

Retornos

Corpo: Task.Api.Features.Calls.CallDTO

Criar uma nova conta

ID da operação:: Account_Create

Cria uma nova conta na empresa especificada.
O usuário que está fazendo a solicitação deve ter o relevante x-permissions para executar essa ação e os detalhes da conta devem ser válidos.

Parâmetros

Nome	Chave	Obrigatório	Tipo
ID	id		string
CompanyId	companyId		string
Nome	name	True	string
Code	code		string
Estanho	tin		string
Email	email		string
Telefone	phone		string
SourceId	sourceId		string
SourceParentId	sourceParentId		string
SourceOwnerId	sourceOwnerId		string
PrimaryContactIds	primaryContactIds		array of string
Identificação da conta dos pais	parentAccountId		string
OwnerId	ownerId		string
Address1	address1		string
Address2	address2		string
City	city		string
Estado	state		string
Latitude	latitude		string
Longtitude	longtitude		string
País	country		string
Código do País	countryCode		string
Código Postal	postalCode		string
Primeiro Nome	firstName		string
LastName	lastName		string
Número de telefone	phoneNumber		string
Email	email		string
UpdateDate	updateDate		date-time
InsertDate	insertDate		date-time
TaxOffice	taxOffice		string
AccountSourceTypeId	accountSourceTypeId		string
IndustryId	industryId		string
TierId	tierId		string
Website	website		string
AccountDescription	accountDescription		string
NoOfEmployees	noOfEmployees		integer
AnnualRevenue	annualRevenue		double
CreatedBy	createdBy		string
LastModifiedBy	lastModifiedBy		string
Fac-símile	fax		string
OwnershipId	ownershipId		string
RatingId	ratingId		string
ClassificationId	classificationId		string
ExtraFields	extraFields		object
AssignedTeams	assignedTeams		array of string
AiScore	aiScore		double
AiScoreReasoning	aiScoreReasoning		string
AiSentiment	aiSentiment		integer
AiGenerationDate	aiGenerationDate		date-time

Retornos

Corpo: Customer.Api.Features.Accounts.AccountDTO

Criar uma nova oportunidade

ID da operação:: Opportunity_Create

Use essa ação para criar uma nova oportunidade no pipeline de vendas.
Uma oportunidade normalmente representa um possível acordo com uma conta, vinculada a um cliente potencial ou criada de forma independente.

Parâmetros

Nome	Chave	Obrigatório	Tipo
ID do tipo	typeId		string
ID do proprietário	ownerId		string
ID da conta	accountId		string
nome	name	True	string
quantidade	amount		double
ID da categoria de previsão	forecastCategoryId		string
ID do pipeline de vendas	salesPipelineId		string
Data de fechamento	closeDate	True	date-time
probabilidade	probability		integer
pontuação	score		integer
descrição	description		string
ID da cotação	quoteId		string
ID de status da oportunidade	opportunityStatusId		string
status	status		string
ID do tipo de origem da conta	accountSourceTypeId		string
próxima etapa	nextStep		string
orçamento confirmado	budgetConfirmed		boolean
descoberta concluída	discoveryCompleted		boolean
Receita esperada	expectedRevenue		double
ID do motivo da perda	lossReasonId		string
particular	private		boolean
Campos extras	extraFields		object

Retornos

Corpo: SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Criar uma nova tarefa

ID da operação:: Task_Create

Use essa ação para adicionar uma nova tarefa ao seu sistema.
Forneça detalhes como assunto, descrição, data de conclusão, prioridade e usuário atribuído.
A tarefa criada pode ser recuperada, atualizada ou excluída posteriormente.

Parâmetros

Nome	Chave	Tipo
Tipo de tarefa	taskType	string
assunto	subject	string
Data de conclusão	dueDate	date-time
status	status	string
ID de prioridade	priorityId	string
atribuído à ID	assignedToId	string
atribuído ao tipo	assignedToType	string
IDs de contato	contactIds	array of string
Tipo de contato	contactType	string
relacionado à ID	relatedToId	string
relacionado ao tipo	relatedToType	string
ID do sub-tipo da tarefa	taskSubTypeId	string
comments	comments	string
corpo do editor	editorBody	string
Conjunto de lembretes	reminderSet	boolean
posição	position	integer
ID pai	parentId	string

Retornos

Corpo: Task.Api.Features.Tasks.TaskDTO

Excluir um cliente potencial por ID

ID da operação:: Lead_Delete

Exclui permanentemente um cliente potencial do sistema. Verifique se o cliente potencial não é necessário para processamento ou conversão adicional antes da exclusão.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo do cliente potencial a ser excluído.

Excluir um contato

ID da operação:: Contact_Delete

Exclui o contato especificado da empresa determinada.
O acesso é determinado pelo contexto da empresa fornecido no x-companyid cabeçalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de contato	contactId	True	string	O identificador exclusivo do contato a ser excluído.

Excluir um evento por ID

ID da operação:: Event_Delete

Remove permanentemente o evento especificado do sistema.
Verifique se o evento não está vinculado a outros processos antes da exclusão.
Somente eventos acessíveis ao usuário atual podem ser excluídos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo do evento a ser excluído.

Excluir uma anotação por ID

ID da operação:: Note_Delete

Remove permanentemente a nota especificada do sistema.
Verifique se a anotação não está vinculada a outros processos antes da exclusão.
Somente anotações acessíveis ao usuário atual podem ser excluídas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo da nota a ser excluída.

Excluir uma chamada por ID

ID da operação:: Call_Delete

Remove permanentemente a chamada especificada do sistema.
Somente chamadas acessíveis ao usuário atual podem ser excluídas.
Verifique se a chamada não está vinculada a outros processos antes da exclusão.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo da chamada a ser excluída.

Excluir uma conta

ID da operação:: Account_Delete

Exclui a conta especificada para a empresa determinada.
A solicitação deve incluir permissões válidas x-companyid e apropriadas para prosseguir.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da conta	accountId	True	string	O identificador exclusivo da conta a ser excluída.

Excluir uma oportunidade por ID

ID da operação:: Opportunity_Delete

Remove permanentemente uma oportunidade do sistema.
Verifique se a oportunidade não é mais necessária antes da exclusão, pois a ação não pode ser desfeita.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo da oportunidade de excluir.

Excluir uma tarefa por ID

ID da operação:: Task_Delete

Remove permanentemente a tarefa especificada do sistema.
Verifique se a tarefa não está vinculada a outros processos antes da exclusão.
Somente tarefas acessíveis ao usuário atual podem ser excluídas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo da tarefa a ser excluída.

Recuperar todas as anotações acessíveis ao usuário

ID da operação:: Note_GetAll

Lista todas as anotações acessíveis ao usuário atual.
Você pode filtrar os resultados usando critérios de pesquisa, como criador, entidade relacionada ou intervalo de datas.
Útil para relatórios, dashboards ou automações que processam várias anotações.

Parâmetros

Nome	Chave	Tipo	Description
ID	Id	string	Obtém ou define a lista de identificadores usados para filtrar anotações.
Pesquisa	Search	string	Obtém ou define o texto usado para executar uma pesquisa entre anotações.
Relacionado à ID	RelatedToId	string	Obtém ou define o identificador relacionado a uma entidade específica para filtrar anotações.
relacionado ao tipo	RelatedToType	string	Obtém ou define o tipo de entidade relacionada à nota.
Criado por	CreatedBy	string	Obtém ou define o identificador para o usuário que criou a anotação.
Última modificação por	LastModifiedBy	string	Obtém ou define o identificador do usuário que modificou a anotação pela última vez.
Página	Page	integer	Define o número da página atual para resultados paginados. Esse valor é usado para determinar o ponto de partida do conjunto de dados para paginação.
Tamanho da Página	PageSize	integer	Define o número de itens a serem incluídos em uma única página de resultados paginados. Esse valor determina o tamanho do conjunto de dados a ser retornado por página.
Classificar	Sort	string	Representa os critérios de classificação para os resultados da pesquisa. Essa propriedade define a ordem de classificação e os campos do conjunto de dados.

Retornos

response: array of Task.Api.Features.Notes.NoteDTO

Recuperar todas as chamadas

ID da operação:: Call_GetAll

Lista todas as atividades de chamada acessíveis ao usuário atual.
Você pode filtrar os resultados usando critérios de pesquisa, como usuário atribuído, status ou intervalo de datas.
Útil para relatórios, dashboards ou automações que processam várias chamadas.

Parâmetros

Nome	Chave	Tipo	Description
ID	Id	string	Identificador exclusivo usado para filtrar e pesquisar tarefas específicas.
Situação	Status	string	Status da tarefa
ID de prioridade	PriorityId	string	Representa o identificador para a prioridade associada a uma tarefa, habilitando a filtragem e a categorização com base nos níveis de prioridade.
Criado por	CreatedBy	string	Identificador que representa o usuário que criou a tarefa, utilizado para fins de filtragem.
Última modificação por	LastModifiedBy	string	Especifica o identificador ou o nome do último usuário que modificou a tarefa. Essa propriedade é utilizada para filtrar e pesquisar tarefas com base no usuário modificador.
Data de vencimento	DueDate	date-time	Representa a data em que a tarefa deve ser concluída ou pela qual a ação é necessária. Usado como um filtro para pesquisar ou consultar tarefas com base na data de conclusão.
Data de Classificação	SortDate	string	Representa a data ou as datas que podem ser usadas para classificar tarefas. Essa propriedade permite a filtragem de tarefas com base nas datas de classificação especificadas.
Atribuído à ID	AssignedToId	string	Representa os identificadores dos usuários ou entidades a quem a tarefa ou chamada é atribuída.
Relacionado à ID	RelatedToId	string	Identificador que vincula a tarefa a uma entidade relacionada. Usado para filtrar ou pesquisar tarefas associadas a outras entidades.
ID do resultado da chamada	CallResultId	string	Representa o identificador de um resultado de chamada, que pode ser usado para filtrar tarefas com base no resultado da chamada associada.
Pesquisa	Search	string	Representa um termo de pesquisa que pode ser usado para filtrar dados aplicando uma operação "StartsWith" em campos relevantes.
Página	Page	integer	Define o número da página atual para resultados paginados. Esse valor é usado para determinar o ponto de partida do conjunto de dados para paginação.
Tamanho da Página	PageSize	integer	Define o número de itens a serem incluídos em uma única página de resultados paginados. Esse valor determina o tamanho do conjunto de dados a ser retornado por página.
Classificar	Sort	string	Representa os critérios de classificação para os resultados da pesquisa. Essa propriedade define a ordem de classificação e os campos do conjunto de dados.

Retornos

response: array of Task.Api.Features.Calls.CallDTO

Recuperar todas as contas de uma empresa

ID da operação:: Account_GetAll

Retorna uma lista de todas as contas pertencentes à empresa especificada.
O usuário que está fazendo a solicitação deve ter permissões apropriadas, definidas nos cabeçalhos de solicitação.
Os filtros podem ser aplicados usando parâmetros de cadeia de caracteres de consulta.

Parâmetros

Nome	Chave	Tipo	Description
Conta pai	ParentAccount	string	Define o ParentAccount associado à pesquisa atual.
Telefone	Phone	string	Define o número de telefone associado à pesquisa atual.
Sugestões	Suggestions	string	Define as Sugestões associadas à pesquisa atual. Esse valor é usado para filtrar os resultados da pesquisa com base nas sugestões especificadas.
ID do proprietário	OwnerId	string	Especifica o filtro OwnerId aplicado à pesquisa de conta atual.
ID de propriedade	OwnershipId	string	Define o OwnershipId usado como um filtro na pesquisa.
ID de classificação	RatingId	string	Define a RatingId associada à pesquisa atual. Usado para filtrar contas com base no identificador de classificação.
ID de classificação	ClassificationId	string	Define a ClassificationId usada para filtrar contas com base em sua classificação.
ID do setor	IndustryId	string	Define a IndustryId associada à pesquisa atual.
ID do tipo de origem da conta	AccountSourceTypeId	string	Define o AccountSourceTypeId associado à pesquisa atual.
ID de contato primário	PrimaryContactId	string	Representa o identificador do contato primário associado à pesquisa de conta.
Equipes Atribuídas	AssignedTeams	string	Define a lista de equipes atribuídas à pesquisa atual.
Pesquisa	Search	string	Define o termo de pesquisa usado para filtrar os resultados da pesquisa atual.
Nome	Name	string	Obtém ou define o nome da conta a ser usada como um filtro nos critérios de pesquisa.
ID	Id	string	Representa uma coleção de identificadores de conta usados para filtrar os resultados da pesquisa.
Página	Page	integer	Especifica o número da página atual para os resultados da pesquisa paginada.
Tamanho da Página	PageSize	integer	Especifica o número de itens a serem exibidos por página nos resultados da pesquisa paginada.
Classificar	Sort	string	Representa o parâmetro de classificação para a ordenação de resultados da pesquisa. Aceita uma lista separada por vírgulas de campos prefixados por "+" para ordem crescente ou "-" para ordem decrescente. O padrão é "id" se não for especificado.

Retornos

response: array of Customer.Api.Features.Accounts.AccountDTO

Recuperar todas as oportunidades com paginação

ID da operação:: Opportunity_GetAll

Lista oportunidades acessíveis ao usuário, com base no escopo (Eu, Equipe ou Todos).
Dá suporte à filtragem, pesquisa e paginação.
Útil para dashboards, relatórios e integrações que exigem acesso em lote.

Parâmetros

Nome	Chave	Tipo	Description
ID	Id	string	Define os identificadores para o filtro de pesquisa de oportunidades.
ID do proprietário	OwnerId	string	Define os identificadores dos proprietários associados à pesquisa de oportunidades.
Nome	Name	string	Representa o nome da oportunidade usada no filtro de pesquisa.
Quantidade	Amount	double	Define a receita esperada ou o valor monetário para o filtro de pesquisa de oportunidades.
Data de Fechamento	CloseDate	string	Representa o filtro de pesquisa de data de fechamento para oportunidades. Essa propriedade permite filtrar oportunidades com base em suas datas de fechamento.
Data de Atualização	UpdateDate	date-time	Define a última data de atualização para o filtro de pesquisa de oportunidade.
Inserir Data	InsertDate	date-time	Define a data e a hora em que a oportunidade foi inserida.
ID da conta	AccountId	string	Especifica os identificadores do filtro de conta nos critérios de pesquisa de oportunidade.
ID da categoria de previsão	ForecastCategoryId	string	Filtra oportunidades com base nos identificadores de categoria de previsão especificados.
ID do tipo de origem da conta	AccountSourceTypeId	string	Representa o identificador do filtro de tipo de origem da conta em uma pesquisa de oportunidades.
ID do status da oportunidade	OpportunityStatusId	string	Especifica os identificadores dos status de oportunidade para filtrar a pesquisa de oportunidades.
ID da cotação	QuoteId	string	Define o identificador exclusivo para a cotação associada no filtro de pesquisa de oportunidade.
ID do Motivo da Perda	LossReasonId	string	Representa o identificador pelo motivo pela qual uma oportunidade foi perdida.
ID do tipo	TypeId	string	Representa o identificador de tipo usado para filtrar oportunidades em uma consulta de pesquisa.
Última modificação por	LastModifiedBy	string	Especifica o usuário que modificou a oportunidade pela última vez.
Criado por	CreatedBy	string	Especifica o identificador do usuário ou sistema que criou a entrada de oportunidade.
Pesquisa	Search	string	Define a palavra-chave ou frase usada para executar uma pesquisa geral entre registros de oportunidade.
ID do Pipeline de Vendas	SalesPipelineId	string	Define o identificador do filtro de pipeline de vendas em pesquisas de oportunidades.
Situação	Status	string	Especifica os status das oportunidades para o filtro de pesquisa.
Página	Page	integer	Define o número da página para resultados paginados. O padrão é 1.
Tamanho da Página	PageSize	integer	Define o número de itens por página para resultados paginados. O padrão é 25.
Classificar	Sort	string	Especifica os critérios de classificação como uma cadeia de caracteres. A cadeia de caracteres de classificação determina a propriedade e a direção (crescente ou decrescente) para classificar os resultados. Vários critérios podem ser combinados usando um separador de vírgula.

Retornos

response: array of SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Recuperar todas as tarefas acessíveis ao usuário

ID da operação:: Task_GetAll

Lista todas as tarefas acessíveis ao usuário atual.
Você pode filtrar os resultados usando critérios de pesquisa, como usuário atribuído, status ou intervalo de datas.
Útil para relatórios, dashboards ou automações que processam várias tarefas.

Parâmetros

Nome	Chave	Tipo	Description
ID	Id	string	Define o identificador exclusivo para a tarefa.
Situação	Status	string	Define o status da tarefa, representando seu estágio atual, como Abrir ou Concluído.
Relacionado a	RelatedTo	string	Define o tipo relacionado para tarefas de filtragem. Essa propriedade é usada para associar tarefas a uma entidade ou categoria específica.
Relacionado à ID	RelatedToId	string	Define o identificador da entidade à qual a tarefa está relacionada.
ID de prioridade	PriorityId	string	Define o identificador para filtrar tarefas por sua prioridade.
Tipo de tarefa	Type	string	Define o tipo da tarefa, indicando sua finalidade ou categoria pretendida.
Data de vencimento	DueDate	date-time	Define a data de conclusão da tarefa. Essa propriedade é usada para filtrar tarefas com base na data de conclusão.
Data de Classificação	SortDate	string	Define os valores de data de classificação usados para filtrar e classificar tarefas.
ID pai	ParentId	string	Define o identificador da tarefa pai associada à tarefa atual.
Última modificação por	LastModifiedBy	string	Define o identificador para o usuário que modificou a tarefa pela última vez.
Criado por	CreatedBy	string	Define o identificador do usuário que criou a tarefa.
Atribuído à ID	AssignedToId	string	Define os identificadores dos usuários aos quais a tarefa é atribuída.
Pesquisa	Search	string	Define a consulta de pesquisa usada para filtrar tarefas com base em uma palavra-chave ou texto especificado.
Página	Page	integer	Define o número da página atual para resultados paginados. Esse valor é usado para determinar o ponto de partida do conjunto de dados para paginação.
Tamanho da Página	PageSize	integer	Define o número de itens a serem incluídos em uma única página de resultados paginados. Esse valor determina o tamanho do conjunto de dados a ser retornado por página.
Classificar	Sort	string	Representa os critérios de classificação para os resultados da pesquisa. Essa propriedade define a ordem de classificação e os campos do conjunto de dados.

Retornos

response: array of Task.Api.Features.Tasks.TaskDTO

Recuperar todos os clientes potenciais com paginação

ID da operação:: Lead_GetAll

Lista todos os clientes potenciais acessíveis ao usuário atual. Dá suporte à paginação e à filtragem por meio de parâmetros de consulta.
Útil para dashboards, relatórios ou integrações que exigem processamento em lote de clientes potenciais.

Parâmetros

Nome	Chave	Tipo	Description
ID	Id	string	Define a lista de IDs potenciais usadas como um critério de filtro na consulta de pesquisa.
Nome	Name	string	Define o nome do lead, que serve como um critério de filtro na consulta de pesquisa.
Primeiro Nome	FirstName	string	Define o nome do cliente potencial, usado como um critério de filtro em consultas de pesquisa.
Apelido	LastName	string	Define o sobrenome do cliente potencial, usado como um critério de filtro na consulta de pesquisa.
Inserir Data	InsertDate	string	Define a lista de Datas de Inserção usadas como um critério de filtro na consulta de pesquisa.
Telefone	Phone	string	Define o número de telefone associado ao lead. Essa propriedade é usada como um critério de filtro na consulta de pesquisa.
Celular	MobilePhone	string	Define o número de telefone celular de um cliente potencial, usado como um critério de filtro em consultas de pesquisa.
Email	Email	string	Define o endereço de email do cliente potencial usado como um critério de filtro na consulta de pesquisa.
ID do proprietário	OwnerId	string	Representa a lista de IDs de proprietário usadas como um critério de filtro na consulta de pesquisa.
Tipo de proprietário	OwnerType	string	Especifica o tipo de proprietário para o cliente potencial, como um indivíduo ou uma fila. Essa propriedade é usada como um critério de filtragem na consulta de pesquisa.
ID do tipo de origem da conta	AccountSourceTypeId	string	Especifica o tipo da fonte da conta usada como um critério de filtro na consulta de pesquisa.
ID do status do cliente potencial	LeadStatusId	string	Filtra clientes potenciais com base na ID de status do cliente potencial associado.
ID do setor	IndustryId	string	Define a ID do Setor usada como um critério de filtro na consulta de pesquisa.
Situação	Status	string	Representa o filtro de status usado em consultas de pesquisa de clientes potenciais. Esse filtro permite especificar o status dos clientes potenciais, como "Padrão", "Qualificado" ou "Não Qualificado".
Pesquisa	Search	string	Define a palavra-chave de pesquisa usada como um critério de filtro na consulta de pesquisa.
Página	Page	integer	Define o número da página para resultados paginados. O padrão é 1.
Tamanho da Página	PageSize	integer	Define o número de itens por página para resultados paginados. O padrão é 25.
Classificar	Sort	string	Especifica os critérios de classificação como uma cadeia de caracteres. A cadeia de caracteres de classificação determina a propriedade e a direção (crescente ou decrescente) para classificar os resultados. Vários critérios podem ser combinados usando um separador de vírgula.

Retornos

response: array of SalesPipeline.Api.Features.Lead.LeadDto

Recuperar todos os contatos de uma empresa

ID da operação:: Contact_GetAll

Retorna uma lista de todos os contatos pertencentes à empresa especificada.
O usuário que está fazendo a solicitação deve ter permissões apropriadas, conforme determinado pelos cabeçalhos. Os filtros podem ser aplicados usando parâmetros de solicitação.

Parâmetros

Nome	Chave	Tipo	Description
Nome	Name	string	Define o nome do contato a ser usado como um filtro no processo de pesquisa.
ID do proprietário	OwnerId	string	Especifica os OwnerId(s) usados para filtrar os resultados da pesquisa para contatos.
Sugestões	Suggestions	string	Define as Sugestões a serem usadas como um filtro no processo de pesquisa.
ID do tipo de origem da conta	AccountSourceTypeId	string	Especifica a ID do tipo de origem da conta a ser usada como um filtro na consulta de pesquisa.
Primeiro Nome	FirstName	string	Define o FirstName do contato a ser usado como um filtro no processo de pesquisa.
Apelido	LastName	string	Define o Sobrenome do contato a ser usado como um filtro no processo de pesquisa.
Telefone	Phone	string	Define o número de telefone do contato a ser usado como um filtro no processo de pesquisa.
Celular	MobilePhone	string	Define o número de telefone celular a ser usado como um filtro no processo de pesquisa de contatos.
IDs de conta	AccountIds	string	Define as IDs da conta a serem usadas como um filtro no processo de pesquisa.
Email	Email	string	Especifica o endereço de email do contato a ser usado como um filtro durante o processo de pesquisa.
ID	Id	string	Especifica a lista de IDs de Contato a serem usadas como um filtro no processo de pesquisa.
Equipes Atribuídas	AssignedTeams	string	Especifica a lista de identificadores de equipe atribuídos ao contato, usada como um filtro no processo de pesquisa.
Pesquisa	Search	string	Especifica o termo ou valor a ser usado como um filtro de pesquisa geral ao consultar contatos.
Página	Page	integer	Especifica o número da página atual para os resultados da pesquisa paginada.
Tamanho da Página	PageSize	integer	Especifica o número de itens a serem exibidos por página nos resultados da pesquisa paginada.
Classificar	Sort	string	Representa o parâmetro de classificação para a ordenação de resultados da pesquisa. Aceita uma lista separada por vírgulas de campos prefixados por "+" para ordem crescente ou "-" para ordem decrescente. O padrão é "id" se não for especificado.

Retornos

response: array of Customer.Api.Features.Contacts.ContactDTO

Recuperar todos os eventos acessíveis ao usuário

ID da operação:: Event_GetAll

Lista todos os eventos acessíveis ao usuário atual.
Você pode filtrar os resultados usando critérios de pesquisa, como intervalo de datas, usuário atribuído ou status.
Útil para relatórios, dashboards ou automações que processam vários eventos.

Parâmetros

Nome	Chave	Tipo	Description
ID	Id	string	Define o identificador exclusivo associado ao evento. Definir essa propriedade adicionará automaticamente um filtro correspondente
Status do evento	Status	string	Define o status do evento associado aos critérios de pesquisa. Definir essa propriedade adicionará automaticamente um filtro correspondente
Status do evento	EventStatus	string	Define o status do evento que está sendo consultado. Definir essa propriedade adicionará automaticamente um filtro correspondente
Data de Início	StartDate	date-time	Define a data de início dos critérios de pesquisa de eventos. Definir essa propriedade adicionará automaticamente um filtro correspondente
Atribuído à ID	AssignedToId	string	Define a coleção de identificadores associados aos usuários atribuídos do evento. Definir essa propriedade adicionará automaticamente um filtro correspondente
Relacionado à ID	RelatedToId	string	Define o identificador da entidade à qual o evento está relacionado. Definir essa propriedade aplicará automaticamente um filtro com o
Data de Classificação	SortDate	string	Define os critérios de classificação com base em valores de data específicos relacionados ao evento. Ao definir essa propriedade, cada valor na coleção é adicionado automaticamente
ID pai	ParentId	string	Define o identificador da entidade pai associada ao evento. Quando essa propriedade é definida, um filtro correspondente é adicionado automaticamente com base no valor fornecido.
ID do resultado do evento	EventResultId	string	Define o identificador do resultado do evento usado para filtrar eventos. Atribuir um valor a essa propriedade aplica automaticamente o filtro correspondente.
ID de prioridade	PriorityId	string	Define o identificador de prioridade associado ao evento. Definir essa propriedade adicionará automaticamente um filtro correspondente com base na ID de prioridade.
Pesquisa	Search	string	Define a consulta de pesquisa usada para filtrar eventos com base em uma palavra-chave ou critérios específicos. Quando essa propriedade é definida, um filtro correspondente do tipo Task.Api.Models.Enums.TaskFilterType.Search é adicionado automaticamente.
Última modificação por	LastModifiedBy	string	Define o identificador do usuário que modificou o evento pela última vez. Definir essa propriedade adicionará um filtro com base no identificador do último usuário modificado.
Criado por	CreatedBy	string	Define o identificador de usuário da entidade que criou o evento. Definir essa propriedade adicionará automaticamente um filtro correspondente para eventos criados pelo usuário especificado.
Página	Page	integer	Define o número da página atual para resultados paginados. Esse valor é usado para determinar o ponto de partida do conjunto de dados para paginação.
Tamanho da Página	PageSize	integer	Define o número de itens a serem incluídos em uma única página de resultados paginados. Esse valor determina o tamanho do conjunto de dados a ser retornado por página.
Classificar	Sort	string	Representa os critérios de classificação para os resultados da pesquisa. Essa propriedade define a ordem de classificação e os campos do conjunto de dados.

Retornos

response: array of Task.Api.Features.Events.EventDTO

Recuperar um cliente potencial por ID

ID da operação:: Lead_GetById

Retorna informações detalhadas para o cliente potencial especificado, incluindo detalhes da empresa, informações de contato, origem e status. Use essa ação para exibir ou atualizar um cliente potencial específico.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo do lead.

Retornos

Corpo: SalesPipeline.Api.Features.Lead.LeadDto

Recuperar um contato por ID

ID da operação:: Contact_GetById

Retorna detalhes do contato especificado, fornecendo informações e dados específicos da empresa.
O acesso é determinado pelo contexto da empresa fornecido no cabeçalho da solicitação x-companyid .

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de contato	contactId	True	string	O identificador exclusivo do contato a ser recuperado.

Retornos

Corpo: Customer.Api.Features.Contacts.Contact

Recuperar um evento por ID

ID da operação:: Event_GetById

Retorna informações detalhadas para o evento especificado, incluindo título, participantes, hora agendada e status.
Use essa ação para exibir ou referenciar um evento específico em sua automação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo do evento.

Retornos

Corpo: Task.Api.Features.Events.EventDTO

Recuperar um usuário de retirada por ID

ID da operação:: User_GetById

Retorna detalhes completos do usuário especificado, incluindo informações de função dentro da empresa determinada.
O acesso é determinado pelo contexto da empresa fornecido no cabeçalho da solicitação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
identificação de usuário	userId	True	string	O identificador exclusivo do usuário backoffice a ser recuperado.

Retornos

Corpo: Identity.Api.BackOfficeUsers.GetUser.GetUserResponse

Recuperar uma anotação por ID

ID da operação:: Note_GetById

Retorna informações detalhadas para a nota especificada, incluindo conteúdo, criador e entidade relacionada.
Use essa ação para exibir ou fazer referência a uma observação específica em sua automação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo da anotação.

Retornos

Corpo: Task.Api.Features.Notes.NoteDTO

Recuperar uma conta por ID

ID da operação:: Account_GetById

Retorna detalhes da conta especificada, incluindo dados específicos da empresa.
O acesso é determinado pelo contexto da empresa fornecido no cabeçalho da solicitação x-companyid .

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da conta	accountId	True	string	O identificador exclusivo da conta a ser recuperada.

Retornos

Corpo: Customer.Api.Features.Accounts.AccountDTO

Recuperar uma equipe por seu identificador exclusivo

ID da operação:: Team_GetById

Retorna detalhes completos da equipe especificada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo da equipe.

Retornos

Corpo: Identity.Api.Teams.Dtos.GetTeamResponse

Recuperar uma oportunidade por ID

ID da operação:: Opportunity_GetById

Retorna detalhes completos da oportunidade especificada, incluindo o proprietário e a conta vinculada.
O acesso é restrito com base nas permissões do usuário.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo da oportunidade.

Retornos

Corpo: SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Recuperar uma tarefa de chamada por ID

ID da operação:: Call_GetById

Retorna informações detalhadas para a chamada especificada, incluindo assunto, participantes, hora agendada e status.
Use essa ação para exibir ou fazer referência a uma chamada específica em sua automação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo da tarefa de chamada.

Retornos

Corpo: Task.Api.Features.Calls.CallDTO

Recuperar uma tarefa por ID

ID da operação:: Task_GetById

Retorna informações detalhadas para a tarefa especificada, incluindo assunto, descrição, data de conclusão, prioridade e usuário atribuído.
Use essa ação para exibir ou fazer referência a uma tarefa específica em sua automação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	O identificador exclusivo da tarefa.

Retornos

Corpo: Task.Api.Features.Tasks.TaskDTO

Gatilhos

Gatilho atualizado da tarefa	Use essa ação para modificar detalhes de uma tarefa existente, como assunto, descrição, data de conclusão, prioridade ou usuário atribuído. Somente tarefas acessíveis ao usuário atual podem ser atualizadas.
Gatilho atualizado de chamada	Use essa ação para modificar detalhes de uma chamada existente, como assunto, participantes, hora agendada ou status. Somente chamadas acessíveis ao usuário atual podem ser atualizadas.
Gatilho atualizado do evento	Use essa ação para modificar detalhes de um evento existente, como título, descrição, participantes ou hora agendada. Somente eventos acessíveis ao usuário atual podem ser atualizados.
Gatilho atualizado por lead	Atualiza os detalhes de um cliente potencial existente, como informações da empresa, detalhes do contato, status ou origem. Somente os clientes potenciais acessíveis ao usuário podem ser atualizados.
Gatilho atualizado por oportunidade	Aplica alterações aos campos da oportunidade especificada, como nome, estágio, valor ou link de conta. Acessível somente se o usuário tiver permissões de gravação.
Gatilho criado pela oportunidade	Use essa ação para criar uma nova oportunidade no pipeline de vendas. Uma oportunidade normalmente representa um possível acordo com uma conta, vinculada a um cliente potencial ou criada de forma independente.
Gatilho criado pela tarefa	Use essa ação para adicionar uma nova tarefa ao seu sistema. Forneça detalhes como assunto, descrição, data de conclusão, prioridade e usuário atribuído. A tarefa criada pode ser recuperada, atualizada ou excluída posteriormente.
Gatilho criado por chamada	Use essa ação para criar uma nova atividade de chamada, incluindo assunto, participantes, hora agendada e status. A chamada criada pode ser recuperada, atualizada ou excluída posteriormente.
Gatilho criado por evento	Use essa ação para agendar ou registrar um novo evento em log. Forneça detalhes como título, descrição, participantes e data/hora agendada. O evento criado pode ser atualizado, recuperado ou vinculado a outras atividades posteriormente.
Gatilho criado por lead	Use essa ação para criar um novo cliente potencial, incluindo detalhes da empresa, informações de contato e fonte. O lead criado pode ser enriquecido, pontuado, convertido ou atualizado posteriormente.
Gatilho excluído da tarefa	Remove permanentemente a tarefa especificada do sistema. Verifique se a tarefa não está vinculada a outros processos antes da exclusão. Somente tarefas acessíveis ao usuário atual podem ser excluídas.
Gatilho excluído de chamada	Remove permanentemente a chamada especificada do sistema. Somente chamadas acessíveis ao usuário atual podem ser excluídas. Verifique se a chamada não está vinculada a outros processos antes da exclusão.
Gatilho excluído do evento	Remove permanentemente o evento especificado do sistema. Verifique se o evento não está vinculado a outros processos antes da exclusão. Somente eventos acessíveis ao usuário atual podem ser excluídos.
Gatilho excluído por chumbo	Exclui permanentemente um cliente potencial do sistema. Verifique se o cliente potencial não é necessário para processamento ou conversão adicional antes da exclusão.
Gatilho excluído por oportunidade	Remove permanentemente uma oportunidade do sistema. Verifique se a oportunidade não é mais necessária antes da exclusão, pois a ação não pode ser desfeita.

Gatilho atualizado da tarefa

ID da operação:: Task_Updated

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Title	Title	True	string	Um título para o registro de webhook

Retornos

Corpo: Task.Api.Features.Tasks.TaskDTO

Gatilho atualizado de chamada

ID da operação:: Call_Updated

Use essa ação para modificar detalhes de uma chamada existente, como assunto, participantes, hora agendada ou status.
Somente chamadas acessíveis ao usuário atual podem ser atualizadas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Title	Title	True	string	Um título para o registro de webhook

Retornos

Corpo: Task.Api.Features.Calls.CallDTO

Gatilho atualizado do evento

ID da operação:: Event_Updated

Use essa ação para modificar detalhes de um evento existente, como título, descrição, participantes ou hora agendada.
Somente eventos acessíveis ao usuário atual podem ser atualizados.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Title	Title	True	string	Um título para o registro de webhook

Retornos

Corpo: Task.Api.Features.Events.EventDTO

Gatilho atualizado por lead

ID da operação:: Lead_Updated

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Title	Title	True	string	Um título para o registro de webhook

Retornos

Corpo: SalesPipeline.Api.Features.Lead.LeadDto

Gatilho atualizado por oportunidade

ID da operação:: Opportunity_Updated

Aplica alterações aos campos da oportunidade especificada, como nome, estágio, valor ou link de conta.
Acessível somente se o usuário tiver permissões de gravação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Title	Title	True	string	Um título para o registro de webhook

Retornos

Corpo: SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Gatilho criado pela oportunidade

ID da operação:: Opportunity_Created

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Title	Title	True	string	Um título para o registro de webhook

Retornos

Corpo: SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Gatilho criado pela tarefa

ID da operação:: Task_Created

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Title	Title	True	string	Um título para o registro de webhook

Retornos

Corpo: Task.Api.Features.Tasks.TaskDTO

Gatilho criado por chamada

ID da operação:: Call_Created

Use essa ação para criar uma nova atividade de chamada, incluindo assunto, participantes, hora agendada e status.
A chamada criada pode ser recuperada, atualizada ou excluída posteriormente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Title	Title	True	string	Um título para o registro de webhook

Retornos

Corpo: Task.Api.Features.Calls.CallDTO

Gatilho criado por evento

ID da operação:: Event_Created

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Title	Title	True	string	Um título para o registro de webhook

Retornos

Corpo: Task.Api.Features.Events.EventDTO

Gatilho criado por lead

ID da operação:: Lead_Created

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Title	Title	True	string	Um título para o registro de webhook

Retornos

Corpo: SalesPipeline.Api.Features.Lead.LeadDto

Gatilho excluído da tarefa

ID da operação:: Task_Deleted

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Title	Title	True	string	Um título para o registro de webhook

Retornos

Corpo: Task.Api.Features.Tasks.TaskDTO

Gatilho excluído de chamada

ID da operação:: Call_Deleted

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Title	Title	True	string	Um título para o registro de webhook

Retornos

Corpo: Task.Api.Features.Calls.CallDTO

Gatilho excluído do evento

ID da operação:: Event_Deleted

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Title	Title	True	string	Um título para o registro de webhook

Retornos

Corpo: Task.Api.Features.Events.EventDTO

Gatilho excluído por chumbo

ID da operação:: Lead_Deleted

Exclui permanentemente um cliente potencial do sistema. Verifique se o cliente potencial não é necessário para processamento ou conversão adicional antes da exclusão.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Title	Title	True	string	Um título para o registro de webhook

Retornos

Corpo: SalesPipeline.Api.Features.Lead.LeadDto

Gatilho excluído por oportunidade

ID da operação:: Opportunity_Deleted

Remove permanentemente uma oportunidade do sistema.
Verifique se a oportunidade não é mais necessária antes da exclusão, pois a ação não pode ser desfeita.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Title	Title	True	string	Um título para o registro de webhook

Retornos

Corpo: SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Definições

Task.Api.Features.Calls.CallDTO

Nome	Caminho	Tipo
id	id	string
companyId	companyId	string
insertDate	insertDate	date-time
updateDate	updateDate	date-time
Tipo de tarefa	taskType	Task.Api.Models.Enums.TaskType
dueDate	dueDate	date-time
assunto	subject	string
atribuído ao tipo	assignedToType	Task.Api.Models.Enums.AssignedToType
assignedToId	assignedToId	string
relacionado ao tipo	relatedToType	Task.Api.Models.Enums.RelatedToType
relatedToId	relatedToId	string
Tipo de contato	contactType	Task.Api.Models.Enums.ContactType
contactIds	contactIds	array of string
status	status	Task.Api.Models.Enums.Status
callDuration	callDuration	date-span
callResultId	callResultId	string
comments	comments	string
editorBody	editorBody	string
priorityId	priorityId	string
lastModifiedBy	lastModifiedBy	string
createdBy	createdBy	string
posição	position	integer
ID do pai	parentId	string
reminderSet	reminderSet	boolean
sortDate	sortDate	date-time
código-fonte	sourceId	string
sourceAssignedToId	sourceAssignedToId	string
sourceRelatedToId	sourceRelatedToId	string
sourceContactIds	sourceContactIds	array of string
direção da chamada	callDirection	Task.Api.Models.Enums.CallDirection

Task.Api.Features.Events.EventDTO

Nome	Caminho	Tipo
id	id	string
companyId	companyId	string
insertDate	insertDate	date-time
updateDate	updateDate	date-time
assunto	subject	string
Tipo de tarefa	taskType	Task.Api.Models.Enums.TaskType
atribuído ao tipo	assignedToType	Task.Api.Models.Enums.AssignedToType
assignedToId	assignedToId	string
relacionado ao tipo	relatedToType	Task.Api.Models.Enums.RelatedToType
relatedToId	relatedToId	string
Tipo de contato	contactType	Task.Api.Models.Enums.ContactType
contactIds	contactIds	array of string
descrição	description	string
editorBody	editorBody	string
priorityId	priorityId	string
local	location	Task.Api.Features.Events.LocationDTO
startDate	startDate	date-time
data de término	endDate	date-time
reminderSet	reminderSet	boolean
createdBy	createdBy	string
lastModifiedBy	lastModifiedBy	string
posição	position	integer
ID do pai	parentId	string
repeat	repeat	string
Status do evento	eventStatus	Task.Api.Models.Enums.EventStatus
eventResultId	eventResultId	string
recurrenceInterval	recurrenceInterval	string
código-fonte	sourceId	string
sourceAssignedToId	sourceAssignedToId	string
sourceRelatedToId	sourceRelatedToId	string
sourceContactIds	sourceContactIds	array of string
teamMembers	teamMembers	array of string

Task.Api.Features.Events.LocationDTO

Nome	Caminho	Tipo	Description
longitude	longitude	string
latitude	latitude	string

Task.Api.Features.Notes.NoteDTO

Nome	Caminho	Tipo
id	id	string
companyId	companyId	string
relacionado ao tipo	relatedToType	Task.Api.Models.Enums.RelatedToType
relatedToId	relatedToId	string
assunto	subject	string
createdBy	createdBy	string
lastModifiedBy	lastModifiedBy	string
body	body	string
editorBody	editorBody	string
insertDate	insertDate	date-time
updateDate	updateDate	date-time
contactIds	contactIds	array of string
Tipo de contato	contactType	Task.Api.Models.Enums.ContactType
Tipo de tarefa	taskType	Task.Api.Models.Enums.TaskType
sortDate	sortDate	date-time

Task.Api.Features.Tasks.TaskDTO

Nome	Caminho	Tipo
id	id	string
companyId	companyId	string
insertDate	insertDate	date-time
updateDate	updateDate	date-time
createdBy	createdBy	string
lastModifiedBy	lastModifiedBy	string
Tipo de tarefa	taskType	Task.Api.Models.Enums.TaskType
assunto	subject	string
dueDate	dueDate	date-time
completedDate	completedDate	date-time
status	status	Task.Api.Models.Enums.Status
priorityId	priorityId	string
assignedToId	assignedToId	string
atribuído ao tipo	assignedToType	Task.Api.Models.Enums.AssignedToType
contactIds	contactIds	array of string
Tipo de contato	contactType	Task.Api.Models.Enums.ContactType
relatedToId	relatedToId	string
relacionado ao tipo	relatedToType	Task.Api.Models.Enums.RelatedToType
taskSubTypeId	taskSubTypeId	string
comments	comments	string
editorBody	editorBody	string
reminderSet	reminderSet	boolean
posição	position	integer
ID do pai	parentId	string

Task.Api.Models.Enums.AssignedToType

atribuído ao tipo: string

Task.Api.Models.Enums.CallDirection

direção da chamada: string

Task.Api.Models.Enums.ContactType

Tipo de contato: string

Task.Api.Models.Enums.EventStatus

Status do evento: string

Task.Api.Models.Enums.RelatedToType

relacionado ao tipo: string

Task.Api.Models.Enums.Status

status: string

Task.Api.Models.Enums.TaskType

Tipo de tarefa: string

SalesPipeline.Api.DTOs.AddressDto

Nome	Caminho	Tipo
endereço1	address1	string
endereço2	address2	string
city	city	string
estado	state	string
country	country	string
código postal	postalCode	string

SalesPipeline.Api.DTOs.EmailDTO

Nome	Caminho	Tipo
endereço eletrônico	emailAddress	string
tipo	type	SalesPipeline.Api.Models.Enums.EmailType
recusar	optOut	boolean

SalesPipeline.Api.DTOs.NameDTO

Nome	Caminho	Tipo
nome próprio	firstName	string
apelido	lastName	string
Nome do meio	middleName	string
ID de saudação	salutationId	string
sufixo	suffix	string

SalesPipeline.Api.DTOs.PhoneDTO

Nome	Caminho	Tipo
Número de telefone	phoneNumber	string
tipo	type	SalesPipeline.Api.Models.Enums.PhoneType
recusar	optOut	boolean

SalesPipeline.Api.Features.Lead.LeadDto

Nome	Caminho	Tipo
id	id	string
companyId	companyId	string
título do cargo	jobTitle	string
leadStatusId	leadStatusId	string
nome	name	SalesPipeline.Api.DTOs.NameDTO
email	email	string
phone	phone	string
mobilePhone	mobilePhone	string
otherEmail	otherEmail	array of SalesPipeline.Api.DTOs.EmailDTO
otherPhone	otherPhone	array of SalesPipeline.Api.DTOs.PhoneDTO
callOptOut	callOptOut	boolean
emailOptOut	emailOptOut	boolean
ratingId	ratingId	string
insertDate	insertDate	date-time
updateDate	updateDate	date-time
ownerId	ownerId	string
Tipo de proprietário	ownerType	SalesPipeline.Api.Models.Enums.OwnerType
site	website	string
empresa	company	string
industryId	industryId	string
noOfEmployees	noOfEmployees	integer
accountSourceTypeId	accountSourceTypeId	string
address	address	SalesPipeline.Api.DTOs.AddressDto
descrição	description	string
createdBy	createdBy	string
lastModifiedBy	lastModifiedBy	string
annualRevenue	annualRevenue	double
lastTransferDate	lastTransferDate	date-time
genderId	genderId	string
pronounceId	pronounceId	string
fullName	fullName	string
status	status	SalesPipeline.Api.Models.Enums.Status
extraFields	extraFields	object
aiScore	aiScore	double
aiScoreReasoning	aiScoreReasoning	string
aiSentiment	aiSentiment	SalesPipeline.Api.Features.Lead.UpdateLeadScore.LeadSentiment
aiGenerationDate	aiGenerationDate	date-time

SalesPipeline.Api.Features.Lead.UpdateLeadScore.LeadSentiment

: string

SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Nome	Caminho	Tipo
id	id	string
companyId	companyId	string
ID da conta	accountId	string
ID do tipo	typeId	string
ownerId	ownerId	string
nome	name	string
quantidade	amount	double
forecastCategoryId	forecastCategoryId	string
salesPipelineId	salesPipelineId	string
insertDate	insertDate	date-time
updateDate	updateDate	date-time
closeDate	closeDate	date-time
probabilidade	probability	integer
pontuação	score	integer
descrição	description	string
quoteId	quoteId	string
opportunityStatusId	opportunityStatusId	string
status	status	SalesPipeline.Api.Models.Enums.OpportunityStatus
accountSourceTypeId	accountSourceTypeId	string
nextStep	nextStep	string
budgetConfirmed	budgetConfirmed	boolean
discoveryCompleted	discoveryCompleted	boolean
expectedRevenue	expectedRevenue	double
lossReasonId	lossReasonId	string
particular	private	boolean
createdBy	createdBy	string
lastModifiedBy	lastModifiedBy	string
extraFields	extraFields	object
aiScore	aiScore	double
aiScoreReasoning	aiScoreReasoning	string
aiSentiment	aiSentiment	SalesPipeline.Api.Features.Opportunity.UpdateOpportunityScore.OpportunitySentiment
aiGenerationDate	aiGenerationDate	date-time

SalesPipeline.Api.Features.Opportunity.UpdateOpportunityScore.OpportunitySentiment

: string

SalesPipeline.Api.Models.Enums.EmailType

tipo: string

SalesPipeline.Api.Models.Enums.OpportunityStatus

status: string

SalesPipeline.Api.Models.Enums.OwnerType

Tipo de proprietário: string

SalesPipeline.Api.Models.Enums.PhoneType

tipo: string

SalesPipeline.Api.Models.Enums.Status

status: string

Identity.Api.BackOfficeUsers.GetUser.GetUserResponse

Nome	Caminho	Tipo	Description
id	id	string	O identificador do usuário
email	email	string	O email do usuário.
primeiro nome	firstName	string	O nome do usuário.
sobrenome	lastName	string	O sobrenome do usuário
fullName	fullName	string	O nome completo do usuário
userRole	userRole	Identity.Api.BackOfficeUsers.GetUser.GetUserResponse_Role
profileImage	profileImage	Identity.Api.BackOfficeUsers.GetUser.GetUserResponse_Image
lastLogin	lastLogin	date-time	A última data de logon dos usuários. Pode ser nulo se o usuário nunca fez logon
insertDate	insertDate	date-time	A data de criação do usuário
updateDate	updateDate	date-time	A última data de atualização do usuário.

Identity.Api.BackOfficeUsers.GetUser.GetUserResponse_Image

Nome	Caminho	Tipo	Description
id	id	string
galleryId	galleryId	string	A ID armazenada na galeria
Alt	alt	string	A alt a ser exibida
link	link	string	A URL da imagem

Identity.Api.BackOfficeUsers.GetUser.GetUserResponse_Role

Nome	Caminho	Tipo	Description
companyId	companyId	string	A ID da empresa para a função, essa sempre será a ID da empresa para a qual você solicitou os usuários.
isAdmin	isAdmin	boolean	Se esse usuário é considerado um administrador na empresa atual.
roleId	roleId	string	A ID da função se o usuário não for um administrador. Quando o usuário estiver administrando, a ID da função estará ausente.

Identity.Api.Teams.Dtos.GetTeamResponse

Nome	Caminho	Tipo
id	id	string
nome	name	string
users	users	array of Identity.Api.Teams.Dtos.TeamUserDto
modifiedBy	modifiedBy	string
createdBy	createdBy	string
createdAt	createdAt	date-time
modifiedAt	modifiedAt	date-time

Identity.Api.Teams.Dtos.TeamUserDto

Nome	Caminho	Tipo	Description
id	id	string

Customer.Api.DTOs.AddressDTO

Nome	Caminho	Tipo
Address1	address1	string
Address2	address2	string
City	city	string
Estado	state	string
Latitude	latitude	string
Longtitude	longtitude	string
País	country	string
Código do País	countryCode	string
Código Postal	postalCode	string
Primeiro Nome	firstName	string
LastName	lastName	string
Número de telefone	phoneNumber	string
Email	email	string

Customer.Api.Features.Accounts.AccountDTO

Nome	Caminho	Tipo
ID	id	string
CompanyId	companyId	string
Nome	name	string
Code	code	string
Estanho	tin	string
Email	email	string
Telefone	phone	string
SourceId	sourceId	string
SourceParentId	sourceParentId	string
SourceOwnerId	sourceOwnerId	string
PrimaryContactIds	primaryContactIds	array of string
Identificação da conta dos pais	parentAccountId	string
OwnerId	ownerId	string
address	address	Customer.Api.DTOs.AddressDTO
UpdateDate	updateDate	date-time
InsertDate	insertDate	date-time
TaxOffice	taxOffice	string
AccountSourceTypeId	accountSourceTypeId	string
IndustryId	industryId	string
TierId	tierId	string
Website	website	string
AccountDescription	accountDescription	string
NoOfEmployees	noOfEmployees	integer
AnnualRevenue	annualRevenue	double
CreatedBy	createdBy	string
LastModifiedBy	lastModifiedBy	string
Fac-símile	fax	string
OwnershipId	ownershipId	string
RatingId	ratingId	string
ClassificationId	classificationId	string
ExtraFields	extraFields	object
AssignedTeams	assignedTeams	array of string
AiScore	aiScore	double
AiScoreReasoning	aiScoreReasoning	string
AiSentiment	aiSentiment	integer
AiGenerationDate	aiGenerationDate	date-time

Customer.Api.Features.Contacts.Contact

Nome	Caminho	Tipo
ID	id	string
CompanyId	companyId	string
PartitionKey	partitionKey	string
OwnerId	ownerId	string
AccountIds	accountIds	array of string
SourceId	sourceId	string
SourceAccountIds	sourceAccountIds	array of string
SourceOwnerId	sourceOwnerId	string
nome	name	Customer.Api.Features.Contacts.Name
Email	email	string
Telefone	phone	string
MobilePhone	mobilePhone	string
Fac-símile	fax	string
CallOptOut	callOptOut	boolean
EmailOptOut	emailOptOut	boolean
OtherEmail	otherEmail	array of Customer.Api.Features.Contacts.Email
OtherPhone	otherPhone	array of Customer.Api.Features.Contacts.Phone
Título do Cargo	jobTitle	string
GenderId	genderId	string
PronounceId	pronounceId	string
address	address	Customer.Api.Models.Address
InsertDate	insertDate	date-time
UpdateDate	updateDate	date-time
CreatedBy	createdBy	string
LastModifiedBy	lastModifiedBy	string
Departamento	department	string
ReportsTo	reportsTo	string
Assistente	assistant	string
AssistantPhone	assistantPhone	string
Birthday	birthday	date-time
Description	description	string
LastStayInTouchReportedDate	lastStayInTouchReportedDate	date-time
LastStayInTouchSaveDate	lastStayInTouchSaveDate	date-time
AccountSourceTypeId	accountSourceTypeId	string
ExtraFields	extraFields	object
SearchTags	searchTags	array of string
AssignedTeams	assignedTeams	array of string

Customer.Api.Features.Contacts.ContactDTO

Nome	Caminho	Tipo
ID	id	string
CompanyId	companyId	string
OwnerId	ownerId	string
AccountIds	accountIds	array of string
SourceId	sourceId	string
SourceOwnerId	sourceOwnerId	string
SourceAccountIds	sourceAccountIds	array of string
nome	name	Customer.Api.Features.Contacts.NameDTO
Email	email	string
Telefone	phone	string
MobilePhone	mobilePhone	string
Fac-símile	fax	string
CallOptOut	callOptOut	boolean
EmailOptOut	emailOptOut	boolean
OtherEmail	otherEmail	array of Customer.Api.Features.Contacts.EmailDTO
OtherPhone	otherPhone	array of Customer.Api.Features.Contacts.PhoneDTO
Título do Cargo	jobTitle	string
GenderId	genderId	string
PronounceId	pronounceId	string
address	address	Customer.Api.DTOs.AddressDTO
InsertDate	insertDate	date-time
UpdateDate	updateDate	date-time
CreatedBy	createdBy	string
LastModifiedBy	lastModifiedBy	string
Departamento	department	string
ReportsTo	reportsTo	string
Assistente	assistant	string
AssistantPhone	assistantPhone	string
Birthday	birthday	date-time
Description	description	string
LastStayInTouchReportedDate	lastStayInTouchReportedDate	date-time
LastStayInTouchSaveDate	lastStayInTouchSaveDate	date-time
AccountSourceTypeId	accountSourceTypeId	string
Nome Completo	fullName	string
ExtraFields	extraFields	object
AssignedTeams	assignedTeams	array of string

Customer.Api.Features.Contacts.Email

Nome	Caminho	Tipo
Endereço de Email	emailAddress	string
Tipo	type	string
OptOut	optOut	boolean

Customer.Api.Features.Contacts.EmailDTO

Nome	Caminho	Tipo
Endereço de Email	emailAddress	string
Tipo	type	string
OptOut	optOut	boolean

Customer.Api.Features.Contacts.Name

Nome	Caminho	Tipo
Primeiro Nome	firstName	string
LastName	lastName	string
MiddleName	middleName	string
SalutationId	salutationId	string
Sufixo	suffix	string

Customer.Api.Features.Contacts.NameDTO

Nome	Caminho	Tipo
Primeiro Nome	firstName	string
LastName	lastName	string
MiddleName	middleName	string
SalutationId	salutationId	string
Sufixo	suffix	string

Customer.Api.Features.Contacts.Phone

Nome	Caminho	Tipo
Número de telefone	phoneNumber	string
Tipo	type	string
OptOut	optOut	boolean

Customer.Api.Features.Contacts.PhoneDTO

Nome	Caminho	Tipo
Número de telefone	phoneNumber	string
Tipo	type	string
OptOut	optOut	boolean

Customer.Api.Models.Address

Nome	Caminho	Tipo
Primeiro Nome	firstName	string
LastName	lastName	string
Número de telefone	phoneNumber	string
Email	email	string
Address1	address1	string
Address2	address2	string
City	city	string
Estado	state	string
Latitude	latitude	string
Longtitude	longtitude	string
País	country	string
Código Postal	postalCode	string
Código do País	countryCode	string

Compartilhar via

Softone Web CRM (versão prévia)

Conector do Softone Web CRM Power Automate

Publicador: Softone Technologies S.A.

Pré-requisitos

Como obter credenciais

Introdução ao conector

Erros e soluções comuns

Erro 1: Chave de API inválida

Erro 2: Não é possível se conectar

Erro 3: Permissões ausentes

Erro 4: Problemas de instalação do conector

Erro 5: Comportamento inesperado

Erro 6: Desempenho lento

perguntas frequentes

Como posso obter suporte se encontro problemas ou tenho dúvidas?

Quais são os principais benefícios do uso do Softone Web CRM?

Instruções de implantação

Criando uma conexão

Padrão

Limitações

Ações

Atualizar um cliente potencial por ID

Parâmetros

Retornos

Atualizar um contato existente

Parâmetros

Retornos

Atualizar um evento existente por ID

Parâmetros

Retornos

Atualizar uma anotação existente por ID

Parâmetros

Retornos

Atualizar uma chamada por ID

Parâmetros

Retornos

Atualizar uma conta existente

Parâmetros

Retornos

Atualizar uma oportunidade existente por ID

Parâmetros

Retornos

Atualizar uma tarefa existente por ID

Parâmetros

Retornos

Criar um novo cliente potencial

Parâmetros

Retornos

Criar um novo contato

Parâmetros

Retornos

Criar um novo evento

Parâmetros

Retornos

Criar uma nova anotação

Parâmetros

Retornos

Criar uma nova chamada

Parâmetros

Retornos

Criar uma nova conta

Parâmetros

Retornos

Criar uma nova oportunidade

Parâmetros

Retornos

Criar uma nova tarefa

Parâmetros

Retornos

Excluir um cliente potencial por ID

Parâmetros

Excluir um contato

Parâmetros

Excluir um evento por ID

Parâmetros

Excluir uma anotação por ID

Parâmetros

Excluir uma chamada por ID

Parâmetros