HubSpot Engagements V2 (publicador independiente) (versión preliminar)
HubSpot Engagements se usa para mantener los registros de CRM up-to-date en cualquier interacción que se produzca fuera de HubSpot. Los informes de actividad de CRM también se alimentan de estos datos.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| Correo Electrónico | ttaylor@hitachisolutions.com |
| Metadatos del conector | |
|---|---|
| Publicador | Troy Taylor |
| Sitio web | https://www.hubspot.com/products/crm |
| Directiva de privacidad | https://legal.hubspot.com/privacy-policy |
| Categorías | Ventas y CRM; Comunicación |
HubSpot Engagements V2
HubSpot Engagements se usa para mantener los registros de CRM up-to-date en cualquier interacción que se produzca fuera de HubSpot. Los informes de actividad de CRM también se alimentan de estos datos.
Editor: Troy Taylor, Hitachi Solutions
Prerrequisitos
Debes tener una cuenta con HubSpot y ser superadministrador.
Obtención de credenciales
Una vez que haya iniciado sesión en su cuenta, vaya a Configuración -> Configuración de la cuenta -> Integraciones -> Aplicaciones privadas. Tendrá que crear una aplicación privada y asignarla solo los ámbitos para los que usará acciones. Una vez creada la aplicación privada, tendrá un token de acceso en la sección Autenticación de la aplicación privada.
Operaciones admitidas
Creación de un lote de llamadas
Crea un lote de llamadas.
Obtención de un lote de llamadas
Recupera un lote de llamadas por identificador interno o valores de propiedad únicos.
Actualización del lote de llamadas
Actualiza un lote de llamadas.
Archivar el lote de llamadas
Archiva un lote de llamadas por identificador.
Enumerar llamadas
Recupera una página de llamadas. Controle lo que se devuelve a través del parámetro de properties consulta.
Creación de una llamada
Crea una llamada con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador.
Leer un objeto
Recupera un objeto identificado por callId.
callId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Controle lo que se devuelve a través del parámetro de properties consulta.
Archivar un objeto
Mueve un objeto identificado por callId a la papelera de reciclaje.
Actualizar un objeto
Realiza una actualización parcial de un objeto identificado por callId.
callId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Combinar dos llamadas
Combina dos llamadas con el mismo tipo.
Eliminación de una llamada: RGPD
Elimina permanentemente una llamada y todo el contenido asociado para seguir el RGPD. Use la propiedad idProperty opcional establecida para email identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Llamadas de búsqueda
Recupera una lista de llamadas.
Creación de un lote de correos electrónicos
Crea un lote de correos electrónicos.
Obtención de lotes de correos electrónicos
Recupera un lote de correos electrónicos por identificador interno o valores de propiedad únicos.
Archivar lotes de correos electrónicos
Archiva un lote de correos electrónicos por identificador.
Actualizar lote de correos electrónicos
Actualiza un lote de correos electrónicos.
Enumerar correos electrónicos
Recupera una página de correos electrónicos. Controle lo que se devuelve a través del parámetro de properties consulta.
Crear un correo electrónico
Crea un correo electrónico con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador.
Obtener correo electrónico
Recupera un objeto identificado por emailId.
emailId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Controle lo que se devuelve a través del parámetro de properties consulta.
Archivar correo electrónico
Mueve un objeto identificado por emailId a la papelera de reciclaje.
Actualizar correo electrónico
Realiza una actualización parcial de un objeto identificado por emailId.
emailId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Combinar dos correos electrónicos
Combina dos correos electrónicos con el mismo tipo.
Eliminar un correo electrónico: RGPD
Elimina permanentemente un correo electrónico y todo el contenido asociado para seguir el RGPD. Use la propiedad idProperty opcional establecida para email identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Buscar correo electrónico
Recuperar una lista de correos electrónicos.
Actualización del lote de reuniones
Actualiza un lote de reuniones.
Archivar el lote de reuniones
Archiva un lote de reuniones por identificador.
Obtención de un lote de reuniones
Recupera un lote de reuniones por identificador interno o valores de propiedad únicos.
Creación de un lote de reuniones
Crea un lote de reuniones.
Obtener reunión
Recupera un objeto identificado por meetingId.
meetingId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Controle lo que se devuelve a través del parámetro de properties consulta.
Reunión de archivo
Mueve un objeto identificado por meetingId a la papelera de reciclaje.
Actualizar reunión
Realiza una actualización parcial de un objeto identificado por meetingId.
meetingId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Enumerar reuniones
Recupera una página de reuniones. Controle lo que se devuelve a través del parámetro de properties consulta.
Crear reunión
Crea una reunión con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador.
Combinar dos reuniones
Combina dos reuniones con el mismo tipo.
Eliminación de una reunión: RGPD
Elimina permanentemente una reunión y todo el contenido asociado para seguir el RGPD. Use la propiedad idProperty opcional establecida para email identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Buscar reuniones
Recuperar una lista de reuniones.
Obtención de un lote de notas
Recupera un lote de notas por identificador interno o valores de propiedad únicos.
Archivo por lotes de notas
Archiva un lote de notas por identificador.
Actualización del lote de notas
Actualiza un lote de notas.
Creación de un lote de notas
Crea un lote de notas.
Notas de la lista
Recupera una página de notas. Controle lo que se devuelve a través del parámetro de properties consulta.
Crear nota
Crea una nota con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador.
Obtener nota
Recupera un objeto identificado por noteId.
noteId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Controle lo que se devuelve a través del parámetro de properties consulta.
Nota de archivo
Mueve un objeto identificado por noteId a la papelera de reciclaje.
Actualizar nota
Realiza una actualización parcial de un objeto identificado por noteId.
noteId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Combinar dos notas
Combina dos notas con el mismo tipo.
Eliminar una nota: RGPD
Elimina permanentemente una nota y todo el contenido asociado para seguir el RGPD. Use la propiedad idProperty opcional establecida para email identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Buscar notas
Recupera una lista de notas.
Obtención del lote de correo postal
Recupera un lote de correo postal por identificador interno o valores de propiedad únicos.
Archivo por lotes de correo postal
Archiva un lote de correo postal por identificador.
Crear un lote de correo postal
Crea un lote de correo postal.
Actualización del lote de correo postal
Actualiza un lote de correo postal.
Enumerar correo postal
Recupera una página de correo postal. Controle lo que se devuelve a través del parámetro de properties consulta.
Crear correo postal
Crea un correo postal con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador.
Obtener correo postal
Recupera un objeto identificado por postalMailId.
postalMailId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Controle lo que se devuelve a través del parámetro de properties consulta.
Archivar correo postal
Mueve un objeto identificado por postalMailId a la papelera de reciclaje.
Actualizar correo postal
Realiza una actualización parcial de un objeto identificado por postalMailId.
postalMailId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Combinar dos correos postales
Combina dos correos postales con el mismo tipo.
Eliminar un correo postal: RGPD
Elimina permanentemente un correo postal y todo el contenido asociado para seguir el RGPD. Use la propiedad idProperty opcional establecida para email identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Buscar correo postal
Recuperar una lista de correo postal.
Archivar el lote de tareas
Archiva un lote de tareas por identificador.
Creación de un lote de tareas
Crea un lote de tareas.
Actualización del lote de tareas
Actualiza un lote de tareas.
Obtención de lotes de tareas
Recupera un lote de tareas por identificador interno o valores de propiedad únicos.
Obtener tarea
Recupera un objeto identificado por taskId.
taskId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Controle lo que se devuelve a través del parámetro de properties consulta.
Tarea Archivar
Mueve un objeto identificado por taskId a la papelera de reciclaje.
Actualizar tarea
Realiza una actualización parcial de un objeto identificado por taskId.
taskId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Enumerar tareas
Recupera una página de tareas. Controle lo que se devuelve a través del parámetro de properties consulta.
Crear tarea
Crea una tarea con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador. Se proporciona documentación y ejemplos para crear tareas estándar.
Combinar dos tareas
Combina dos tareas con el mismo tipo.
Eliminación de una tarea: RGPD
Elimina permanentemente una tarea y todo el contenido asociado para seguir el RGPD. Use la propiedad idProperty opcional establecida para email identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Tareas de búsqueda
Recuperar una lista de tareas.
Actualización del lote de comunicaciones
Actualiza un lote de comunicaciones.
Archivo por lotes de comunicaciones
Archiva un lote de comunicaciones por identificador.
Creación de un lote de comunicaciones
Crea un lote de comunicaciones.
Obtención del lote de comunicaciones
Recupera un lote de comunicaciones por identificador interno o valores de propiedad únicos.
Enumerar comunicaciones
Recupera una página de comunicaciones. Controle lo que se devuelve a través del parámetro de properties consulta.
Crear comunicación
Crea una comunicación con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador.
Obtener comunicación
Recupera un objeto identificado por communicationId.
communicationId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Controle lo que se devuelve a través del parámetro de properties consulta.
Comunicación de archivo
Mueve un objeto identificado por communicationId a la papelera de reciclaje.
Actualización de la comunicación
Realiza una actualización parcial de un objeto identificado por communicationId.
communicationId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Combinar dos comunicaciones
Combina dos comunicaciones con el mismo tipo.
Eliminar una comunicación: RGPD
Elimina permanentemente una comunicación y todo el contenido asociado para seguir el RGPD. Use la propiedad idProperty opcional establecida para email identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Buscar comunicaciones
Recuperar una lista de comunicaciones.
Problemas conocidos y limitaciones
No hay problemas conocidos en este momento.
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Token de acceso (en el formato "Bearer YOUR_ACCESS_TOKEN") | securestring | Token de acceso (con el formato "Bearer YOUR_ACCESS_TOKEN") para esta API | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualización de la comunicación |
Realiza una actualización parcial de un objeto identificado por "communicationId". "communicationId" hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de |
| Actualización del lote de comunicaciones |
Actualiza un lote de comunicaciones. |
| Actualización del lote de correo postal |
Actualiza un lote de correo postal. |
| Actualización del lote de llamadas |
Actualiza un lote de llamadas. |
| Actualización del lote de notas |
Actualiza un lote de notas. |
| Actualización del lote de reuniones |
Actualiza un lote de reuniones. |
| Actualización del lote de tareas |
Actualiza un lote de tareas. |
| Actualizar correo electrónico |
Realiza una actualización parcial de un objeto identificado por "emailId". "emailId" hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de |
| Actualizar correo postal |
Realiza una actualización parcial de un objeto identificado por "postalMailId". "postalMailId" hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de |
| Actualizar lote de correos electrónicos |
Actualiza un lote de correos electrónicos. |
| Actualizar nota |
Realiza una actualización parcial de un objeto identificado por "noteId". 'noteId' hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de |
| Actualizar reunión |
Realiza una actualización parcial de un objeto identificado por "meetingId". 'meetingId' hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de |
| Actualizar tarea |
Realiza una actualización parcial de un objeto identificado por "taskId". 'taskId' hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de |
| Actualizar un objeto |
Realiza una actualización parcial de un objeto identificado por "callId". 'callId' hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta |
| Archivar correo electrónico |
Mueve un objeto identificado por "emailId" a la papelera de reciclaje. |
| Archivar correo postal |
Mueve un objeto identificado por "postalMailId" a la papelera de reciclaje. |
| Archivar el lote de llamadas |
Archiva un lote de llamadas por identificador. |
| Archivar el lote de reuniones |
Archiva un lote de reuniones por identificador. |
| Archivar el lote de tareas |
Archiva un lote de tareas por identificador. |
| Archivar lotes de correos electrónicos |
Archiva un lote de correos electrónicos por identificador. |
| Archivar un objeto |
Mueve un objeto identificado por 'callId' a la papelera de reciclaje. |
| Archivo por lotes de comunicaciones |
Archiva un lote de comunicaciones por identificador. |
| Archivo por lotes de correo postal |
Archiva un lote de correo postal por identificador. |
| Archivo por lotes de notas |
Archiva un lote de notas por identificador. |
| Buscar comunicaciones |
Recuperar una lista de comunicaciones. |
| Buscar correo electrónico |
Recuperar una lista de correos electrónicos. |
| Buscar correo postal |
Recuperar una lista de correo postal. |
| Buscar notas |
Recupera una lista de notas. |
| Buscar reuniones |
Recuperar una lista de reuniones. |
| Combinar dos comunicaciones |
Combina dos comunicaciones con el mismo tipo. |
| Combinar dos correos electrónicos |
Combina dos correos electrónicos con el mismo tipo. |
| Combinar dos correos postales |
Combina dos correos postales con el mismo tipo. |
| Combinar dos llamadas |
Combina dos llamadas con el mismo tipo. |
| Combinar dos notas |
Combina dos notas con el mismo tipo. |
| Combinar dos reuniones |
Combina dos reuniones con el mismo tipo. |
| Combinar dos tareas |
Combina dos tareas con el mismo tipo. |
| Comunicación de archivo |
Mueve un objeto identificado por 'communicationId' a la papelera de reciclaje. |
| Creación de un lote de comunicaciones |
Crea un lote de comunicaciones. |
| Creación de un lote de correos electrónicos |
Crea un lote de correos electrónicos. |
| Creación de un lote de llamadas |
Crea un lote de llamadas. |
| Creación de un lote de notas |
Crea un lote de notas. |
| Creación de un lote de reuniones |
Crea un lote de reuniones. |
| Creación de un lote de tareas |
Crea un lote de tareas. |
| Creación de una llamada |
Crea una llamada con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador. |
| Crear comunicación |
Crea una comunicación con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador. |
| Crear correo postal |
Crea un correo postal con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador. |
| Crear nota |
Crea una nota con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador. |
| Crear reunión |
Crea una reunión con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador. |
| Crear tarea |
Crea una tarea con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador. Se proporciona documentación y ejemplos para crear tareas estándar. |
| Crear un correo electrónico |
Crea un correo electrónico con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador. |
| Crear un lote de correo postal |
Crea un lote de correo postal. |
| Eliminación de una llamada: RGPD |
Elimina permanentemente una llamada y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "idProperty" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Eliminación de una reunión: RGPD |
Elimina permanentemente una reunión y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "idProperty" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Eliminación de una tarea: RGPD |
Elimina permanentemente una tarea y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "idProperty" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Eliminar un correo electrónico: RGPD |
Elimina permanentemente un correo electrónico y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "idProperty" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Eliminar un correo postal: RGPD |
Elimina permanentemente un correo postal y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "idProperty" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Eliminar una comunicación: RGPD |
Elimina permanentemente una comunicación y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "idProperty" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Eliminar una nota: RGPD |
Elimina permanentemente una nota y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "idProperty" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Enumerar comunicaciones |
Recupera una página de comunicaciones. Controle lo que se devuelve a través del parámetro de |
| Enumerar correo postal |
Recupera una página de correo postal. Controle lo que se devuelve a través del parámetro de |
| Enumerar correos electrónicos |
Recupera una página de correos electrónicos. Controle lo que se devuelve a través del parámetro de |
| Enumerar llamadas |
Recupera una página de llamadas. Controle lo que se devuelve a través del parámetro de |
| Enumerar reuniones |
Recupera una página de reuniones. Controle lo que se devuelve a través del parámetro de |
| Enumerar tareas |
Recupera una página de tareas. Controle lo que se devuelve a través del parámetro de |
| Leer un objeto |
Recupera un objeto identificado por 'callId'. 'callId' hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta |
| Llamadas de búsqueda |
Recupera una lista de llamadas. |
| Nota de archivo |
Mueve un objeto identificado por 'noteId' a la papelera de reciclaje. |
| Notas de la lista |
Recupera una página de notas. Controle lo que se devuelve a través del parámetro de |
| Obtención de lotes de correos electrónicos |
Recupera un lote de correos electrónicos por identificador interno o valores de propiedad únicos. |
| Obtención de lotes de tareas |
Recupera un lote de tareas por identificador interno o valores de propiedad únicos. |
| Obtención de un lote de llamadas |
Recupera un lote de llamadas por identificador interno o valores de propiedad únicos. |
| Obtención de un lote de notas |
Recupera un lote de notas por identificador interno o valores de propiedad únicos. |
| Obtención de un lote de reuniones |
Recupera un lote de reuniones por identificador interno o valores de propiedad únicos. |
| Obtención del lote de comunicaciones |
Recupera un lote de comunicaciones por identificador interno o valores de propiedad únicos. |
| Obtención del lote de correo postal |
Recupera un lote de correo postal por identificador interno o valores de propiedad únicos. |
| Obtener comunicación |
Recupera un objeto identificado por "communicationId". "communicationId" hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de |
| Obtener correo electrónico |
Recupera un objeto identificado por "emailId". "emailId" hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de |
| Obtener correo postal |
Recupera un objeto identificado por "postalMailId". "postalMailId" hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de |
| Obtener nota |
Recupera un objeto identificado por 'noteId'. 'noteId' hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de |
| Obtener reunión |
Recupera un objeto identificado por 'meetingId'. 'meetingId' hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de |
| Obtener tarea |
Recupera un objeto identificado por "taskId". 'taskId' hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de |
| Reunión de archivo |
Mueve un objeto identificado por 'meetingId' a la papelera de reciclaje. |
| Tarea Archivar |
Mueve un objeto identificado por "taskId" a la papelera de reciclaje. |
| Tareas de búsqueda |
Recuperar una lista de tareas. |
Actualización de la comunicación
Realiza una actualización parcial de un objeto identificado por "communicationId". "communicationId" hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de comunicación
|
communicationId | True | string |
Identificador de comunicación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Actualización del lote de comunicaciones
Actualiza un lote de comunicaciones.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualización del lote de correo postal
Actualiza un lote de correo postal.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualización del lote de llamadas
Actualiza un lote de llamadas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualización del lote de notas
Actualiza un lote de notas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualización del lote de reuniones
Actualiza un lote de reuniones.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualización del lote de tareas
Actualiza un lote de tareas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualizar correo electrónico
Realiza una actualización parcial de un objeto identificado por "emailId". "emailId" hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Identificador de correo electrónico
|
emailId | True | string |
Identificador de correo electrónico. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Actualizar correo postal
Realiza una actualización parcial de un objeto identificado por "postalMailId". "postalMailId" hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de correo postal
|
postalMailId | True | string |
Identificador de correo postal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Actualizar lote de correos electrónicos
Actualiza un lote de correos electrónicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualizar nota
Realiza una actualización parcial de un objeto identificado por "noteId". 'noteId' hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de nota
|
noteId | True | string |
Identificador de nota. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Actualizar reunión
Realiza una actualización parcial de un objeto identificado por "meetingId". 'meetingId' hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de reunión
|
meetingId | True | string |
Identificador de la reunión. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Actualizar tarea
Realiza una actualización parcial de un objeto identificado por "taskId". 'taskId' hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de tarea
|
taskId | True | string |
Identificador de tarea. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Actualizar un objeto
Realiza una actualización parcial de un objeto identificado por "callId". 'callId' hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty . Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de llamada
|
callId | True | string |
Identificador de llamada. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Archivar correo electrónico
Mueve un objeto identificado por "emailId" a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de correo electrónico
|
emailId | True | string |
Identificador de correo electrónico. |
Devoluciones
- response
- string
Archivar correo postal
Mueve un objeto identificado por "postalMailId" a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de correo postal
|
postalMailId | True | string |
Identificador de correo postal. |
Devoluciones
- response
- string
Archivar el lote de llamadas
Archiva un lote de llamadas por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Archivar el lote de reuniones
Archiva un lote de reuniones por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Archivar el lote de tareas
Archiva un lote de tareas por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Archivar lotes de correos electrónicos
Archiva un lote de correos electrónicos por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Archivar un objeto
Mueve un objeto identificado por 'callId' a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de llamada
|
callId | True | string |
Identificador de llamada. |
Devoluciones
- response
- string
Archivo por lotes de comunicaciones
Archiva un lote de comunicaciones por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Archivo por lotes de correo postal
Archiva un lote de correo postal por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Archivo por lotes de notas
Archiva un lote de notas por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Buscar comunicaciones
Recuperar una lista de comunicaciones.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
El después. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
Propiedades. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | integer |
Total. |
|
Después
|
paging.next.after | string |
El después. |
|
Link
|
paging.next.link | string |
Vínculo. |
Buscar correo electrónico
Recuperar una lista de correos electrónicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
El después. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
Propiedades. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | integer |
Total. |
|
Después
|
paging.next.after | string |
El después. |
|
Link
|
paging.next.link | string |
Vínculo. |
Buscar correo postal
Recuperar una lista de correo postal.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
El después. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
Propiedades. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | integer |
Total. |
|
Después
|
paging.next.after | string |
El después. |
|
Link
|
paging.next.link | string |
Vínculo. |
Buscar notas
Recupera una lista de notas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
El después. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
Propiedades. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | integer |
Total. |
|
Después
|
paging.next.after | string |
El después. |
|
Link
|
paging.next.link | string |
Vínculo. |
Buscar reuniones
Recuperar una lista de reuniones.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
El después. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
Propiedades. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | integer |
Total. |
|
Después
|
paging.next.after | string |
El después. |
|
Link
|
paging.next.link | string |
Vínculo. |
Combinar dos comunicaciones
Combina dos comunicaciones con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto que se va a combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Combinar dos correos electrónicos
Combina dos correos electrónicos con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto que se va a combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Combinar dos correos postales
Combina dos correos postales con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto que se va a combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Combinar dos llamadas
Combina dos llamadas con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto que se va a combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Combinar dos notas
Combina dos notas con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto que se va a combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Combinar dos reuniones
Combina dos reuniones con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto que se va a combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Combinar dos tareas
Combina dos tareas con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto que se va a combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Comunicación de archivo
Mueve un objeto identificado por 'communicationId' a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de comunicación
|
communicationId | True | string |
Identificador de comunicación. |
Devoluciones
- response
- string
Creación de un lote de comunicaciones
Crea un lote de comunicaciones.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Creación de un lote de correos electrónicos
Crea un lote de correos electrónicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Creación de un lote de llamadas
Crea un lote de llamadas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Creación de un lote de notas
Crea un lote de notas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Creación de un lote de reuniones
Crea un lote de reuniones.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Creación de un lote de tareas
Crea un lote de tareas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Creación de una llamada
Crea una llamada con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Crear comunicación
Crea una comunicación con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Crear correo postal
Crea un correo postal con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Crear nota
Crea una nota con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Crear reunión
Crea una reunión con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Crear tarea
Crea una tarea con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador. Se proporciona documentación y ejemplos para crear tareas estándar.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Crear un correo electrónico
Crea un correo electrónico con las propiedades especificadas y devuelve una copia del objeto, incluido el identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Crear un lote de correo postal
Crea un lote de correo postal.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Eliminación de una llamada: RGPD
Elimina permanentemente una llamada y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "idProperty" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Eliminación de una reunión: RGPD
Elimina permanentemente una reunión y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "idProperty" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Eliminación de una tarea: RGPD
Elimina permanentemente una tarea y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "idProperty" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Eliminar un correo electrónico: RGPD
Elimina permanentemente un correo electrónico y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "idProperty" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Eliminar un correo postal: RGPD
Elimina permanentemente un correo postal y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "idProperty" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Eliminar una comunicación: RGPD
Elimina permanentemente una comunicación y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "idProperty" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Eliminar una nota: RGPD
Elimina permanentemente una nota y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "idProperty" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Enumerar comunicaciones
Recupera una página de comunicaciones. Controle lo que se devuelve a través del parámetro de properties consulta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
El límite. |
|
|
Después
|
after | string |
El después. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si está archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
El después. |
|
Link
|
paging.next.link | string |
Vínculo. |
Enumerar correo postal
Recupera una página de correo postal. Controle lo que se devuelve a través del parámetro de properties consulta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
El límite. |
|
|
Después
|
after | string |
El después. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si está archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
El después. |
|
Link
|
paging.next.link | string |
Vínculo. |
Enumerar correos electrónicos
Recupera una página de correos electrónicos. Controle lo que se devuelve a través del parámetro de properties consulta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
El límite. |
|
|
Después
|
after | string |
El después. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si está archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
El después. |
|
Link
|
paging.next.link | string |
Vínculo. |
Enumerar llamadas
Recupera una página de llamadas. Controle lo que se devuelve a través del parámetro de properties consulta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
El límite. |
|
|
Después
|
after | string |
El después. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si está archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
El después. |
|
Link
|
paging.next.link | string |
Vínculo. |
Enumerar reuniones
Recupera una página de reuniones. Controle lo que se devuelve a través del parámetro de properties consulta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
El límite. |
|
|
Después
|
after | string |
El después. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si está archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
El después. |
|
Link
|
paging.next.link | string |
Vínculo. |
Enumerar tareas
Recupera una página de tareas. Controle lo que se devuelve a través del parámetro de properties consulta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
El límite. |
|
|
Después
|
after | string |
El después. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si está archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
El después. |
|
Link
|
paging.next.link | string |
Vínculo. |
Leer un objeto
Recupera un objeto identificado por 'callId'. 'callId' hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty . Controle lo que se devuelve a través del parámetro de properties consulta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si está archivado. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de llamada
|
callId | True | string |
Identificador de llamada. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Llamadas de búsqueda
Recupera una lista de llamadas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
El después. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
Propiedades. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | integer |
Total. |
|
Después
|
paging.next.after | string |
El después. |
|
Link
|
paging.next.link | string |
Vínculo. |
Nota de archivo
Mueve un objeto identificado por 'noteId' a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de nota
|
noteId | True | string |
Identificador de nota. |
Devoluciones
- response
- string
Notas de la lista
Recupera una página de notas. Controle lo que se devuelve a través del parámetro de properties consulta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
El límite. |
|
|
Después
|
after | string |
El después. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si está archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
El después. |
|
Link
|
paging.next.link | string |
Vínculo. |
Obtención de lotes de correos electrónicos
Recupera un lote de correos electrónicos por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si está archivado. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con historial. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtención de lotes de tareas
Recupera un lote de tareas por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si está archivado. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con historial. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtención de un lote de llamadas
Recupera un lote de llamadas por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si está archivado. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con historial. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtención de un lote de notas
Recupera un lote de notas por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si está archivado. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con historial. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtención de un lote de reuniones
Recupera un lote de reuniones por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si está archivado. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con historial. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtención del lote de comunicaciones
Recupera un lote de comunicaciones por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si está archivado. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con historial. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtención del lote de correo postal
Recupera un lote de correo postal por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si está archivado. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con historial. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtener comunicación
Recupera un objeto identificado por "communicationId". "communicationId" hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Controle lo que se devuelve a través del parámetro de properties consulta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si está archivado. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de comunicación
|
communicationId | True | string |
Identificador de comunicación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Obtener correo electrónico
Recupera un objeto identificado por "emailId". "emailId" hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Controle lo que se devuelve a través del parámetro de properties consulta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si está archivado. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Identificador de correo electrónico
|
emailId | True | string |
Identificador de correo electrónico. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Obtener correo postal
Recupera un objeto identificado por "postalMailId". "postalMailId" hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Controle lo que se devuelve a través del parámetro de properties consulta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si está archivado. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de correo postal
|
postalMailId | True | string |
Identificador de correo postal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Obtener nota
Recupera un objeto identificado por 'noteId'. 'noteId' hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Controle lo que se devuelve a través del parámetro de properties consulta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si está archivado. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de nota
|
noteId | True | string |
Identificador de nota. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Obtener reunión
Recupera un objeto identificado por 'meetingId'. 'meetingId' hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Controle lo que se devuelve a través del parámetro de properties consulta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si está archivado. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de reunión
|
meetingId | True | string |
Identificador de la reunión. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Obtener tarea
Recupera un objeto identificado por "taskId". 'taskId' hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de idProperty consulta. Controle lo que se devuelve a través del parámetro de properties consulta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si está archivado. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de tarea
|
taskId | True | string |
Identificador de tarea. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Reunión de archivo
Mueve un objeto identificado por 'meetingId' a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de reunión
|
meetingId | True | string |
Identificador de la reunión. |
Devoluciones
- response
- string
Tarea Archivar
Mueve un objeto identificado por "taskId" a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de tarea
|
taskId | True | string |
Identificador de tarea. |
Devoluciones
- response
- string
Tareas de búsqueda
Recuperar una lista de tareas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
El después. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
Propiedades. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | integer |
Total. |
|
Después
|
paging.next.after | string |
El después. |
|
Link
|
paging.next.link | string |
Vínculo. |
Definiciones
cuerda / cadena
Este es el tipo de datos básico "string".