Partilhar via


HubSpot CRM V2 (Editora Independente) (Visualização)

Com o HubSpot CRM fácil de usar, você nunca precisará atualizar relatórios manualmente ou se perguntar como sua equipe está acompanhando as cotas. Obtenha uma visão em tempo real de todo o seu funil de vendas em um painel visual. O HubSpot CRM organizará, enriquecerá e rastreará automaticamente cada contato em uma linha do tempo organizada.

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 Troia Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadados do conector
Editora Troia Taylor
Sítio Web https://www.hubspot.com/products/crm
Política de privacidade hhttps://legal.hubspot.com/privacy-policy
Categorias Vendas e CRM

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
Token de acesso (no formato 'Portador ${YOUR_TOKEN}') securestring O token de acesso (no formato 'Portador ${YOUR_TOKEN}') 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

Adicionar e ou remover registos de uma lista

Adicione e ou remova registros que já foram criados no sistema para e ou de uma lista. Este ponto de extremidade só funciona para listas que têm um processingType de MANUAL ou SNAPSHOT.

Adicionar registos a uma lista

Adicione os registros fornecidos à lista. Os registos que não existem ou que já são membros da lista são ignorados. Este ponto de extremidade só funciona para listas que têm um processingType de MANUAL ou SNAPSHOT.

Adicionar todos os registos de uma lista de origem a uma lista de destinos

Adicione todos os registros de uma lista de origem (especificada pelo sourceListId) a uma lista de destino (especificada pelo listId). Os registros que já são membros da lista de destino serão ignorados. Os IDs da lista de destino e de origem devem ser diferentes. As listas de destino e de origem devem conter registos do mesmo tipo (por exemplo, contactos, empresas, etc.). Este ponto de extremidade só funciona para listas de destino que tenham um processingType de MANUAL ou SNAPSHOT. A lista de fontes pode ter qualquer processingTypearquivo .

Arquivar um alvo de meta

Mova um objeto identificado por goalTargetId para a lixeira.

Arquivar um bilhete

Mova um objeto identificado por ticketId para a lixeira.

Arquivar um contacto por ID

Mova um objeto identificado por contactId para a lixeira.

Arquivar um desconto

Mova um objeto identificado por discountId para a lixeira.

Arquivar um envio de feedback

Mova um objeto identificado por feedbackSubmissionId para a lixeira.

Arquivar um imposto

Mova um objeto identificado por taxId para a lixeira.

Arquivar um item de linha

Mova um objeto identificado por lineItemId para a lixeira.

Arquivar um lote de alvos de meta por ID

Arquive um lote de alvos de meta por identificador.

Arquivar um lote de contatos por ID

Arquivar um lote de contatos por identificador.

Arquivar um lote de cotações por ID

Arquive um lote de cotações por identificador.

Arquivar um lote de descontos por ID

Arquive um lote de descontos por identificador.

Arquivar um lote de empresas por ID

Arquivar um lote de empresas por identificador.

Arquivar um lote de envios de feedback por ID

Arquive um lote de envios de feedback por identificador.

Arquivar um lote de impostos por ID

Arquivar um lote de impostos por identificador.

Arquivar um lote de itens de linha por ID

Arquive um lote de itens de linha por identificador.

Arquivar um lote de negócios por ID

Arquive um lote de negócios por identificador.

Arquivar um lote de objetos por ID

Arquivar um lote de objetos por identificador.

Arquivar um lote de produtos por ID

Arquivar um lote de produtos por identificador.

Arquivar um lote de taxas por ID

Arquive um lote de taxas por identificador.

Arquivar um lote de tickets por ID

Arquive um lote de tíquetes por identificador.

Arquivar um negócio por ID

Mova um objeto identificado por dealId para a lixeira.

Arquivar um objeto

Mova um objeto identificado por objectId para a lixeira.

Arquivar um orçamento por ID

Mova um objeto identificado por quoteId para a lixeira.

Arquivar um produto

Mova um objeto identificado por productId para a lixeira.

Arquivar uma empresa por ID

Mova um objeto identificado por companyId para a lixeira.

Arquivar uma taxa por ID

Mova um objeto identificado por feeId para a lixeira.

Atualizar um cartão

Atualize uma definição de cartão com novos detalhes.

Atualizar um contacto por ID

Execute uma atualização parcial de um objeto identificado por contactidentifier. contactId refere-se ao identificador de objeto interno. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Atualizar um desconto

Execute uma atualização parcial de um objeto identificado por discountidentifier. discountId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Atualizar um envio de comentários

Execute uma atualização parcial de um objeto identificado por feedbackSubmissionidentifier. feedbackSubmissionId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Atualizar um imposto

Execute uma atualização parcial de um objeto identificado por taxidentifier. taxId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Atualizar um item de linha

Execute uma atualização parcial de um objeto identificado por lineItemidentifier. lineItemId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Atualizar um lote de contatos

Atualize um lote de contatos.

Atualizar um lote de cotações

Atualize um lote de cotações.

Atualizar um lote de descontos

Atualize um lote de descontos.

Atualizar um lote de empresas

Atualize um lote de empresas.

Atualizar um lote de envios de comentários

Atualize um lote de envios de comentários.

Atualizar um lote de impostos

Atualize um lote de impostos.

Atualizar um lote de itens de linha

Atualize um lote de itens de linha.

Atualizar um lote de metas

Atualize um lote de metas de metas.

Atualizar um lote de objetos

Atualize um lote de objetos.

Atualizar um lote de ofertas

Atualize um lote de ofertas.

Atualizar um lote de produtos

Atualize um lote de produtos.

Atualizar um lote de taxas

Atualize um lote de taxas.

Atualizar um lote de tickets

Atualize um lote de tickets.

Atualizar um objeto

Execute uma atualização parcial de um objeto identificado por objectidentifier. objectId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Atualizar um orçamento

Execute uma atualização parcial de um objeto identificado por quoteidentifier. quoteId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Atualizar um produto

Execute uma atualização parcial de um objeto identificado por productidentifier. productId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Atualizar um ticket

Execute uma atualização parcial de um objeto identificado por ticketidentifier. ticketId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Atualizar uma empresa por ID

Execute uma atualização parcial de um objeto identificado pelo identificador da empresa. companyId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Atualizar uma meta

Execute uma atualização parcial de um objeto identificado por goalTargetidentifier. goalTargetId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Atualizar uma oferta

Execute uma atualização parcial de um objeto identificado por dealidentifier. dealId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Atualizar uma taxa por ID

Execute uma atualização parcial de um objeto identificado por feeidentifier. feeId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Buscar membros da lista

Buscar as associações de uma lista em ordem ordenada pelos recordId registros na lista. Os recordIds são classificados em ordem crescente se um after deslocamento ou nenhum deslocamento for fornecido. Se apenas um before deslocamento for fornecido, os registros serão classificados em ordem decrescente. O after parâmetro offset terá precedência sobre o before offset em um caso em que ambos são fornecidos.

Cancelar uma importação ativa

Isso permite que um desenvolvedor cancele uma importação ativa.

Criar associação padrão

Crie o tipo de associação padrão (mais genérico) entre dois tipos de objeto.

Criar associações em lote

Criar associações em lote para objetos.

Criar associações padrão

Crie o tipo de associação padrão (mais genérico) entre dois tipos de objeto.

Criar etiquetas de associação

Defina rótulos de associação entre dois registros.

Criar orçamento

Crie uma cotação com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Criar um alvo de meta

Crie um destino de meta com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Criar um contacto

Crie um contato com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Criar um desconto

Crie um desconto com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Criar um envio de feedback

Crie um envio de feedback com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Criar um imposto

Crie um imposto com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Criar um item de linha

Crie um item de linha com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Criar um lote de contatos

Crie um lote de contatos.

Criar um lote de cotações

Crie um lote de cotações.

Criar um lote de descontos

Crie um lote de descontos.

Criar um lote de empresas

Crie um lote de empresas.

Criar um lote de envios de comentários

Crie um lote de envios de comentários.

Criar um lote de impostos

Crie um lote de impostos.

Criar um lote de itens de linha

Crie um lote de itens de linha.

Criar um lote de metas

Crie um lote de metas de metas.

Criar um lote de negócios

Crie um lote de negócios.

Criar um lote de objetos

Crie um lote de objetos.

Criar um lote de produtos

Crie um lote de produtos.

Criar um lote de taxas

Crie um lote de taxas.

Criar um lote de tíquetes

Crie um lote de tickets.

Criar um negócio

Crie um acordo com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Criar um novo cartão

Define um novo cartão que ficará ativo em uma conta quando este aplicativo for instalado.

Criar um objeto

Crie um objeto CRM com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Criar um produto

Crie um produto com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Criar um ticket

Crie um ticket com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Criar uma empresa

Crie uma empresa com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Criar uma taxa

Crie uma taxa com as propriedades fornecidas e devolva uma cópia do objeto, incluindo o identificador.

Eliminar um acordo para seguir o RGPD

Exclua permanentemente um acordo e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Eliminar um bilhete para seguir o RGPD

Elimine permanentemente um bilhete e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Eliminar um cartão

Exclui permanentemente uma definição de cartão com o identificador fornecido. Uma vez excluídos, os pedidos de busca de dados para este cartão não serão mais enviados para o seu serviço. Isso não pode ser desfeito.

Eliminar um contacto para seguir o RGPD

Elimine permanentemente um contacto e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Eliminar um desconto para seguir o RGPD

Elimine permanentemente um desconto e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Eliminar um imposto para seguir o RGPD

Elimine permanentemente um imposto e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Eliminar um item de linha para seguir o RGPD

Exclua permanentemente um item de linha e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Eliminar um produto para seguir o RGPD

Exclua permanentemente um produto e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Envios de comentários de pesquisa

Recupere uma lista de envios de comentários.

Excluir associações

Exclui todas as associações entre dois registros.

Excluir associações de lote

Associações de exclusão em lote para objetos.

Excluir rótulos de associação específicos

Excluir em lote rótulos de associação específicos para objetos. A exclusão de uma associação sem rótulo também excluirá todas as associações rotuladas entre esses dois objetos.

Excluir todos os registros de uma lista

Remova todos os registros de uma lista. Nota: A lista não é eliminada. Este ponto de extremidade só funciona para listas que têm um processingType de MANUAL ou SNAPSHOT.

Excluir um envio de feedback para seguir o GDPR

Exclua permanentemente um envio de feedback e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Excluir um tipo de objeto para seguir o GDPR

Exclua permanentemente um tipo de objeto e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Excluir uma cotação para seguir o GDPR

Elimine permanentemente uma citação e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Excluir uma empresa para seguir o GDPR

Exclua permanentemente uma empresa e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Excluir uma meta para seguir o GDPR

Exclua permanentemente uma meta e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Excluir uma taxa para seguir o GDPR

Elimine permanentemente uma taxa e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Fusão de dois acordos

Mesclar dois negócios com o mesmo tipo.

Fusão de dois impostos

