Softone Web CRM (Pré-visualização)

Aumente as vendas e fortaleça os relacionamentos com os clientes com o SOFTONE WEB CRM orientado por IA. Trabalhe de qualquer lugar com uma plataforma web e nativa da nuvem de 100%, automatize tarefas repetitivas e acelere processos para economizar tempo e esforço.

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

Serviço	Class	Regiões
Estúdio Copiloto	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Aplicações Power	Premium	Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Automatize o poder	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

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

Metadados do conector
Editora	Softone Tecnologias
Sítio Web	https://webcrm.softone.gr
Política de Privacidade	https://webcrm.softone.gr/privacy-policy
Categorias	Vendas e CRM

Conector Softone Web CRM Power Automate

Bem-vindo ao Softone Web CRM Power Automate Connector! Este conector integra perfeitamente o sistema ERP da sua empresa com as operações de CRM de vendas, capacitando-o para automatizar tarefas críticas e simplificar fluxos de trabalho.

Editora: Softone Technologies S.A.

Pré-requisitos

Uma assinatura válida do Softone Web CRM.

Como obter credenciais

Para aceder aos dados da sua empresa utilizando o conector Softone Web CRM, siga estes passos:

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

Introdução ao conector

Para começar a usar o Softone Web CRM Power Automate Connector, siga estes passos:

Instalação: instale o conector no seu ambiente Power Automatic.
Configuração: Digite sua chave de api para se conectar ao Softone Web CRM.
Uso: comece a automatizar tarefas e fluxos de trabalho sem problemas.

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 da API é inválida. Remédio: Verifique se você gerou uma chave de API válida em sua conta do Softone Web CRM. Certifique-se de que não há espaços à esquerda ou à direita na chave da API ao inseri-la na configuração do conector.

Erro 2: Não é possível conectar

Sintoma: Não é possível estabelecer uma conexão com o Softone Web CRM ao configurar o conector. Solução: verifique se você configurou corretamente o conector com a chave da 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. Solução: 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. Consulte 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 Power Automatic. Solução: Certifique-se de seguir as instruções de instalação fornecidas para o conector do Softone Web CRM cuidadosamente. Verifique o seu ambiente Power Automate para quaisquer restrições ou políticas que possam estar a afetar 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ê está encontrando erros inexplicáveis durante a execução do fluxo de trabalho. Solução: revise 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 um e-mail para support@shopranos.eu.

Erro 6: Desempenho lento

Sintoma: O conector ou fluxos de trabalho estão com desempenho lento. Solução: Verifique sua conexão de rede e certifique-se de que sua conta do Softone Web CRM não está enfrentando problemas de desempenho. Além disso, revise o design do fluxo de trabalho para otimizá-lo para 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 suas soluções correspondentes devem ajudar os usuários a solucionar e resolver problemas ao usar o Softone Web CRM Power Automate Connector. Se você encontrar quaisquer 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.

FAQ

Como posso obter suporte se tiver problemas ou 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 de usar o 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 CRM de vendas, melhorando o fluxo de dados e a eficiência operacional. Event-Driven Automação: responda a eventos críticos, como criação de tarefas ou leads. Dispare notificações instantâneas e automatize os processos de aprovação com facilidade. Integração do Microsoft Power Automatic: aproveite o poder do Microsoft Power Automate para desbloquear uma ampla gama de possibilidades de automação. Envie mensagens importantes, impulsione fluxos de trabalho de aprovação e simplifique processos complexos.

Instruções de implantação

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

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:


Predefinição	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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	100	60 segundos

Ações

Atualizar um contato existente	Atualiza os detalhes do contato especificado na empresa em questão. 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 esta ação para modificar detalhes de um evento existente, como título, descrição, participantes ou horário agendado. Somente os eventos acessíveis ao usuário atual podem ser atualizados.
Atualizar um lead por ID	Atualiza detalhes de um lead existente, como informações da empresa, detalhes de contato, status ou fonte. Somente leads acessíveis ao usuário podem ser atualizados.
Atualizar uma chamada por ID	Use esta ação para modificar detalhes de uma chamada existente, como assunto, participantes, hora agendada ou status. Somente as chamadas acessíveis ao usuário atual podem ser atualizadas.
Atualizar uma conta existente	Atualiza os detalhes da conta especificada na empresa em questão. 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 realizar a atualização.
Atualizar uma nota existente por ID	Use esta ação para modificar detalhes de uma nota existente, como conteúdo ou referências relacionadas. Apenas as notas acessíveis ao utilizador atual podem ser atualizadas.
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 esta ação para modificar detalhes de uma tarefa existente, como assunto, descrição, data de conclusão, prioridade ou usuário atribuído. Somente as tarefas acessíveis ao usuário atual podem ser atualizadas.
Criar um novo contacto	Cria um novo contato na empresa especificada. O usuário que faz a solicitação deve ter o relevante `x-permissions` para executar essa ação.
Criar um novo evento	Use esta ação para agendar ou registrar um novo evento. Forneça detalhes como título, descrição, participantes e data/hora agendada. O evento criado pode ser posteriormente atualizado, recuperado ou vinculado a outras atividades.
Criar um novo lead	Use esta ação para criar um novo lead, incluindo detalhes da empresa, informações de contato e fonte. O lead criado pode ser posteriormente enriquecido, pontuado, convertido ou atualizado.
Criar uma nova chamada	Use esta 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 faz 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 nota	Use esta ação para adicionar uma nota 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 oportunidade	Use esta ação para criar uma nova oportunidade no pipeline de vendas. Uma oportunidade normalmente representa um negócio potencial com uma conta, vinculada a um lead ou criada de forma independente.
Criar uma nova tarefa	Use esta 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.
Eliminar uma nota por ID	Remove permanentemente a nota especificada do sistema. Certifique-se de que a nota não está vinculada a outros processos antes da exclusão. Apenas as notas acessíveis ao utilizador atual podem ser eliminadas.
Excluir um contato	Exclui o contato especificado da empresa fornecida. 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. Certifique-se de que o evento não está vinculado a outros processos antes da exclusão. Somente os eventos acessíveis ao usuário atual podem ser excluídos.
Excluir um lead por ID	Exclui permanentemente um lead do sistema. Certifique-se de que o lead não é necessário para processamento adicional ou conversão antes da exclusão.
Excluir uma chamada por ID	Remove permanentemente a chamada especificada do sistema. Somente chamadas acessíveis ao usuário atual podem ser excluídas. Certifique-se de que a chamada não está vinculada a outros processos antes da exclusão.
Excluir uma conta	Exclui a conta especificada para a empresa em questão. 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. Certifique-se de que 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. Certifique-se de que a tarefa não está vinculada a outros processos antes da exclusão. Somente as tarefas acessíveis ao usuário atual podem ser excluídas.
Recuperar todas as chamadas	Lista todas as atividades de chamada acessíveis ao usuário atual. Você pode filtrar resultados usando critérios de pesquisa, como usuário atribuído, status ou intervalo de datas. Útil para relatórios, painéis ou automações que processam várias chamadas.
Recuperar todas as contas de uma empresa	Devolve uma lista de todas as contas pertencentes à empresa especificada. O usuário que faz a solicitação deve ter permissões apropriadas, definidas nos cabeçalhos da solicitação. Os filtros podem ser aplicados usando parâmetros de cadeia de caracteres de consulta.
Recuperar todas as notas 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, painéis ou automações que processam várias notas.
Recuperar todas as tarefas acessíveis ao usuário	Lista todas as tarefas acessíveis ao usuário atual. Você pode filtrar resultados usando critérios de pesquisa, como usuário atribuído, status ou intervalo de datas. Útil para relatórios, painéis ou automações que processam várias tarefas.
Recuperar todos os contatos de uma empresa	Retorna uma lista de todos os contatos pertencentes à empresa especificada. O usuário que faz 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 resultados usando critérios de pesquisa, como intervalo de datas, usuário atribuído ou status. Útil para relatórios, painéis ou automações que processam vários eventos.
Recuperar todos os leads com paginação	Lista todos os leads acessíveis ao usuário atual. Suporta paginação e filtragem através de parâmetros de consulta. Útil para painéis, relatórios ou integrações que exigem processamento em lote de leads.
Recuperar um contato por ID	Retorna detalhes para o contato especificado, fornecendo dados e informações específicos da empresa. O acesso é determinado pelo contexto da empresa fornecido no cabeçalho da `x-companyid` solicitação.
Recuperar um evento por ID	Retorna informações detalhadas para o evento especificado, incluindo título, participantes, hora agendada e status. Use esta ação para exibir ou fazer referência a um evento específico em sua automação.
Recuperar um lead por ID	Retorna informações detalhadas para o lead especificado, incluindo detalhes da empresa, informações de contato, fonte e status. Use esta ação para visualizar ou atualizar um lead específico.
Recuperar um usuário de backoffice por ID	Retorna detalhes completos do usuário especificado, incluindo informações de função dentro de uma determinada empresa. O acesso é determinado pelo contexto da empresa fornecido no cabeçalho da solicitaçã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 `x-companyid` solicitação.
Recuperar uma equipe por seu identificador exclusivo	Retorna detalhes completos da equipe especificada.
Recuperar uma nota por ID	Retorna informações detalhadas para a nota especificada, incluindo conteúdo, criador e entidade relacionada. Use esta ação para exibir ou fazer referência a uma nota específica em sua automação.
Recuperar uma oportunidade por ID	Retorna detalhes completos da oportunidade especificada, incluindo proprietário e 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, horário agendado e status. Use esta 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 esta ação para exibir ou fazer referência a uma tarefa específica em sua automação.
Recupere todas as oportunidades com paginação	Lista oportunidades acessíveis ao usuário, com base no escopo (Eu, Equipe ou Todos). Suporta filtragem, pesquisa e paginação. Útil para painéis, relatórios e integrações que exigem acesso em lote.

