HubSpot Engagements V2 (Editor Independente) (versão prévia)
O HubSpot Engagements é usado para manter seus registros CRM up-to-date em quaisquer interações que ocorram fora do HubSpot. O relatório de atividades no CRM também se alimenta desses dados.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Publicador | Troy Taylor |
| Site | https://www.hubspot.com/products/crm |
| Política de privacidade | https://legal.hubspot.com/privacy-policy |
| Categorias | Vendas e CRM; Comunicação |
HubSpot Engagements V2
O HubSpot Engagements é usado para manter seus registros CRM up-to-date em quaisquer interações que ocorram fora do HubSpot. O relatório de atividades no CRM também se alimenta desses dados.
Publicador: Troy Taylor, Hitachi Solutions
Pré-requisitos
Você deve ter uma conta com o HubSpot e ser um Super Administrador.
Obtendo credenciais
Depois de fazer logon em sua conta, vá para Configurações –> Configuração da Conta –> Integrações –> Aplicativos Privados. Você precisará criar um aplicativo privado e atribuí-lo apenas aos escopos para os quais 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 com suporte
Criar lote de chamadas
Cria um lote de chamadas.
Obter 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. Controlar o que é retornado por meio 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 à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo idProperty parâmetro de consulta. Controlar o que é retornado por meio do properties parâmetro de consulta.
Arquivar um objeto
Move um objeto identificado pela callId lixeira.
Atualizar um objeto
Executa uma atualização parcial de um objeto identificado por callId.
callId refere-se à 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. As 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.
Excluir uma chamada – RGPD
Exclui permanentemente uma chamada e todo o conteúdo associado para seguir o RGPD. Use a propriedade idProperty opcional definida para email identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Chamadas de pesquisa
Recupera uma lista de chamadas.
Criar um lote de emails
Cria um lote de emails.
Obter lote de emails
Recupera um lote de emails por ID interna ou valores de propriedade exclusivos.
Arquivar lote de emails
Arquiva um lote de emails por ID.
Atualizar lote de emails
Atualiza um lote de emails.
Listar e-mails
Recupera uma página de emails. Controlar o que é retornado por meio do properties parâmetro de consulta.
Criar um email
Cria um email com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID.
Obter email
Recupera um objeto identificado por emailId.
emailId refere-se à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo idProperty parâmetro de consulta. Controlar o que é retornado por meio do properties parâmetro de consulta.
Arquivar email
Move um objeto identificado pela emailId lixeira.
Atualizar email
Executa uma atualização parcial de um objeto identificado por emailId.
emailId refere-se à 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. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Mesclar dois emails
Mescla dois emails com o mesmo tipo.
Excluir um email – RGPD
Exclui permanentemente um email e todo o conteúdo associado para seguir o RGPD. Use a propriedade idProperty opcional definida para email identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Pesquisar email
Recupere uma lista de emails.
Atualizar lote de reuniões
Atualiza um lote de reuniões.
Arquivar lote de reuniões
Arquiva um lote de reuniões por ID.
Obter 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 à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo idProperty parâmetro de consulta. Controlar o que é retornado por meio do properties parâmetro de consulta.
Arquivar reunião
Move um objeto identificado pela meetingId lixeira.
Atualizar reunião
Executa uma atualização parcial de um objeto identificado por meetingId.
meetingId refere-se à 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. As 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. Controlar o que é retornado por meio 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.
Excluir uma reunião – RGPD
Exclui permanentemente uma reunião e todo o conteúdo associado para seguir o RGPD. Use a propriedade idProperty opcional definida para email identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Pesquisar reuniões
Recupere uma lista de reuniões.
Obter o lote de anotações
Recupera um lote de anotações por ID interna ou valores de propriedade exclusivos.
Arquivar lote de anotações
Arquiva um lote de anotações por ID.
Atualizar lote de anotações
Atualiza um lote de anotações.
Criar um lote de anotações
Cria um lote de anotações.
Listar notas
Recupera uma página de anotações. Controlar o que é retornado por meio do properties parâmetro de consulta.
Criar nota
Cria uma anotação com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID.
Obter nota
Recupera um objeto identificado por noteId.
noteId refere-se à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo idProperty parâmetro de consulta. Controlar o que é retornado por meio do properties parâmetro de consulta.
Anotação de arquivo morto
Move um objeto identificado pela noteId lixeira.
Anotação de atualização
Executa uma atualização parcial de um objeto identificado por noteId.
noteId refere-se à 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. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Mesclar duas anotações
Mescla duas anotações com o mesmo tipo.
Excluir uma nota – RGPD
Exclui permanentemente uma anotação e todo o conteúdo associado para seguir o RGPD. Use a propriedade idProperty opcional definida para email identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Anotações de pesquisa
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.
Arquivar lote 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. Controlar o que é retornado por meio do properties parâmetro de consulta.
Criar correio postal
Cria um correio 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 à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo idProperty parâmetro de consulta. Controlar o que é retornado por meio do properties parâmetro de consulta.
Arquivar correio postal
Move um objeto identificado pela postalMailId lixeira.
Atualizar correio postal
Executa uma atualização parcial de um objeto identificado por postalMailId.
postalMailId refere-se à 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. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Mesclar dois correios postais
Mescla dois correios postais com o mesmo tipo.
Excluir um correio postal – RGPD
Exclui permanentemente um correio postal e todo o conteúdo associado para seguir o RGPD. Use a propriedade idProperty opcional definida para email identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele 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 à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo idProperty parâmetro de consulta. Controlar o que é retornado por meio do properties parâmetro de consulta.
Tarefa arquivar
Move um objeto identificado pela taskId lixeira.
Atualizar tarefa
Executa uma atualização parcial de um objeto identificado por taskId.
taskId refere-se à 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. As 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. Controlar o que é retornado por meio 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. A documentação e os exemplos para a criação de tarefas padrão são fornecidos.
Mesclar duas tarefas
Mescla duas tarefas com o mesmo tipo.
Excluir uma tarefa – RGPD
Exclui permanentemente uma tarefa e todo o conteúdo associado para seguir o RGPD. Use a propriedade idProperty opcional definida para email identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele 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 interna ou valores de propriedade exclusivos.
Listar comunicações
Recupera uma página de comunicações. Controlar o que é retornado por meio 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 à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo idProperty parâmetro de consulta. Controlar o que é retornado por meio do properties parâmetro de consulta.
Comunicação de arquivo morto
Move um objeto identificado pela communicationId lixeira.
Atualizar comunicação
Executa uma atualização parcial de um objeto identificado por communicationId.
communicationId refere-se à 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. As 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.
Excluir uma comunicação – RGPD
Exclui permanentemente uma comunicação e todo o conteúdo associado para seguir o RGPD. Use a propriedade idProperty opcional definida para email identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Pesquisar comunicações
Recupere uma lista de comunicações.
Problemas e limitações conhecidos
Não há problemas conhecidos no momento.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Token de Acesso (no formato 'Portador YOUR_ACCESS_TOKEN') | secureString | O Token de Acesso (no formato 'Bearer YOUR_ACCESS_TOKEN') para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Anotação de arquivo morto |
Move um objeto identificado por 'noteId' para a lixeira. |
| Anotação de atualização |
Executa uma atualização parcial de um objeto identificado por 'noteId'. 'noteId' refere-se à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de |
| Anotações de pesquisa |
Recupera uma lista de anotações. |
| Arquivar correio postal |
Move um objeto identificado por 'postalMailId' para a lixeira. |
| Arquivar email |
Move um objeto identificado por 'emailId' para a lixeira. |
| Arquivar lote de anotações |
Arquiva um lote de anotações por ID. |
| 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 correio postal |
Arquiva um lote de correio postal por ID. |
| Arquivar lote de emails |
Arquiva um lote de emails 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 reunião |
Move um objeto identificado por 'meetingId' para a lixeira. |
| Arquivar um objeto |
Move um objeto identificado por 'callId' para a lixeira. |
| Atualizar comunicação |
Executa uma atualização parcial de um objeto identificado por 'communicationId'. 'communicationId' refere-se à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de |
| Atualizar correio postal |
Executa uma atualização parcial de um objeto identificado por 'postalMailId'. 'postalMailId' refere-se à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de |
| Atualizar email |
Executa uma atualização parcial de um objeto identificado por 'emailId'. 'emailId' refere-se à ID do objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de |
| Atualizar lote de anotações |
Atualiza um lote de anotações. |
| 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 emails |
Atualiza um lote de emails. |
| 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 à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de |
| Atualizar tarefa |
Executa uma atualização parcial de um objeto identificado por 'taskId'. 'taskId' refere-se à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de |
| Atualizar um objeto |
Executa uma atualização parcial de um objeto identificado por 'callId'. 'callId' refere-se à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de |
| Chamadas de pesquisa |
Recupera uma lista de chamadas. |
| Comunicação de arquivo morto |
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 um correio 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 anotação 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. A documentação e os exemplos para a criação de tarefas padrão são fornecidos. |
| Criar um email |
Cria um email com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID. |
| Criar um lote de anotações |
Cria um lote de anotações. |
| 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 emails |
Cria um lote de emails. |
| 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. |
| Excluir um correio postal – RGPD |
Exclui permanentemente um correio postal 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 email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Excluir um email – RGPD |
Exclui permanentemente um email 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 email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Excluir uma chamada – RGPD |
Exclui permanentemente uma chamada 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 email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Excluir uma comunicação – RGPD |
Exclui 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 email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Excluir uma nota – RGPD |
Exclui permanentemente uma anotaçã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 email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Excluir uma reunião – RGPD |
Exclui permanentemente uma reuniã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 email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Excluir uma tarefa – RGPD |
Exclui permanentemente uma tarefa 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 email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Ler um objeto |
Recupera um objeto identificado por 'callId'. 'callId' refere-se à 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. Controlar o que é retornado por meio do |
| Listar comunicações |
Recupera uma página de comunicações. Controlar o que é retornado por meio do |
| Listar correio postal |
Recupera uma página de correio postal. Controlar o que é retornado por meio do |
| Listar e-mails |
Recupera uma página de emails. Controlar o que é retornado por meio do |
| Listar notas |
Recupera uma página de anotações. Controlar o que é retornado por meio do |
| Listar reuniões |
Recupera uma página de reuniões. Controlar o que é retornado por meio do |
| Listar tarefas |
Recupera uma página de tarefas. Controlar o que é retornado por meio do |
| Mesclar dois correios postais |
Mescla dois correios postais com o mesmo tipo. |
| Mesclar dois emails |
Mescla dois emails com o mesmo tipo. |
| Mesclar duas anotações |
Mescla duas anotações 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 reuniões |
Mescla duas reuniões com o mesmo tipo. |
| Mesclar duas tarefas |
Mescla duas tarefas com o mesmo tipo. |
| Obter comunicação |
Recupera um objeto identificado por 'communicationId'. 'communicationId' refere-se à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de |
| Obter correio postal |
Recupera um objeto identificado por 'postalMailId'. 'postalMailId' refere-se à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de |
| Obter email |
Recupera um objeto identificado por 'emailId'. 'emailId' refere-se à ID do objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de |
| Obter lote de chamadas |
Recupera um lote de chamadas por ID interna ou valores de propriedade exclusivos. |
| Obter lote de comunicações |
Recupera um lote de comunicações por ID interna 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 emails |
Recupera um lote de emails por ID interna ou valores de propriedade exclusivos. |
| Obter lote de reuniões |
Recupera um lote de reuniões por ID interna ou valores de propriedade exclusivos. |
| Obter lote de tarefas |
Recupera um lote de tarefas por ID interna ou valores de propriedade exclusivos. |
| Obter nota |
Recupera um objeto identificado por 'noteId'. 'noteId' refere-se à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de |
| Obter o lote de anotações |
Recupera um lote de anotações por ID interna ou valores de propriedade exclusivos. |
| Obter reunião |
Recupera um objeto identificado por 'meetingId'. 'meetingId' refere-se à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de |
| Obter tarefa |
Recupera um objeto identificado por 'taskId'. 'taskId' refere-se à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de |
| Pesquisar comunicações |
Recupere uma lista de comunicações. |
| Pesquisar correio postal |
Recupere uma lista de correio postal. |
| Pesquisar email |
Recupere uma lista de emails. |
| Pesquisar reuniões |
Recupere uma lista de reuniões. |
| Tarefa arquivar |
Move um objeto identificado por 'taskId' para a lixeira. |
| Tarefas de pesquisa |
Recupere uma lista de tarefas. |
Anotação de arquivo morto
Move um objeto identificado por 'noteId' para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da anotação
|
noteId | True | string |
O identificador de anotação. |
Retornos
- response
- string
Anotação de atualização
Executa uma atualização parcial de um objeto identificado por 'noteId'. 'noteId' refere-se à 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. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID da anotação
|
noteId | True | string |
O identificador de anotação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Anotações de pesquisa
Recupera uma lista de anotações.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
O depois. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | integer |
O total. |
|
Após
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Arquivar correio postal
Move um objeto identificado por 'postalMailId' para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Postal Mail ID
|
postalMailId | True | string |
O identificador de correio postal. |
Retornos
- response
- string
Arquivar email
Move um objeto identificado por 'emailId' para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Email
|
emailId | True | string |
O identificador de email. |
Retornos
- response
- string
Arquivar lote de anotações
Arquiva um lote de anotações por ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar lote de chamadas
Arquiva um lote de chamadas por ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar lote de comunicações
Arquiva um lote de comunicações por ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar lote de correio postal
Arquiva um lote de correio postal por ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar lote de emails
Arquiva um lote de emails por ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar lote de reuniões
Arquiva um lote de reuniões por ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar lote de tarefas
Arquiva um lote de tarefas por ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar reunião
Move um objeto identificado por 'meetingId' para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Reunião
|
meetingId | True | string |
O identificador da reunião. |
Retornos
- response
- string
Arquivar um objeto
Move um objeto identificado por 'callId' para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da chamada
|
callId | True | string |
O identificador de chamada. |
Retornos
- response
- string
Atualizar comunicação
Executa uma atualização parcial de um objeto identificado por 'communicationId'. 'communicationId' refere-se à 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. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID de comunicação
|
communicationId | True | string |
O identificador de comunicação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
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 à 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. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
Postal Mail ID
|
postalMailId | True | string |
O identificador de correio postal. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Atualizar email
Executa uma atualização parcial de um objeto identificado por 'emailId'. 'emailId' refere-se à ID do objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID do Email
|
emailId | True | string |
O identificador de email. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Atualizar lote de anotações
Atualiza um lote de anotações.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Atualizar lote de chamadas
Atualiza um lote de chamadas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Atualizar lote de emails
Atualiza um lote de emails.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Atualizar lote de tarefas
Atualiza um lote de tarefas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
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 à 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. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID da Reunião
|
meetingId | True | string |
O identificador da reunião. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Atualizar tarefa
Executa uma atualização parcial de um objeto identificado por 'taskId'. 'taskId' refere-se à 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. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID da Tarefa
|
taskId | True | string |
O identificador de tarefa. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
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 à 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. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID da chamada
|
callId | True | string |
O identificador de chamada. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Chamadas de pesquisa
Recupera uma lista de chamadas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
O depois. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | integer |
O total. |
|
Após
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Comunicação de arquivo morto
Move um objeto identificado por 'communicationId' para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de comunicação
|
communicationId | True | string |
O identificador de comunicação. |
Retornos
- 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
| Nome | Chave | Obrigató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. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Criar correio postal
Cria um correio postal com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID.
Parâmetros
| Nome | Chave | Obrigató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. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Criar lote de chamadas
Cria um lote de chamadas.
Parâmetros
| Nome | Chave | Obrigató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. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Criar nota
Cria uma anotação com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID.
Parâmetros
| Nome | Chave | Obrigató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. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
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
| Nome | Chave | Obrigató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. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
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. A documentação e os exemplos para a criação de tarefas padrão são fornecidos.
Parâmetros
| Nome | Chave | Obrigató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. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Criar um email
Cria um email com as propriedades fornecidas e retorna uma cópia do objeto, incluindo a ID.
Parâmetros
| Nome | Chave | Obrigató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. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Criar um lote de anotações
Cria um lote de anotações.
Parâmetros
| Nome | Chave | Obrigató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. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Criar um lote de comunicações
Cria um lote de comunicações.
Parâmetros
| Nome | Chave | Obrigató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. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
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
| Nome | Chave | Obrigató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. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Criar um lote de emails
Cria um lote de emails.
Parâmetros
| Nome | Chave | Obrigató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. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
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
| Nome | Chave | Obrigató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. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
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
| Nome | Chave | Obrigató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. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
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
| Nome | Chave | Obrigató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. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Excluir um correio postal – RGPD
Exclui permanentemente um correio postal 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 email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Excluir um email – RGPD
Exclui permanentemente um email 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 email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Excluir uma chamada – RGPD
Exclui permanentemente uma chamada 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 email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Excluir uma comunicação – RGPD
Exclui 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 email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Excluir uma nota – RGPD
Exclui permanentemente uma anotaçã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 email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Excluir uma reunião – RGPD
Exclui permanentemente uma reuniã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 email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Excluir uma tarefa – RGPD
Exclui permanentemente uma tarefa 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 email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Ler um objeto
Recupera um objeto identificado por 'callId'. 'callId' refere-se à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. Controlar o que é retornado por meio do properties parâmetro de consulta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID da chamada
|
callId | True | string |
O identificador de chamada. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Listar chamadas
Recupera uma página de chamadas. Controlar o que é retornado por meio do properties parâmetro de consulta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
O limite. |
|
|
Após
|
after | string |
O depois. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se arquivado. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Listar comunicações
Recupera uma página de comunicações. Controlar o que é retornado por meio do properties parâmetro de consulta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
O limite. |
|
|
Após
|
after | string |
O depois. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se arquivado. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Listar correio postal
Recupera uma página de correio postal. Controlar o que é retornado por meio do properties parâmetro de consulta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
O limite. |
|
|
Após
|
after | string |
O depois. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se arquivado. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Listar e-mails
Recupera uma página de emails. Controlar o que é retornado por meio do properties parâmetro de consulta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
O limite. |
|
|
Após
|
after | string |
O depois. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se arquivado. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Listar notas
Recupera uma página de anotações. Controlar o que é retornado por meio do properties parâmetro de consulta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
O limite. |
|
|
Após
|
after | string |
O depois. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se arquivado. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Listar reuniões
Recupera uma página de reuniões. Controlar o que é retornado por meio do properties parâmetro de consulta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
O limite. |
|
|
Após
|
after | string |
O depois. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se arquivado. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Listar tarefas
Recupera uma página de tarefas. Controlar o que é retornado por meio do properties parâmetro de consulta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
O limite. |
|
|
Após
|
after | string |
O depois. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se arquivado. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Mesclar dois correios postais
Mescla dois correios postais com o mesmo tipo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto a ser mesclada
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Mesclar dois emails
Mescla dois emails com o mesmo tipo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto a ser mesclada
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Mesclar duas anotações
Mescla duas anotações com o mesmo tipo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto a ser mesclada
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Mesclar duas chamadas
Mescla duas chamadas com o mesmo tipo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto a ser mesclada
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto a ser mesclada
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto a ser mesclada
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Mesclar duas tarefas
Mescla duas tarefas com o mesmo tipo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto a ser mesclada
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Obter comunicação
Recupera um objeto identificado por 'communicationId'. 'communicationId' refere-se à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. Controlar o que é retornado por meio do properties parâmetro de consulta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID de comunicação
|
communicationId | True | string |
O identificador de comunicação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Obter correio postal
Recupera um objeto identificado por 'postalMailId'. 'postalMailId' refere-se à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. Controlar o que é retornado por meio do properties parâmetro de consulta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
Postal Mail ID
|
postalMailId | True | string |
O identificador de correio postal. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Obter email
Recupera um objeto identificado por 'emailId'. 'emailId' refere-se à ID do objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. Controlar o que é retornado por meio do properties parâmetro de consulta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID do Email
|
emailId | True | string |
O identificador de email. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Obter lote de chamadas
Recupera um lote de chamadas por ID interna ou valores de propriedade exclusivos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Obter lote de comunicações
Recupera um lote de comunicações por ID interna ou valores de propriedade exclusivos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Obter lote de emails
Recupera um lote de emails por ID interna ou valores de propriedade exclusivos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Obter lote de reuniões
Recupera um lote de reuniões por ID interna ou valores de propriedade exclusivos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Obter nota
Recupera um objeto identificado por 'noteId'. 'noteId' refere-se à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. Controlar o que é retornado por meio do properties parâmetro de consulta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID da anotação
|
noteId | True | string |
O identificador de anotação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Obter o lote de anotações
Recupera um lote de anotações por ID interna ou valores de propriedade exclusivos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
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 à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. Controlar o que é retornado por meio do properties parâmetro de consulta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID da Reunião
|
meetingId | True | string |
O identificador da reunião. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Obter tarefa
Recupera um objeto identificado por 'taskId'. 'taskId' refere-se à ID do objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de idProperty consulta. Controlar o que é retornado por meio do properties parâmetro de consulta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID da Tarefa
|
taskId | True | string |
O identificador de tarefa. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Pesquisar comunicações
Recupere uma lista de comunicações.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
O depois. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | integer |
O total. |
|
Após
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Pesquisar correio postal
Recupere uma lista de correio postal.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
O depois. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | integer |
O total. |
|
Após
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Pesquisar email
Recupere uma lista de emails.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
O depois. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | integer |
O total. |
|
Após
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Pesquisar reuniões
Recupere uma lista de reuniões.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
O depois. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | integer |
O total. |
|
Após
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Tarefa arquivar
Move um objeto identificado por 'taskId' para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Tarefa
|
taskId | True | string |
O identificador de tarefa. |
Retornos
- response
- string
Tarefas de pesquisa
Recupere uma lista de tarefas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
O depois. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
As propriedades. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | 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. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | integer |
O total. |
|
Após
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Definições
cadeia
Esse é o tipo de dados básico 'string'.