Mesclar dois impostos com o mesmo tipo.

Fusão de duas empresas

Fundir duas empresas com o mesmo tipo.

Iniciar uma exportação

Começa a exportar dados do CRM para o portal conforme especificado no corpo da solicitação.

Iniciar uma nova importação

Começa a importar dados dos recursos de arquivo especificados. Isso carrega o arquivo correspondente e usa o objeto de solicitação de importação para converter linhas nos arquivos em objetos.

Ler associações de lotes

Associações de leitura em lote de objetos para um tipo de objeto específico. O campo 'after' em um objeto de paginação retornado pode ser adicionado ao lado do 'id' para recuperar a próxima página de associações desse objectidentifier. O campo 'link' foi preterido e deve ser ignorado.

Listar associações para um objeto

Liste todas as associações de um objeto por tipo de objeto. Limite de 500 por chamada.

Listar citações

Recupere uma página de cotações. Controle o que é retornado através do parâmetro de consulta de propriedades.

Listar descontos

Recupere uma página de descontos. Controle o que é retornado através do parâmetro de consulta de propriedades.

Listar envios de comentários

Recupere uma página de envios de comentários. Controle o que é retornado através do parâmetro de consulta de propriedades.

Listar tipos de associação

Liste todos os tipos de associação válidos disponíveis entre dois tipos de objeto.

Listas de pesquisa

Pesquise listas por nome de lista ou página em todas as listas, fornecendo um valor vazio query .

Mesclar dois alvos de meta

Mescle dois alvos de meta com o mesmo tipo.

Mesclar dois contatos

Mesclar dois contatos com o mesmo tipo.

Mesclar dois descontos

Mescle dois descontos com o mesmo tipo.

Mesclar dois envios de comentários

Mescle dois envios de feedback com o mesmo tipo.

Mesclar dois itens de linha

Mesclar dois itens de linha com o mesmo tipo.

Mesclar dois objetos

Mesclar dois objetos com o mesmo tipo.

Mesclar dois produtos

Mesclar dois produtos com o mesmo tipo.

Mesclar dois tíquetes

Mescle dois tíquetes com o mesmo tipo.

Mesclar duas cotações

Mescle duas aspas com o mesmo tipo.

Mesclar duas taxas

Mescle duas taxas com o mesmo tipo.

Metas de pesquisa

Recupere uma lista de alvos de metas.

Obtenha as informações sobre qualquer importação

Um resumo completo de um registro de importação, incluindo quaisquer atualizações.

Obtenha um acordo

Recupere um objeto identificado por dealidentifier. dealId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obtenha um desconto

Recupere um objeto identificado por discountidentifier. discountId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obtenha um lote de bilhetes por ID

Recupere um lote de tíquetes por identificador interno ou valores de propriedade exclusivos.

Obtenha um lote de descontos por ID

Recupere um lote de descontos por identificador interno ou valores de propriedade exclusivos.

Obtenha um lote de impostos por ID

Recupere um lote de impostos por identificador interno ou valores de propriedade exclusivos.

Obtenha um lote de ofertas por ID

Recupere um lote de negócios por identificador interno ou valores de propriedade exclusivos.

Obtenha um lote de taxas por ID

Recupere um lote de taxas por identificador interno ou valores de propriedade exclusivos.

Obtenha um orçamento por ID

Recupere um objeto identificado por quoteidentifier. quoteId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obtenha um produto

Recupere um objeto identificado por productidentifier. productId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obter bilhetes

Recupere uma página de tickets. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obter contactos

Recupere uma página de contatos. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obter empresas

Recupere uma página de empresas. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obter empresas por ID

Recupere um lote de empresas por identificador interno ou valores de propriedade exclusivos.

Obter erros de importação

Recupere uma lista de erros para uma importação.

Obter importações ativas

Devolve uma lista paginada de importações ativas para esta conta.

Obter impostos

Recupere uma página de impostos. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obter item de linha

Recupere um objeto identificado por lineItemidentifier. lineItemId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obter itens de linha

Recuperar uma página de itens de linha. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obter metas

Recupere uma página de metas de metas. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obter o status da ID da tarefa

Recupere o status de um identificador de tarefa.

Obter objetos

Recuperar uma página de objetos. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obter ofertas

Recupere uma página de ofertas. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obter produtos

Recupere uma página de produtos. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obter proprietários

Recupere uma lista de proprietários.

Obter resposta de detalhes do cartão de amostra

Retorna um exemplo de resposta de detalhes do cartão. Esta é a carga útil com os detalhes exibidos para um cartão que será mostrado a um usuário. Um aplicativo deve enviar isso em resposta à solicitação de busca de dados.

Obter taxas

Recupere uma página de taxas. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obter todos os cartões

Retorna uma lista de cartões para um determinado aplicativo.

Obter um alvo de meta por ID

Recupere um objeto identificado por goalTargetidentifier. goalTargetId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obter um bilhete

Recupere um objeto identificado por ticketidentifier. ticketId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obter um cartão

Devolve a definição de um cartão com o identificador fornecido.

Obter um contacto por ID

Recupere um objeto identificado por contactidentifier. contactId refere-se ao identificador de objeto interno. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obter um envio de feedback

Recupere um objeto identificado por feedbackSubmissionidentifier. feedbackSubmissionId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obter um imposto por ID

Recupere um objeto identificado por taxidentifier. taxId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obter um lote de contactos por ID

Recupere um lote de contatos por identificador interno ou valores de propriedade exclusivos.

Obter um lote de envios de feedback por ID

Recupere um lote de envios de feedback por identificador interno ou valores de propriedade exclusivos.

Obter um lote de itens de linha por ID

Recupere um lote de itens de linha por identificador interno ou valores de propriedade exclusivos.

Obter um lote de metas por ID

Recupere um lote de destinos de meta por identificador interno ou valores de propriedade exclusivos.

Obter um lote de objetos por ID

Recupere um lote de objetos por identificador interno ou valores de propriedade exclusivos.

Obter um lote de orçamentos por ID

Recupere um lote de cotações por identificador interno ou valores de propriedade exclusivos.

Obter um lote de produtos por ID

Recupere um lote de produtos por identificador interno ou valores de propriedade exclusivos.

Obter um objeto por ID

Recupere um objeto identificado por objectidentifier. objectId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Obter um proprietário por ID

Recupere um proprietário por determinado identificador ou identificador de usuário.

Obter uma empresa por ID

Recupere um objeto identificado por companyidentifier. companyId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Pesquisar bilhetes

Recupere uma lista de tickets.

Pesquisar cotações

Recupere uma lista de cotações.

Pesquisar descontos

Recupere uma lista de descontos.

Pesquisar empresas

Recupere uma lista de empresas.

Pesquisar impostos

Recupere uma lista de impostos.

Pesquisar itens de linha

Recupere uma lista de itens de linha.

Pesquisar ofertas

Recupere uma lista de ofertas.

Pesquisar por tipo de objeto

Recupere uma lista de objetos por tipo de objeto.

Pesquisar produtos

Recupere uma lista de produtos.

Pesquisar taxas

Recupere uma lista de taxas.

Procurar contactos

Recupere uma lista de contatos.

Receba uma taxa por ID

Recupere um objeto identificado por feeidentifier. feeId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Remover registos de uma lista

Remova os registros fornecidos da lista. Os registos que não existem ou que não são membros da lista são ignorados. Este ponto de extremidade só funciona para listas que têm um processingType de MANUAL ou SNAPSHOT.

Adicionar e ou remover registos de uma lista

Adicione e ou remova registros que já foram criados no sistema para e ou de uma lista. Este ponto de extremidade só funciona para listas que têm um processingType de MANUAL ou SNAPSHOT.

Parâmetros

Name Chave Necessário Tipo Description
ID da lista
listId True string

O identificador da lista.

IDs de registro a serem adicionados
recordIdsToAdd array of string

Os identificadores de registo a adicionar.

IDs de registro a serem removidos
recordIdsToRemove array of string

Os identificadores de registo a remover.

Devoluções

Name Caminho Tipo Description
IDs de registro ausentes
recordIdsMissing array of string

Faltam os identificadores de registo.

IDs de registro removidos
recordIdsRemoved array of string

Os identificadores de registro removidos.

IDs de registro adicionados
recordsIdsAdded array of string

Os identificadores de registro adicionados.

Adicionar registos a uma lista

Adicione os registros fornecidos à lista. Os registos que não existem ou que já são membros da lista são ignorados. Este ponto de extremidade só funciona para listas que têm um processingType de MANUAL ou SNAPSHOT.

Parâmetros

Name Chave Necessário Tipo Description
ID da lista
listId True string

O identificador da lista.

body
body True array of string

Devoluções

Name Caminho Tipo Description
IDs de registro ausentes
recordIdsMissing array of string

Faltam os identificadores de registo.

IDs de registro removidos
recordIdsRemoved array of string

Os identificadores de registro removidos.

IDs de registro adicionados
recordsIdsAdded array of string

Os identificadores de registro adicionados.

Adicionar todos os registos de uma lista de origem a uma lista de destinos

Adicione todos os registros de uma lista de origem (especificada pelo sourceListId) a uma lista de destino (especificada pelo listId). Os registros que já são membros da lista de destino serão ignorados. Os IDs da lista de destino e de origem devem ser diferentes. As listas de destino e de origem devem conter registos do mesmo tipo (por exemplo, contactos, empresas, etc.). Este ponto de extremidade só funciona para listas de destino que tenham um processingType de MANUAL ou SNAPSHOT. A lista de fontes pode ter qualquer processingTypearquivo .

Parâmetros

Name Chave Necessário Tipo Description
ID da lista
listId True string

O identificador da lista.

ID da lista de origem
sourceListId True string

O identificador da lista de fontes.

Devoluções

response
string

Arquivar um alvo de meta

Mova um objeto identificado por goalTargetId para a lixeira.

Parâmetros

Name Chave Necessário Tipo Description
ID do Alvo da Meta
goalTargetId True string

O identificador de destino de meta.

Devoluções

response
string

Arquivar um bilhete

Mova um objeto identificado por ticketId para a lixeira.

Parâmetros

Name Chave Necessário Tipo Description
ID do bilhete
ticketId True string

O identificador do bilhete.

Devoluções

response
string

Arquivar um contacto por ID

Mova um objeto identificado por contactId para a lixeira.

Parâmetros

Name Chave Necessário Tipo Description
ID de contato
contactId True string

O identificador de contato.

Devoluções

response
string

Arquivar um desconto

Mova um objeto identificado por discountId para a lixeira.

Parâmetros

Name Chave Necessário Tipo Description
ID de desconto
discountId True string

O identificador de desconto.

Devoluções

response
string

Arquivar um envio de feedback

Mova um objeto identificado por feedbackSubmissionId para a lixeira.

Parâmetros

Name Chave Necessário Tipo Description
ID de envio de comentários
feedbackSubmissionId True string

O identificador de envio de feedback.

Devoluções