Atualizar um contato existente

ID da Operação:: Contact_Update

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de contato	contactId	True	string	O identificador exclusivo do contato a ser atualizado.
ID do proprietário	ownerId		string
AccountIds	accountIds		array of string
FonteId	sourceId		string
SourceOwnerId	sourceOwnerId		string
SourceAccountIds	sourceAccountIds		array of string
Primeiro nome	firstName		string
Apelido	lastName		string
MiddleName	middleName		string
SaudaçãoId	salutationId		string
Sufixo	suffix		string
Email	email		string
Telemóvel	phone		string
Telemóvel	mobilePhone		string
Fax	fax		string
CallOptOut	callOptOut		boolean
E-mailOptOut	emailOptOut		boolean
Endereço de e-mail	emailAddress		string
Tipo	type		string
Optar por não participar	optOut		boolean
Número de telefone	phoneNumber		string
Tipo	type		string
Optar por não participar	optOut		boolean
Título do Cargo	jobTitle		string
GenderId	genderId		string
Pronuncie-se	pronounceId		string
Endereço1	address1		string
Endereço2	address2		string
City	city		string
Estado	state		string
Latitude	latitude		string
Longevidade	longtitude		string
Country	country		string
Código de País	countryCode		string
Código Postal	postalCode		string
Primeiro nome	firstName		string
Apelido	lastName		string
Número de telefone	phoneNumber		string
Email	email		string
Criado Por	createdBy		string
Última modificação por	lastModifiedBy		string
Departamento	department		string
RelatóriosPara	reportsTo		string
Assistente	assistant		string
AssistenteTelefone	assistantPhone		string
Aniversário	birthday		date-time
Description	description		string
LastStayInTouchReportedDate	lastStayInTouchReportedDate		date-time
LastStayInTouchSaveDate	lastStayInTouchSaveDate		date-time
AccountSourceTypeId	accountSourceTypeId		string
Campos Extras	extraFields		object
Equipas Atribuídas	assignedTeams		array of string

Devoluções

Body: Customer.Api.Features.Contacts.ContactDTO

Atualizar um evento existente por ID

ID da Operação:: Event_Update

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

Parâmetros

Name	Chave	Necessá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 a Id	assignedToId		string
relacionados com o tipo	relatedToType		string
relacionados com Id	relatedToId		string
Tipo de contato	contactType		string
contato Ids	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 fim	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
repetir	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 a id	sourceAssignedToId		string
fonte relacionada com Id	sourceRelatedToId		string
Ids de contato de origem	sourceContactIds		array of string
Membros da equipa	teamMembers		array of string

Devoluções

Body: Task.Api.Features.Events.EventDTO

Atualizar um lead por ID

ID da Operação:: Lead_Update

Atualiza detalhes de um lead existente, como informações da empresa, detalhes de contato, status ou fonte. Somente leads acessíveis ao usuário podem ser atualizados.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	O identificador único do lead a atualizar.
Cargo	jobTitle		string
ID do status do lead	leadStatusId		string
Nome próprio	firstName	True	string
apelido	lastName		string
Nome do meio	middleName		string
saudação Id	salutationId		string
sufixo	suffix		string
e-mail	email		string
phone	phone		string
telemóvel	mobilePhone		string
Endereço de e-mail	emailAddress		string
tipo	type		string
optar por não participar	optOut		boolean
número de telefone	phoneNumber		string
tipo	type		string
optar por não participar	optOut		boolean
ligue para Opt out	callOptOut		boolean
e-mail Opt out	emailOptOut		boolean
ID da avaliaçã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
N.º de Empregados	noOfEmployees		integer
ID do tipo de origem da conta	accountSourceTypeId		string
Endereço1	address1		string
Endereço2	address2		string
city	city		string
state	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
sexo Id	genderId		string
Pronuncie Id	pronounceId		string
estado	status		string
última modificação por	lastModifiedBy		string
Campos extras	extraFields		object

Devoluções

Body: SalesPipeline.Api.Features.Lead.LeadDto

Atualizar uma chamada por ID

ID da Operação:: Call_Update

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	O identificador exclusivo da chamada para atualização.
Tipo de tarefa	taskType		string
Data de Vencimento	dueDate		date-time
Assunto	subject		string
atribuído ao tipo	assignedToType		string
atribuído a Id	assignedToId		string
relacionados com o tipo	relatedToType		string
relacionados com Id	relatedToId		string
Tipo de contato	contactType		string
contato Ids	contactIds		array of string
estado	status		string
Duração da chamada	callDuration		date-span
ID do resultado da chamada	callResultId		string
comentários	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
Data de classificação	sortDate		date-time
ID de origem	sourceId		string
origem atribuída a id	sourceAssignedToId		string
fonte relacionada com Id	sourceRelatedToId		string
Ids de contato de origem	sourceContactIds		array of string
Direção da chamada	callDirection		string

Devoluções

Body: Task.Api.Features.Calls.CallDTO

Atualizar uma conta existente

ID da Operação:: Account_Update

Atualiza os detalhes da conta especificada na empresa em questão.
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 realizar a atualização.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da conta	accountId	True	string	O identificador exclusivo da conta a ser atualizada.
Nome	name		string
Telemóvel	phone		string
Estanho	tin		string
Código	code		string
Email	email		string
FonteId	sourceId		string
SourceParentId	sourceParentId		string
SourceOwnerId	sourceOwnerId		string
PrimaryContactIds	primaryContactIds		array of string
ParentAccountId	parentAccountId		string
ID do proprietário	ownerId		string
Endereço1	address1		string
Endereço2	address2		string
City	city		string
Estado	state		string
Latitude	latitude		string
Longevidade	longtitude		string
Country	country		string
Código de País	countryCode		string
Código Postal	postalCode		string
Primeiro nome	firstName		string
Apelido	lastName		string
Número de telefone	phoneNumber		string
Email	email		string
AccountSourceTypeId	accountSourceTypeId		string
IndústriaId	industryId		string
TierId	tierId		string
Sítio Web	website		string
Descrição da Conta	accountDescription		string
NoOfFuncionários	noOfEmployees		integer
Receita Anual	annualRevenue		double
Criado Por	createdBy		string
Última modificação por	lastModifiedBy		string
Fax	fax		string
OwnershipId	ownershipId		string
RatingId	ratingId		string
ClassificationId	classificationId		string
Campos Extras	extraFields		object
Equipas Atribuídas	assignedTeams		array of string

Devoluções

Body: Customer.Api.Features.Accounts.AccountDTO

Atualizar uma nota existente por ID

