HubSpot Engagements V2 (Editora independente) (Visualização)
O HubSpot Engagements é usado para manter seus registros de CRM up-toatualizados em quaisquer interações que ocorram fora do HubSpot. O relatório de atividades no CRM também se alimenta desses dados.
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 |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Editora | Troia Taylor |
| Sítio Web | https://www.hubspot.com/products/crm |
| Política de privacidade | https://legal.hubspot.com/privacy-policy |
| Categorias | Vendas e CRM; Comunicação |
Compromissos da HubSpot V2
O HubSpot Engagements é usado para manter seus registros de CRM up-toatualizados em quaisquer interações que ocorram fora do HubSpot. O relatório de atividades no CRM também se alimenta desses dados.
Editora: Troy Taylor, Hitachi Solutions
Pré-requisitos
Você deve ter uma conta na HubSpot e ser um Superadministrador.
Obtenção de credenciais
Depois de iniciar sessão na sua conta, aceda a Definições -> Configuração da Conta -> Integrações -> Aplicações Privadas. Você precisará criar um aplicativo privado e atribuir-lhe apenas os escopos para os quais você usará ações. Depois que seu aplicativo privado for criado, você terá um token de acesso na seção Autenticação do aplicativo privado.
Operações suportadas
Criar lote de chamadas
Cria um lote de chamadas.
Receba um lote de chamadas
Recupera um lote de chamadas por ID interna ou valores de propriedade exclusivos.
Atualizar lote de chamadas
Atualiza um lote de chamadas.
Arquivar lote de chamadas
Arquiva um lote de chamadas por ID.
Listar chamadas
Recupera uma página de chamadas. Controle o que é retornado através do properties parâmetro de consulta.
Criar uma chamada
Cria uma chamada com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID.
Ler um objeto
Recupera um objeto identificado por callId.
callId refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. Controle o que é retornado através do properties parâmetro de consulta.
Arquivar um objeto
Move um objeto identificado por callId para a lixeira.
Atualizar um objeto
Executa uma atualização parcial de um objeto identificado por callId.
callId refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. 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.
Mesclar duas chamadas
Mescla duas chamadas com o mesmo tipo.
Eliminar uma chamada - RGPD
Exclui permanentemente uma chamada e todo o conteúdo associado para seguir o GDPR. Use a propriedade idProperty opcional 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.
Pesquisar chamadas
Recupera uma lista de chamadas.
Criar um lote de e-mails
Cria um lote de e-mails.
Receba um lote de e-mails
Recupera um lote de e-mails por ID interno ou valores de propriedade exclusivos.
Arquivar lote de e-mails
Arquiva um lote de e-mails por ID.
Atualizar lote de e-mails
Atualiza um lote de e-mails.
Listar e-mails
Recupera uma página de e-mails. Controle o que é retornado através do properties parâmetro de consulta.
Criar um e-mail
Cria um e-mail com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID.
Receber e-mail
Recupera um objeto identificado por emailId.
emailId refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. Controle o que é retornado através do properties parâmetro de consulta.
Arquivar e-mail
Move um objeto identificado por emailId para a lixeira.
Atualizar e-mail
Executa uma atualização parcial de um objeto identificado por emailId.
emailId refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. 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.
Mesclar dois e-mails
Mescla dois e-mails com o mesmo tipo.
Excluir um e-mail - GDPR
Exclui permanentemente um e-mail e todo o conteúdo associado para seguir o GDPR. Use a propriedade idProperty opcional 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.
Pesquisar e-mail
Recupere uma lista de e-mails.
Atualizar lote de reuniões
Atualiza um lote de reuniões.
Arquivar lote de reuniões
Arquiva um lote de reuniões por ID.
Obtenha um lote de reuniões
Recupera um lote de reuniões por ID interna ou valores de propriedade exclusivos.
Criar um lote de reuniões
Cria um lote de reuniões.
Obter reunião
Recupera um objeto identificado por meetingId.
meetingId refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. Controle o que é retornado através do properties parâmetro de consulta.
Reunião de arquivo
Move um objeto identificado por meetingId para a lixeira.
Atualizar reunião
Executa uma atualização parcial de um objeto identificado por meetingId.
meetingId refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. 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.
Listar reuniões
Recupera uma página de reuniões. Controle o que é retornado através do properties parâmetro de consulta.
Criar reunião
Cria uma reunião com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID.
Mesclar duas reuniões
Mescla duas reuniões com o mesmo tipo.
Eliminar uma reunião - RGPD
Exclui permanentemente uma reunião e todo o conteúdo associado para seguir o GDPR. Use a propriedade idProperty opcional 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.
Pesquisar reuniões
Recuperar uma lista de reuniões.
Obter lote de notas
Recupera um lote de notas por ID interno ou valores de propriedade exclusivos.
Lote de arquivo de notas
Arquiva um lote de notas por ID.
Atualizar lote de notas
Atualiza um lote de notas.
Criar um lote de notas
Cria um lote de notas.
Listar notas
Recupera uma página de anotações. Controle o que é retornado através do properties parâmetro de consulta.
Criar nota
Cria uma nota com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID.
Receba nota
Recupera um objeto identificado por noteId.
noteId refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. Controle o que é retornado através do properties parâmetro de consulta.
Nota de arquivo
Move um objeto identificado por noteId para a lixeira.
Nota de atualização
Executa uma atualização parcial de um objeto identificado por noteId.
noteId refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. 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.
Mesclar duas notas
Mescla duas notas com o mesmo tipo.
Eliminar uma nota - RGPD
Exclui permanentemente uma nota e todo o conteúdo associado para seguir o GDPR. Use a propriedade idProperty opcional 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.
Pesquisar notas
Recupera uma lista de anotações.
Obter lote de correio postal
Recupera um lote de correio postal por ID interna ou valores de propriedade exclusivos.
Lote de arquivo de correio postal
Arquiva um lote de correio postal por ID.
Criar um lote de correio postal
Cria um lote de correio postal.
Atualizar lote de correio postal
Atualiza um lote de correio postal.
Listar correio postal
Recupera uma página de correio postal. Controle o que é retornado através do properties parâmetro de consulta.
Criar correio postal
Cria uma mensagem postal com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID.
Obter correio postal
Recupera um objeto identificado por postalMailId.
postalMailId refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. Controle o que é retornado através do properties parâmetro de consulta.
Arquivo de correio postal
Move um objeto identificado por postalMailId para a lixeira.
Atualizar correio postal
Executa uma atualização parcial de um objeto identificado por postalMailId.
postalMailId refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. 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.
Mesclar dois correios
Mescla duas correspondências postais com o mesmo tipo.
Eliminar um correio postal - RGPD
Exclui permanentemente um e-mail postal e todo o conteúdo associado para seguir o GDPR. Use a propriedade idProperty opcional 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.
Pesquisar correio postal
Recupere uma lista de correio postal.
Arquivar lote de tarefas
Arquiva um lote de tarefas por ID.
Criar um lote de tarefas
Cria um lote de tarefas.
Atualizar lote de tarefas
Atualiza um lote de tarefas.
Obter lote de tarefas
Recupera um lote de tarefas por ID interna ou valores de propriedade exclusivos.
Obter tarefa
Recupera um objeto identificado por taskId.
taskId refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. Controle o que é retornado através do properties parâmetro de consulta.
Tarefa de arquivamento
Move um objeto identificado por taskId para a lixeira.
Tarefa de atualização
Executa uma atualização parcial de um objeto identificado por taskId.
taskId refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. 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.
Listar tarefas
Recupera uma página de tarefas. Controle o que é retornado através do properties parâmetro de consulta.
Criar tarefa
Cria uma tarefa com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID. Documentação e exemplos para a criação de tarefas padrão são fornecidos.
Mesclar duas tarefas
Mescla duas tarefas com o mesmo tipo.
Eliminar uma tarefa - RGPD
Exclui permanentemente uma tarefa e todo o conteúdo associado para seguir o GDPR. Use a propriedade idProperty opcional 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.
Tarefas de pesquisa
Recupere uma lista de tarefas.
Atualizar lote de comunicações
Atualiza um lote de comunicações.
Arquivar lote de comunicações
Arquiva um lote de comunicações por ID.
Criar um lote de comunicações
Cria um lote de comunicações.
Obter lote de comunicações
Recupera um lote de comunicações por ID interno ou valores de propriedade exclusivos.
Listar comunicações
Recupera uma página de comunicações. Controle o que é retornado através do properties parâmetro de consulta.
Criar comunicação
Cria uma comunicação com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID.
Obter comunicação
Recupera um objeto identificado por communicationId.
communicationId refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. Controle o que é retornado através do properties parâmetro de consulta.
Comunicação de arquivo
Move um objeto identificado por communicationId para a lixeira.
Atualizar comunicação
Executa uma atualização parcial de um objeto identificado por communicationId.
communicationId refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. 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.
Mesclar duas comunicações
Mescla duas comunicações com o mesmo tipo.
Eliminar uma comunicação - RGPD
Elimina permanentemente uma comunicação e todo o conteúdo associado para seguir o RGPD. Use a propriedade idProperty opcional 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.
Pesquisar comunicações
Recupere uma lista de comunicações.
Problemas conhecidos e limitações
Não há problemas conhecidos no momento.
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 (na forma 'YOUR_ACCESS_TOKEN ao portador') | securestring | O token de acesso (no formato 'Bearer YOUR_ACCESS_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
| Arquivar e-mail |
Move um objeto identificado por 'emailId' para a lixeira. |
| Arquivar lote de chamadas |
Arquiva um lote de chamadas por ID. |
| Arquivar lote de comunicações |
Arquiva um lote de comunicações por ID. |
| Arquivar lote de e-mails |
Arquiva um lote de e-mails por ID. |
| Arquivar lote de reuniões |
Arquiva um lote de reuniões por ID. |
| Arquivar lote de tarefas |
Arquiva um lote de tarefas por ID. |
| Arquivar um objeto |
Move um objeto identificado por 'callId' para a lixeira. |
| Arquivo de correio postal |
Move um objeto identificado por 'postalMailId' para a lixeira. |
| Atualizar comunicação |
Executa uma atualização parcial de um objeto identificado por 'communicationId'. 'communicationId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo |
| Atualizar correio postal |
Executa uma atualização parcial de um objeto identificado por 'postalMailId'. 'postalMailId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo |
| Atualizar e-mail |
Executa uma atualização parcial de um objeto identificado por 'emailId'. 'emailId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo |
| Atualizar lote de chamadas |
Atualiza um lote de chamadas. |
| Atualizar lote de comunicações |
Atualiza um lote de comunicações. |
| Atualizar lote de correio postal |
Atualiza um lote de correio postal. |
| Atualizar lote de e-mails |
Atualiza um lote de e-mails. |
| Atualizar lote de notas |
Atualiza um lote de notas. |
| Atualizar lote de reuniões |
Atualiza um lote de reuniões. |
| Atualizar lote de tarefas |
Atualiza um lote de tarefas. |
| Atualizar reunião |
Executa uma atualização parcial de um objeto identificado por 'meetingId'. 'meetingId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo |
| Atualizar um objeto |
Executa uma atualização parcial de um objeto identificado por 'callId'. 'callId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de |
| Comunicação de arquivo |
Move um objeto identificado por 'communicationId' para a lixeira. |
| Criar comunicação |
Cria uma comunicação com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID. |
| Criar correio postal |
Cria uma mensagem postal com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID. |
| Criar lote de chamadas |
Cria um lote de chamadas. |
| Criar nota |
Cria uma nota com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID. |
| Criar reunião |
Cria uma reunião com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID. |
| Criar tarefa |
Cria uma tarefa com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID. Documentação e exemplos para a criação de tarefas padrão são fornecidos. |
| Criar um e-mail |
Cria um e-mail com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID. |
| Criar um lote de comunicações |
Cria um lote de comunicações. |
| Criar um lote de correio postal |
Cria um lote de correio postal. |
| Criar um lote de e-mails |
Cria um lote de e-mails. |
| Criar um lote de notas |
Cria um lote de notas. |
| Criar um lote de reuniões |
Cria um lote de reuniões. |
| Criar um lote de tarefas |
Cria um lote de tarefas. |
| Criar uma chamada |
Cria uma chamada com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID. |
| Eliminar um correio postal - RGPD |
Exclui permanentemente um e-mail postal e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'idProperty' 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 uma chamada - RGPD |
Exclui permanentemente uma chamada e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'idProperty' 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 uma comunicação - RGPD |
Elimina permanentemente uma comunicação e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'idProperty' 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 uma nota - RGPD |
Exclui permanentemente uma nota e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'idProperty' 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 uma reunião - RGPD |
Exclui permanentemente uma reunião e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'idProperty' 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 uma tarefa - RGPD |
Exclui permanentemente uma tarefa e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'idProperty' 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 e-mail - GDPR |
Exclui permanentemente um e-mail e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'idProperty' 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. |
| Ler um objeto |
Recupera um objeto identificado por 'callId'. 'callId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de |
| Listar chamadas |
Recupera uma página de chamadas. Controle o que é retornado através do |
| Listar comunicações |
Recupera uma página de comunicações. Controle o que é retornado através do |
| Listar correio postal |
Recupera uma página de correio postal. Controle o que é retornado através do |
| Listar e-mails |
Recupera uma página de e-mails. Controle o que é retornado através do |
| Listar notas |
Recupera uma página de anotações. Controle o que é retornado através do |
| Listar reuniões |
Recupera uma página de reuniões. Controle o que é retornado através do |
| Listar tarefas |
Recupera uma página de tarefas. Controle o que é retornado através do |
| Lote de arquivo de correio postal |
Arquiva um lote de correio postal por ID. |
| Lote de arquivo de notas |
Arquiva um lote de notas por ID. |
| Mesclar dois correios |
Mescla duas correspondências postais com o mesmo tipo. |
| Mesclar dois e-mails |
Mescla dois e-mails com o mesmo tipo. |
| Mesclar duas chamadas |
Mescla duas chamadas com o mesmo tipo. |
| Mesclar duas comunicações |
Mescla duas comunicações com o mesmo tipo. |
| Mesclar duas notas |
Mescla duas notas com o mesmo tipo. |
| Mesclar duas reuniões |
Mescla duas reuniões com o mesmo tipo. |
| Mesclar duas tarefas |
Mescla duas tarefas com o mesmo tipo. |
| Nota de arquivo |
Move um objeto identificado por 'noteId' para a lixeira. |
| Nota de atualização |
Executa uma atualização parcial de um objeto identificado por 'noteId'. 'noteId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo |
| Obtenha um lote de reuniões |
Recupera um lote de reuniões por ID interna ou valores de propriedade exclusivos. |
| Obter comunicação |
Recupera um objeto identificado por 'communicationId'. 'communicationId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo |
| Obter correio postal |
Recupera um objeto identificado por 'postalMailId'. 'postalMailId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo |
| Obter lote de comunicações |
Recupera um lote de comunicações por ID interno ou valores de propriedade exclusivos. |
| Obter lote de correio postal |
Recupera um lote de correio postal por ID interna ou valores de propriedade exclusivos. |
| Obter lote de notas |
Recupera um lote de notas por ID interno ou valores de propriedade exclusivos. |
| Obter lote de tarefas |
Recupera um lote de tarefas por ID interna ou valores de propriedade exclusivos. |
| Obter reunião |
Recupera um objeto identificado por 'meetingId'. 'meetingId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo |
| Obter tarefa |
Recupera um objeto identificado por 'taskId'. 'taskId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo |
| Pesquisar chamadas |
Recupera uma lista de chamadas. |
| Pesquisar comunicações |
Recupere uma lista de comunicações. |
| Pesquisar correio postal |
Recupere uma lista de correio postal. |
| Pesquisar e-mail |
Recupere uma lista de e-mails. |
| Pesquisar notas |
Recupera uma lista de anotações. |
| Pesquisar reuniões |
Recuperar uma lista de reuniões. |
| Receba nota |
Recupera um objeto identificado por 'noteId'. 'noteId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo |
| Receba um lote de chamadas |
Recupera um lote de chamadas por ID interna ou valores de propriedade exclusivos. |
| Receba um lote de e-mails |
Recupera um lote de e-mails por ID interno ou valores de propriedade exclusivos. |
| Receber e-mail |
Recupera um objeto identificado por 'emailId'. 'emailId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo |
| Reunião de arquivo |
Move um objeto identificado por 'meetingId' para a lixeira. |
| Tarefa de arquivamento |
Move um objeto identificado por 'taskId' para a lixeira. |
| Tarefa de atualização |
Executa uma atualização parcial de um objeto identificado por 'taskId'. 'taskId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo |
| Tarefas de pesquisa |
Recupere uma lista de tarefas. |
Arquivar e-mail
Move um objeto identificado por 'emailId' para a lixeira.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de E-mail
|
emailId | True | string |
O identificador de e-mail. |
Devoluções
- response
- string
Arquivar lote de chamadas
Arquiva um lote de chamadas por ID.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Devoluções
- response
- string
Arquivar lote de comunicações
Arquiva um lote de comunicações por ID.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Devoluções
- response
- string
Arquivar lote de e-mails
Arquiva um lote de e-mails por ID.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Devoluções
- response
- string
Arquivar lote de reuniões
Arquiva um lote de reuniões por ID.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Devoluções
- response
- string
Arquivar lote de tarefas
Arquiva um lote de tarefas por ID.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Devoluções
- response
- string
Arquivar um objeto
Move um objeto identificado por 'callId' para a lixeira.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da chamada
|
callId | True | string |
O identificador de chamada. |
Devoluções
- response
- string
Arquivo de correio postal
Move um objeto identificado por 'postalMailId' para a lixeira.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do correio postal
|
postalMailId | True | string |
O identificador do correio postal. |
Devoluções
- response
- string
Atualizar comunicação
Executa uma atualização parcial de um objeto identificado por 'communicationId'. 'communicationId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo idProperty parâmetro de consulta. 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 comunicação
|
communicationId | True | string |
O identificador de comunicaçã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 correio postal
Executa uma atualização parcial de um objeto identificado por 'postalMailId'. 'postalMailId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo idProperty parâmetro de consulta. 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 correio postal
|
postalMailId | True | string |
O identificador do correio postal. |
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 e-mail
Executa uma atualização parcial de um objeto identificado por 'emailId'. 'emailId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo idProperty parâmetro de consulta. 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 E-mail
|
emailId | True | string |
O identificador de e-mail. |
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 lote de chamadas
Atualiza um lote de chamadas.
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 lote de comunicações
Atualiza um lote de comunicaçõ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 lote de correio postal
Atualiza um lote de correio postal.
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 lote de e-mails
Atualiza um lote de e-mails.
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 lote de notas
Atualiza um lote de notas.
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 lote de reuniões
Atualiza um lote de reuniõ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 lote de tarefas
Atualiza um lote de tarefas.
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 reunião
Executa uma atualização parcial de um objeto identificado por 'meetingId'. 'meetingId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo idProperty parâmetro de consulta. 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 reunião
|
meetingId | True | string |
O identificador da reuniã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 objeto
Executa uma atualização parcial de um objeto identificado por 'callId'. 'callId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. 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 chamada
|
callId | True | string |
O identificador de chamada. |
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. |
Comunicação de arquivo
Move um objeto identificado por 'communicationId' para a lixeira.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de comunicação
|
communicationId | True | string |
O identificador de comunicação. |
Devoluções
- response
- string
Criar comunicação
Cria uma comunicação com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID.
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 correio postal
Cria uma mensagem postal com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID.
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 lote de chamadas
Cria um lote de chamadas.
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 nota
Cria uma nota com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID.
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 reunião
Cria uma reunião com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID.
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 tarefa
Cria uma tarefa com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID. Documentação e exemplos para a criação de tarefas padrão são fornecidos.
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 e-mail
Cria um e-mail com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID.
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 comunicações
Cria um lote de comunicaçõ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 correio postal
Cria um lote de correio postal.
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 e-mails
Cria um lote de e-mails.
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 notas
Cria um lote de notas.
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 reuniões
Cria um lote de reuniõ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 tarefas
Cria um lote de tarefas.
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 uma chamada
Cria uma chamada com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID.
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 correio postal - RGPD
Exclui permanentemente um e-mail postal e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'idProperty' 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 uma chamada - RGPD
Exclui permanentemente uma chamada e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'idProperty' 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 uma comunicação - RGPD
Elimina permanentemente uma comunicação e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'idProperty' 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 uma nota - RGPD
Exclui permanentemente uma nota e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'idProperty' 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 uma reunião - RGPD
Exclui permanentemente uma reunião e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'idProperty' 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 uma tarefa - RGPD
Exclui permanentemente uma tarefa e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'idProperty' 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 e-mail - GDPR
Exclui permanentemente um e-mail e todo o conteúdo associado para seguir o GDPR. Use a propriedade opcional 'idProperty' 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
Ler um objeto
Recupera um objeto identificado por 'callId'. 'callId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. Controle o que é retornado através do properties parâmetro de consulta.
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 arquivado. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade identifier. |
|
|
ID da chamada
|
callId | True | string |
O identificador de chamada. |
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. |
Listar chamadas
Recupera uma página de chamadas. Controle o que é retornado através do properties parâmetro de consulta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Limite
|
limit | integer |
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 arquivado. |
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 |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Listar comunicações
Recupera uma página de comunicações. Controle o que é retornado através do properties parâmetro de consulta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Limite
|
limit | integer |
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 arquivado. |
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 |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Listar correio postal
Recupera uma página de correio postal. Controle o que é retornado através do properties parâmetro de consulta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Limite
|
limit | integer |
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 arquivado. |
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 |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Listar e-mails
Recupera uma página de e-mails. Controle o que é retornado através do properties parâmetro de consulta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Limite
|
limit | integer |
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 arquivado. |
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 |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Listar notas
Recupera uma página de anotações. Controle o que é retornado através do properties parâmetro de consulta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Limite
|
limit | integer |
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 arquivado. |
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 |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Listar reuniões
Recupera uma página de reuniões. Controle o que é retornado através do properties parâmetro de consulta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Limite
|
limit | integer |
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 arquivado. |
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 |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Listar tarefas
Recupera uma página de tarefas. Controle o que é retornado através do properties parâmetro de consulta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Limite
|
limit | integer |
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 arquivado. |
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 |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Lote de arquivo de correio postal
Arquiva um lote de correio postal por ID.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Devoluções
- response
- string
Lote de arquivo de notas
Arquiva um lote de notas por ID.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Devoluções
- response
- string
Mesclar dois correios
Mescla duas correspondências postais com o mesmo tipo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do 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 e-mails
Mescla dois e-mails com o mesmo tipo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do 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 chamadas
Mescla duas chamadas com o mesmo tipo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do 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 comunicações
Mescla duas comunicações com o mesmo tipo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do 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 notas
Mescla duas notas com o mesmo tipo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do 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 reuniões
Mescla duas reuniões com o mesmo tipo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do 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 tarefas
Mescla duas tarefas com o mesmo tipo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do 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. |
Nota de arquivo
Move um objeto identificado por 'noteId' para a lixeira.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da nota
|
noteId | True | string |
O identificador da nota. |
Devoluções
- response
- string
Nota de atualização
Executa uma atualização parcial de um objeto identificado por 'noteId'. 'noteId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo idProperty parâmetro de consulta. 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 nota
|
noteId | True | string |
O identificador da nota. |
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 reuniões
Recupera um lote de reuniões por ID interna ou valores de propriedade exclusivos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Arquivado
|
archived | boolean |
Se arquivado. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Imóveis com história
|
propertiesWithHistory | array of string |
Os imóveis com história. |
|
|
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 comunicação
Recupera um objeto identificado por 'communicationId'. 'communicationId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo idProperty parâmetro de consulta. Controle o que é retornado através do properties parâmetro de consulta.
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 arquivado. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade identifier. |
|
|
ID de comunicação
|
communicationId | True | string |
O identificador de comunicaçã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. |
Obter correio postal
Recupera um objeto identificado por 'postalMailId'. 'postalMailId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo idProperty parâmetro de consulta. Controle o que é retornado através do properties parâmetro de consulta.
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 arquivado. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade identifier. |
|
|
ID do correio postal
|
postalMailId | True | string |
O identificador do correio postal. |
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 lote de comunicações
Recupera um lote de comunicações por ID interno ou valores de propriedade exclusivos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Arquivado
|
archived | boolean |
Se arquivado. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Imóveis com história
|
propertiesWithHistory | array of string |
Os imóveis com história. |
|
|
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 lote de correio postal
Recupera um lote de correio postal por ID interna ou valores de propriedade exclusivos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Arquivado
|
archived | boolean |
Se arquivado. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Imóveis com história
|
propertiesWithHistory | array of string |
Os imóveis com história. |
|
|
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 lote de notas
Recupera um lote de notas por ID interno ou valores de propriedade exclusivos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Arquivado
|
archived | boolean |
Se arquivado. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Imóveis com história
|
propertiesWithHistory | array of string |
Os imóveis com história. |
|
|
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 lote de tarefas
Recupera um lote de tarefas por ID interna ou valores de propriedade exclusivos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Arquivado
|
archived | boolean |
Se arquivado. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Imóveis com história
|
propertiesWithHistory | array of string |
Os imóveis com história. |
|
|
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 reunião
Recupera um objeto identificado por 'meetingId'. 'meetingId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo idProperty parâmetro de consulta. Controle o que é retornado através do properties parâmetro de consulta.
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 arquivado. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade identifier. |
|
|
ID da reunião
|
meetingId | True | string |
O identificador da reuniã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. |
Obter tarefa
Recupera um objeto identificado por 'taskId'. 'taskId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo idProperty parâmetro de consulta. Controle o que é retornado através do properties parâmetro de consulta.
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 arquivado. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade identifier. |
|
|
ID da tarefa
|
taskId | True | string |
O identificador da tarefa. |
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 chamadas
Recupera uma lista de chamadas.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Depois
|
after | string |
O depois. |
|
|
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 |
As propriedades. |
|
|
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 | integer |
O total. |
|
Depois
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Pesquisar comunicações
Recupere uma lista de comunicações.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Depois
|
after | string |
O depois. |
|
|
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 |
As propriedades. |
|
|
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 | integer |
O total. |
|
Depois
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Pesquisar correio postal
Recupere uma lista de correio postal.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Depois
|
after | string |
O depois. |
|
|
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 |
As propriedades. |
|
|
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 | integer |
O total. |
|
Depois
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Pesquisar e-mail
Recupere uma lista de e-mails.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Depois
|
after | string |
O depois. |
|
|
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 |
As propriedades. |
|
|
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 | integer |
O total. |
|
Depois
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Pesquisar notas
Recupera uma lista de anotações.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Depois
|
after | string |
O depois. |
|
|
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 |
As propriedades. |
|
|
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 | integer |
O total. |
|
Depois
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Pesquisar reuniões
Recuperar uma lista de reuniões.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Depois
|
after | string |
O depois. |
|
|
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 |
As propriedades. |
|
|
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 | integer |
O total. |
|
Depois
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Receba nota
Recupera um objeto identificado por 'noteId'. 'noteId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo idProperty parâmetro de consulta. Controle o que é retornado através do properties parâmetro de consulta.
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 arquivado. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade identifier. |
|
|
ID da nota
|
noteId | True | string |
O identificador da nota. |
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. |
Receba um lote de chamadas
Recupera um lote de chamadas por ID interna ou valores de propriedade exclusivos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Arquivado
|
archived | boolean |
Se arquivado. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Imóveis com história
|
propertiesWithHistory | array of string |
Os imóveis com história. |
|
|
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. |
Receba um lote de e-mails
Recupera um lote de e-mails por ID interno ou valores de propriedade exclusivos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Arquivado
|
archived | boolean |
Se arquivado. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Imóveis com história
|
propertiesWithHistory | array of string |
Os imóveis com história. |
|
|
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. |
Receber e-mail
Recupera um objeto identificado por 'emailId'. 'emailId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo idProperty parâmetro de consulta. Controle o que é retornado através do properties parâmetro de consulta.
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 arquivado. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade identifier. |
|
|
ID de E-mail
|
emailId | True | string |
O identificador de e-mail. |
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. |
Reunião de arquivo
Move um objeto identificado por 'meetingId' para a lixeira.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da reunião
|
meetingId | True | string |
O identificador da reunião. |
Devoluções
- response
- string
Tarefa de arquivamento
Move um objeto identificado por 'taskId' para a lixeira.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da tarefa
|
taskId | True | string |
O identificador da tarefa. |
Devoluções
- response
- string
Tarefa de atualização
Executa uma atualização parcial de um objeto identificado por 'taskId'. 'taskId' refere-se ao ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo idProperty parâmetro de consulta. 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 tarefa
|
taskId | True | string |
O identificador da tarefa. |
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. |
Tarefas de pesquisa
Recupere uma lista de tarefas.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Depois
|
after | string |
O depois. |
|
|
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 |
As propriedades. |
|
|
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 | integer |
O total. |
|
Depois
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Definições
cadeia (de caracteres)
Este é o tipo de dados básico 'string'.