response
string

Arquivar um imposto

Mova um objeto identificado por taxId para a lixeira.

Parâmetros

Name Chave Necessário Tipo Description
NIF
taxId True string

O identificador de imposto.

Devoluções

response
string

Arquivar um item de linha

Mova um objeto identificado por lineItemId para a lixeira.

Parâmetros

Name Chave Necessário Tipo Description
ID do item de linha
lineItemId True string

O identificador de item de linha.

Devoluções

response
string

Arquivar um lote de alvos de meta por ID

Arquive um lote de alvos de meta por identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

response
string

Arquivar um lote de contatos por ID

Arquivar um lote de contatos por identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

response
string

Arquivar um lote de cotações por ID

Arquive um lote de cotações por identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

response
string

Arquivar um lote de descontos por ID

Arquive um lote de descontos por identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

response
string

Arquivar um lote de empresas por ID

Arquivar um lote de empresas por identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

response
string

Arquivar um lote de envios de feedback por ID

Arquive um lote de envios de feedback por identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

response
string

Arquivar um lote de impostos por ID

Arquivar um lote de impostos por identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

response
string

Arquivar um lote de itens de linha por ID

Arquive um lote de itens de linha por identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

response
string

Arquivar um lote de negócios por ID

Arquive um lote de negócios por identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

response
string

Arquivar um lote de objetos por ID

Arquivar um lote de objetos por identificador.

Parâmetros

Name Chave Necessário Tipo Description
Tipo de objeto
objectType True string

O tipo de objeto.

ID
id string

O identificador.

Devoluções

response
string

Arquivar um lote de produtos por ID

Arquivar um lote de produtos por identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

response
string

Arquivar um lote de taxas por ID

Arquive um lote de taxas por identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

response
string

Arquivar um lote de tickets por ID

Arquive um lote de tíquetes por identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

response
string

Arquivar um negócio por ID

Mova um objeto identificado por dealId para a lixeira.

Parâmetros

Name Chave Necessário Tipo Description
ID do Negócio
dealId True string

O identificador de negócio.

Devoluções

response
string

Arquivar um objeto

Mova um objeto identificado por objectId para a lixeira.

Parâmetros

Name Chave Necessário Tipo Description
Tipo de objeto
objectType True string

O tipo de objeto.

ID do objeto
objectId True string

O identificador de objeto.

Devoluções

response
string

Arquivar um orçamento por ID

Mova um objeto identificado por quoteId para a lixeira.

Parâmetros

Name Chave Necessário Tipo Description
ID da cotação
quoteId True string

O identificador de citação.

Devoluções

response
string

Arquivar um produto

Mova um objeto identificado por productId para a lixeira.

Parâmetros

Name Chave Necessário Tipo Description
ID do produto
productId True string

O identificador do produto.

Devoluções

response
string

Arquivar uma empresa por ID

Mova um objeto identificado por companyId para a lixeira.

Parâmetros

Name Chave Necessário Tipo Description
ID da Empresa
companyId True string

O identificador da empresa.

Devoluções

response
string

Arquivar uma taxa por ID

Mova um objeto identificado por feeId para a lixeira.

Parâmetros

Name Chave Necessário Tipo Description
ID da taxa
feeId True string

O identificador da taxa.

Devoluções

response
string

Atualizar um cartão

Atualize uma definição de cartão com novos detalhes.

Parâmetros

Name Chave Necessário Tipo Description
ID de Aplicação
appId True string

O identificador do aplicativo.

Identificação do cartão
cardId True string

O identificador do cartão.

Title
title string

O título.

Nome
name string

O nome.

Propriedades a Enviar
propertiesToSend array of string

As propriedades a serem enviadas.

Tipo de Cartão
cardType string

O tipo de cartão.

URL de destino
targetUrl string

O endereço URL de destino.

Função sem servidor
serverlessFunction string

A função serverless.

Tipo de dados
dataType string

O tipo de dados.

Etiqueta
label string

O rótulo.

Nome
name string

O nome.

Etiqueta
label string

O rótulo.

Nome
name string

O nome.

Tipo
type string

O tipo.

Base URLs
baseUrls array of string

Os endereços de URL base.

Devoluções

Name Caminho Tipo Description
Base URLs
actions.baseUrls array of string

Os endereços de URL base.

Histórico de auditorias
auditHistory array of object
Tipo de ação
auditHistory.actionType string

O tipo de ação.

ID da aplicação
auditHistory.applicationId string

O identificador do aplicativo.

Fonte de autorização
auditHistory.authSource string

A fonte de autorização.

Alterado em
auditHistory.changedAt string

Quando alterado em.

Iniciando ID de usuário
auditHistory.initiatingUserId string

O identificador de usuário inicial.

ID do tipo de objeto
auditHistory.objectTypeId string

O identificador de tipo de objeto.

Propriedades
display.properties array of object
Tipo de dados
display.properties.dataType string

O tipo de dados.

Etiqueta
display.properties.label string

O rótulo.

Nome
display.properties.name string

O nome.

Opções
display.properties.options array of object
Etiqueta
display.properties.options.label string

O rótulo.

Nome
display.properties.options.name string

O nome.

Tipo
display.properties.options.type string

O tipo.

Tipos de objeto
fetch.objectTypes array of object
Nome
fetch.objectTypes.name string

O nome.

Propriedades a Enviar
fetch.objectTypes.propertiesToSend array of string

As propriedades a serem enviadas.

URL de destino
fetch.targetUrl string

O endereço URL de destino.

ID
id string

O identificador.

Title
title string

O título.

Criado em
createdAt string

Quando criado em.

Atualizado em
updatedAt string

Quando atualizado em.

Atualizar um contacto por ID

Execute uma atualização parcial de um objeto identificado por contactidentifier. contactId refere-se ao identificador de objeto interno. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Parâmetros

Name Chave Necessário Tipo Description
ID de contato
contactId True string

O identificador de contato.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Atualizar um desconto

Execute uma atualização parcial de um objeto identificado por discountidentifier. discountId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Parâmetros

Name Chave Necessário Tipo Description
Propriedade ID
idProperty string

A propriedade identifier.

ID de desconto
discountId True string

O identificador de desconto.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Atualizar um envio de comentários

Execute uma atualização parcial de um objeto identificado por feedbackSubmissionidentifier. feedbackSubmissionId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Parâmetros

Name Chave Necessário Tipo Description
Propriedade ID
idProperty string

A propriedade identifier.

ID de envio de comentários
feedbackSubmissionId True string

O identificador de envio de feedback.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Atualizar um imposto

Execute uma atualização parcial de um objeto identificado por taxidentifier. taxId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Parâmetros

Name Chave Necessário Tipo Description
Propriedade ID
idProperty string

A propriedade identifier.

NIF
taxId True string

O identificador de imposto.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Atualizar um item de linha

Execute uma atualização parcial de um objeto identificado por lineItemidentifier. lineItemId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Parâmetros

Name Chave Necessário Tipo Description
Propriedade ID
idProperty string

A propriedade identifier.

ID do item de linha
lineItemId True string

O identificador de item de linha.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Atualizar um lote de contatos

Atualize um lote de contatos.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Atualizar um lote de cotações

Atualize um lote de cotações.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Atualizar um lote de descontos

Atualize um lote de descontos.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Atualizar um lote de empresas

Atualize um lote de empresas.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Atualizar um lote de envios de comentários

Atualize um lote de envios de comentários.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Atualizar um lote de impostos

Atualize um lote de impostos.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Atualizar um lote de itens de linha

Atualize um lote de itens de linha.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Atualizar um lote de metas

Atualize um lote de metas de metas.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Atualizar um lote de objetos

Atualize um lote de objetos.

Parâmetros

Name Chave Necessário Tipo Description
Tipo de objeto
objectType True string

O tipo de objeto.

ID
id string

O identificador.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Atualizar um lote de ofertas

Atualize um lote de ofertas.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Atualizar um lote de produtos

Atualize um lote de produtos.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Atualizar um lote de taxas

Atualize um lote de taxas.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Atualizar um lote de tickets

Atualize um lote de tickets.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Atualizar um objeto

Execute uma atualização parcial de um objeto identificado por objectidentifier. objectId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Parâmetros

Name Chave Necessário Tipo Description
Propriedade ID
idProperty string

A propriedade identifier.

Tipo de objeto
objectType True string

O tipo de objeto.

ID do objeto
objectId True string

O identificador de objeto.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Atualizar um orçamento

Execute uma atualização parcial de um objeto identificado por quoteidentifier. quoteId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Parâmetros

Name Chave Necessário Tipo Description
Propriedade ID
idProperty string

A propriedade identifier.

ID da cotação
quoteId True string

O identificador de citação.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Atualizar um produto

Execute uma atualização parcial de um objeto identificado por productidentifier. productId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Parâmetros

Name Chave Necessário Tipo Description
Propriedade ID
idProperty string

A propriedade identifier.

ID do produto
productId True string

O identificador do produto.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Atualizar um ticket

Execute uma atualização parcial de um objeto identificado por ticketidentifier. ticketId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Parâmetros

Name Chave Necessário Tipo Description
Propriedade ID
idProperty string

A propriedade identifier.

ID do bilhete
ticketId True string

O identificador do bilhete.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Atualizar uma empresa por ID

Execute uma atualização parcial de um objeto identificado pelo identificador da empresa. companyId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Parâmetros

Name Chave Necessário Tipo Description
Propriedade ID
idProperty string

A propriedade identifier.

ID da Empresa
companyId True string

O identificador da empresa.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Atualizar uma meta

Execute uma atualização parcial de um objeto identificado por goalTargetidentifier. goalTargetId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Parâmetros

Name Chave Necessário Tipo Description
Propriedade ID
idProperty string

A propriedade identifier.

ID do Alvo da Meta
goalTargetId True string

O identificador de destino de meta.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Atualizar uma oferta

Execute uma atualização parcial de um objeto identificado por dealidentifier. dealId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Parâmetros

Name Chave Necessário Tipo Description
Propriedade ID
idProperty string

A propriedade identifier.

ID do Negócio
dealId True string

O identificador de negócio.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Atualizar uma taxa por ID

Execute uma atualização parcial de um objeto identificado por feeidentifier. feeId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. Propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.

Parâmetros

Name Chave Necessário Tipo Description
Propriedade ID
idProperty string

A propriedade identifier.

ID da taxa
feeId True string

O identificador da taxa.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Buscar membros da lista

Buscar as associações de uma lista em ordem ordenada pelos recordId registros na lista. Os recordIds são classificados em ordem crescente se um after deslocamento ou nenhum deslocamento for fornecido. Se apenas um before deslocamento for fornecido, os registros serão classificados em ordem decrescente. O after parâmetro offset terá precedência sobre o before offset em um caso em que ambos são fornecidos.

Parâmetros

Name Chave Necessário Tipo Description
Depois
after string

O depois.

Antes
before string

O antes.

Limite
limit string