ID da Operação:: Note_Update

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	O identificador exclusivo da nota a atualizar.
relacionados com o tipo	relatedToType		string
relacionados com Id	relatedToId		string
Assunto	subject		string
body	body		string
corpo do editor	editorBody		string
última modificação por	lastModifiedBy		string
contato Ids	contactIds		array of string
Tipo de contato	contactType		string

Devoluções

Body: Task.Api.Features.Notes.NoteDTO

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

Name	Chave	Necessário	Tipo	Description
id	id	True	string	O identificador exclusivo da oportunidade de atualização.
digite Id	typeId		string
ID do proprietário	ownerId		string
ID da conta	accountId		string
nome	name		string
Montante	amount		double
previsão Categoria Id	forecastCategoryId		string
Data de encerramento	closeDate		date-time
probabilidade	probability		integer
classificação	score		integer
descrição	description		string
ID do pipeline de vendas	salesPipelineId		string
citação Id	quoteId		string
ID do Status da Oportunidade	opportunityStatusId		string
estado	status		string
ID do tipo de origem da conta	accountSourceTypeId		string
próximo passo	nextStep		string
orçamento confirmado	budgetConfirmed		boolean
descoberta concluída	discoveryCompleted		boolean
Receitas esperadas	expectedRevenue		double
perda Razão Id	lossReasonId		string
privado	private		boolean
última modificação por	lastModifiedBy		string
Campos extras	extraFields		object

Devoluções

Body: SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Atualizar uma tarefa existente por ID

ID da Operação:: Task_Update

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

Parâmetros

Name	Chave	Necessá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 Vencimento	dueDate		date-time
Data de conclusão	completedDate		date-time
estado	status		string
ID de prioridade	priorityId		string
atribuído a Id	assignedToId		string
atribuído ao tipo	assignedToType		string
contato Ids	contactIds		array of string
Tipo de contato	contactType		string
relacionados com Id	relatedToId		string
relacionados com o tipo	relatedToType		string
tarefa Sub Type Id	taskSubTypeId		string
comentários	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

Devoluções

Body: Task.Api.Features.Tasks.TaskDTO

Criar um novo contacto

ID da Operação:: Contact_Create

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

Parâmetros

Name	Chave	Tipo
Id	id	string
Identificação da empresa	companyId	string
ID do proprietário	ownerId	string
AccountIds	accountIds	array of string
FonteId	sourceId	string
SourceOwnerId	sourceOwnerId	string
SourceAccountIds	sourceAccountIds	array of string
Primeiro nome	firstName	string
Apelido	lastName	string
MiddleName	middleName	string
SaudaçãoId	salutationId	string
Sufixo	suffix	string
Email	email	string
Telemóvel	phone	string
Telemóvel	mobilePhone	string
Fax	fax	string
CallOptOut	callOptOut	boolean
E-mailOptOut	emailOptOut	boolean
Endereço de e-mail	emailAddress	string
Tipo	type	string
Optar por não participar	optOut	boolean
Número de telefone	phoneNumber	string
Tipo	type	string
Optar por não participar	optOut	boolean
Título do Cargo	jobTitle	string
GenderId	genderId	string
Pronuncie-se	pronounceId	string
Endereço1	address1	string
Endereço2	address2	string
City	city	string
Estado	state	string
Latitude	latitude	string
Longevidade	longtitude	string
Country	country	string
Código de País	countryCode	string
Código Postal	postalCode	string
Primeiro nome	firstName	string
Apelido	lastName	string
Número de telefone	phoneNumber	string
Email	email	string
InserirData	insertDate	date-time
UpdateDate	updateDate	date-time
Criado Por	createdBy	string
Última modificação por	lastModifiedBy	string
Departamento	department	string
RelatóriosPara	reportsTo	string
Assistente	assistant	string
AssistenteTelefone	assistantPhone	string
Aniversário	birthday	date-time
Description	description	string
LastStayInTouchReportedDate	lastStayInTouchReportedDate	date-time
LastStayInTouchSaveDate	lastStayInTouchSaveDate	date-time
AccountSourceTypeId	accountSourceTypeId	string
Nome Completo	fullName	string
Campos Extras	extraFields	object
Equipas Atribuídas	assignedTeams	array of string

Devoluções

Body: Customer.Api.Features.Contacts.ContactDTO

Criar um novo evento

ID da Operação:: Event_Create

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

Parâmetros

Name	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 a Id	assignedToId	string
relacionados com o tipo	relatedToType	string
relacionados com Id	relatedToId	string
Tipo de contato	contactType	string
contato Ids	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 fim	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
repetir	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 a id	sourceAssignedToId	string
fonte relacionada com Id	sourceRelatedToId	string
Ids de contato de origem	sourceContactIds	array of string
Membros da equipa	teamMembers	array of string

Devoluções

Body: Task.Api.Features.Events.EventDTO

Criar um novo lead

ID da Operação:: Lead_Create

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

Parâmetros

Name	Chave	Necessário	Tipo
Cargo	jobTitle		string
ID do status do lead	leadStatusId		string
Nome próprio	firstName	True	string
apelido	lastName		string
Nome do meio	middleName		string
saudação Id	salutationId		string
sufixo	suffix		string
e-mail	email		string
phone	phone		string
telemóvel	mobilePhone		string
Endereço de e-mail	emailAddress		string
tipo	type		string
optar por não participar	optOut		boolean
número de telefone	phoneNumber		string
tipo	type		string
optar por não participar	optOut		boolean
ligue para Opt out	callOptOut		boolean
e-mail Opt out	emailOptOut		boolean
ID da avaliaçã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
N.º de Empregados	noOfEmployees		integer
ID do tipo de origem da conta	accountSourceTypeId		string
Endereço1	address1		string
Endereço2	address2		string
city	city		string
state	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
sexo Id	genderId		string
Pronuncie Id	pronounceId		string
estado	status		string
Campos extras	extraFields		object

Devoluções

Body: SalesPipeline.Api.Features.Lead.LeadDto

Criar uma nova chamada

ID da Operação:: Call_Create

Use esta 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

Name	Chave	Tipo
Data de Vencimento	dueDate	date-time
Assunto	subject	string
atribuído ao tipo	assignedToType	string
atribuído a Id	assignedToId	string
relacionados com o tipo	relatedToType	string
relacionados com Id	relatedToId	string
Tipo de contato	contactType	string
contato Ids	contactIds	array of string
estado	status	string
Duração da chamada	callDuration	date-span
ID do resultado da chamada	callResultId	string
comentários	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
Data de classificação	sortDate	date-time
ID de origem	sourceId	string
origem atribuída a id	sourceAssignedToId	string
fonte relacionada com Id	sourceRelatedToId	string
Ids de contato de origem	sourceContactIds	array of string
Direção da chamada	callDirection	string

Devoluções

Body: 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 faz 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

Name	Chave	Necessário	Tipo
Id	id		string
Identificação da empresa	companyId		string
Nome	name	True	string
Código	code		string
Estanho	tin		string
Email	email		string
Telemóvel	phone		string
FonteId	sourceId		string
SourceParentId	sourceParentId		string
SourceOwnerId	sourceOwnerId		string
PrimaryContactIds	primaryContactIds		array of string
ParentAccountId	parentAccountId		string
ID do proprietário	ownerId		string
Endereço1	address1		string
Endereço2	address2		string
City	city		string
Estado	state		string
Latitude	latitude		string
Longevidade	longtitude		string
Country	country		string
Código de País	countryCode		string
Código Postal	postalCode		string
Primeiro nome	firstName		string
Apelido	lastName		string
Número de telefone	phoneNumber		string
Email	email		string
UpdateDate	updateDate		date-time
InserirData	insertDate		date-time
Repartição de Finanças	taxOffice		string
AccountSourceTypeId	accountSourceTypeId		string
IndústriaId	industryId		string
TierId	tierId		string
Sítio Web	website		string
Descrição da Conta	accountDescription		string
NoOfFuncionários	noOfEmployees		integer
Receita Anual	annualRevenue		double
Criado Por	createdBy		string
Última modificação por	lastModifiedBy		string
Fax	fax		string
OwnershipId	ownershipId		string
RatingId	ratingId		string
ClassificationId	classificationId		string
Campos Extras	extraFields		object
Equipas Atribuídas	assignedTeams		array of string
AiScore	aiScore		double
AiScoreRaciocínio	aiScoreReasoning		string
AiSentiment	aiSentiment		integer
AiGenerationDate	aiGenerationDate		date-time

