Interação (versão prévia)
LexisNexis InterAction+ é uma solução abrangente de CRM (Gerenciamento de Relacionamento com o Cliente) projetada especificamente para escritórios de advocacia. Aproveite esse conector para integrar aplicativos de terceiros ao InterAction+ para automatizar seu trabalho, simplificar tarefas e fortalecer as relações do cliente.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Interação |
| URL | https://www.lexisnexis.com/en-us/products/interaction/default.page |
| support@interaction.com |
| Metadados do conector | |
|---|---|
| Publicador | LexisNexis Legal e Profissional |
| Site | https://www.lexisnexis.com/en-us/products/interaction/default.page |
| Política de privacidade | https://www.lexisnexis.com/en-us/terms/privacy-policy.page |
| Categorias | Marketing |
InterAção+
LexisNexis InterAction+ é uma solução abrangente de CRM (Gerenciamento de Relacionamento com o Cliente) projetada especificamente para escritórios de advocacia. Aproveite esse conector para integrar aplicativos de terceiros ao InterAction+ para automatizar seu trabalho, simplificar tarefas e fortalecer as relações do cliente.
Publicador: LexisNexis
Pré-requisitos
Você precisará do seguinte para continuar:
- Um plano do Microsoft PowerAutomate/Flow.
- Uma conta com InterAction+ com acesso de Administrador.
- URL do aplicativo InterAction+ (por exemplo,
https://example.apps.interaction.comou https://us.apps.interaction.com/example) e Região (EUA, UA ou UE). Para saber mais sobre o InterAction+ e nossos serviços, entre em contato conosco em support@interaction.com.
Operações com suporte
O conector dá suporte às seguintes operações:
-
Get Lists:Get All Lists from InterAction+ que inclui workingList, marketingList e marketingListWithSponsorship. -
Get List By Id:Obter um detalhe de lista por ID de lista no InterAction+. -
Get List By Name:Get a List detail by List Name in InterAction+. -
Get Additional Field Definitions And Values:Obter definições de campo adicionais e valores de lista de Interação+. -
Add or Update Additional field values for Contact:Add or Update Additional field values for Contact in Interaction+. -
Get Contact By Id:Get a Contact Details by Id in InterAction+. -
Create Person Contact:Criar contato de pessoa no InterAction+. -
Update Person Contact:Atualize um contato de pessoa pública no InterAction+. -
Search Person Contact:Pesquisar contato de pessoa com base no nome, sobrenome e filtro de endereço de email no InterAction+. -
Add Contacts to Lists:Adicionar um ou mais contatos a uma ou mais listas no InterAction+. Para mais de um contato ou listas, alterne o modo de entrada. -
Remove Contacts from List:Remover contatos da lista no InterAction+. -
Create Activity:Criar atividade no InterAction+. -
Update Activity:Editar ou atualizar o valor do campo Atividade para Contato na Interação+. -
Get List Contact Membership Changes:Essa ação recupera contatos que foram adicionados ou removidos de listas especificadas dentro de um determinado intervalo de datas. Ele foi projetado para capturar alterações delta na lista de contatos, ajudando os usuários a monitorar atualizações, sincronizar dados ou disparar processos downstream com base em modificações. -
Get Created or Removed Lists:Esta ação recupera listas que foram criadas ou removidas no InterAction+ dentro de um determinado intervalo de datas. Ele foi projetado para capturar alterações delta para listas, ajudando os usuários a monitorar atualizações, sincronizar dados ou disparar processos downstream com base em modificações. -
Get Created or Removed Contacts:Essa ação recupera contatos que foram criados ou removidos no InterAction+ em um determinado intervalo de datas. Ele foi projetado para capturar alterações delta para contatos, ajudando os usuários a monitorar atualizações, sincronizar dados ou disparar processos downstream com base em modificações. -
Get Updated Contacts:Esta ação recupera contatos que foram atualizados no InterAction+ em um determinado intervalo de datas. Ele foi projetado para capturar alterações delta para contatos, ajudando os usuários a monitorar atualizações, sincronizar dados ou disparar processos downstream com base em modificações.
Obtendo credenciais
Solicitar acesso entrando em contato com o Suporte do InterAction+ (support@interaction.com)
Erros e soluções comuns
Aqui estão alguns problemas que você pode enfrentar ao usar o conector:
-
Error 400: aparece quando você faz uma solicitação incorreta, significa que você insere os parâmetros incorretamente. -
Error 401: aparece quando você não está autorizado a acessar as informações solicitadas. -
Error 429: erro de muitas solicitações que informa ao aplicativo cliente para parar de enviar solicitações porque eles simplesmente não têm recursos suficientes para aceitá-lo no momento.
Support
Para obter mais suporte, entre em contato support@interaction.com
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| URL do Aplicativo | cadeia | URL do aplicativo InterAction+ (por exemplo) https://us.apps.interaction.com/tpcqa | Verdade |
| Região | cadeia | Selecione a região | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Adicionar contatos a listas |
Adicione um ou mais contatos a uma ou mais listas no InterAction+. Para mais de um contato ou listas, alterne o modo de entrada. |
| Adicionar ou atualizar valores de campo adicionais para contato |
Adicionar ou atualizar valores de campo adicionais para contato no InterAction+. |
| Atividade de atualização |
Edite ou atualize o valor do campo Atividade para Contato na Interação+. |
| Atualizar Contato de Pessoa |
Atualize um contato de pessoa no InterAction+. |
| Criar Atividade |
Criar atividade no InterAction+. |
| Criar contato de pessoa |
Criar contato de pessoa no InterAction+. |
| Obter alterações de associação de contato de lista |
Essa ação recupera contatos que foram adicionados ou removidos de listas especificadas dentro de um determinado intervalo de datas. Ele foi projetado para capturar alterações delta na lista de contatos, ajudando os usuários a monitorar atualizações, sincronizar dados ou disparar processos downstream com base em modificações. |
| Obter contato por Id |
Obter contato por Id junto com valores de campo adicionais em InterAction+. |
| Obter contatos atualizados |
Essa ação recupera contatos que foram atualizados no InterAction+ em um determinado intervalo de datas. Ele foi projetado para capturar alterações delta para contatos, ajudando os usuários a monitorar atualizações, sincronizar dados ou disparar processos downstream com base em modificações. |
| Obter contatos criados ou removidos |
Essa ação recupera contatos que foram criados ou removidos no InterAction+ dentro de um determinado intervalo de datas. Ele foi projetado para capturar alterações delta para contatos, ajudando os usuários a monitorar atualizações, sincronizar dados ou disparar processos downstream com base em modificações. |
| Obter definições e valores de campo adicionais |
Obtenha definições de campo adicionais e valores de lista de InterAction+. |
| Obter Lista por ID |
Obter Lista por ID no InterAction+. |
| Obter Lista por Nome |
Obter lista por nome em InterAction+. |
| Obter listas |
Obtenha listas do InterAction+ que inclui workingList, marketingList e marketingListWithSponsorship. |
| Obter listas criadas ou removidas |
Essa ação recupera listas que foram criadas ou removidas no InterAction+ dentro de um determinado intervalo de datas. Ele foi projetado para capturar alterações delta para listas, ajudando os usuários a monitorar atualizações, sincronizar dados ou disparar processos downstream com base em modificações. |
| Pesquisar Contato de Pessoa |
Pesquisar contato de pessoa com base no nome, sobrenome e endereço de email. |
| Remover contatos da lista |
Remover contatos da lista no InterAction+. |
Adicionar contatos a listas
Adicione um ou mais contatos a uma ou mais listas no InterAction+. Para mais de um contato ou listas, alterne o modo de entrada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IDs de lista
|
listIds | True | array of string |
ID da lista para adicionar contato |
|
IDs de contato
|
contactIds | True | array of string |
ID de contato para adicionar à lista |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
totalCount
|
data.addContactsToLists.totalCount | integer |
totalCount |
|
successCount
|
data.addContactsToLists.successCount | integer |
successCount |
|
resultText
|
data.addContactsToLists.resultText | string |
resultText |
Adicionar ou atualizar valores de campo adicionais para contato
Adicionar ou atualizar valores de campo adicionais para contato no InterAction+.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de contato
|
contactId | True | string |
ID de contato a ser atualizada. |
|
ID do campo
|
fieldId | True | string |
ID do campo adicional. |
|
Value
|
value | True | string |
Valor do campo adicional. |
|
ID do valor
|
valueId | string |
A ID do valor é necessária apenas para atualizar o valor existente. No caso de um novo valor, deixe esse campo vazio. |
|
|
Data da Última Edição
|
lastEditDate | string |
A data da última edição é necessária apenas para atualizar o valor existente. No caso de um novo valor, deixe esse campo vazio. |
|
|
Tipo de dados de campo
|
fieldDataType | True | string |
Tipo de dados de campo adicional. Os tipos de dados permitidos são inteiros, texto, booliano, decimal, usuário, data e lista. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
models
|
data.updateListContactAdditionalFields.models | array of object |
models |
|
razão da falha
|
data.updateListContactAdditionalFields.models.failureReason | string |
razão da falha |
|
fieldId
|
data.updateListContactAdditionalFields.models.fieldId | string |
fieldId |
|
isSuccessful
|
data.updateListContactAdditionalFields.models.isSuccessful | boolean |
isSuccessful |
|
valueId
|
data.updateListContactAdditionalFields.models.valueId | string |
valueId |
|
__typename
|
data.updateListContactAdditionalFields.models.__typename | string |
__typename |
|
__typename
|
data.updateListContactAdditionalFields.__typename | string |
__typename |
Atividade de atualização
Edite ou atualize o valor do campo Atividade para Contato na Interação+.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da atividade
|
activityId | True | string |
ID da atividade, ela aceita o tipo de formato GUID 00000000-0000-0000-0000-000000000000000000. |
|
Tipo de atividade
|
typeId | True | string |
Tipo de atividade para atividade de atualização. |
|
Data da atividade
|
activityDate | string |
A data da atividade no formato de cadeia de caracteres. Ele aceita o formato datetime no YYYY-MM-DD HH:mm:ss. |
|
|
Assunto
|
subject | string |
Assunto da atividade. |
|
|
Resumo
|
summary | string |
Resumo da atividade. |
|
|
IDs de entidade vinculada
|
linkedEntityIds | True | array of string |
ID de contato que representa as entidades vinculadas à atividade. Ele aceita o formato GUID 00000000-0000-0000-0000-0000000000000000000. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
validationErrors
|
data.updateActivity.validationErrors | array of |
validationErrors |
|
id
|
data.updateActivity.item.id | string |
id |
|
tipo
|
data.updateActivity.item.type | string |
tipo |
|
ID do tipo
|
data.updateActivity.item.typeId | string |
ID do tipo |
|
activityClass
|
data.updateActivity.item.activityClass | string |
activityClass |
|
typeGroup
|
data.updateActivity.item.typeGroup | string |
typeGroup |
|
activityStartDate
|
data.updateActivity.item.activityStartDate | string |
activityStartDate |
|
lastEditedDate
|
data.updateActivity.item.lastEditedDate | string |
lastEditedDate |
|
assunto
|
data.updateActivity.item.subject | string |
assunto |
|
resumo
|
data.updateActivity.item.summary | string |
resumo |
|
local
|
data.updateActivity.item.location | string |
local |
|
sobre
|
data.updateActivity.item.regarding | string |
sobre |
Atualizar Contato de Pessoa
Atualize um contato de pessoa no InterAction+.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de contato
|
id | True | string |
Contate a ID da pessoa. |
|
Title
|
title | string |
Título (Sr., Sra., Dr., etc.). |
|
|
Primeiro Nome
|
firstName | string |
Nome próprio. |
|
|
Nome do Meio
|
middleName | string |
Nome do meio. |
|
|
Apelido
|
lastName | True | string |
Sobrenome da pessoa. |
|
GoesBy
|
goesBy | string |
Nome Comum. |
|
|
Cargo
|
jobTitle | string |
Cargo. |
|
|
Rua
|
street | string |
Rua. |
|
|
City
|
city | string |
Cidade. |
|
|
Divisão Administrativa/Estado/Região/Distrito/Província
|
administrativeDivision | string |
Divisão Administrativa/Estado/Região/Distrito/Província. |
|
|
País
|
country | string |
Para atualizar o País, o campo Cidade também é necessário. |
|
|
Código postal
|
postalCode | string |
O Código Postal do endereço comercial se o seu país não usar o código postal, deixe-o em branco. |
|
|
Endereço de Email
|
electronicAddress | string |
Endereço de email comercial. |
|
|
Telefone direto/primário
|
number | string |
Telefone direto/primário. |
|
|
Nome da Empresa
|
companyName | string |
Nome da Empresa. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
data.updatePublicPerson.item.id | string |
id |
|
status
|
data.updatePublicPerson.status | string |
status |
|
validationErrors
|
data.updatePublicPerson.validationErrors | array of |
validationErrors |
Criar Atividade
Criar atividade no InterAction+.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de atividade
|
typeId | True | string |
Tipo de atividade para nova atividade. |
|
Data da atividade
|
activityDate | True | string |
A data da atividade no formato de cadeia de caracteres. Ele aceita o formato datetime no YYYY-MM-DD HH:mm:ss. |
|
Assunto
|
subject | True | string |
Assunto da atividade. |
|
Resumo
|
summary | string |
Resumo da atividade. |
|
|
IDs de entidade vinculada
|
linkedEntityIds | True | array of string |
ID de contato que representa as entidades vinculadas à atividade. Ele aceita o formato GUID 00000000-0000-0000-0000-0000000000000000000. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
data.addActivity.id | string |
id |
Criar contato de pessoa
Criar contato de pessoa no InterAction+.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Primeiro Nome
|
firstName | string |
Nome próprio. |
|
|
Nome do Meio
|
middleName | string |
Nome do meio. |
|
|
Apelido
|
lastName | True | string |
Apelido. |
|
GoesBy
|
goesBy | string |
Nome Comum. |
|
|
Title
|
title | string |
Título (Sr., Sra., Dr., etc.). |
|
|
Endereço de Email
|
emailAddress | string |
Endereço de email comercial. |
|
|
Nome da Empresa
|
companyName | string |
Nome da Empresa. |
|
|
Cargo
|
jobTitle | string |
Cargo. |
|
|
Telefone direto/primário
|
primaryPhone | string |
Telefone direto/primário. |
|
|
País
|
country | string |
O país do endereço comercial. |
|
|
Rua
|
street | string |
A Rua do endereço comercial. |
|
|
City
|
city | string |
A cidade do endereço comercial. |
|
|
Divisão Administrativa/Estado/Região/Distrito/Província
|
administrativeDivision | string |
Divisão Administrativa/Estado/Região/Distrito/Província. |
|
|
Código postal
|
postalCode | string |
O Código Postal do endereço comercial se o seu país não usar o código postal, deixe-o em branco. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
status
|
data.addPerson.status | string |
status |
|
id
|
data.addPerson.item.id | string |
id |
|
primeiro nome
|
data.addPerson.item.firstName | string |
primeiro nome |
|
sobrenome
|
data.addPerson.item.lastName | string |
sobrenome |
|
goesBy
|
data.addPerson.item.goesBy | string |
goesBy |
|
currentJobTitle
|
data.addPerson.item.currentJobTitle | string |
currentJobTitle |
|
phoneNumbers
|
data.addPerson.item.phoneNumbers | array of object |
phoneNumbers |
|
id
|
data.addPerson.item.phoneNumbers.id | string |
id |
|
número
|
data.addPerson.item.phoneNumbers.number | string |
número |
|
etiqueta
|
data.addPerson.item.phoneNumbers.label | string |
etiqueta |
|
tipo
|
data.addPerson.item.phoneNumbers.type | string |
tipo |
|
uso
|
data.addPerson.item.phoneNumbers.usage | string |
uso |
|
endereços de e-mail
|
data.addPerson.item.emailAddresses | array of object |
endereços de e-mail |
|
id
|
data.addPerson.item.emailAddresses.id | string |
id |
|
tipo
|
data.addPerson.item.emailAddresses.type | string |
tipo |
|
uso
|
data.addPerson.item.emailAddresses.usage | string |
uso |
|
address
|
data.addPerson.item.emailAddresses.address | string |
address |
|
etiqueta
|
data.addPerson.item.emailAddresses.label | string |
etiqueta |
|
validationErrors
|
data.addPerson.validationErrors | array of |
validationErrors |
Obter alterações de associação de contato de lista
Essa ação recupera contatos que foram adicionados ou removidos de listas especificadas dentro de um determinado intervalo de datas. Ele foi projetado para capturar alterações delta na lista de contatos, ajudando os usuários a monitorar atualizações, sincronizar dados ou disparar processos downstream com base em modificações.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipos de evento
|
eventTypes | True | array of string |
Tipo de evento |
|
Data de Início
|
start | date-time |
Especifica a data de início do intervalo de datas, incluindo informações de fuso horário. A data de início tem o padrão de 90 dias atrás, se não for fornecido. Quando a data de início não é fornecida, o deslocamento da data de início é determinado a partir da data de término, se especificado, caso contrário, o padrão é UTC (deslocamento zero). Formato de data YYYY-MM-DDTHH:mm:ssZ. |
|
|
Data de Término
|
end | date-time |
Especifica a data de término do intervalo de datas, incluindo informações de fuso horário. Formato de data YYYY-MM-DDTHH:mm:ssZ. |
|
|
IDs de lista
|
listIds | True | array of string |
Recupere eventos de adição ou remoção de contato para as IDs de Lista especificadas. |
|
Ignorar
|
skip | integer |
O índice inicial para paginação. Padrão = 0 |
|
|
Limit
|
limit | integer |
O número máximo de itens a serem recuperados. Padrão = 100 |
|
|
Campo classificar
|
field | True | string |
Especifica o campo a ser usado para classificar eventos. |
|
Direção da Ordenação
|
direction | string |
Especifica a direção de classificação (crescente ou decrescente). Padrão = Crescente |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Total de modelos
|
data.listEventViews.totalModels | integer |
O número total de itens encontrados. |
|
models
|
data.listEventViews.models | array of object |
Representa os eventos ocorridos em uma lista. |
|
Tipo de Evento
|
data.listEventViews.models.eventType | string |
O tipo de evento que ocorreu na lista. |
|
EventDate
|
data.listEventViews.models.eventDate | string |
A data e hora em que o evento ocorreu. |
|
ListId
|
data.listEventViews.models.listId | string |
A ID da lista em que esse evento ocorreu. |
|
Identificação do contato
|
data.listEventViews.models.contactId | string |
A ID do contato que foi adicionado ou removido da lista. |
|
Identificação do contato
|
data.listEventViews.models.contact.contactId | string |
A ID do contato. |
|
DisplayName
|
data.listEventViews.models.contact.displayName | string |
O nome de exibição do contato. |
|
ContactEntity
|
data.listEventViews.models.contact.contactEntity | string |
O tipo de entidade do contato. |
|
Title
|
data.listEventViews.models.contact.title | string |
O título do contato. |
|
Primeiro Nome
|
data.listEventViews.models.contact.firstName | string |
O nome do contato. |
|
MiddleName
|
data.listEventViews.models.contact.middleName | string |
O nome do meio do contato. |
|
LastName
|
data.listEventViews.models.contact.lastName | string |
O sobrenome do contato. |
|
GoesBy
|
data.listEventViews.models.contact.goesBy | string |
O nome ou apelido preferencial do contato. |
|
CurrentJobTitle
|
data.listEventViews.models.contact.currentJobTitle | string |
O cargo atual do contato. |
|
Nome da Empresa
|
data.listEventViews.models.contact.currentEmployer.companyName | string |
O nome da empresa. |
|
CompanyId
|
data.listEventViews.models.contact.currentEmployer.companyId | string |
A ID da empresa. |
|
endereços
|
data.listEventViews.models.contact.addresses | array of object |
Recupera os endereços associados ao contato. |
|
AddressId
|
data.listEventViews.models.contact.addresses.addressID | string |
A ID do endereço. |
|
Rua
|
data.listEventViews.models.contact.addresses.street | string |
O nome da rua do endereço. |
|
City
|
data.listEventViews.models.contact.addresses.city | string |
A cidade do endereço (cidade, cidade, vila, etc.). |
|
AdministrativeDivision
|
data.listEventViews.models.contact.addresses.administrativeDivision | string |
A divisão administrativa do endereço. Isso representa um estado, província, província, departamento ou divisão regional semelhante, dependendo do país. Esse campo pode não ser aplicável a todos os países. |
|
País
|
data.listEventViews.models.contact.addresses.country | string |
O país do endereço. |
|
Código Postal
|
data.listEventViews.models.contact.addresses.postalCode | string |
O CEP ou o código postal do endereço. Esse campo pode não ser aplicável a todos os países. |
|
Tipo
|
data.listEventViews.models.contact.addresses.type | string |
O tipo do endereço. |
|
Usage
|
data.listEventViews.models.contact.addresses.usage | string |
O tipo de uso do endereço (AlternateBusiness, AlternateHome etc.). |
|
Visibilidade
|
data.listEventViews.models.contact.visibility | string |
As configurações de visibilidade do contato. |
|
endereços de e-mail
|
data.listEventViews.models.contact.emailAddresses | array of object |
Recupera os endereços de email associados ao contato. |
|
EmailId
|
data.listEventViews.models.contact.emailAddresses.emailId | string |
A ID do endereço de email. |
|
Tipo
|
data.listEventViews.models.contact.emailAddresses.type | string |
O tipo do endereço de email (Email, FTPSite, Site). |
|
Usage
|
data.listEventViews.models.contact.emailAddresses.usage | string |
O tipo de uso do endereço de email (AlternateBusiness, AlternateHome etc.). |
|
Endereço de Email
|
data.listEventViews.models.contact.emailAddresses.address | string |
O endereço de email. |
|
Etiqueta
|
data.listEventViews.models.contact.emailAddresses.label | string |
O rótulo do endereço de email. |
|
OwningContactId
|
data.listEventViews.models.contact.emailAddresses.owningContactId | string |
A ID do contato que possui esse endereço de email. |
|
IsGlobal
|
data.listEventViews.models.contact.emailAddresses.isGlobal | boolean |
Indica se esse é um endereço de email global. |
|
phoneNumbers
|
data.listEventViews.models.contact.phoneNumbers | array of object |
Recupera os números de telefone associados ao contato. |
|
PhoneId
|
data.listEventViews.models.contact.phoneNumbers.phoneId | string |
A ID do número de telefone. |
|
Número
|
data.listEventViews.models.contact.phoneNumbers.number | string |
O número de telefone. |
|
Etiqueta
|
data.listEventViews.models.contact.phoneNumbers.label | string |
O rótulo do número de telefone. |
|
Tipo
|
data.listEventViews.models.contact.phoneNumbers.type | string |
O tipo do número de telefone (Celular, Telefone, Pager etc.). |
|
Usage
|
data.listEventViews.models.contact.phoneNumbers.usage | string |
O tipo de uso do número de telefone (AlternateBusiness, AlternateHome, etc.). |
|
OwningContactId
|
data.listEventViews.models.contact.phoneNumbers.owningContactId | string |
A ID do contato que possui esse número de telefone. |
|
IsGlobal
|
data.listEventViews.models.contact.phoneNumbers.isGlobal | boolean |
Indica se esse é um número de telefone global. |
|
Nome
|
data.listEventViews.models.contact.name | string |
O nome do contato. |
|
ListId
|
data.listEventViews.models.list.listId | string |
A ID da lista. |
|
Nome
|
data.listEventViews.models.list.name | string |
O nome da lista. |
|
Description
|
data.listEventViews.models.list.description | string |
A descrição da lista. |
|
ID
|
data.listEventViews.models.list.listType.id | string |
A ID do tipo de lista. |
|
IsActive
|
data.listEventViews.models.list.listType.isActive | boolean |
Indica se o tipo de lista está ativo. |
|
ListClass
|
data.listEventViews.models.list.listType.listClass | string |
A classe de lista associada a esse tipo de lista. |
|
Nome
|
data.listEventViews.models.list.listType.name | string |
O nome do tipo de pasta. |
|
AllowedLinkInto
|
data.listEventViews.models.list.allowedLinkInto | boolean |
Indica se as entradas podem ser vinculadas a essa lista. |
|
AllowedRemoveFrom
|
data.listEventViews.models.list.allowedRemoveFrom | boolean |
Indica se as entradas vinculadas podem ser removidas dessa lista. |
|
AddAllowed
|
data.listEventViews.models.list.addAllowed | boolean |
Indica se as entradas podem ser adicionadas a essa lista. |
|
DeleteAllowed
|
data.listEventViews.models.list.deleteAllowed | boolean |
Indica se as entradas podem ser excluídas dessa lista. |
|
AddActivityAllowed
|
data.listEventViews.models.list.addActivityAllowed | boolean |
Indica se as atividades podem ser adicionadas. |
|
AddNoteAllowed
|
data.listEventViews.models.list.addNoteAllowed | boolean |
Indica se as anotações podem ser adicionadas. |
|
OwnerName
|
data.listEventViews.models.list.ownerName | string |
O nome do proprietário desta lista. |
|
CreatorName
|
data.listEventViews.models.list.creatorName | string |
O nome do criador desta lista. |
|
AllowedContactEntity
|
data.listEventViews.models.list.allowedContactEntity | string |
Os tipos de entidade de contato permitidos para esta lista. |
|
IsAdministrator
|
data.listEventViews.models.list.isAdministrator | boolean |
Indica se o usuário atual é um administrador desta lista. |
Obter contato por Id
Obter contato por Id junto com valores de campo adicionais em InterAction+.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de contato
|
contactid | True | string |
ID de contato. |
|
ID da lista
|
listid | True | string |
A ID da lista não pode ser nula e o valor padrão é definido como 00000000-0000-0000-0000-0000000000000. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
contactId
|
data.contact.contactId | string |
contactId |
|
nome de exibição
|
data.contact.displayName | string |
nome de exibição |
|
title
|
data.contact.title | string |
title |
|
primeiro nome
|
data.contact.firstName | string |
primeiro nome |
|
nome do meio
|
data.contact.middleName | string |
nome do meio |
|
sobrenome
|
data.contact.lastName | string |
sobrenome |
|
goesBy
|
data.contact.goesBy | string |
goesBy |
|
contactEntity
|
data.contact.contactEntity | string |
contactEntity |
|
currentJobTitle
|
data.contact.currentJobTitle | string |
currentJobTitle |
|
CompanyName
|
data.contact.currentEmployer.companyName | string |
CompanyName |
|
companyId
|
data.contact.currentEmployer.companyId | string |
companyId |
|
totalModels
|
data.contact.additionalFieldValues.totalModels | integer |
totalModels |
|
models
|
data.contact.additionalFieldValues.models | array of object |
models |
|
contactId
|
data.contact.additionalFieldValues.models.contactId | string |
contactId |
|
Datatype
|
data.contact.additionalFieldValues.models.dataType | string |
Datatype |
|
fieldId
|
data.contact.additionalFieldValues.models.fieldId | string |
fieldId |
|
fieldDisplayName
|
data.contact.additionalFieldValues.models.fieldDisplayName | string |
fieldDisplayName |
|
additionalFieldValueId
|
data.contact.additionalFieldValues.models.additionalFieldValueId | string |
additionalFieldValueId |
|
listId
|
data.contact.additionalFieldValues.models.listId | string |
listId |
|
valueItems
|
data.contact.additionalFieldValues.models.valueItems | array of object |
valueItems |
|
lastEditDate
|
data.contact.additionalFieldValues.models.valueItems.lastEditDate | string |
lastEditDate |
|
value
|
data.contact.additionalFieldValues.models.valueItems.value | string |
value |
|
valueId
|
data.contact.additionalFieldValues.models.valueItems.valueId | string |
valueId |
|
endereços
|
data.contact.addresses | array of object | |
|
id
|
data.contact.addresses.id | string |
addressId |
|
rua
|
data.contact.addresses.street | string |
rua |
|
city
|
data.contact.addresses.city | string |
city |
|
administrativeDivision
|
data.contact.addresses.administrativeDivision | string |
administrativeDivision |
|
country
|
data.contact.addresses.country | string |
country |
|
postalCode
|
data.contact.addresses.postalCode | string |
postalCode |
|
tipo
|
data.contact.addresses.type | string |
tipo |
|
uso
|
data.contact.addresses.usage | string |
uso |
|
visibilidade
|
data.contact.visibility | string |
visibilidade |
|
endereços de e-mail
|
data.contact.emailAddresses | array of object |
endereços de e-mail |
|
emailId
|
data.contact.emailAddresses.emailId | string |
emailId |
|
tipo
|
data.contact.emailAddresses.type | string |
tipo |
|
uso
|
data.contact.emailAddresses.usage | string |
uso |
|
address
|
data.contact.emailAddresses.address | string |
address |
|
etiqueta
|
data.contact.emailAddresses.label | string |
etiqueta |
|
owningContactId
|
data.contact.emailAddresses.owningContactId | string |
owningContactId |
|
éGlobal
|
data.contact.emailAddresses.isGlobal | boolean |
éGlobal |
|
phoneNumbers
|
data.contact.phoneNumbers | array of object |
phoneNumbers |
|
phoneId
|
data.contact.phoneNumbers.phoneId | string |
phoneId |
|
número
|
data.contact.phoneNumbers.number | string |
número |
|
etiqueta
|
data.contact.phoneNumbers.label | string |
etiqueta |
|
tipo
|
data.contact.phoneNumbers.type | string |
tipo |
|
uso
|
data.contact.phoneNumbers.usage | string |
uso |
|
owningContactId
|
data.contact.phoneNumbers.owningContactId | string |
owningContactId |
|
éGlobal
|
data.contact.phoneNumbers.isGlobal | boolean |
éGlobal |
|
ignorar
|
data.contact.activities.skip | integer |
ignorar |
|
limit
|
data.contact.activities.limit | integer |
limit |
|
totalModels
|
data.contact.activities.totalModels | integer |
totalModels |
|
models
|
data.contact.activities.models | array of object |
models |
|
activityId
|
data.contact.activities.models.activityId | string |
activityId |
|
tipo
|
data.contact.activities.models.type | string |
tipo |
|
ID do tipo
|
data.contact.activities.models.typeId | string |
ID do tipo |
|
activityClass
|
data.contact.activities.models.activityClass | string |
activityClass |
|
typeGroup
|
data.contact.activities.models.typeGroup | string |
typeGroup |
|
activityStartDate
|
data.contact.activities.models.activityStartDate | string |
activityStartDate |
|
lastEditedDate
|
data.contact.activities.models.lastEditedDate | string |
lastEditedDate |
|
assunto
|
data.contact.activities.models.subject | string |
assunto |
|
resumo
|
data.contact.activities.models.summary | string |
resumo |
|
local
|
data.contact.activities.models.location | string |
local |
|
totalModels
|
data.contact.notes.allNotes.totalModels | integer |
totalModels |
|
models
|
data.contact.notes.allNotes.models | array of object |
models |
|
changeDate
|
data.contact.notes.allNotes.models.changeDate | string |
changeDate |
|
folderId
|
data.contact.notes.allNotes.models.folderId | string |
folderId |
|
noteId
|
data.contact.notes.allNotes.models.noteId | string |
noteId |
|
notas
|
data.contact.notes.allNotes.models.notes | string |
notas |
|
totalModels
|
data.contact.lists.totalModels | integer |
totalModels |
|
models
|
data.contact.lists.models | array of object |
models |
|
listId
|
data.contact.lists.models.listId | string |
listId |
|
nome
|
data.contact.lists.models.name | string |
nome |
|
listClass
|
data.contact.lists.models.listClass | string |
listClass |
|
descrição
|
data.contact.lists.models.description | string |
descrição |
|
tipo
|
data.contact.lists.models.type | string |
tipo |
|
userIsSponsor
|
data.contact.lists.models.userIsSponsor | boolean |
userIsSponsor |
|
allowedLinkInto
|
data.contact.lists.models.allowedLinkInto | boolean |
allowedLinkInto |
|
allowedRemoveFrom
|
data.contact.lists.models.allowedRemoveFrom | boolean |
allowedRemoveFrom |
|
ownerName
|
data.contact.lists.models.ownerName | string |
ownerName |
|
creatorName
|
data.contact.lists.models.creatorName | string |
creatorName |
|
patrocinadores
|
data.contact.lists.models.sponsors | array of object |
patrocinadores |
|
sponsorId
|
data.contact.lists.models.sponsors.sponsorId | string |
sponsorId |
|
nome de exibição
|
data.contact.lists.models.sponsors.displayName | string |
nome de exibição |
|
é Primário
|
data.contact.lists.models.sponsors.isPrimary | boolean |
é Primário |
|
fullName
|
data.contact.lists.models.sponsors.fullName | string |
fullName |
Obter contatos atualizados
Essa ação recupera contatos que foram atualizados no InterAction+ em um determinado intervalo de datas. Ele foi projetado para capturar alterações delta para contatos, ajudando os usuários a monitorar atualizações, sincronizar dados ou disparar processos downstream com base em modificações.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipos de evento
|
eventTypes | True | array of string |
Tipo de evento. |
|
Data de Início
|
start | date-time |
Especifica a data de início do intervalo de datas, incluindo informações de fuso horário. A data de início tem o padrão de 90 dias atrás, se não for fornecido. Quando a data de início não é fornecida, o deslocamento da data de início é determinado a partir da data de término, se especificado, caso contrário, o padrão é UTC (deslocamento zero). Formato de data YYYY-MM-DDTHH:mm:ssZ. |
|
|
Data de Término
|
end | date-time |
Especifica a data de término do intervalo de datas, incluindo informações de fuso horário. Formato de data YYYY-MM-DDTHH:mm:ssZ. |
|
|
IDs de contato
|
contactIds | array of string |
As IDs dos contatos da empresa para filtrar eventos de contato da empresa. |
|
|
Ignorar
|
skip | integer |
O índice inicial para paginação. Padrão = 0 |
|
|
Limit
|
limit | integer |
O número máximo de itens a serem recuperados. Padrão = 100 |
|
|
Campo classificar
|
field | True | string |
Especifica o campo a ser usado para classificar eventos. |
|
Direção da Ordenação
|
direction | string |
Especifica a direção de classificação (crescente ou decrescente). Padrão = Crescente |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
TotalModels
|
data.firmContactEventViews.totalModels | integer |
O número total de itens encontrados. |
|
models
|
data.firmContactEventViews.models | array of object |
A lista de eventos de contato da empresa. |
|
Tipo de Evento
|
data.firmContactEventViews.models.eventType | string |
O tipo de evento que ocorreu no contato da empresa. |
|
EventDate
|
data.firmContactEventViews.models.eventDate | string |
A data e hora em que o evento ocorreu. |
|
Identificação do contato
|
data.firmContactEventViews.models.contactId | string |
A ID do contato da empresa em que esse evento ocorreu. |
|
Identificação do contato
|
data.firmContactEventViews.models.contact.contactId | string |
A ID do contato. |
|
DisplayName
|
data.firmContactEventViews.models.contact.displayName | string |
O nome de exibição do contato. |
|
ContactEntity
|
data.firmContactEventViews.models.contact.contactEntity | string |
O tipo de entidade do contato. |
|
Title
|
data.firmContactEventViews.models.contact.title | string |
O título do contato. |
|
Primeiro Nome
|
data.firmContactEventViews.models.contact.firstName | string |
O nome do contato. |
|
MiddleName
|
data.firmContactEventViews.models.contact.middleName | string |
O nome do meio do contato. |
|
LastName
|
data.firmContactEventViews.models.contact.lastName | string |
O sobrenome do contato. |
|
GoesBy
|
data.firmContactEventViews.models.contact.goesBy | string |
O nome ou apelido preferencial do contato. |
|
CurrentJobTitle
|
data.firmContactEventViews.models.contact.currentJobTitle | string |
O cargo atual do contato. |
|
Nome da Empresa
|
data.firmContactEventViews.models.contact.currentEmployer.companyName | string |
O nome da empresa. |
|
CompanyId
|
data.firmContactEventViews.models.contact.currentEmployer.companyId | string |
A ID da empresa. |
|
endereços
|
data.firmContactEventViews.models.contact.addresses | array of object |
Recupera os endereços associados ao contato. |
|
AddressId
|
data.firmContactEventViews.models.contact.addresses.addressID | string |
A ID do endereço. |
|
Rua
|
data.firmContactEventViews.models.contact.addresses.street | string |
O nome da rua do endereço. |
|
City
|
data.firmContactEventViews.models.contact.addresses.city | string |
A cidade do endereço (cidade, cidade, vila, etc.). |
|
AdministrativeDivision
|
data.firmContactEventViews.models.contact.addresses.administrativeDivision | string |
A divisão administrativa do endereço. Isso representa um estado, província, província, departamento ou divisão regional semelhante, dependendo do país. Esse campo pode não ser aplicável a todos os países. |
|
País
|
data.firmContactEventViews.models.contact.addresses.country | string |
O país do endereço. |
|
Código Postal
|
data.firmContactEventViews.models.contact.addresses.postalCode | string |
O CEP ou o código postal do endereço. Esse campo pode não ser aplicável a todos os países. |
|
Tipo
|
data.firmContactEventViews.models.contact.addresses.type | string |
O tipo do endereço. |
|
Usage
|
data.firmContactEventViews.models.contact.addresses.usage | string |
O tipo de uso do endereço (AlternateBusiness, AlternateHome etc.). |
|
Visibilidade
|
data.firmContactEventViews.models.contact.visibility | string |
As configurações de visibilidade do contato. |
|
endereços de e-mail
|
data.firmContactEventViews.models.contact.emailAddresses | array of object |
Recupera os endereços de email associados ao contato. |
|
EmailId
|
data.firmContactEventViews.models.contact.emailAddresses.emailId | string |
A ID do endereço de email. |
|
Tipo
|
data.firmContactEventViews.models.contact.emailAddresses.type | string |
O tipo do endereço de email (Email, FTPSite, Site). |
|
Usage
|
data.firmContactEventViews.models.contact.emailAddresses.usage | string |
O tipo de uso do endereço de email (AlternateBusiness, AlternateHome etc.). |
|
Endereço de Email
|
data.firmContactEventViews.models.contact.emailAddresses.address | string |
O endereço de email. |
|
Etiqueta
|
data.firmContactEventViews.models.contact.emailAddresses.label | string |
O rótulo do endereço de email. |
|
OwningContactId
|
data.firmContactEventViews.models.contact.emailAddresses.owningContactId | string |
A ID do contato que possui esse endereço de email. |
|
IsGlobal
|
data.firmContactEventViews.models.contact.emailAddresses.isGlobal | boolean |
Indica se esse é um endereço de email global. |
|
phoneNumbers
|
data.firmContactEventViews.models.contact.phoneNumbers | array of object |
Recupera os números de telefone associados ao contato. |
|
PhoneId
|
data.firmContactEventViews.models.contact.phoneNumbers.phoneId | string |
A ID do número de telefone. |
|
Número
|
data.firmContactEventViews.models.contact.phoneNumbers.number | string |
O número de telefone. |
|
Etiqueta
|
data.firmContactEventViews.models.contact.phoneNumbers.label | string |
O rótulo do número de telefone. |
|
Tipo
|
data.firmContactEventViews.models.contact.phoneNumbers.type | string |
O tipo do número de telefone (Celular, Telefone, Pager etc.). |
|
Usage
|
data.firmContactEventViews.models.contact.phoneNumbers.usage | string |
O tipo de uso do número de telefone (AlternateBusiness, AlternateHome, etc.). |
|
OwningContactId
|
data.firmContactEventViews.models.contact.phoneNumbers.owningContactId | string |
A ID do contato que possui esse número de telefone. |
|
IsGlobal
|
data.firmContactEventViews.models.contact.phoneNumbers.isGlobal | boolean |
Indica se esse é um número de telefone global. |
|
Nome
|
data.firmContactEventViews.models.contact.name | string |
O nome do contato. |
Obter contatos criados ou removidos
Essa ação recupera contatos que foram criados ou removidos no InterAction+ dentro de um determinado intervalo de datas. Ele foi projetado para capturar alterações delta para contatos, ajudando os usuários a monitorar atualizações, sincronizar dados ou disparar processos downstream com base em modificações.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipos de evento
|
eventTypes | True | array of string |
Tipo de evento. |
|
Data de Início
|
start | date-time |
Especifica a data de início do intervalo de datas, incluindo informações de fuso horário. A data de início tem o padrão de 90 dias atrás, se não for fornecido. Quando a data de início não é fornecida, o deslocamento da data de início é determinado a partir da data de término, se especificado, caso contrário, o padrão é UTC (deslocamento zero). Formato de data YYYY-MM-DDTHH:mm:ssZ. |
|
|
Data de Término
|
end | date-time |
Especifica a data de término do intervalo de datas, incluindo informações de fuso horário. Formato de data YYYY-MM-DDTHH:mm:ssZ. |
|
|
Ignorar
|
skip | integer |
O índice inicial para paginação. Padrão = 0 |
|
|
Limit
|
limit | integer |
O número máximo de itens a serem recuperados. Padrão = 100 |
|
|
Campo classificar
|
field | True | string |
Especifica o campo a ser usado para classificar eventos. |
|
Direção da Ordenação
|
direction | string |
Especifica a direção de classificação (crescente ou decrescente). Padrão = Crescente |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
TotalModels
|
data.firmContactEventViews.totalModels | integer |
O número total de itens encontrados. |
|
models
|
data.firmContactEventViews.models | array of object |
A lista de eventos de contato da empresa. |
|
Tipo de Evento
|
data.firmContactEventViews.models.eventType | string |
O tipo de evento que ocorreu no contato da empresa. |
|
EventDate
|
data.firmContactEventViews.models.eventDate | string |
A data e hora em que o evento ocorreu. |
|
Identificação do contato
|
data.firmContactEventViews.models.contactId | string |
A ID do contato da empresa em que esse evento ocorreu. |
|
Identificação do contato
|
data.firmContactEventViews.models.contact.contactId | string |
A ID do contato. |
|
DisplayName
|
data.firmContactEventViews.models.contact.displayName | string |
O nome de exibição do contato. |
|
ContactEntity
|
data.firmContactEventViews.models.contact.contactEntity | string |
O tipo de entidade do contato. |
|
Title
|
data.firmContactEventViews.models.contact.title | string |
O título do contato. |
|
Primeiro Nome
|
data.firmContactEventViews.models.contact.firstName | string |
O nome do contato. |
|
MiddleName
|
data.firmContactEventViews.models.contact.middleName | string |
O nome do meio do contato. |
|
LastName
|
data.firmContactEventViews.models.contact.lastName | string |
O sobrenome do contato. |
|
GoesBy
|
data.firmContactEventViews.models.contact.goesBy | string |
O nome ou apelido preferencial do contato. |
|
CurrentJobTitle
|
data.firmContactEventViews.models.contact.currentJobTitle | string |
O cargo atual do contato. |
|
Nome da Empresa
|
data.firmContactEventViews.models.contact.currentEmployer.companyName | string |
O nome da empresa. |
|
CompanyId
|
data.firmContactEventViews.models.contact.currentEmployer.companyId | string |
A ID da empresa. |
|
endereços
|
data.firmContactEventViews.models.contact.addresses | array of object |
Recupera os endereços associados ao contato. |
|
AddressId
|
data.firmContactEventViews.models.contact.addresses.addressID | string |
A ID do endereço. |
|
Rua
|
data.firmContactEventViews.models.contact.addresses.street | string |
O nome da rua do endereço. |
|
City
|
data.firmContactEventViews.models.contact.addresses.city | string |
A cidade do endereço (cidade, cidade, vila, etc.). |
|
AdministrativeDivision
|
data.firmContactEventViews.models.contact.addresses.administrativeDivision | string |
A divisão administrativa do endereço. Isso representa um estado, província, província, departamento ou divisão regional semelhante, dependendo do país. Esse campo pode não ser aplicável a todos os países. |
|
País
|
data.firmContactEventViews.models.contact.addresses.country | string |
O país do endereço. |
|
Código Postal
|
data.firmContactEventViews.models.contact.addresses.postalCode | string |
O CEP ou o código postal do endereço. Esse campo pode não ser aplicável a todos os países. |
|
Tipo
|
data.firmContactEventViews.models.contact.addresses.type | string |
O tipo do endereço. |
|
Usage
|
data.firmContactEventViews.models.contact.addresses.usage | string |
O tipo de uso do endereço (AlternateBusiness, AlternateHome etc.). |
|
Visibilidade
|
data.firmContactEventViews.models.contact.visibility | string |
As configurações de visibilidade do contato. |
|
endereços de e-mail
|
data.firmContactEventViews.models.contact.emailAddresses | array of object |
Recupera os endereços de email associados ao contato. |
|
EmailId
|
data.firmContactEventViews.models.contact.emailAddresses.emailId | string |
A ID do endereço de email. |
|
Tipo
|
data.firmContactEventViews.models.contact.emailAddresses.type | string |
O tipo do endereço de email (Email, FTPSite, Site). |
|
Usage
|
data.firmContactEventViews.models.contact.emailAddresses.usage | string |
O tipo de uso do endereço de email (AlternateBusiness, AlternateHome etc.). |
|
Endereço de Email
|
data.firmContactEventViews.models.contact.emailAddresses.address | string |
O endereço de email. |
|
Etiqueta
|
data.firmContactEventViews.models.contact.emailAddresses.label | string |
O rótulo do endereço de email. |
|
OwningContactId
|
data.firmContactEventViews.models.contact.emailAddresses.owningContactId | string |
A ID do contato que possui esse endereço de email. |
|
IsGlobal
|
data.firmContactEventViews.models.contact.emailAddresses.isGlobal | boolean |
Indica se esse é um endereço de email global. |
|
phoneNumbers
|
data.firmContactEventViews.models.contact.phoneNumbers | array of object |
Recupera os números de telefone associados ao contato. |
|
PhoneId
|
data.firmContactEventViews.models.contact.phoneNumbers.phoneId | string |
A ID do número de telefone. |
|
Número
|
data.firmContactEventViews.models.contact.phoneNumbers.number | string |
O número de telefone. |
|
Etiqueta
|
data.firmContactEventViews.models.contact.phoneNumbers.label | string |
O rótulo do número de telefone. |
|
Tipo
|
data.firmContactEventViews.models.contact.phoneNumbers.type | string |
O tipo do número de telefone (Celular, Telefone, Pager etc.). |
|
Usage
|
data.firmContactEventViews.models.contact.phoneNumbers.usage | string |
O tipo de uso do número de telefone (AlternateBusiness, AlternateHome, etc.). |
|
OwningContactId
|
data.firmContactEventViews.models.contact.phoneNumbers.owningContactId | string |
A ID do contato que possui esse número de telefone. |
|
IsGlobal
|
data.firmContactEventViews.models.contact.phoneNumbers.isGlobal | boolean |
Indica se esse é um número de telefone global. |
|
Nome
|
data.firmContactEventViews.models.contact.name | string |
O nome do contato. |
Obter definições e valores de campo adicionais
Obtenha definições de campo adicionais e valores de lista de InterAction+.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
id | True | string |
ID da lista. |
|
Ignorar contatos
|
skip | integer |
Ponto de partida para recuperação de contatos. O valor padrão é definido como 0. |
|
|
Limitar contatos
|
limit | integer |
Número de contatos a serem recuperados de listas. O valor padrão é definido como 100. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
data.list.id | string |
id |
|
nome
|
data.list.name | string |
nome |
|
descrição
|
data.list.description | string |
descrição |
|
id
|
data.list.listType.id | string |
id |
|
isActive
|
data.list.listType.isActive | boolean |
isActive |
|
listClass
|
data.list.listType.listClass | string |
listClass |
|
nome
|
data.list.listType.name | string |
nome |
|
totalModels
|
data.list.additionalFieldDefinitions.totalModels | integer |
totalModels |
|
models
|
data.list.additionalFieldDefinitions.models | array of object |
models |
|
userDataTypeUserProfessional
|
data.list.additionalFieldDefinitions.models.userDataTypeUserProfessional | string |
userDataTypeUserProfessional |
|
userDataTypeUserActive
|
data.list.additionalFieldDefinitions.models.userDataTypeUserActive | string |
userDataTypeUserActive |
|
stringDataTypeMultiLine
|
data.list.additionalFieldDefinitions.models.stringDataTypeMultiLine | boolean |
stringDataTypeMultiLine |
|
stringDataTypeMaxLength
|
data.list.additionalFieldDefinitions.models.stringDataTypeMaxLength | integer |
stringDataTypeMaxLength |
|
secondaryFieldName
|
data.list.additionalFieldDefinitions.models.secondaryFieldName | string |
secondaryFieldName |
|
numericDataTypeMinValue
|
data.list.additionalFieldDefinitions.models.numericDataTypeMinValue | string |
numericDataTypeMinValue |
|
numericDataTypeMaxValue
|
data.list.additionalFieldDefinitions.models.numericDataTypeMaxValue | string |
numericDataTypeMaxValue |
|
nome
|
data.list.additionalFieldDefinitions.models.name | string |
nome |
|
opções
|
data.list.additionalFieldDefinitions.models.listDataType.options | array of |
opções |
|
id
|
data.list.additionalFieldDefinitions.models.id | string |
id |
|
fieldDataType
|
data.list.additionalFieldDefinitions.models.fieldDataType | string |
fieldDataType |
|
descrição
|
data.list.additionalFieldDefinitions.models.description | string |
descrição |
|
decimalDataTypePrecision
|
data.list.additionalFieldDefinitions.models.decimalDataTypePrecision | integer |
decimalDataTypePrecision |
|
dataTypeDisplayName
|
data.list.additionalFieldDefinitions.models.dataTypeDisplayName | string |
dataTypeDisplayName |
|
booleanDataTypeFalseValue
|
data.list.additionalFieldDefinitions.models.booleanDataTypeFalseValue | string |
booleanDataTypeFalseValue |
|
booleanDataTypeTrueValue
|
data.list.additionalFieldDefinitions.models.booleanDataTypeTrueValue | string |
booleanDataTypeTrueValue |
|
allowsSecondaryField
|
data.list.additionalFieldDefinitions.models.allowsSecondaryField | boolean |
allowsSecondaryField |
|
allowsMultipleValues
|
data.list.additionalFieldDefinitions.models.allowsMultipleValues | boolean |
allowsMultipleValues |
|
totalModels
|
data.list.contacts.totalModels | integer |
totalModels |
|
models
|
data.list.contacts.models | array of object |
models |
|
id
|
data.list.contacts.models.id | string |
id |
|
title
|
data.list.contacts.models.title | string |
title |
|
número de telefone
|
data.list.contacts.models.phoneNumber | string |
número de telefone |
|
endereço de email
|
data.list.contacts.models.emailAddress | string |
endereço de email |
|
nome de exibição
|
data.list.contacts.models.displayName | string |
nome de exibição |
|
CompanyName
|
data.list.contacts.models.companyName | string |
CompanyName |
|
companyId
|
data.list.contacts.models.companyId | string |
companyId |
|
contactEntity
|
data.list.contacts.models.contactEntity | string |
contactEntity |
|
nome de exibição
|
data.list.contacts.models.sponsors.displayName | string |
nome de exibição |
|
fullName
|
data.list.contacts.models.sponsors.fullName | string |
fullName |
|
id
|
data.list.contacts.models.sponsors.id | string |
id |
|
é Primário
|
data.list.contacts.models.sponsors.isPrimary | boolean |
é Primário |
|
totalModels
|
data.list.contacts.models.additionalFieldValues.totalModels | integer |
totalModels |
|
models
|
data.list.contacts.models.additionalFieldValues.models | array of object |
models |
|
contactId
|
data.list.contacts.models.additionalFieldValues.models.contactId | string |
contactId |
|
Datatype
|
data.list.contacts.models.additionalFieldValues.models.dataType | string |
Datatype |
|
fieldDisplayName
|
data.list.contacts.models.additionalFieldValues.models.fieldDisplayName | string |
fieldDisplayName |
|
fieldId
|
data.list.contacts.models.additionalFieldValues.models.fieldId | string |
fieldId |
|
format
|
data.list.contacts.models.additionalFieldValues.models.format | string |
format |
|
id
|
data.list.contacts.models.additionalFieldValues.models.id | string |
id |
|
listId
|
data.list.contacts.models.additionalFieldValues.models.listId | string |
listId |
|
separador
|
data.list.contacts.models.additionalFieldValues.models.separator | string |
separador |
|
valueItems
|
data.list.contacts.models.additionalFieldValues.models.valueItems | array of object |
valueItems |
|
lastEditDate
|
data.list.contacts.models.additionalFieldValues.models.valueItems.lastEditDate | string |
lastEditDate |
|
qualificação
|
data.list.contacts.models.additionalFieldValues.models.valueItems.qualification | string |
qualificação |
|
value
|
data.list.contacts.models.additionalFieldValues.models.valueItems.value | string |
value |
|
valueId
|
data.list.contacts.models.additionalFieldValues.models.valueItems.valueId | string |
valueId |
Obter Lista por ID
Obter Lista por ID no InterAction+.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
id | True | string |
ID da lista. |
|
Ignorar contatos
|
skip | integer |
Ponto de partida para recuperação de contatos. O valor padrão é definido como 0. |
|
|
Limitar contatos
|
limit | integer |
Número de contatos a serem recuperados de listas. O valor padrão é definido como 100. |
|
|
Nome do patrocinador primário
|
primarySponsorName | string |
Filtrar contatos de lista com o Nome do Patrocinador Primário que correspondem exatamente ao nome de exibição do contato. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
data.list.id | string |
id |
|
nome
|
data.list.name | string |
nome |
|
descrição
|
data.list.description | string |
descrição |
|
id
|
data.list.listType.id | string |
id |
|
isActive
|
data.list.listType.isActive | boolean |
isActive |
|
listClass
|
data.list.listType.listClass | string |
listClass |
|
nome
|
data.list.listType.name | string |
nome |
|
allowedLinkInto
|
data.list.allowedLinkInto | boolean |
allowedLinkInto |
|
allowedRemoveFrom
|
data.list.allowedRemoveFrom | boolean |
allowedRemoveFrom |
|
addAllowed
|
data.list.addAllowed | boolean |
addAllowed |
|
deleteAllowed
|
data.list.deleteAllowed | boolean |
deleteAllowed |
|
addActivityAllowed
|
data.list.addActivityAllowed | boolean |
addActivityAllowed |
|
addNoteAllowed
|
data.list.addNoteAllowed | boolean |
addNoteAllowed |
|
ownerName
|
data.list.ownerName | string |
ownerName |
|
creatorName
|
data.list.creatorName | string |
creatorName |
|
allowedContactEntity
|
data.list.allowedContactEntity | string |
allowedContactEntity |
|
isAdministrator
|
data.list.isAdministrator | boolean |
isAdministrator |
|
totalModels
|
data.list.contacts.totalModels | integer |
totalModels |
|
models
|
data.list.contacts.models | array of object |
models |
|
id
|
data.list.contacts.models.id | string |
id |
|
title
|
data.list.contacts.models.title | string |
title |
|
número de telefone
|
data.list.contacts.models.phoneNumber | string |
número de telefone |
|
endereço de email
|
data.list.contacts.models.emailAddress | string |
endereço de email |
|
nome de exibição
|
data.list.contacts.models.displayName | string |
nome de exibição |
|
CompanyName
|
data.list.contacts.models.companyName | string |
CompanyName |
|
companyId
|
data.list.contacts.models.companyId | string |
companyId |
|
contactEntity
|
data.list.contacts.models.contactEntity | string |
contactEntity |
|
nome de exibição
|
data.list.contacts.models.sponsors.displayName | string |
nome de exibição |
|
fullName
|
data.list.contacts.models.sponsors.fullName | string |
fullName |
|
id
|
data.list.contacts.models.sponsors.id | string |
id |
|
é Primário
|
data.list.contacts.models.sponsors.isPrimary | boolean |
é Primário |
Obter Lista por Nome
Obter lista por nome em InterAction+.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da Lista
|
filterByName | True | string |
Nome da lista (recupera a lista que corresponde exatamente ao nome especificado). |
|
Ignorar contatos
|
skip | integer |
Ponto de partida para recuperação de contatos. O valor padrão é definido como 0. |
|
|
Limitar contatos
|
limit | integer |
Número de contatos a serem recuperados de listas. O valor padrão é definido como 100. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
totalModels
|
data.lists.totalModels | integer |
totalModels |
|
models
|
data.lists.models | array of object |
models |
|
id
|
data.lists.models.id | string |
id |
|
nome
|
data.lists.models.name | string |
nome |
|
descrição
|
data.lists.models.description | string |
descrição |
|
id
|
data.lists.models.listType.id | string |
id |
|
isActive
|
data.lists.models.listType.isActive | boolean |
isActive |
|
listClass
|
data.lists.models.listType.listClass | string |
listClass |
|
nome
|
data.lists.models.listType.name | string |
nome |
|
allowedLinkInto
|
data.lists.models.allowedLinkInto | boolean |
allowedLinkInto |
|
allowedRemoveFrom
|
data.lists.models.allowedRemoveFrom | boolean |
allowedRemoveFrom |
|
addAllowed
|
data.lists.models.addAllowed | boolean |
addAllowed |
|
deleteAllowed
|
data.lists.models.deleteAllowed | boolean |
deleteAllowed |
|
addActivityAllowed
|
data.lists.models.addActivityAllowed | boolean |
addActivityAllowed |
|
addNoteAllowed
|
data.lists.models.addNoteAllowed | boolean |
addNoteAllowed |
|
ownerName
|
data.lists.models.ownerName | string |
ownerName |
|
creatorName
|
data.lists.models.creatorName | string |
creatorName |
|
allowedContactEntity
|
data.lists.models.allowedContactEntity | string |
allowedContactEntity |
|
isAdministrator
|
data.lists.models.isAdministrator | boolean |
isAdministrator |
|
totalModels
|
data.lists.models.contacts.totalModels | integer |
totalModels |
|
models
|
data.lists.models.contacts.models | array of object |
models |
|
id
|
data.lists.models.contacts.models.id | string |
id |
|
title
|
data.lists.models.contacts.models.title | string |
title |
|
número de telefone
|
data.lists.models.contacts.models.phoneNumber | string |
número de telefone |
|
endereço de email
|
data.lists.models.contacts.models.emailAddress | string |
endereço de email |
|
nome de exibição
|
data.lists.models.contacts.models.displayName | string |
nome de exibição |
|
CompanyName
|
data.lists.models.contacts.models.companyName | string |
CompanyName |
|
companyId
|
data.lists.models.contacts.models.companyId | string |
companyId |
|
contactEntity
|
data.lists.models.contacts.models.contactEntity | string |
contactEntity |
|
nome de exibição
|
data.lists.models.contacts.models.sponsors.displayName | string |
nome de exibição |
|
fullName
|
data.lists.models.contacts.models.sponsors.fullName | string |
fullName |
|
id
|
data.lists.models.contacts.models.sponsors.id | string |
id |
|
é Primário
|
data.lists.models.contacts.models.sponsors.isPrimary | boolean |
é Primário |
Obter listas
Obtenha listas do InterAction+ que inclui workingList, marketingList e marketingListWithSponsorship.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Classe List
|
listClass | string |
O tipo de classificação da lista. |
|
|
Ignorar listas
|
skip | integer |
Ponto de partida para recuperação de listas. O valor padrão é definido como 0. |
|
|
Listas de limites
|
limit | integer |
Número de listas a serem recuperadas. O valor padrão é definido como 100. |
|
|
Nome da Lista
|
filterByName | string |
Nome da lista (recupera listas que contêm o nome especificado). |
Retornos
- Corpo
- ListResponse
Obter listas criadas ou removidas
Essa ação recupera listas que foram criadas ou removidas no InterAction+ dentro de um determinado intervalo de datas. Ele foi projetado para capturar alterações delta para listas, ajudando os usuários a monitorar atualizações, sincronizar dados ou disparar processos downstream com base em modificações.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipos de evento
|
eventTypes | True | array of string |
Tipo de evento. |
|
Data de Início
|
start | date-time |
Especifica a data de início do intervalo de datas, incluindo informações de fuso horário. A data de início tem o padrão de 90 dias atrás, se não for fornecido. Quando a data de início não é fornecida, o deslocamento da data de início é determinado a partir da data de término, se especificado, caso contrário, o padrão é UTC (deslocamento zero). Formato de data YYYY-MM-DDTHH:mm:ssZ. |
|
|
Data de Término
|
end | date-time |
Especifica a data de término do intervalo de datas, incluindo informações de fuso horário. Formato de data YYYY-MM-DDTHH:mm:ssZ. |
|
|
Ignorar
|
skip | integer |
O índice inicial para paginação. Padrão = 0 |
|
|
Limit
|
limit | integer |
O número máximo de itens a serem recuperados. Padrão = 100 |
|
|
Campo classificar
|
field | True | string |
Especifica o campo a ser usado para classificar eventos. |
|
Direção da Ordenação
|
direction | string |
Especifica a direção de classificação (crescente ou decrescente). Padrão = Crescente |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
TotalModels
|
data.listEventViews.totalModels | integer |
O número total de itens encontrados. |
|
models
|
data.listEventViews.models | array of object |
A lista de eventos de lista. |
|
Tipo de Evento
|
data.listEventViews.models.eventType | string |
Representa os tipos de eventos que podem ocorrer em uma lista. |
|
EventDate
|
data.listEventViews.models.eventDate | string |
A data e hora em que o evento ocorreu. |
|
ListId
|
data.listEventViews.models.listId | string |
A ID da lista em que esse evento ocorreu. |
|
ListId
|
data.listEventViews.models.list.listId | string |
A ID da lista. |
|
Nome
|
data.listEventViews.models.list.name | string |
O nome da lista. |
|
descrição
|
data.listEventViews.models.list.description | string |
A descrição da lista. |
|
ID
|
data.listEventViews.models.list.listType.id | string |
A ID do tipo de pasta. |
|
IsActive
|
data.listEventViews.models.list.listType.isActive | boolean |
Indica se o tipo de pasta está ativo. |
|
ListClass
|
data.listEventViews.models.list.listType.listClass | string |
A classe de lista associada a esse tipo de pasta. |
|
Nome
|
data.listEventViews.models.list.listType.name | string |
O nome do tipo de pasta. |
|
AllowedLinkInto
|
data.listEventViews.models.list.allowedLinkInto | boolean |
Indica se as entradas podem ser vinculadas a essa lista. |
|
AllowedRemoveFrom
|
data.listEventViews.models.list.allowedRemoveFrom | boolean |
Indica se as entradas vinculadas podem ser removidas dessa lista. |
|
AddAllowed
|
data.listEventViews.models.list.addAllowed | boolean |
Indica se as entradas podem ser adicionadas a essa lista. |
|
DeleteAllowed
|
data.listEventViews.models.list.deleteAllowed | boolean |
Indica se as entradas podem ser excluídas dessa lista. |
|
AddActivityAllowed
|
data.listEventViews.models.list.addActivityAllowed | boolean |
Indica se as atividades podem ser adicionadas. |
|
AddNoteAllowed
|
data.listEventViews.models.list.addNoteAllowed | boolean |
Indica se as anotações podem ser adicionadas. |
|
OwnerName
|
data.listEventViews.models.list.ownerName | string |
O nome do proprietário desta lista. |
|
CreatorName
|
data.listEventViews.models.list.creatorName | string |
O nome do criador desta lista. |
|
AllowedContactEntity
|
data.listEventViews.models.list.allowedContactEntity | string |
Os tipos de entidade de contato permitidos para esta lista. |
|
IsAdministrator
|
data.listEventViews.models.list.isAdministrator | boolean |
isAdministrator |
Pesquisar Contato de Pessoa
Pesquisar contato de pessoa com base no nome, sobrenome e endereço de email.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Pesquisar por endereço de email
|
emailAddress | string |
Pesquisar contatos de pessoa com o endereço de email. |
|
|
Pesquisar por Nome
|
firstName | string |
Pesquise contatos de pessoa com o nome. |
|
|
Pesquisar por Sobrenome
|
lastName | string |
Pesquisar contatos de pessoa com sobrenome |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
totalModels
|
data.searchFirmContacts.totalModels | integer |
totalModels |
|
models
|
data.searchFirmContacts.models | array of object |
models |
|
contactId
|
data.searchFirmContacts.models.contactId | string |
contactId |
|
nome de exibição
|
data.searchFirmContacts.models.displayName | string |
nome de exibição |
|
contactEntity
|
data.searchFirmContacts.models.contactEntity | string |
contactEntity |
|
title
|
data.searchFirmContacts.models.title | string |
title |
|
primeiro nome
|
data.searchFirmContacts.models.firstName | string |
primeiro nome |
|
nome do meio
|
data.searchFirmContacts.models.middleName | string |
nome do meio |
|
sobrenome
|
data.searchFirmContacts.models.lastName | string |
sobrenome |
|
currentJobTitle
|
data.searchFirmContacts.models.currentJobTitle | string |
currentJobTitle |
|
CompanyName
|
data.searchFirmContacts.models.currentEmployer.companyName | string |
CompanyName |
|
companyId
|
data.searchFirmContacts.models.currentEmployer.companyId | string |
companyId |
|
endereços
|
data.searchFirmContacts.models.addresses | array of object |
endereços |
|
addressID
|
data.searchFirmContacts.models.addresses.addressID | string |
addressID |
|
rua
|
data.searchFirmContacts.models.addresses.street | string |
rua |
|
city
|
data.searchFirmContacts.models.addresses.city | string |
city |
|
administrativeDivision
|
data.searchFirmContacts.models.addresses.administrativeDivision | string |
administrativeDivision |
|
country
|
data.searchFirmContacts.models.addresses.country | string |
country |
|
postalCode
|
data.searchFirmContacts.models.addresses.postalCode | string |
postalCode |
|
tipo
|
data.searchFirmContacts.models.addresses.type | string |
tipo |
|
uso
|
data.searchFirmContacts.models.addresses.usage | string |
uso |
|
visibilidade
|
data.searchFirmContacts.models.visibility | string |
visibilidade |
|
endereços de e-mail
|
data.searchFirmContacts.models.emailAddresses | array of object |
endereços de e-mail |
|
emailId
|
data.searchFirmContacts.models.emailAddresses.emailId | string |
emailId |
|
tipo
|
data.searchFirmContacts.models.emailAddresses.type | string |
tipo |
|
uso
|
data.searchFirmContacts.models.emailAddresses.usage | string |
uso |
|
address
|
data.searchFirmContacts.models.emailAddresses.address | string |
address |
|
etiqueta
|
data.searchFirmContacts.models.emailAddresses.label | string |
etiqueta |
|
owningContactId
|
data.searchFirmContacts.models.emailAddresses.owningContactId | string |
owningContactId |
|
éGlobal
|
data.searchFirmContacts.models.emailAddresses.isGlobal | boolean |
éGlobal |
|
phoneNumbers
|
data.searchFirmContacts.models.phoneNumbers | array of object |
phoneNumbers |
|
phoneId
|
data.searchFirmContacts.models.phoneNumbers.phoneId | string |
phoneId |
|
número
|
data.searchFirmContacts.models.phoneNumbers.number | string |
número |
|
etiqueta
|
data.searchFirmContacts.models.phoneNumbers.label | string |
etiqueta |
|
tipo
|
data.searchFirmContacts.models.phoneNumbers.type | string |
tipo |
|
uso
|
data.searchFirmContacts.models.phoneNumbers.usage | string |
uso |
|
owningContactId
|
data.searchFirmContacts.models.phoneNumbers.owningContactId | string |
owningContactId |
|
éGlobal
|
data.searchFirmContacts.models.phoneNumbers.isGlobal | boolean |
éGlobal |
|
ignorar
|
data.searchFirmContacts.models.activities.skip | integer |
ignorar |
|
limit
|
data.searchFirmContacts.models.activities.limit | integer |
limit |
|
totalModels
|
data.searchFirmContacts.models.activities.totalModels | integer |
totalModels |
|
models
|
data.searchFirmContacts.models.activities.models | array of object |
models |
|
activityId
|
data.searchFirmContacts.models.activities.models.activityId | string |
activityId |
|
tipo
|
data.searchFirmContacts.models.activities.models.type | string |
tipo |
|
ID do tipo
|
data.searchFirmContacts.models.activities.models.typeId | string |
ID do tipo |
|
activityClass
|
data.searchFirmContacts.models.activities.models.activityClass | string |
activityClass |
|
typeGroup
|
data.searchFirmContacts.models.activities.models.typeGroup | string |
typeGroup |
|
activityStartDate
|
data.searchFirmContacts.models.activities.models.activityStartDate | string |
activityStartDate |
|
lastEditedDate
|
data.searchFirmContacts.models.activities.models.lastEditedDate | string |
lastEditedDate |
|
assunto
|
data.searchFirmContacts.models.activities.models.subject | string |
assunto |
|
resumo
|
data.searchFirmContacts.models.activities.models.summary | string |
resumo |
|
local
|
data.searchFirmContacts.models.activities.models.location | string |
local |
|
totalModels
|
data.searchFirmContacts.models.notes.allNotes.totalModels | integer |
totalModels |
|
models
|
data.searchFirmContacts.models.notes.allNotes.models | array of |
models |
|
totalModels
|
data.searchFirmContacts.models.lists.totalModels | integer |
totalModels |
|
models
|
data.searchFirmContacts.models.lists.models | array of object |
models |
|
listId
|
data.searchFirmContacts.models.lists.models.listId | string |
listId |
|
nome
|
data.searchFirmContacts.models.lists.models.name | string |
nome |
|
listClass
|
data.searchFirmContacts.models.lists.models.listClass | string |
listClass |
|
descrição
|
data.searchFirmContacts.models.lists.models.description | string |
descrição |
|
tipo
|
data.searchFirmContacts.models.lists.models.type | string |
tipo |
|
userIsSponsor
|
data.searchFirmContacts.models.lists.models.userIsSponsor | boolean |
userIsSponsor |
|
allowedLinkInto
|
data.searchFirmContacts.models.lists.models.allowedLinkInto | boolean |
allowedLinkInto |
|
allowedRemoveFrom
|
data.searchFirmContacts.models.lists.models.allowedRemoveFrom | boolean |
allowedRemoveFrom |
|
ownerName
|
data.searchFirmContacts.models.lists.models.ownerName | string |
ownerName |
|
creatorName
|
data.searchFirmContacts.models.lists.models.creatorName | string |
creatorName |
|
patrocinadores
|
data.searchFirmContacts.models.lists.models.sponsors | array of object |
patrocinadores |
|
sponsorId
|
data.searchFirmContacts.models.lists.models.sponsors.sponsorId | string |
sponsorId |
|
nome de exibição
|
data.searchFirmContacts.models.lists.models.sponsors.displayName | string |
nome de exibição |
|
é Primário
|
data.searchFirmContacts.models.lists.models.sponsors.isPrimary | boolean |
é Primário |
|
fullName
|
data.searchFirmContacts.models.lists.models.sponsors.fullName | string |
fullName |
Remover contatos da lista
Remover contatos da lista no InterAction+.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IDs de contato
|
contactIds | True | array of string |
ID de contato para remover de uma lista. |
|
ID da lista
|
listId | True | string |
ID da lista da qual remover contatos. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
resultText
|
data.removeContactsFromList.resultText | string |
resultText |
|
pendingContactsEffected
|
data.removeContactsFromList.pendingContactsEffected | integer |
pendingContactsEffected |
|
contactsEffected
|
data.removeContactsFromList.contactsEffected | integer |
contactsEffected |
Definições
ListResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ignorar
|
data.lists.skip | integer |
ignorar |
|
limit
|
data.lists.limit | integer |
limit |
|
totalModels
|
data.lists.totalModels | integer |
totalModels |
|
models
|
data.lists.models | array of object |
models |
|
id
|
data.lists.models.id | string |
id |
|
nome
|
data.lists.models.name | string |
nome |
|
descrição
|
data.lists.models.description | string |
descrição |
|
id
|
data.lists.models.listType.id | string |
id |
|
isActive
|
data.lists.models.listType.isActive | boolean |
isActive |
|
listClass
|
data.lists.models.listType.listClass | string |
listClass |
|
nome
|
data.lists.models.listType.name | string |
nome |
|
allowedLinkInto
|
data.lists.models.allowedLinkInto | boolean |
allowedLinkInto |
|
allowedRemoveFrom
|
data.lists.models.allowedRemoveFrom | boolean |
allowedRemoveFrom |
|
addAllowed
|
data.lists.models.addAllowed | boolean |
addAllowed |
|
deleteAllowed
|
data.lists.models.deleteAllowed | boolean |
deleteAllowed |
|
addActivityAllowed
|
data.lists.models.addActivityAllowed | boolean |
addActivityAllowed |
|
addNoteAllowed
|
data.lists.models.addNoteAllowed | boolean |
addNoteAllowed |
|
ownerName
|
data.lists.models.ownerName | string |
ownerName |
|
creatorName
|
data.lists.models.creatorName | string |
creatorName |
|
allowedContactEntity
|
data.lists.models.allowedContactEntity | string |
allowedContactEntity |
|
isAdministrator
|
data.lists.models.isAdministrator | boolean |
isAdministrator |