O limite.

ID da lista
listId True string

O identificador da lista.

Devoluções

Name Caminho Tipo Description
Results
results array of string

Os resultados.

Depois
paging.next.after string

O depois.

Link
paging.next.link string

O link.

Antes
paging.prev.before string

O antes.

Link
paging.prev.link string

O link.

Cancelar uma importação ativa

Isso permite que um desenvolvedor cancele uma importação ativa.

Parâmetros

Name Chave Necessário Tipo Description
ID de importação
importId True string

O identificador de importação.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Criar associação padrão

Crie o tipo de associação padrão (mais genérico) entre dois tipos de objeto.

Parâmetros

Name Chave Necessário Tipo Description
Do tipo de objeto
fromObjectType True string

O tipo de objeto De.

Da ID do objeto
fromObjectId True string

O identificador de objeto De.

Para o tipo de objeto
toObjectType True string

O tipo de objeto Para.

Para ID do objeto
toObjectId True string

O identificador de objeto Para.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Categoria de Associação
results.associationSpec.associationCategory string

A categoria de associação.

ID do tipo de associação
results.associationSpec.associationTypeId string

O identificador de tipo de associação.

ID
results.from.id string

O identificador.

ID
results.to.id string

O identificador.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Errors
numErrors string

O número de erros.

Solicitado em
requestedAt string

Quando solicitado em.

Errors
errors array of object
Categoria
errors.category string

A categoria.

Errors
errors.errors array of object
Message
errors.errors.message string

A mensagem.

Sub Categoria
errors.errors.subCategory string

A subcategoria.

Código
errors.errors.code string

O código.

In
errors.errors.in string

O in.

Message
errors.message string

A mensagem.

Situação
errors.status string

O status.

ID
errors.id string

O identificador.

Criar associações em lote

Criar associações em lote para objetos.

Parâmetros

Name Chave Necessário Tipo Description
Do tipo de objeto
fromObjectType True string

O tipo de objeto De.

Para o tipo de objeto
toObjectType True string

O tipo de objeto Para.

ID
id string

O identificador.

ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Da ID do objeto
results.fromObjectId string

O objeto De identfiier.

Da ID do Tipo de Objeto
results.fromObjectTypeId string

O identificador de tipo de objeto De.

Rótulos / Etiquetas
results.labels array of string

Os rótulos.

Para ID do objeto
results.toObjectId string

O identificador de objeto Para.

Para ID do tipo de objeto
results.toObjectTypeId string

O identificador de tipo de objeto Para.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Criar associações padrão

Crie o tipo de associação padrão (mais genérico) entre dois tipos de objeto.

Parâmetros

Name Chave Necessário Tipo Description
Do tipo de objeto
fromObjectType True string

O tipo de objeto De.

Para o tipo de objeto
toObjectType True string

O tipo de objeto Para.

ID
id string

O identificador.

ID
id string

O identificador.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Categoria de Associação
results.associationSpec.associationCategory string

A categoria de associação.

ID do tipo de associação
results.associationSpec.associationTypeId string

O identificador de tipo de associação.

ID
results.from.id string

O identificador.

ID
results.to.id string

O identificador.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Errors
numErrors string

O número de erros.

Solicitado em
requestedAt string

Quando solicitado em.

Errors
errors array of object
Categoria
errors.category string

A categoria.

Errors
errors.errors array of object
Message
errors.errors.message string

A mensagem.

Sub Categoria
errors.errors.subCategory string

A subcategoria.

Código
errors.errors.code string

O código.

In
errors.errors.in string

O in.

Message
errors.message string

A mensagem.

Situação
errors.status string

O status.

ID
errors.id string

O identificador.

Criar etiquetas de associação

Defina rótulos de associação entre dois registros.

Parâmetros

Name Chave Necessário Tipo Description
Tipo de objeto
objectType True string

O tipo de objeto.

ID do objeto
objectId True string

O identificador de objeto.

Para o tipo de objeto
toObjectType True string

O tipo de objeto Para.

Para ID do objeto
toObjectId True string

O identificador de objeto Para.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Da ID do objeto
fromObjectId string

O identificador de objeto De.

Da ID do Tipo de Objeto
fromObjectTypeId string

O identificador de tipo de objeto De.

Rótulos / Etiquetas
labels array of string

Os rótulos.

Para ID do objeto
toObjectId string

O identificador de objeto Para.

Para ID do tipo de objeto
toObjectTypeId string

O identificador de tipo de objeto Para.

Criar orçamento

Crie uma cotação com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

elit_26
elit_26 string

elit_26.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Criar um alvo de meta

Crie um destino de meta com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Criar um contacto

Crie um contato com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Criar um desconto

Crie um desconto com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Nostrudcf
nostrudcf string

Nostrudcf.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Criar um envio de feedback

Crie um envio de feedback com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Criar um imposto

Crie um imposto com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Criar um item de linha

Crie um item de linha com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Criar um lote de contatos

Crie um lote de contatos.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Criar um lote de cotações

Crie um lote de cotações.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Criar um lote de descontos

Crie um lote de descontos.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Criar um lote de empresas

Crie um lote de empresas.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Criar um lote de envios de comentários

Crie um lote de envios de comentários.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Criar um lote de impostos

Crie um lote de impostos.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Criar um lote de itens de linha

Crie um lote de itens de linha.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Criar um lote de metas

Crie um lote de metas de metas.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Criar um lote de negócios

Crie um lote de negócios.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Criar um lote de objetos

Crie um lote de objetos.

Parâmetros

Name Chave Necessário Tipo Description
Tipo de objeto
objectType True string

O tipo de objeto.

ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Criar um lote de produtos

Crie um lote de produtos.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Criar um lote de taxas

Crie um lote de taxas.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Criar um lote de tíquetes

Crie um lote de tickets.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Criar um negócio

Crie um acordo com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Criar um novo cartão

Define um novo cartão que ficará ativo em uma conta quando este aplicativo for instalado.

Parâmetros

Name Chave Necessário Tipo Description
ID de Aplicação
appId True string

O identificador do aplicativo.

Base URLs
baseUrls array of string

Os endereços de URL base.

Tipo de dados
dataType string

O tipo de dados.

Etiqueta
label string

O rótulo.

Nome
name string

O nome.

Etiqueta
label string

O rótulo.

Nome
name string

O nome.

Tipo
type string

O tipo.

Nome
name string

O nome.

Propriedades a Enviar
propertiesToSend array of string

As propriedades a serem enviadas.

URL de destino
targetUrl string

O endereço URL de destino.

Tipo de Cartão
cardType string

O tipo de cartão.

Função sem servidor
serverlessFunction string

A função serverless.

Title
title string

O título.

Devoluções

Name Caminho Tipo Description
Base URLs
actions.baseUrls array of string

Os endereços de URL base.

Histórico de auditorias
auditHistory array of object
Tipo de ação
auditHistory.actionType string

O tipo de ação.

ID da aplicação
auditHistory.applicationId string

O identificador do aplicativo.

Fonte de autorização
auditHistory.authSource string

A fonte de autorização.

Alterado em
auditHistory.changedAt string

Quando alterado em.

Iniciando ID de usuário
auditHistory.initiatingUserId string

O identificador de usuário inicial.

ID do tipo de objeto
auditHistory.objectTypeId string

O identificador de tipo de objeto.

Propriedades
display.properties array of object
Tipo de dados
display.properties.dataType string

O tipo de dados.

Etiqueta
display.properties.label string

O rótulo.

Nome
display.properties.name string

O nome.

Opções
display.properties.options array of object
Etiqueta
display.properties.options.label string

O rótulo.

Nome
display.properties.options.name string

O nome.

Tipo
display.properties.options.type string

O tipo.

Tipos de objeto
fetch.objectTypes array of object
Nome
fetch.objectTypes.name string

O nome.

Propriedades a Enviar
fetch.objectTypes.propertiesToSend array of string

As propriedades a serem enviadas.

URL de destino
fetch.targetUrl string

O endereço URL de destino.

ID
id string

O identificador.

Title
title string

O título.

Criado em
createdAt string

Quando criado em.

Atualizado em
updatedAt string

Quando atualizado em.

Criar um objeto

Crie um objeto CRM com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Parâmetros

Name Chave Necessário Tipo Description
Tipo de objeto
objectType True string

O tipo de objeto.

ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Criar um produto

Crie um produto com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Criar um ticket

Crie um ticket com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Criar uma empresa

Crie uma empresa com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Criar uma taxa

Crie uma taxa com as propriedades fornecidas e devolva uma cópia do objeto, incluindo o identificador.

Parâmetros

Name Chave Necessário Tipo Description
ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Eliminar um acordo para seguir o RGPD

Exclua permanentemente um acordo e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Parâmetros

Name Chave Necessário Tipo Description
ID do objeto
objectId string

O identificador de objeto.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

response
string

Eliminar um bilhete para seguir o RGPD

Elimine permanentemente um bilhete e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Parâmetros

Name Chave Necessário Tipo Description
ID do objeto
objectId string

O identificador de objeto.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

response
string

Eliminar um cartão

Exclui permanentemente uma definição de cartão com o identificador fornecido. Uma vez excluídos, os pedidos de busca de dados para este cartão não serão mais enviados para o seu serviço. Isso não pode ser desfeito.

Parâmetros

Name Chave Necessário Tipo Description
ID de Aplicação
appId True string

O identificador do aplicativo.

Identificação do cartão
cardId True string

O identificador do cartão.

Devoluções

response
string

Eliminar um contacto para seguir o RGPD

Elimine permanentemente um contacto e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Parâmetros

Name Chave Necessário Tipo Description
ID do objeto
objectId string

O identificador de objeto.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

response
string

Eliminar um desconto para seguir o RGPD

Elimine permanentemente um desconto e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Parâmetros

Name Chave Necessário Tipo Description
ID do objeto
objectId string

O identificador de objeto.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

response
string

Eliminar um imposto para seguir o RGPD

Elimine permanentemente um imposto e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Parâmetros

Name Chave Necessário Tipo Description
ID do objeto
objectId string

O identificador de objeto.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

response
string

Eliminar um item de linha para seguir o RGPD

Exclua permanentemente um item de linha e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Parâmetros

Name Chave Necessário Tipo Description
ID do objeto
objectId string

O identificador de objeto.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

response
string

Eliminar um produto para seguir o RGPD

Exclua permanentemente um produto e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Parâmetros

Name Chave Necessário Tipo Description
ID do objeto
objectId string

O identificador de objeto.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

response
string

Envios de comentários de pesquisa

Recupere uma lista de envios de comentários.

Parâmetros

Name Chave Necessário Tipo Description
Depois
after string

A página seguinte.

Operator
operator string

O operador.

Nome da propriedade
propertyName string

O nome da propriedade.

Valor
value string

O valor.

Alto Valor
highValue string

O valor alto.

Valores
values array of string

Os valores.

Limite
limit string

O limite.

Propriedades
properties array of string

O objeto properties.