Devoluções

Body: Customer.Api.Features.Accounts.AccountDTO

Criar uma nova nota

ID da Operação:: Note_Create

Use esta ação para adicionar uma nota 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

Name	Chave	Necessário	Tipo
Tipo de tarefa	taskType		string
relacionados com o tipo	relatedToType		string
Tipo de contato	contactType		string
relacionados com Id	relatedToId		string
Assunto	subject	True	string
body	body		string
corpo do editor	editorBody		string
contato Ids	contactIds		array of string

Devoluções

Body: Task.Api.Features.Notes.NoteDTO

Criar uma nova oportunidade

ID da Operação:: Opportunity_Create

Use esta ação para criar uma nova oportunidade no pipeline de vendas.
Uma oportunidade normalmente representa um negócio potencial com uma conta, vinculada a um lead ou criada de forma independente.

Parâmetros

Name	Chave	Necessário	Tipo
digite Id	typeId		string
ID do proprietário	ownerId		string
ID da conta	accountId		string
nome	name	True	string
Montante	amount		double
previsão Categoria Id	forecastCategoryId		string
ID do pipeline de vendas	salesPipelineId		string
Data de encerramento	closeDate	True	date-time
probabilidade	probability		integer
classificação	score		integer
descrição	description		string
citação Id	quoteId		string
ID do Status da Oportunidade	opportunityStatusId		string
estado	status		string
ID do tipo de origem da conta	accountSourceTypeId		string
próximo passo	nextStep		string
orçamento confirmado	budgetConfirmed		boolean
descoberta concluída	discoveryCompleted		boolean
Receitas esperadas	expectedRevenue		double
perda Razão Id	lossReasonId		string
privado	private		boolean
Campos extras	extraFields		object

Devoluções

Body: SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Criar uma nova tarefa

ID da Operação:: Task_Create

Use esta 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

Name	Chave	Tipo
Tipo de tarefa	taskType	string
Assunto	subject	string
Data de Vencimento	dueDate	date-time
estado	status	string
ID de prioridade	priorityId	string
atribuído a Id	assignedToId	string
atribuído ao tipo	assignedToType	string
contato Ids	contactIds	array of string
Tipo de contato	contactType	string
relacionados com Id	relatedToId	string
relacionados com o tipo	relatedToType	string
tarefa Sub Type Id	taskSubTypeId	string
comentários	comments	string
corpo do editor	editorBody	string
conjunto de lembretes	reminderSet	boolean
posição	position	integer
ID pai	parentId	string

Devoluções

Body: Task.Api.Features.Tasks.TaskDTO

Eliminar uma nota por ID

ID da Operação:: Note_Delete

Remove permanentemente a nota especificada do sistema.
Certifique-se de que a nota não está vinculada a outros processos antes da exclusão.
Apenas as notas acessíveis ao utilizador atual podem ser eliminadas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	O identificador exclusivo da nota a ser excluída.

Excluir um contato

ID da Operação:: Contact_Delete

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

Parâmetros

Name	Chave	Necessá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.
Certifique-se de que o evento não está vinculado a outros processos antes da exclusão.
Somente os eventos acessíveis ao usuário atual podem ser excluídos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	O identificador exclusivo do evento a ser excluído.

Excluir um lead por ID

ID da Operação:: Lead_Delete

Exclui permanentemente um lead do sistema. Certifique-se de que o lead não é necessário para processamento adicional ou conversão antes da exclusão.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	O identificador único do lead a eliminar.

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.
Certifique-se de que a chamada não está vinculada a outros processos antes da exclusão.

Parâmetros

Name	Chave	Necessá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 em questão.
A solicitação deve incluir permissões válidas x-companyid e apropriadas para prosseguir.

Parâmetros

Name	Chave	Necessá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.
Certifique-se de que a oportunidade não é mais necessária antes da exclusão, pois a ação não pode ser desfeita.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	O identificador exclusivo da oportunidade de exclusão.

Excluir uma tarefa por ID

ID da Operação:: Task_Delete

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	O identificador exclusivo da tarefa a ser excluída.

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 resultados usando critérios de pesquisa, como usuário atribuído, status ou intervalo de datas.
Útil para relatórios, painéis ou automações que processam várias chamadas.

Parâmetros

Name	Chave	Tipo	Description
Id	Id	string	Identificador exclusivo usado para filtrar e pesquisar tarefas específicas.
Situação	Status	string	Estado da tarefa
ID de prioridade	PriorityId	string	Representa o identificador da prioridade associada a uma tarefa, permitindo 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.
modificado pela última vez por	LastModifiedBy	string	Especifica o identificador ou nome do último usuário que modificou a tarefa. Esta propriedade é utilizada para filtrar e pesquisar tarefas com base no usuário modificador.
Data Para Conclusão	DueDate	date-time	Representa a data em que a tarefa deve ser concluída ou até a qual ação é necessária. Usado como um filtro para pesquisar ou consultar tarefas com base em sua data de conclusão.
Data de classificação	SortDate	string	Representa a data ou datas que podem ser usadas para classificar tarefas. Esta propriedade permite a filtragem de tarefas com base em datas de classificação especificadas.
Atribuído a Id	AssignedToId	string	Representa os identificadores dos usuários ou entidades aos quais a tarefa ou chamada é atribuída.
Relacionados com 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 de chamada associado.
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 de página atual para resultados paginados. Esse valor é usado para determinar o ponto inicial 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.
Ordenar	Sort	string	Representa os critérios de classificação para os resultados da pesquisa. Esta propriedade define a ordem de classificação e os campos para o conjunto de dados.

Devoluções

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

Recuperar todas as contas de uma empresa

ID da Operação:: Account_GetAll

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

Parâmetros

Name	Chave	Tipo	Description
Conta de Encarregado de Educação	ParentAccount	string	Define a ParentAccount associada à pesquisa atual.
Telemóvel	Phone	string	Define o número de telefone associado à pesquisa atual.
Suggestions	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 da avaliação	RatingId	string	Define o RatingId associado à pesquisa atual. Usado para filtrar contas com base em seu identificador de classificação.
ID de classificação	ClassificationId	string	Define o ClassificationId usado para filtrar contas com base em sua classificação.
Id da Indústria	IndustryId	string	Define o IndustryId associado à pesquisa atual.
ID do tipo de origem da conta	AccountSourceTypeId	string	Define o AccountSourceTypeId associado à pesquisa atual.
ID de contato principal	PrimaryContactId	string	Representa o identificador do contato principal associado à pesquisa de conta.
Equipas 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 usado 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 de página atual para resultados de pesquisa paginados.
Tamanho da página	PageSize	integer	Especifica o número de itens a serem exibidos por página nos resultados de pesquisa paginados.
Ordenar	Sort	string	Representa o parâmetro sort para ordenar os 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.

Devoluções

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

Recuperar todas as notas 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, painéis ou automações que processam várias notas.

Parâmetros

Name	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 realizar uma pesquisa entre anotações.
Relacionados com Id	RelatedToId	string	Obtém ou define o identificador relacionado a uma entidade específica para filtrar notas.
relacionados com o 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 nota.
modificado pela última vez por	LastModifiedBy	string	Obtém ou define o identificador do usuário que modificou a nota pela última vez.
Página	Page	integer	Define o número de página atual para resultados paginados. Esse valor é usado para determinar o ponto inicial 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.
Ordenar	Sort	string	Representa os critérios de classificação para os resultados da pesquisa. Esta propriedade define a ordem de classificação e os campos para o conjunto de dados.

Devoluções

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

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 resultados usando critérios de pesquisa, como usuário atribuído, status ou intervalo de datas.
Útil para relatórios, painéis ou automações que processam várias tarefas.

Parâmetros