Classifica
sorts array of string

Os tipos.

Query
query string

A consulta.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Total
total string

O total.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Excluir associações

Exclui todas as associações entre dois registros.

Parâmetros

Name Chave Necessário Tipo Description
Tipo de objeto
objectType True string

O tipo de objeto.

ID do objeto
objectId True string

O identificador de objeto.

Para o tipo de objeto
toObjectType True string

O tipo de objeto Para.

Para ID do objeto
toObjectId True string

O identificador de objeto Para.

Devoluções

response
string

Excluir associações de lote

Associações de exclusão em lote para objetos.

Parâmetros

Name Chave Necessário Tipo Description
Do tipo de objeto
fromObjectType True string

O tipo de objeto De.

Para o tipo de objeto
toObjectType True string

O tipo de objeto Para.

ID
id string

O identificador.

ID
id string

O identificador.

Devoluções

response
string

Excluir rótulos de associação específicos

Excluir em lote rótulos de associação específicos para objetos. A exclusão de uma associação sem rótulo também excluirá todas as associações rotuladas entre esses dois objetos.

Parâmetros

Name Chave Necessário Tipo Description
Do tipo de objeto
fromObjectType True string

O tipo de objeto De.

Para o tipo de objeto
toObjectType True string

O tipo de objeto Para.

ID
id string

O identificador.

ID
id string

O identificador.

Categoria de Associação
associationCategory string

A categoria de associação.

ID do tipo de associação
associationTypeId string

O identificador de tipo de associação.

Devoluções

response
string

Excluir todos os registros de uma lista

Remova todos os registros de uma lista. Nota: A lista não é eliminada. Este ponto de extremidade só funciona para listas que têm um processingType de MANUAL ou SNAPSHOT.

Parâmetros

Name Chave Necessário Tipo Description
ID da lista
listId True string

O identificador da lista.

Devoluções

response
string

Excluir um envio de feedback para seguir o GDPR

Exclua permanentemente um envio de feedback e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Parâmetros

Name Chave Necessário Tipo Description
ID do objeto
objectId string

O identificador de objeto.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

response
string

Excluir um tipo de objeto para seguir o GDPR

Exclua permanentemente um tipo de objeto e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Parâmetros

Name Chave Necessário Tipo Description
Tipo de objeto
objectType True string

O tipo de objeto.

ID do objeto
objectId string

O identificador de objeto.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

response
string

Excluir uma cotação para seguir o GDPR

Elimine permanentemente uma citação e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Parâmetros

Name Chave Necessário Tipo Description
ID do objeto
objectId string

O identificador de objeto.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

response
string

Excluir uma empresa para seguir o GDPR

Exclua permanentemente uma empresa e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Parâmetros

Name Chave Necessário Tipo Description
ID do objeto
objectId string

O identificador de objeto.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

response
string

Excluir uma meta para seguir o GDPR

Exclua permanentemente uma meta e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Parâmetros

Name Chave Necessário Tipo Description
ID do objeto
objectId string

O identificador de objeto.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

response
string

Excluir uma taxa para seguir o GDPR

Elimine permanentemente uma taxa e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de e-mail. Se o endereço de e-mail não for encontrado, o endereço de e-mail será adicionado a uma lista de bloqueio e impedirá que seja usado no futuro.

Parâmetros

Name Chave Necessário Tipo Description
ID do objeto
objectId string

O identificador de objeto.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

response
string

Fusão de dois acordos

Mesclar dois negócios com o mesmo tipo.

Parâmetros

Name Chave Necessário Tipo Description
Identificador de objeto a ser mesclado
objectIdToMerge string

O identificador de objeto a ser mesclado.

ID do objeto primário
primaryObjectId string

O identificador de objeto primário.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Fusão de dois impostos

Mesclar dois impostos com o mesmo tipo.

Parâmetros

Name Chave Necessário Tipo Description
Identificador de objeto a ser mesclado
objectIdToMerge string

O identificador de objeto a ser mesclado.

ID do objeto primário
primaryObjectId string

O identificador de objeto primário.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Fusão de duas empresas

Fundir duas empresas com o mesmo tipo.

Parâmetros

Name Chave Necessário Tipo Description
Identificador de objeto a ser mesclado
objectIdToMerge string

O identificador de objeto a ser mesclado.

ID do objeto primário
primaryObjectId string

O identificador de objeto primário.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Iniciar uma exportação

Começa a exportar dados do CRM para o portal conforme especificado no corpo da solicitação.

Parâmetros

Name Chave Necessário Tipo Description
Nome da exportação
exportName string

O nome da exportação.

Tipo de exportação
exportType string

O tipo de exportação.

Formato
format string

O formato.

Linguagem
language string

A língua.

Propriedades do objeto
objectProperties array of string

As propriedades do objeto.

Tipo de objeto
objectType string

O objeto tyep.

Tipo de objeto associado
associatedObjectType string

O tipo de objeto associado.

Operator
operator string

O operador.

Nome da propriedade
propertyName string

O nome da propriedade.

Valor
value string

O valor.

Alto Valor
highValue string

O valor alto.

Valores
values array of string

Os valores.

Query
query string

A consulta.

Classifica
sorts array of string

Os tipos.

Devoluções

Name Caminho Tipo Description
ID
id string

O identificador.

Iniciar uma nova importação

Começa a importar dados dos recursos de arquivo especificados. Isso carrega o arquivo correspondente e usa o objeto de solicitação de importação para converter linhas nos arquivos em objetos.

Parâmetros

Name Chave Necessário Tipo Description
Tipo de conteúdo
Content-Type True string

Tipo de conteúdo.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

IDs de arquivo
metadata.fileIds array of string

Os identificadores de arquivo.

Listas de objetos
metadata.objectLists array of object
ID da lista
metadata.objectLists.listId string

O identificador da lista.

Tipo de objeto
metadata.objectLists.objectType string

O tipo de objeto.

Opt-Out Importação
optOutImport string

A importação opt-out.

Estado
state string

O Estado.

Atualizado em
updatedAt string

Quando atualizado em.

ID do modelo
importTemplate.templateId string

O identificador do modelo.

Tipo de modelo
importTemplate.templateType string

O tipo de modelo.

Origem de importação
importSource string

A fonte de importação.

Nome de importação
importName string

O nome da importação.

Ler associações de lotes

Associações de leitura em lote de objetos para um tipo de objeto específico. O campo 'after' em um objeto de paginação retornado pode ser adicionado ao lado do 'id' para recuperar a próxima página de associações desse objectidentifier. O campo 'link' foi preterido e deve ser ignorado.

Parâmetros

Name Chave Necessário Tipo Description
Do tipo de objeto
fromObjectType True string

O tipo de objeto De.

Para o tipo de objeto
toObjectType True string

O tipo de objeto Para.

ID
id string

O identificador.

Depois
after string

O link depois.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
ID
results.from.id string

O identificador.

Para
results.to array of object
Tipos de Associação
results.to.associationTypes array of object
Categoria
results.to.associationTypes.category string

A categoria.

ID do tipo
results.to.associationTypes.typeId string

O identificador de tipo.

Etiqueta
results.to.associationTypes.label string

O rótulo.

Para ID do objeto
results.to.toObjectId string

O identificador de objeto Para.

Depois
results.paging.next.after string

O link depois.

Link
results.paging.next.link string

O link.

Antes
results.paging.prev.before string

O link anterior.

Link
results.paging.prev.link string

O link.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Listar associações para um objeto

Liste todas as associações de um objeto por tipo de objeto. Limite de 500 por chamada.

Parâmetros

Name Chave Necessário Tipo Description
Depois
after string

O depois.

Limite
limit string

O limite.

Tipo de objeto
objectType True string

O tipo de objeto.

ID do objeto
objectId True string

O identificador de objeto.

Para o tipo de objeto
toObjectType True string

O tipo de objeto Para.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Tipos de Associação
results.associationTypes array of object
Categoria
results.associationTypes.category string

A categoria.

ID do tipo
results.associationTypes.typeId string

O identificador de tipo.

Etiqueta
results.associationTypes.label string

O rótulo.

Para ID do objeto
results.toObjectId string

O identificador de objeto Para.

Depois
paging.next.after string

O depois.

Link
paging.next.link string

O link.

Listar citações

Recupere uma página de cotações. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Limite
limit string

O limite.

Depois
after string

O depois.

Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Listar descontos

Recupere uma página de descontos. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Limite
limit string

O limite.

Depois
after string

O depois.

Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Listar envios de comentários

Recupere uma página de envios de comentários. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Limite
limit string

O limite.

Depois
after string

O depois.

Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Listar tipos de associação

Liste todos os tipos de associação válidos disponíveis entre dois tipos de objeto.

Parâmetros

Name Chave Necessário Tipo Description
Do tipo de objeto
fromObjectType True string

O tipo de objeto De.

Para o tipo de objeto
toObjectType True string

O tipo de objeto Para.

Devoluções

Name Caminho Tipo Description
Results
results array of object
ID
results.id string

O identificador.

Nome
results.name string

O nome.

Listas de pesquisa

Pesquise listas por nome de lista ou página em todas as listas, fornecendo um valor vazio query .

Parâmetros

Name Chave Necessário Tipo Description
Propriedades Adicionais
additionalProperties array of string

As propriedades adicionais.

Compensação
offset string

A compensação.

Query
query string

A consulta.

Contar
count string

A contagem.

Devoluções

Name Caminho Tipo Description
Tem mais
hasMore boolean

Se tem mais.

Lists
lists array of object
ID da lista
lists.listId string

O identificador da lista.

Versão da lista
lists.listVersion string

A versão da lista.

Nome
lists.name string

O nome.

ID do tipo de objeto
lists.objectTypeId string

O identificador de tipo de objeto.

Status de processamento
lists.processingStatus string

O status do processamento.

Tipo de processamento
lists.processingType string

O tipo de processamento.

Atualizado por ID
lists.updatedById string

O atualizado por identificador.

Filtros atualizados em
lists.filtersUpdatedAt string

Quando os filtros foram atualizados em.

Criado em
lists.createdAt string

Quando criado em.

Suprimido em
lists.deletedAt string

Quando excluído em.

Criado por ID
lists.createdById string

O criado pelo identificador.

Atualizado em
lists.updatedAt string

Quando atualizado em.

Compensação
offset string

A compensação.

Total
total string

O total.

Mesclar dois alvos de meta

Mescle dois alvos de meta com o mesmo tipo.

Parâmetros

Name Chave Necessário Tipo Description
Identificador de objeto a ser mesclado
objectIdToMerge string

O identificador de objeto a ser mesclado.

ID do objeto primário
primaryObjectId string

O identificador de objeto primário.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Mesclar dois contatos

Mesclar dois contatos com o mesmo tipo.

Parâmetros

Name Chave Necessário Tipo Description
Identificador de objeto a ser mesclado
objectIdToMerge string

O identificador de objeto a ser mesclado.

ID do objeto primário
primaryObjectId string