Name	Chave	Tipo	Description
Id	Id	string	Define o identificador exclusivo da tarefa.
Situação	Status	string	Define o status da tarefa, representando seu estágio atual, como Aberto 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.
Relacionados com Id	RelatedToId	string	Define o identificador da entidade à qual a tarefa está relacionada.
ID de prioridade	PriorityId	string	Define o identificador para tarefas de filtragem por sua prioridade.
Tipo de tarefa	Type	string	Define o tipo da tarefa, indicando sua finalidade ou categoria.
Data Para Conclusão	DueDate	date-time	Define a data de conclusão da tarefa. Esta propriedade é usada para filtrar tarefas com base em sua 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 principal	ParentId	string	Define o identificador da tarefa pai associada à tarefa atual.
modificado pela última vez por	LastModifiedBy	string	Define o identificador do 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 a 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 de página atual para resultados paginados. Esse valor é usado para determinar o ponto inicial 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.
Ordenar	Sort	string	Representa os critérios de classificação para os resultados da pesquisa. Esta propriedade define a ordem de classificação e os campos para o conjunto de dados.

Devoluções

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

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 faz 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

Name	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 o(s) OwnerId(s) usado(s) para filtrar os resultados da pesquisa de contatos.
Suggestions	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 o ID do Tipo de Origem da Conta a ser usado como filtro na consulta de pesquisa.
Nome Próprio	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.
Telemóvel	Phone	string	Define o número de telefone do contato a ser usado como um filtro no processo de pesquisa.
Telemóvel	MobilePhone	string	Define o número de telemóvel a utilizar como filtro no processo de pesquisa de contactos.
IDs da conta	AccountIds	string	Define os IDs de conta a serem usados como um filtro no processo de pesquisa.
Email	Email	string	Especifica o endereço de e-mail do contato a ser usado como 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.
Equipas Atribuídas	AssignedTeams	string	Especifica a lista de identificadores de equipe atribuídos ao contato, usados 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 de página atual para resultados de pesquisa paginados.
Tamanho da página	PageSize	integer	Especifica o número de itens a serem exibidos por página nos resultados de pesquisa paginados.
Ordenar	Sort	string	Representa o parâmetro sort para ordenar os 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.

Devoluções

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 resultados usando critérios de pesquisa, como intervalo de datas, usuário atribuído ou status.
Útil para relatórios, painéis ou automações que processam vários eventos.

Parâmetros

Name	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 a 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
Relacionados com Id	RelatedToId	string	Define o identificador da entidade à qual o evento está relacionado. A configuração dessa 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 principal	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. A atribuição de um valor a essa propriedade aplica automaticamente o filtro correspondente.
ID de prioridade	PriorityId	string	Define o identificador de prioridade associado ao evento. A definição dessa 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.
modificado pela última vez por	LastModifiedBy	string	Define o identificador do usuário que modificou o evento pela última vez. A configuração dessa propriedade adicionará um filtro com base no identificador do usuário modificado pela última vez.
Criado por	CreatedBy	string	Define o identificador de usuário da entidade que criou o evento. A definição dessa propriedade adicionará automaticamente um filtro correspondente para eventos criados pelo usuário especificado.
Página	Page	integer	Define o número de página atual para resultados paginados. Esse valor é usado para determinar o ponto inicial 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.
Ordenar	Sort	string	Representa os critérios de classificação para os resultados da pesquisa. Esta propriedade define a ordem de classificação e os campos para o conjunto de dados.

Devoluções

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

Recuperar todos os leads com paginação

ID da Operação:: Lead_GetAll

Lista todos os leads acessíveis ao usuário atual. Suporta paginação e filtragem através de parâmetros de consulta.
Útil para painéis, relatórios ou integrações que exigem processamento em lote de leads.

Parâmetros

Name	Chave	Tipo	Description
Id	Id	string	Define a lista de IDs de leads usados como 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.
Nome Próprio	FirstName	string	Define o primeiro nome do lead, usado como critério de filtro em consultas de pesquisa.
Apelido	LastName	string	Define o sobrenome do lead, usado como critério de filtro na consulta de pesquisa.
Inserir data	InsertDate	string	Define a lista de Inserir Datas usada como critério de filtro na consulta de pesquisa.
Telemóvel	Phone	string	Define o número de telefone associado ao lead. Esta propriedade é usada como um critério de filtro na consulta de pesquisa.
Telemóvel	MobilePhone	string	Define o número de telefone celular de um lead, usado como critério de filtro em consultas de pesquisa.
Email	Email	string	Define o endereço de e-mail do lead usado como critério de filtro na consulta de pesquisa.
ID do proprietário	OwnerId	string	Representa a lista de IDs de proprietário usada como critério de filtro na consulta de pesquisa.
Tipo de proprietário	OwnerType	string	Especifica o tipo de proprietário para o lead, como um indivíduo ou uma fila. Esta 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 critério de filtro na consulta de pesquisa.
Lead Status Id	LeadStatusId	string	Filtra leads com base no ID de status de lead associado.
Id da Indústria	IndustryId	string	Define a ID do setor usada como critério de filtro na consulta de pesquisa.
Situação	Status	string	Representa o filtro de status usado em consultas de pesquisa de leads. Esse filtro permite especificar o status de leads, como "Padrão", "Qualificado" ou "Não qualificado".
Pesquisa	Search	string	Define a palavra-chave de pesquisa usada como critério de filtro na consulta de pesquisa.
Página	Page	integer	Define o número de 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.
Ordenar	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 resultados. Vários critérios podem ser combinados usando um separador de vírgula.

Devoluções

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

Recuperar um contato por ID

ID da Operação:: Contact_GetById

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de contato	contactId	True	string	O identificador exclusivo do contato a ser recuperado.

Devoluções

Body: 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 esta ação para exibir ou fazer referência a um evento específico em sua automação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	O identificador exclusivo do evento.

Devoluções

Body: Task.Api.Features.Events.EventDTO

Recuperar um lead por ID

ID da Operação:: Lead_GetById

Retorna informações detalhadas para o lead especificado, incluindo detalhes da empresa, informações de contato, fonte e status. Use esta ação para visualizar ou atualizar um lead específico.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	O identificador exclusivo do lead.

Devoluções

Body: SalesPipeline.Api.Features.Lead.LeadDto

Recuperar um usuário de backoffice por ID

ID da Operação:: User_GetById

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do usuário	userId	True	string	O identificador exclusivo do usuário de backoffice a ser recuperado.

Devoluções

Body: Identity.Api.BackOfficeUsers.GetUser.GetUserResponse

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 x-companyid solicitação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da conta	accountId	True	string	O identificador exclusivo da conta a ser recuperada.

Devoluções

Body: 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

Name	Chave	Necessário	Tipo	Description
id	id	True	string	O identificador único da equipa.

Devoluções

Body: Identity.Api.Teams.Dtos.GetTeamResponse

Recuperar uma nota por ID

ID da Operação:: Note_GetById

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	O identificador exclusivo da nota.

Devoluções

Body: Task.Api.Features.Notes.NoteDTO

Recuperar uma oportunidade por ID

ID da Operação:: Opportunity_GetById

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	O identificador único da oportunidade.

Devoluções

Body: 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, horário agendado e status.
Use esta ação para exibir ou fazer referência a uma chamada específica em sua automação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	O identificador exclusivo da tarefa de chamada.

Devoluções

Body: 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 esta ação para exibir ou fazer referência a uma tarefa específica em sua automação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	O identificador exclusivo da tarefa.

Devoluções

Body: Task.Api.Features.Tasks.TaskDTO

Recupere 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).
Suporta filtragem, pesquisa e paginação.
Útil para painéis, relatórios e integrações que exigem acesso em lote.

Parâmetros

Name	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.
Montante	Amount	double	Define a receita esperada ou o valor monetário para o filtro de pesquisa de oportunidades.
Data de Fecho	CloseDate	string	Representa o filtro de pesquisa de data de fechamento para oportunidades. Esta propriedade permite filtrar oportunidades com base em suas datas de fechamento.
Data de atualização	UpdateDate	date-time	Define a data da última atualização para o filtro de pesquisa de oportunidades.
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 para o 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 fonte de conta em uma pesquisa de oportunidade.
ID do status da oportunidade	OpportunityStatusId	string	Especifica os identificadores dos status de oportunidade para filtrar a pesquisa de oportunidades.
Id da citaçã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 pelo qual uma oportunidade foi perdida.
Id do tipo	TypeId	string	Representa o identificador de tipo usado para filtrar oportunidades em uma consulta de pesquisa.
modificado pela última vez 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 realizar uma pesquisa geral em registros de oportunidade.
ID do Pipeline de Vendas	SalesPipelineId	string	Define o identificador para o filtro de pipeline de vendas em pesquisas de oportunidade.
Situação	Status	string	Especifica os status das oportunidades para o filtro de pesquisa.
Página	Page	integer	Define o número de 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.
Ordenar	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 resultados. Vários critérios podem ser combinados usando um separador de vírgula.

Devoluções

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

Acionadores

Gatilho atualizado da 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 atualizado da tarefa	Use esta ação para modificar detalhes de uma tarefa existente, como assunto, descrição, data de conclusão, prioridade ou usuário atribuído. Somente as tarefas acessíveis ao usuário atual podem ser atualizadas.
Gatilho atualizado do evento	Use esta ação para modificar detalhes de um evento existente, como título, descrição, participantes ou horário agendado. Somente os eventos acessíveis ao usuário atual podem ser atualizados.
Gatilho atualizado do lead	Atualiza detalhes de um lead existente, como informações da empresa, detalhes de contato, status ou fonte. Somente leads acessíveis ao usuário podem ser atualizados.
Gatilho criado pela chamada	Use esta 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 pela oportunidade	Use esta ação para criar uma nova oportunidade no pipeline de vendas. Uma oportunidade normalmente representa um negócio potencial com uma conta, vinculada a um lead ou criada de forma independente.
Gatilho criado por evento	Use esta ação para agendar ou registrar um novo evento. Forneça detalhes como título, descrição, participantes e data/hora agendada. O evento criado pode ser posteriormente atualizado, recuperado ou vinculado a outras atividades.
Gatilho criado por lead	Use esta ação para criar um novo lead, incluindo detalhes da empresa, informações de contato e fonte. O lead criado pode ser posteriormente enriquecido, pontuado, convertido ou atualizado.
Gatilho criado por tarefa	Use esta 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 de chamada atualizado	Use esta ação para modificar detalhes de uma chamada existente, como assunto, participantes, hora agendada ou status. Somente as chamadas acessíveis ao usuário atual podem ser atualizadas.
Gatilho de chamada excluída	Remove permanentemente a chamada especificada do sistema. Somente chamadas acessíveis ao usuário atual podem ser excluídas. Certifique-se de que a chamada não está vinculada a outros processos antes da exclusão.
Gatilho de chumbo excluído	Exclui permanentemente um lead do sistema. Certifique-se de que o lead não é necessário para processamento adicional ou conversão antes da exclusão.
Gatilho de Tarefa Excluída	Remove permanentemente a tarefa especificada do sistema. Certifique-se de que a tarefa não está vinculada a outros processos antes da exclusão. Somente as tarefas acessíveis ao usuário atual podem ser excluídas.
Gatilho excluído de evento	Remove permanentemente o evento especificado do sistema. Certifique-se de que o evento não está vinculado a outros processos antes da exclusão. Somente os eventos acessíveis ao usuário atual podem ser excluídos.
Gatilho excluído de oportunidade	Remove permanentemente uma oportunidade do sistema. Certifique-se de que a oportunidade não é mais necessária antes da exclusão, pois a ação não pode ser desfeita.

Gatilho atualizado da 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

Name	Chave	Necessário	Tipo	Description
Title	Title	True	string	Um título para o registro do webhook

Devoluções

Body: SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Gatilho atualizado da tarefa

ID da Operação:: Task_Updated

Parâmetros

Name	Chave	Necessário	Tipo	Description
Title	Title	True	string	Um título para o registro do webhook

Devoluções

Body: Task.Api.Features.Tasks.TaskDTO

Gatilho atualizado do evento

ID da Operação:: Event_Updated

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Title	Title	True	string	Um título para o registro do webhook

Devoluções

Body: Task.Api.Features.Events.EventDTO

Gatilho atualizado do lead

ID da Operação:: Lead_Updated

Atualiza detalhes de um lead existente, como informações da empresa, detalhes de contato, status ou fonte. Somente leads acessíveis ao usuário podem ser atualizados.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Title	Title	True	string	Um título para o registro do webhook

Devoluções

Body: SalesPipeline.Api.Features.Lead.LeadDto

Gatilho criado pela chamada

ID da Operação:: Call_Created

Use esta 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

Name	Chave	Necessário	Tipo	Description
Title	Title	True	string	Um título para o registro do webhook

Devoluções

Body: Task.Api.Features.Calls.CallDTO

Gatilho criado pela oportunidade

ID da Operação:: Opportunity_Created

Parâmetros

Name	Chave	Necessário	Tipo	Description
Title	Title	True	string	Um título para o registro do webhook

Devoluções

Body: SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Gatilho criado por evento

ID da Operação:: Event_Created

Parâmetros

Name	Chave	Necessário	Tipo	Description
Title	Title	True	string	Um título para o registro do webhook

Devoluções

Body: Task.Api.Features.Events.EventDTO

Gatilho criado por lead

ID da Operação:: Lead_Created

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Title	Title	True	string	Um título para o registro do webhook

Devoluções

Body: SalesPipeline.Api.Features.Lead.LeadDto

Gatilho criado por tarefa

ID da Operação:: Task_Created

Parâmetros

Name	Chave	Necessário	Tipo	Description
Title	Title	True	string	Um título para o registro do webhook

Devoluções

Body: Task.Api.Features.Tasks.TaskDTO

Gatilho de chamada atualizado

ID da Operação:: Call_Updated

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Title	Title	True	string	Um título para o registro do webhook

Devoluções

Body: Task.Api.Features.Calls.CallDTO

Gatilho de chamada excluída

ID da Operação:: Call_Deleted

Parâmetros

Name	Chave	Necessário	Tipo	Description
Title	Title	True	string	Um título para o registro do webhook

Devoluções

Body: Task.Api.Features.Calls.CallDTO

Gatilho de chumbo excluído

ID da Operação:: Lead_Deleted

Exclui permanentemente um lead do sistema. Certifique-se de que o lead não é necessário para processamento adicional ou conversão antes da exclusão.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Title	Title	True	string	Um título para o registro do webhook

Devoluções

Body: SalesPipeline.Api.Features.Lead.LeadDto

Gatilho de Tarefa Excluída

ID da Operação:: Task_Deleted

Parâmetros

Name	Chave	Necessário	Tipo	Description
Title	Title	True	string	Um título para o registro do webhook

Devoluções

Body: Task.Api.Features.Tasks.TaskDTO

Gatilho excluído de evento

ID da Operação:: Event_Deleted

Parâmetros

Name	Chave	Necessário	Tipo	Description
Title	Title	True	string	Um título para o registro do webhook

Devoluções

Body: Task.Api.Features.Events.EventDTO

Gatilho excluído de oportunidade

ID da Operação:: Opportunity_Deleted

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Title	Title	True	string	Um título para o registro do webhook

Devoluções

Body: SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Definições

Task.Api.Features.Calls.CallDTO

Name	Caminho	Tipo
id	id	string
companyId	companyId	string
inserirData	insertDate	date-time
updateDate	updateDate	date-time
Tipo de tarefa	taskType	Task.Api.Models.Enums.TaskType
data de vencimento	dueDate	date-time
Assunto	subject	string
atribuído ao tipo	assignedToType	Task.Api.Models.Enums.AssignedToType
atribuídoToId	assignedToId	string
relacionados com o tipo	relatedToType	Task.Api.Models.Enums.RelatedToType
relacionadoToId	relatedToId	string
Tipo de contato	contactType	Task.Api.Models.Enums.ContactType
contactIds	contactIds	array of string
estado	status	Task.Api.Models.Enums.Status
callDuration	callDuration	date-span
callResultId	callResultId	string
comentários	comments	string
editorBody	editorBody	string
priorityId	priorityId	string
última modificação por	lastModifiedBy	string
criado por	createdBy	string
posição	position	integer
parentId	parentId	string
reminderSet	reminderSet	boolean
sortDate	sortDate	date-time
fonteId	sourceId	string
sourceAssignedToId	sourceAssignedToId	string
fonteRelatedToId	sourceRelatedToId	string
sourceContactIds	sourceContactIds	array of string
Direção da chamada	callDirection	Task.Api.Models.Enums.CallDirection