O identificador de objeto primário.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Mesclar dois descontos

Mescle dois descontos com o mesmo tipo.

Parâmetros

Name Chave Necessário Tipo Description
Identificador de objeto a ser mesclado
objectIdToMerge string

O identificador de objeto a ser mesclado.

ID do objeto primário
primaryObjectId string

O identificador de objeto primário.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Mesclar dois envios de comentários

Mescle dois envios de feedback com o mesmo tipo.

Parâmetros

Name Chave Necessário Tipo Description
Identificador de objeto a ser mesclado
objectIdToMerge string

O identificador de objeto a ser mesclado.

ID do objeto primário
primaryObjectId string

O identificador de objeto primário.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Mesclar dois itens de linha

Mesclar dois itens de linha com o mesmo tipo.

Parâmetros

Name Chave Necessário Tipo Description
Identificador de objeto a ser mesclado
objectIdToMerge string

O identificador de objeto a ser mesclado.

ID do objeto primário
primaryObjectId string

O identificador de objeto primário.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Mesclar dois objetos

Mesclar dois objetos com o mesmo tipo.

Parâmetros

Name Chave Necessário Tipo Description
Tipo de objeto
objectType True string

O tipo de objeto.

Identificador de objeto a ser mesclado
objectIdToMerge string

O identificador de objeto a ser mesclado.

ID do objeto primário
primaryObjectId string

O identificador de objeto primário.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Mesclar dois produtos

Mesclar dois produtos com o mesmo tipo.

Parâmetros

Name Chave Necessário Tipo Description
Identificador de objeto a ser mesclado
objectIdToMerge string

O identificador de objeto a ser mesclado.

ID do objeto primário
primaryObjectId string

O identificador de objeto primário.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Mesclar dois tíquetes

Mescle dois tíquetes com o mesmo tipo.

Parâmetros

Name Chave Necessário Tipo Description
Identificador de objeto a ser mesclado
objectIdToMerge string

O identificador de objeto a ser mesclado.

ID do objeto primário
primaryObjectId string

O identificador de objeto primário.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Mesclar duas cotações

Mescle duas aspas com o mesmo tipo.

Parâmetros

Name Chave Necessário Tipo Description
Identificador de objeto a ser mesclado
objectIdToMerge string

O identificador de objeto a ser mesclado.

ID do objeto primário
primaryObjectId string

O identificador de objeto primário.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Mesclar duas taxas

Mescle duas taxas com o mesmo tipo.

Parâmetros

Name Chave Necessário Tipo Description
Identificador de objeto a ser mesclado
objectIdToMerge string

O identificador de objeto a ser mesclado.

ID do objeto primário
primaryObjectId string

O identificador de objeto primário.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Metas de pesquisa

Recupere uma lista de alvos de metas.

Parâmetros

Name Chave Necessário Tipo Description
Depois
after string

A página seguinte.

Operator
operator string

O operador.

Nome da propriedade
propertyName string

O nome da propriedade.

Valor
value string

O valor.

Alto Valor
highValue string

O valor alto.

Valores
values array of string

Os valores.

Limite
limit string

O limite.

Propriedades
properties array of string

O objeto properties.

Classifica
sorts array of string

Os tipos.

Query
query string

A consulta.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Total
total string

O total.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Obtenha as informações sobre qualquer importação

Um resumo completo de um registro de importação, incluindo quaisquer atualizações.

Parâmetros

Name Chave Necessário Tipo Description
ID de importação
importId True string

O identificador de importação.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

IDs de arquivo
metadata.fileIds array of string

Os identificadores de arquivo.

Listas de objetos
metadata.objectLists array of object
ID da lista
metadata.objectLists.listId string

O identificador da lista.

Tipo de objeto
metadata.objectLists.objectType string

O tipo de objeto.

Opt-Out Importação
optOutImport string

A importação opt-out.

Estado
state string

O Estado.

Atualizado em
updatedAt string

Quando atualizado em.

ID do modelo
importTemplate.templateId string

O identificador do modelo.

Tipo de modelo
importTemplate.templateType string

O tipo de modelo.

Origem de importação
importSource string

A fonte de importação.

Nome de importação
importName string

O nome da importação.

Obtenha um acordo

Recupere um objeto identificado por dealidentifier. dealId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Propriedade ID
idProperty string

A propriedade identifier.

ID do Negócio
dealId True string

O identificador de negócio.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Obtenha um desconto

Recupere um objeto identificado por discountidentifier. discountId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Propriedade ID
idProperty string

A propriedade identifier.

ID de desconto
discountId True string

O identificador de desconto.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Obtenha um lote de bilhetes por ID

Recupere um lote de tíquetes por identificador interno ou valores de propriedade exclusivos.

Parâmetros

Name Chave Necessário Tipo Description
Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

ID
id string

O identificador.

Propriedades
properties array of string

O objeto properties.

Imóveis com história
propertiesWithHistory array of string

As propriedades com o objeto history.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Obtenha um lote de descontos por ID

Recupere um lote de descontos por identificador interno ou valores de propriedade exclusivos.

Parâmetros

Name Chave Necessário Tipo Description
Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

ID
id string

O identificador.

Propriedades
properties array of string

O objeto properties.

Imóveis com história
propertiesWithHistory array of string

As propriedades com o objeto history.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Obtenha um lote de impostos por ID

Recupere um lote de impostos por identificador interno ou valores de propriedade exclusivos.

Parâmetros

Name Chave Necessário Tipo Description
Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

ID
id string

O identificador.

Propriedades
properties array of string

O objeto properties.

Imóveis com história
propertiesWithHistory array of string

As propriedades com o objeto history.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Obtenha um lote de ofertas por ID

Recupere um lote de negócios por identificador interno ou valores de propriedade exclusivos.

Parâmetros

Name Chave Necessário Tipo Description
Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

ID
id string

O identificador.

Propriedades
properties array of string

O objeto properties.

Imóveis com história
propertiesWithHistory array of string

As propriedades com o objeto history.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Obtenha um lote de taxas por ID

Recupere um lote de taxas por identificador interno ou valores de propriedade exclusivos.

Parâmetros

Name Chave Necessário Tipo Description
Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

ID
id string

O identificador.

Propriedades
properties array of string

O objeto properties.

Imóveis com história
propertiesWithHistory array of string

As propriedades com o objeto history.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Obtenha um orçamento por ID

Recupere um objeto identificado por quoteidentifier. quoteId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Propriedade ID
idProperty string

A propriedade identifier.

ID da cotação
quoteId True string

O identificador de citação.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Obtenha um produto

Recupere um objeto identificado por productidentifier. productId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Propriedade ID
idProperty string

A propriedade identifier.

ID do produto
productId True string

O identificador do produto.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Obter bilhetes

Recupere uma página de tickets. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Limite
limit string

O limite.

Depois
after string

O depois.

Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Obter contactos

Recupere uma página de contatos. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Limite
limit string

O limite.

Depois
after string

A página seguinte.

Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Obter empresas

Recupere uma página de empresas. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Limite
limit string

O limite.

Depois
after string

A página seguinte.

Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Obter empresas por ID

Recupere um lote de empresas por identificador interno ou valores de propriedade exclusivos.

Parâmetros

Name Chave Necessário Tipo Description
Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

ID
id string

O identificador.

Propriedades
properties array of string

O objeto properties.

Imóveis com história
propertiesWithHistory array of string

As propriedades com o objeto history.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Obter erros de importação

Recupere uma lista de erros para uma importação.

Parâmetros

Name Chave Necessário Tipo Description
Depois
after string

O depois.

Limite
limit string

O limite.

ID de importação
importId True string

O identificador de importação.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

Tipo de Erro
results.errorType string

O tipo de erro.

ID
results.id string

O identificador.

ID do ficheiro
results.sourceData.fileId string

O identificador de arquivo.

Número da linha
results.sourceData.lineNumber string

O número da linha.

Dados de linha
results.sourceData.rowData array of string

Os dados da linha.

Nome da página
results.sourceData.pageName string

O nome da página.

Tipo de objeto
results.objectType string

O tipo de objeto.

Valor inválido
results.invalidValue string

O valor inválido.

Contexto Extra
results.extraContext string

O contexto extra.

ID do tipo de objeto
results.objectTypeId string

O identificador de tipo de objeto.

Número de coluna conhecido
results.knownColumnNumber string

O número da coluna conhecido.

Depois
paging.next.after string

O depois.

Link
paging.next.link string

O link.

Obter importações ativas

Devolve uma lista paginada de importações ativas para esta conta.

Parâmetros

Name Chave Necessário Tipo Description
Depois
after string

O depois.

Antes
before string

O antes.

Limite
limit string

O limite.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

IDs de arquivo
results.metadata.fileIds array of string

Os identificadores de arquivo.

Listas de objetos
results.metadata.objectLists array of object
ID da lista
results.metadata.objectLists.listId string

O identificador da lista.

Tipo de objeto
results.metadata.objectLists.objectType string

O tipo de objeto.

Opt-Out Importação
results.optOutImport string

A importação opt-out.

Estado
results.state string

O Estado.

Atualizado em
results.updatedAt string

Quando atualizado em.

ID do modelo
results.importTemplate.templateId string

O identificador do modelo.

Tipo de modelo
results.importTemplate.templateType string

O tipo de modelo.

Origem de importação
results.importSource string

A fonte de importação.

Nome de importação
results.importName string

O nome da importação.

Depois
paging.next.after string

O depois.

Link
paging.next.link string

O link.

Antes
paging.prev.before string

O antes.

Link
paging.prev.link string

O link.

Obter impostos

Recupere uma página de impostos. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Limite
limit string

O limite.

Depois
after string

O depois.

Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Obter item de linha

Recupere um objeto identificado por lineItemidentifier. lineItemId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Propriedade ID
idProperty string

A propriedade identifier.

ID do item de linha
lineItemId True string

O identificador de item de linha.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Obter itens de linha

Recuperar uma página de itens de linha. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Limite
limit string

O limite.

Depois
after string

A página seguinte.

Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Obter metas

Recupere uma página de metas de metas. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Limite
limit string

O limite.

Depois
after string

A página seguinte.

Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Obter o status da ID da tarefa

Recupere o status de um identificador de tarefa.

Parâmetros

Name Chave Necessário Tipo Description
ID da tarefa
taskId True string

O identificador da tarefa.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Result
result string

O resultado.

Errors
numErrors string

O número de erros.

Errors
errors array of object
Categoria
errors.category string

A categoria.

Errors
errors.errors array of object
Message
errors.errors.message string

A mensagem.

In
errors.errors.in string

O in.

Código
errors.errors.code string

O código.

Sub Categoria
errors.errors.subCategory string

A subcategoria.

Message
errors.message string

A mensagem.

Situação
errors.status string

O status.

ID
errors.id string

O identificador.

Solicitado em
requestedAt string

Quando solicitado em.

Obter objetos

Recuperar uma página de objetos. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Limite
limit string

O limite.

Depois
after string

O depois.

Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Tipo de objeto
objectType True string

O tipo de objeto.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Obter ofertas

Recupere uma página de ofertas. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Limite
limit string

O limite.

Depois
after string

A página seguinte.

Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Obter produtos

Recupere uma página de produtos. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Limite
limit string

O limite.

Depois
after string

A página seguinte.

Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Obter proprietários

Recupere uma lista de proprietários.

Parâmetros

Name Chave Necessário Tipo Description
Email
email True string

O endereço de e-mail.

Depois
after string

A página seguinte.

Limite
limit string

O limite.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Arquivado
results.archived boolean

Se arquivado.

Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Email
results.email string

O endereço de e-mail.

Nome Próprio
results.firstName string

O primeiro nome.

Apelido
results.lastName string

O sobrenome.

ID de utilizador
results.userId string

O identificador do usuário.

Equipas
results.teams array of object
ID
results.teams.id string

O identificador.

Nome
results.teams.name string

O nome.

Primary
results.teams.primary string

O primário.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Obter resposta de detalhes do cartão de amostra

Retorna um exemplo de resposta de detalhes do cartão. Esta é a carga útil com os detalhes exibidos para um cartão que será mostrado a um usuário. Um aplicativo deve enviar isso em resposta à solicitação de busca de dados.

Devoluções

Name Caminho Tipo Description
Contagem Total
totalCount string

A contagem total.

URL do link de todos os itens
allItemsLinkUrl string

O endereço URL do link de todos os itens.

Etiqueta do cartão
cardLabel string

A etiqueta do cartão.

Secundária
topLevelActions.secondary array of object
Método HTTP
topLevelActions.secondary.httpMethod string

O método HTTP.

Nomes de Propriedades Incluídas
topLevelActions.secondary.propertyNamesIncluded array of string

Os nomes das propriedades incluíram.

Tipo
topLevelActions.secondary.type string

O tipo.

URL
topLevelActions.secondary.url string

O endereço URL.

Cancelar rótulo do botão
topLevelActions.secondary.confirmation.cancelButtonLabel string

O rótulo do botão cancelar.

Confirmar rótulo do botão
topLevelActions.secondary.confirmation.confirmButtonLabel string

O rótulo do botão de confirmação.

Pronta
topLevelActions.secondary.confirmation.prompt string

O prompt.

Etiqueta
topLevelActions.secondary.label string

O rótulo.

Altura
topLevelActions.settings.height string

A altura.

Nomes de Propriedades Incluídas
topLevelActions.settings.propertyNamesIncluded array of string

Os nomes das propriedades incluíram.

Tipo
topLevelActions.settings.type string

O tipo.

URL
topLevelActions.settings.url string

O endereço URL.

Largura
topLevelActions.settings.width string

A largura.

Etiqueta
topLevelActions.settings.label string

O rótulo.

Método HTTP
topLevelActions.primary.httpMethod string

O método HTTP.

Nomes de Propriedades Incluídas
topLevelActions.primary.propertyNamesIncluded array of string

Os nomes das propriedades incluíram.

Tipo
topLevelActions.primary.type string

O tipo.

URL
topLevelActions.primary.url string

O endereço URL.

Cancelar rótulo do botão
topLevelActions.primary.confirmation.cancelButtonLabel string

O rótulo do botão cancelar.

Confirmar rótulo do botão
topLevelActions.primary.confirmation.confirmButtonLabel string

O rótulo do botão de confirmação.

Pronta
topLevelActions.primary.confirmation.prompt string

O prompt.

Etiqueta
topLevelActions.primary.label string

O rótulo.

Secções
sections array of object
Ações
sections.actions array of object
Método HTTP
sections.actions.httpMethod string

O método HTTP.

Nomes de Propriedades Incluídas
sections.actions.propertyNamesIncluded array of string

Os nomes das propriedades incluíram.

Tipo
sections.actions.type string

O tipo.

URL
sections.actions.url string

O endereço URL.

Cancelar rótulo do botão
sections.actions.confirmation.cancelButtonLabel string

O rótulo do botão cancelar.

Confirmar rótulo do botão
sections.actions.confirmation.confirmButtonLabel string

O rótulo do botão de confirmação.

Pronta
sections.actions.confirmation.prompt string

O prompt.

Etiqueta
sections.actions.label string

O rótulo.

ID
sections.id string

O identificador.

Title
sections.title string

O título.

Tokens
sections.tokens array of object
Valor
sections.tokens.value string

O valor.

Nome
sections.tokens.name string

O nome.

Etiqueta
sections.tokens.label string

O rótulo.

Tipo de dados
sections.tokens.dataType string

O tipo de dados.

Ligação URL
sections.linkUrl string

O endereço URL do link.

Versão de resposta
responseVersion string

A versão de resposta.

Obter taxas

Recupere uma página de taxas. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Limite
limit string

O limite.

Depois
after string

A página seguinte.

Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Obter todos os cartões

Retorna uma lista de cartões para um determinado aplicativo.

Parâmetros

Name Chave Necessário Tipo Description
ID de Aplicação
appId True string

O identificador do aplicativo.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Base URLs
results.actions.baseUrls array of string

Os endereços de URL base.

Histórico de auditorias
results.auditHistory array of object
Tipo de ação
results.auditHistory.actionType string

O tipo de ação.

ID da aplicação
results.auditHistory.applicationId string

O identificador do aplicativo.

Fonte de autenticação
results.auditHistory.authSource string

A fonte de autorização.

Alterado em
results.auditHistory.changedAt string

Quando alterado em.

Iniciando ID de usuário
results.auditHistory.initiatingUserId string

O identificador de usuário inicial.

ID do tipo de objeto
results.auditHistory.objectTypeId string

O identificador de tipo de objeto.

Propriedades
results.display.properties array of object
Tipo de dados
results.display.properties.dataType string

O tipo de dados.

Etiqueta
results.display.properties.label string

O rótulo.

Nome
results.display.properties.name string

O nome.

Opções
results.display.properties.options array of object
Etiqueta
results.display.properties.options.label string

O rótulo.

Nome
results.display.properties.options.name string

O nome.

Tipo
results.display.properties.options.type string

O tipo.

Tipos de objeto
results.fetch.objectTypes array of object
Nome
results.fetch.objectTypes.name string

O nome.

Propriedades a Enviar
results.fetch.objectTypes.propertiesToSend array of string

As propriedades a serem enviadas.

URL de destino
results.fetch.targetUrl string

O endereço URL de destino.

ID
results.id string

O identificador.

Title
results.title string

O título.

Criado em
results.createdAt string

Quando criado em.

Atualizado em
results.updatedAt string

Quando atualizado em.

Obter um alvo de meta por ID

Recupere um objeto identificado por goalTargetidentifier. goalTargetId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Propriedade ID
idProperty string

A propriedade identifier.

ID do Alvo da Meta
goalTargetId True string

O identificador de destino de meta.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Obter um bilhete

Recupere um objeto identificado por ticketidentifier. ticketId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Propriedade ID
idProperty string

A propriedade identifier.

ID do bilhete
ticketId True string

O identificador do bilhete.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Obter um cartão

Devolve a definição de um cartão com o identificador fornecido.

Parâmetros

Name Chave Necessário Tipo Description
ID de Aplicação
appId True string

O identificador do aplicativo.

Identificação do cartão
cardId True string

O identificador do cartão.

Devoluções

Name Caminho Tipo Description
Base URLs
actions.baseUrls array of string

Os endereços de URL base.

Histórico de auditorias
auditHistory array of object
Tipo de ação
auditHistory.actionType string

O tipo de ação.

ID da aplicação
auditHistory.applicationId string

O identificador do aplicativo.

Fonte de autorização
auditHistory.authSource string

A fonte de autorização.

Alterado em
auditHistory.changedAt string

Quando alterado em.

Iniciando ID de usuário
auditHistory.initiatingUserId string

O identificador de usuário inicial.

ID do tipo de objeto
auditHistory.objectTypeId string

O identificador de tipo de objeto.

Propriedades
display.properties array of object
Tipo de dados
display.properties.dataType string

O tipo de dados.

Etiqueta
display.properties.label string

O rótulo.

Nome
display.properties.name string

O nome.

Opções
display.properties.options array of object
Etiqueta
display.properties.options.label string

O rótulo.

Nome
display.properties.options.name string

O nome.

Tipo
display.properties.options.type string

O tipo.

Tipos de objeto
fetch.objectTypes array of object
Nome
fetch.objectTypes.name string

O nome.

Propriedades a Enviar
fetch.objectTypes.propertiesToSend array of string

As propriedades a serem enviadas.

URL de destino
fetch.targetUrl string

O endereço URL de destino.

ID
id string

O identificador.

Title
title string

O título.

Criado em
createdAt string

Quando criado em.

Atualizado em
updatedAt string

Quando atualizado em.

Obter um contacto por ID

Recupere um objeto identificado por contactidentifier. contactId refere-se ao identificador de objeto interno. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

ID de contato
contactId True string

O identificador de contato.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Results
associations.etc.results array of object
ID
associations.etc.results.id string

O identificador.

Tipo
associations.etc.results.type string

O tipo.

Depois
associations.etc.paging.next.after string

A página seguinte.

Link
associations.etc.paging.next.link string

A página de link.

Antes
associations.etc.paging.prev.before string

A página anterior.

Link
associations.etc.paging.prev.link string

A página de link.

Obter um envio de feedback

Recupere um objeto identificado por feedbackSubmissionidentifier. feedbackSubmissionId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Propriedade ID
idProperty string

A propriedade identifier.

ID de envio de comentários
feedbackSubmissionId True string

O identificador de envio de feedback.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Obter um imposto por ID

Recupere um objeto identificado por taxidentifier. taxId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Propriedade ID
idProperty string

A propriedade identifier.

NIF
taxId True string

O identificador de imposto.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Obter um lote de contactos por ID

Recupere um lote de contatos por identificador interno ou valores de propriedade exclusivos.

Parâmetros

Name Chave Necessário Tipo Description
Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

ID
id string

O identificador.

Propriedades
properties array of string

O objeto properties.

Imóveis com história
propertiesWithHistory array of string

As propriedades com o objeto history.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Obter um lote de envios de feedback por ID

Recupere um lote de envios de feedback por identificador interno ou valores de propriedade exclusivos.

Parâmetros

Name Chave Necessário Tipo Description
Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

ID
id string

O identificador.

Propriedades
properties array of string

O objeto properties.

Imóveis com história
propertiesWithHistory array of string

As propriedades com o objeto history.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Obter um lote de itens de linha por ID

Recupere um lote de itens de linha por identificador interno ou valores de propriedade exclusivos.

Parâmetros

Name Chave Necessário Tipo Description
Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

ID
id string

O identificador.

Propriedades
properties array of string

O objeto properties.

Imóveis com história
propertiesWithHistory array of string

As propriedades com o objeto history.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Obter um lote de metas por ID

Recupere um lote de destinos de meta por identificador interno ou valores de propriedade exclusivos.