Task.Api.Features.Events.EventDTO

Name	Caminho	Tipo
id	id	string
companyId	companyId	string
inserirData	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
atribuídoToId	assignedToId	string
relacionados com o tipo	relatedToType	Task.Api.Models.Enums.RelatedToType
relacionadoToId	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
localização	location	Task.Api.Features.Events.LocationDTO
startDate	startDate	date-time
data de término	endDate	date-time
reminderSet	reminderSet	boolean
criado por	createdBy	string
última modificação por	lastModifiedBy	string
posição	position	integer
parentId	parentId	string
repetir	repeat	string
Status do evento	eventStatus	Task.Api.Models.Enums.EventStatus
eventResultId	eventResultId	string
Intervalo de recorrência	recurrenceInterval	string
fonteId	sourceId	string
sourceAssignedToId	sourceAssignedToId	string
fonteRelatedToId	sourceRelatedToId	string
sourceContactIds	sourceContactIds	array of string
Membros da equipa	teamMembers	array of string

Task.Api.Features.Events.LocationDTO

Name	Caminho	Tipo	Description
longitude	longitude	string
latitude	latitude	string

Task.Api.Features.Notes.NotaDTO

Name	Caminho	Tipo
id	id	string
companyId	companyId	string
relacionados com o tipo	relatedToType	Task.Api.Models.Enums.RelatedToType
relacionadoToId	relatedToId	string
Assunto	subject	string
criado por	createdBy	string
última modificação por	lastModifiedBy	string
body	body	string
editorBody	editorBody	string
inserirData	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

Name	Caminho	Tipo
id	id	string
companyId	companyId	string
inserirData	insertDate	date-time
updateDate	updateDate	date-time
criado por	createdBy	string
última modificação por	lastModifiedBy	string
Tipo de tarefa	taskType	Task.Api.Models.Enums.TaskType
Assunto	subject	string
data de vencimento	dueDate	date-time
completedDate	completedDate	date-time
estado	status	Task.Api.Models.Enums.Status
priorityId	priorityId	string
atribuídoToId	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
relacionadoToId	relatedToId	string
relacionados com o tipo	relatedToType	Task.Api.Models.Enums.RelatedToType
taskSubTypeId	taskSubTypeId	string
comentários	comments	string
editorBody	editorBody	string
reminderSet	reminderSet	boolean
posição	position	integer
parentId	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

relacionados com o tipo: string

Task.Api.Models.Enums.Status

estado: string

Task.Api.Models.Enums.TaskType

Tipo de tarefa: string

SalesPipeline.Api.DTOs.AddressDto

Name	Caminho	Tipo
Endereço1	address1	string
Endereço2	address2	string
city	city	string
state	state	string
country	country	string
Código Postal	postalCode	string

SalesPipeline.Api.DTOs.EmailDTO

Name	Caminho	Tipo
Endereço de e-mail	emailAddress	string
tipo	type	SalesPipeline.Api.Models.Enums.EmailType
optar por não participar	optOut	boolean

SalesPipeline.Api.DTOs.NameDTO

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

SalesPipeline.Api.DTOs.PhoneDTO

Name	Caminho	Tipo
número de telefone	phoneNumber	string
tipo	type	SalesPipeline.Api.Models.Enums.PhoneType
optar por não participar	optOut	boolean

SalesPipeline.Api.Features.Lead.LeadDto

Name	Caminho	Tipo
id	id	string
companyId	companyId	string
título do trabalho	jobTitle	string
leadStatusId	leadStatusId	string
nome	name	SalesPipeline.Api.DTOs.NameDTO
e-mail	email	string
phone	phone	string
telemóvel	mobilePhone	string
outroE-mail	otherEmail	array of SalesPipeline.Api.DTOs.EmailDTO
outroTelefone	otherPhone	array of SalesPipeline.Api.DTOs.PhoneDTO
callOptOut	callOptOut	boolean
emailOptOut	emailOptOut	boolean
ratingId	ratingId	string
inserirData	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
indústriaId	industryId	string
noDeFuncionários	noOfEmployees	integer
accountSourceTypeId	accountSourceTypeId	string
address	address	SalesPipeline.Api.DTOs.AddressDto
descrição	description	string
criado por	createdBy	string
última modificação por	lastModifiedBy	string
receita anual	annualRevenue	double
lastTransferDate	lastTransferDate	date-time
genderId	genderId	string
pronounceId	pronounceId	string
Nome completo	fullName	string
estado	status	SalesPipeline.Api.Models.Enums.Status
extraCampos	extraFields	object
aiScore	aiScore	double
aiScoreRaciocínio	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

Name	Caminho	Tipo
id	id	string
companyId	companyId	string
accountId	accountId	string
typeId	typeId	string
ownerId	ownerId	string
nome	name	string
Montante	amount	double
forecastCategoryId	forecastCategoryId	string
salesPipelineId	salesPipelineId	string
inserirData	insertDate	date-time
updateDate	updateDate	date-time
fecharData	closeDate	date-time
probabilidade	probability	integer
classificação	score	integer
descrição	description	string
quoteId	quoteId	string
opportunityStatusId	opportunityStatusId	string
estado	status	SalesPipeline.Api.Models.Enums.OpportunityStatus
accountSourceTypeId	accountSourceTypeId	string
PróximoPasso	nextStep	string
orçamentoConfirmado	budgetConfirmed	boolean
descobertaConcluída	discoveryCompleted	boolean
Receita esperada	expectedRevenue	double
perdaReasonId	lossReasonId	string
privado	private	boolean
criado por	createdBy	string
última modificação por	lastModifiedBy	string
extraCampos	extraFields	object
aiScore	aiScore	double
aiScoreRaciocínio	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

estado: string

SalesPipeline.Api.Models.Enums.OwnerType

Tipo de proprietário: string

SalesPipeline.Api.Models.Enums.PhoneType

tipo: string

SalesPipeline.Api.Models.Enums.Status

estado: string

Identity.Api.BackOfficeUsers.GetUser.GetUserResponse

Name	Caminho	Tipo	Description
id	id	string	O identificador do utilizador
e-mail	email	string	O e-mail do usuário.
primeiroNome	firstName	string	O nome do usuário.
sobrenome	lastName	string	O sobrenome do usuário
Nome completo	fullName	string	O nome completo do usuário
userRole	userRole	Identity.Api.BackOfficeUsers.GetUser.GetUserResponse_Role
perfilImagem	profileImage	Identity.Api.BackOfficeUsers.GetUser.GetUserResponse_Image
últimoLogin	lastLogin	date-time	A data do último login dos usuários. Pode ser nulo se o usuário nunca tiver feito login
inserirData	insertDate	date-time	A data de criação do usuário
updateDate	updateDate	date-time	A data da última atualização do usuário.

Identity.Api.BackOfficeUsers.GetUser.GetUserResponse_Image

Name	Caminho	Tipo	Description
id	id	string
galeriaId	galleryId	string	O id armazenado na galeria
Alt	alt	string	O alt para mostrar
ligação	link	string	O url da imagem

Identity.Api.BackOfficeUsers.GetUser.GetUserResponse_Role

Name	Caminho	Tipo	Description
companyId	companyId	string	O ID da empresa para a função, este será sempre o ID da empresa para o qual solicitou os utilizadores.
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 for administrador, o ID da função estará ausente.

Identity.Api.Teams.Dtos.GetTeamResponse

Name	Caminho	Tipo
id	id	string
nome	name	string
users	users	array of Identity.Api.Teams.Dtos.TeamUserDto
modificadoPor	modifiedBy	string
criado por	createdBy	string
criadosAt	createdAt	date-time
modificado em	modifiedAt	date-time

Identidade.Api.Teams.Dtos.TeamUserDto

Name	Caminho	Tipo	Description
id	id	string

Customer.Api.DTOs.AddressDTO

Name	Caminho	Tipo
Endereço1	address1	string
Endereço2	address2	string
City	city	string
Estado	state	string
Latitude	latitude	string
Longevidade	longtitude	string
Country	country	string
Código de País	countryCode	string
Código Postal	postalCode	string
Primeiro nome	firstName	string
Apelido	lastName	string
Número de telefone	phoneNumber	string
Email	email	string