Parâmetros

Name Chave Necessário Tipo Description
Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

ID
id string

O identificador.

Propriedades
properties array of string

O objeto properties.

Imóveis com história
propertiesWithHistory array of string

As propriedades com o objeto history.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Obter um lote de objetos por ID

Recupere um lote de objetos por identificador interno ou valores de propriedade exclusivos.

Parâmetros

Name Chave Necessário Tipo Description
Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Tipo de objeto
objectType True string

O tipo de objeto.

ID
id string

O identificador.

Propriedades
properties array of string

O objeto properties.

Imóveis com história
propertiesWithHistory array of string

As propriedades com o objeto history.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Obter um lote de orçamentos por ID

Recupere um lote de cotações por identificador interno ou valores de propriedade exclusivos.

Parâmetros

Name Chave Necessário Tipo Description
Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

ID
id string

O identificador.

Propriedades
properties array of string

O objeto properties.

Imóveis com história
propertiesWithHistory array of string

As propriedades com o objeto history.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Obter um lote de produtos por ID

Recupere um lote de produtos por identificador interno ou valores de propriedade exclusivos.

Parâmetros

Name Chave Necessário Tipo Description
Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

ID
id string

O identificador.

Propriedades
properties array of string

O objeto properties.

Imóveis com história
propertiesWithHistory array of string

As propriedades com o objeto history.

Propriedade ID
idProperty string

A propriedade identifier.

Devoluções

Name Caminho Tipo Description
Concluído em
completedAt string

Quando concluído em.

Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Começou em
startedAt string

Quando iniciado em.

Situação
status string

O status.

Solicitado em
requestedAt string

Quando solicitado em.

Obter um objeto por ID

Recupere um objeto identificado por objectidentifier. objectId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Propriedade ID
idProperty string

A propriedade identifier.

Tipo de objeto
objectType True string

O tipo de objeto.

ID do objeto
objectId True string

O identificador de objeto.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Obter um proprietário por ID

Recupere um proprietário por determinado identificador ou identificador de usuário.

Parâmetros

Name Chave Necessário Tipo Description
Propriedade ID
idProperty string

A propriedade identifier.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

ID do Proprietário
ownerId True string

O identificador do proprietário.

Devoluções

Name Caminho Tipo Description
Arquivado
archived boolean

Se arquivado.

Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Email
email string

O endereço de e-mail.

Nome Próprio
firstName string

O primeiro nome.

Apelido
lastName string

O sobrenome.

ID de utilizador
userId string

O identificador do usuário.

Equipas
teams array of object
ID
teams.id string

O identificador.

Nome
teams.name string

O nome.

Primary
teams.primary string

O primário.

Obter uma empresa por ID

Recupere um objeto identificado por companyidentifier. companyId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Propriedade ID
idProperty string

A propriedade identifier.

ID da Empresa
companyId True string

O identificador da empresa.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Pesquisar bilhetes

Recupere uma lista de tickets.

Parâmetros

Name Chave Necessário Tipo Description
Depois
after string

A página seguinte.

Operator
operator string

O operador.

Nome da propriedade
propertyName string

O nome da propriedade.

Valor
value string

O valor.

Alto Valor
highValue string

O valor alto.

Valores
values array of string

Os valores.

Limite
limit string

O limite.

Propriedades
properties array of string

O objeto properties.

Classifica
sorts array of string

Os tipos.

Query
query string

A consulta.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Total
total string

O total.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Pesquisar cotações

Recupere uma lista de cotações.

Parâmetros

Name Chave Necessário Tipo Description
Depois
after string

A página seguinte.

Operator
operator string

O operador.

Nome da propriedade
propertyName string

O nome da propriedade.

Valor
value string

O valor.

Alto Valor
highValue string

O valor alto.

Valores
values array of string

Os valores.

Limite
limit string

O limite.

Propriedades
properties array of string

O objeto properties.

Classifica
sorts array of string

Os tipos.

Query
query string

A consulta.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Total
total string

O total.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Pesquisar descontos

Recupere uma lista de descontos.

Parâmetros

Name Chave Necessário Tipo Description
Depois
after string

A página seguinte.

Operator
operator string

O operador.

Nome da propriedade
propertyName string

O nome da propriedade.

Valor
value string

O valor.

Alto Valor
highValue string

O valor alto.

Valores
values array of string

Os valores.

Limite
limit string

O limite.

Propriedades
properties array of string

O objeto properties.

Classifica
sorts array of string

Os tipos.

Query
query string

A consulta.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Total
total string

O total.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Pesquisar empresas

Recupere uma lista de empresas.

Parâmetros

Name Chave Necessário Tipo Description
Depois
after string

A página seguinte.

Operator
operator string

O operador.

Nome da propriedade
propertyName string

O nome da propriedade.

Valor
value string

O valor.

Alto Valor
highValue string

O valor alto.

Valores
values array of string

Os valores.

Limite
limit string

O limite.

Propriedades
properties array of string

O objeto properties.

Classifica
sorts array of string

Os tipos.

Query
query string

A consulta.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Total
total string

O total.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Pesquisar impostos

Recupere uma lista de impostos.

Parâmetros

Name Chave Necessário Tipo Description
Depois
after string

A página seguinte.

Operator
operator string

O operador.

Nome da propriedade
propertyName string

O nome da propriedade.

Valor
value string

O valor.

Alto Valor
highValue string

O valor alto.

Valores
values array of string

Os valores.

Limite
limit string

O limite.

Propriedades
properties array of string

O objeto properties.

Classifica
sorts array of string

Os tipos.

Query
query string

A consulta.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Total
total string

O total.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Pesquisar itens de linha

Recupere uma lista de itens de linha.

Parâmetros

Name Chave Necessário Tipo Description
Depois
after string

A página seguinte.

Operator
operator string

O operador.

Nome da propriedade
propertyName string

O nome da propriedade.

Valor
value string

O valor.

Alto Valor
highValue string

O valor alto.

Valores
values array of string

Os valores.

Limite
limit string

O limite.

Propriedades
properties array of string

O objeto properties.

Classifica
sorts array of string

Os tipos.

Query
query string

A consulta.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Total
total string

O total.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Pesquisar ofertas

Recupere uma lista de ofertas.

Parâmetros

Name Chave Necessário Tipo Description
Depois
after string

A página seguinte.

Operator
operator string

O operador.

Nome da propriedade
propertyName string

O nome da propriedade.

Valor
value string

O valor.

Alto Valor
highValue string

O valor alto.

Valores
values array of string

Os valores.

Limite
limit string

O limite.

Propriedades
properties array of string

O objeto properties.

Classifica
sorts array of string

Os tipos.

Query
query string

A consulta.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Total
total string

O total.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Pesquisar por tipo de objeto

Recupere uma lista de objetos por tipo de objeto.

Parâmetros

Name Chave Necessário Tipo Description
Tipo de objeto
objectType True string

O tipo de objeto.

Depois
after string

A página seguinte.

Operator
operator string

O operador.

Nome da propriedade
propertyName string

O nome da propriedade.

Valor
value string

O valor.

Alto Valor
highValue string

O valor alto.

Valores
values array of string

Os valores.

Limite
limit string

O limite.

Propriedades
properties array of string

O objeto properties.

Classifica
sorts array of string

Os tipos.

Query
query string

A consulta.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Total
total string

O total.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Pesquisar produtos

Recupere uma lista de produtos.

Parâmetros

Name Chave Necessário Tipo Description
Depois
after string

A página seguinte.

Operator
operator string

O operador.

Nome da propriedade
propertyName string

O nome da propriedade.

Valor
value string

O valor.

Alto Valor
highValue string

O valor alto.

Valores
values array of string

Os valores.

Limite
limit string

O limite.

Propriedades
properties array of string

O objeto properties.

Classifica
sorts array of string

Os tipos.

Query
query string

A consulta.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Total
total string

O total.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Pesquisar taxas

Recupere uma lista de taxas.

Parâmetros

Name Chave Necessário Tipo Description
Depois
after string

A página seguinte.

Operator
operator string

O operador.

Nome da propriedade
propertyName string

O nome da propriedade.

Valor
value string

O valor.

Alto Valor
highValue string

O valor alto.

Valores
values array of string

Os valores.

Limite
limit string

O limite.

Propriedades
properties array of string

O objeto properties.

Classifica
sorts array of string

Os tipos.

Query
query string

A consulta.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Total
total string

O total.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Procurar contactos

Recupere uma lista de contatos.

Parâmetros

Name Chave Necessário Tipo Description
Depois
after string

A página seguinte.

Operator
operator string

O operador.

Nome da propriedade
propertyName string

O nome da propriedade.

Valor
value string

O valor.

Alto Valor
highValue string

O valor alto.

Valores
values array of string

Os valores.

Limite
limit string

O limite.

Propriedades
properties array of string

O objeto properties.

Classifica
sorts array of string

Os tipos.

Query
query string

A consulta.

Devoluções

Name Caminho Tipo Description
Results
results array of object
Criado em
results.createdAt string

Quando criado em.

ID
results.id string

O identificador.

Atualizado em
results.updatedAt string

Quando atualizado em.

Arquivado
results.archived boolean

Se arquivado.

Arquivado em
results.archivedAt string

Quando arquivado em.

Total
total string

O total.

Depois
paging.next.after string

A página seguinte.

Link
paging.next.link string

O link.

Receba uma taxa por ID

Recupere um objeto identificado por feeidentifier. feeId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controle o que é retornado através do parâmetro de consulta de propriedades.

Parâmetros

Name Chave Necessário Tipo Description
Propriedades
properties string

As propriedades.

Imóveis com História
propertiesWithHistory string

Os imóveis com história.

Associações
associations string

As associações.

Arquivado
archived boolean

Se deseja retornar apenas os resultados que foram arquivados.

Propriedade ID
idProperty string

A propriedade identifier.

ID da taxa
feeId True string

O identificador da taxa.

Devoluções

Name Caminho Tipo Description
Criado em
createdAt string

Quando criado em.

ID
id string

O identificador.

Atualizado em
updatedAt string

Quando atualizado em.

Arquivado
archived boolean

Se arquivado.

Arquivado em
archivedAt string

Quando arquivado em.

Remover registos de uma lista

Remova os registros fornecidos da lista. Os registos que não existem ou que não são membros da lista são ignorados. Este ponto de extremidade só funciona para listas que têm um processingType de MANUAL ou SNAPSHOT.

Parâmetros

Name Chave Necessário Tipo Description
ID da lista
listId True string

O identificador da lista.

body
body True array of string

Devoluções

Name Caminho Tipo Description
IDs de registro ausentes
recordIdsMissing array of string

Faltam os identificadores de registo.

IDs de registro removidos
recordIdsRemoved array of string

Os identificadores de registro removidos.

IDs de registro adicionados
recordsIdsAdded array of string

Os identificadores de registro adicionados.

Definições

cadeia (de caracteres)

Este é o tipo de dados básico 'string'.