Customer.Api.Features.Accounts.AccountDTO

Name	Caminho	Tipo
Id	id	string
Identificação da empresa	companyId	string
Nome	name	string
Código	code	string
Estanho	tin	string
Email	email	string
Telemóvel	phone	string
FonteId	sourceId	string
SourceParentId	sourceParentId	string
SourceOwnerId	sourceOwnerId	string
PrimaryContactIds	primaryContactIds	array of string
ParentAccountId	parentAccountId	string
ID do proprietário	ownerId	string
address	address	Customer.Api.DTOs.AddressDTO
UpdateDate	updateDate	date-time
InserirData	insertDate	date-time
Repartição de Finanças	taxOffice	string
AccountSourceTypeId	accountSourceTypeId	string
IndústriaId	industryId	string
TierId	tierId	string
Sítio Web	website	string
Descrição da Conta	accountDescription	string
NoOfFuncionários	noOfEmployees	integer
Receita Anual	annualRevenue	double
Criado Por	createdBy	string
Última modificação por	lastModifiedBy	string
Fax	fax	string
OwnershipId	ownershipId	string
RatingId	ratingId	string
ClassificationId	classificationId	string
Campos Extras	extraFields	object
Equipas Atribuídas	assignedTeams	array of string
AiScore	aiScore	double
AiScoreRaciocínio	aiScoreReasoning	string
AiSentiment	aiSentiment	integer
AiGenerationDate	aiGenerationDate	date-time

Customer.Api.Features.Contacts.Contact

Name	Caminho	Tipo
Id	id	string
Identificação da empresa	companyId	string
PartitionKey	partitionKey	string
ID do proprietário	ownerId	string
AccountIds	accountIds	array of string
FonteId	sourceId	string
SourceAccountIds	sourceAccountIds	array of string
SourceOwnerId	sourceOwnerId	string
nome	name	Customer.Api.Features.Contacts.Name
Email	email	string
Telemóvel	phone	string
Telemóvel	mobilePhone	string
Fax	fax	string
CallOptOut	callOptOut	boolean
E-mailOptOut	emailOptOut	boolean
OutroE-mail	otherEmail	array of Customer.Api.Features.Contacts.Email
OutroTelefone	otherPhone	array of Customer.Api.Features.Contacts.Phone
Título do Cargo	jobTitle	string
GenderId	genderId	string
Pronuncie-se	pronounceId	string
address	address	Customer.Api.Models.Address
InserirData	insertDate	date-time
UpdateDate	updateDate	date-time
Criado Por	createdBy	string
Última modificação por	lastModifiedBy	string
Departamento	department	string
RelatóriosPara	reportsTo	string
Assistente	assistant	string
AssistenteTelefone	assistantPhone	string
Aniversário	birthday	date-time
Description	description	string
LastStayInTouchReportedDate	lastStayInTouchReportedDate	date-time
LastStayInTouchSaveDate	lastStayInTouchSaveDate	date-time
AccountSourceTypeId	accountSourceTypeId	string
Campos Extras	extraFields	object
SearchTags	searchTags	array of string
Equipas Atribuídas	assignedTeams	array of string

Customer.Api.Features.Contacts.ContactDTO

Name	Caminho	Tipo
Id	id	string
Identificação da empresa	companyId	string
ID do proprietário	ownerId	string
AccountIds	accountIds	array of string
FonteId	sourceId	string
SourceOwnerId	sourceOwnerId	string
SourceAccountIds	sourceAccountIds	array of string
nome	name	Customer.Api.Features.Contacts.NameDTO
Email	email	string
Telemóvel	phone	string
Telemóvel	mobilePhone	string
Fax	fax	string
CallOptOut	callOptOut	boolean
E-mailOptOut	emailOptOut	boolean
OutroE-mail	otherEmail	array of Customer.Api.Features.Contacts.EmailDTO
OutroTelefone	otherPhone	array of Customer.Api.Features.Contacts.PhoneDTO
Título do Cargo	jobTitle	string
GenderId	genderId	string
Pronuncie-se	pronounceId	string
address	address	Customer.Api.DTOs.AddressDTO
InserirData	insertDate	date-time
UpdateDate	updateDate	date-time
Criado Por	createdBy	string
Última modificação por	lastModifiedBy	string
Departamento	department	string
RelatóriosPara	reportsTo	string
Assistente	assistant	string
AssistenteTelefone	assistantPhone	string
Aniversário	birthday	date-time
Description	description	string
LastStayInTouchReportedDate	lastStayInTouchReportedDate	date-time
LastStayInTouchSaveDate	lastStayInTouchSaveDate	date-time
AccountSourceTypeId	accountSourceTypeId	string
Nome Completo	fullName	string
Campos Extras	extraFields	object
Equipas Atribuídas	assignedTeams	array of string

Customer.Api.Features.Contacts.Email

Name	Caminho	Tipo
Endereço de e-mail	emailAddress	string
Tipo	type	string
Optar por não participar	optOut	boolean

Customer.Api.Features.Contacts.EmailDTO

Name	Caminho	Tipo
Endereço de e-mail	emailAddress	string
Tipo	type	string
Optar por não participar	optOut	boolean

Customer.Api.Features.Contacts.Name

Name	Caminho	Tipo
Primeiro nome	firstName	string
Apelido	lastName	string
MiddleName	middleName	string
SaudaçãoId	salutationId	string
Sufixo	suffix	string

Customer.Api.Features.Contacts.NameDTO

Name	Caminho	Tipo
Primeiro nome	firstName	string
Apelido	lastName	string
MiddleName	middleName	string
SaudaçãoId	salutationId	string
Sufixo	suffix	string

Customer.Api.Features.Contacts.Phone

Name	Caminho	Tipo
Número de telefone	phoneNumber	string
Tipo	type	string
Optar por não participar	optOut	boolean

Customer.Api.Features.Contacts.PhoneDTO

Name	Caminho	Tipo
Número de telefone	phoneNumber	string
Tipo	type	string
Optar por não participar	optOut	boolean

Customer.Api.Models.Address

Name	Caminho	Tipo
Primeiro nome	firstName	string
Apelido	lastName	string
Número de telefone	phoneNumber	string
Email	email	string
Endereço1	address1	string
Endereço2	address2	string
City	city	string
Estado	state	string
Latitude	latitude	string
Longevidade	longtitude	string
Country	country	string
Código Postal	postalCode	string
Código de País	countryCode	string

Partilhar via

Softone Web CRM (Pré-visualização)

Conector Softone Web CRM Power Automate

Editora: 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 conectar

Erro 3: Permissões ausentes

Erro 4: Problemas de instalação do conector

Erro 5: Comportamento inesperado

Erro 6: Desempenho lento

FAQ

Como posso obter suporte se tiver problemas ou dúvidas?

Quais são os principais benefícios de usar o Softone Web CRM?

Instruções de implantação

A criar uma ligação

Padrão

Limites de Limitação

Ações

Atualizar um contato existente

Parâmetros

Devoluções

Atualizar um evento existente por ID

Parâmetros

Devoluções

Atualizar um lead por ID

Parâmetros

Devoluções

Atualizar uma chamada por ID

Parâmetros

Devoluções

Atualizar uma conta existente

Parâmetros

Devoluções

Atualizar uma nota existente por ID

Parâmetros

Devoluções

Atualizar uma oportunidade existente por ID

Parâmetros

Devoluções

Atualizar uma tarefa existente por ID

Parâmetros

Devoluções

Criar um novo contacto

Parâmetros

Devoluções

Criar um novo evento

Parâmetros

Devoluções

Criar um novo lead

Parâmetros

Devoluções

Criar uma nova chamada

Parâmetros

Devoluções

Criar uma nova conta

Parâmetros

Devoluções

Criar uma nova nota

Parâmetros

Devoluções

Criar uma nova oportunidade

Parâmetros

Devoluções

Criar uma nova tarefa

Parâmetros

Devoluções

Eliminar uma nota por ID

Parâmetros

Excluir um contato

Parâmetros

Excluir um evento por ID

Parâmetros

Excluir um lead por ID

Parâmetros

Excluir uma chamada por ID

Parâmetros