HubSpot Engagements V2 (éditeur indépendant) (préversion)
HubSpot Engagements est utilisé pour conserver vos enregistrements CRM up-to-date sur toutes les interactions qui se produisent en dehors de HubSpot. Les rapports d’activité dans crm alimentent également ces données.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| Messagerie électronique | ttaylor@hitachisolutions.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Troy Taylor |
| Site internet | https://www.hubspot.com/products/crm |
| Politique de confidentialité | https://legal.hubspot.com/privacy-policy |
| Catégories | Ventes et CRM ; Communication |
HubSpot Engagements V2
HubSpot Engagements est utilisé pour conserver vos enregistrements CRM up-to-date sur toutes les interactions qui se produisent en dehors de HubSpot. Les rapports d’activité dans crm alimentent également ces données.
Éditeur : Troy Taylor, Hitachi Solutions
Prerequisites
Vous devez disposer d’un compte avec HubSpot et être un super administrateur.
Obtention des informations d’identification
Une fois connecté à votre compte, accédez à Paramètres -> Configuration du compte -> Intégrations -> Applications privées. Vous devez créer une application privée et l’affecter uniquement aux étendues pour lesquelles vous utiliserez des actions. Une fois votre application privée créée, vous aurez un jeton d’accès dans la section Authentification de l’application privée.
Opérations prises en charge
Créer un lot d’appels
Crée un lot d’appels.
Obtenir un lot d’appels
Récupère un lot d’appels par ID interne ou par valeurs de propriété uniques.
Mettre à jour le lot d’appels
Met à jour un lot d’appels.
Archiver le lot d’appels
Archive un lot d’appels par ID.
Répertorier les appels
Récupère une page d’appels. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Créer un appel
Crée un appel avec les propriétés données et retourne une copie de l’objet, y compris l’ID.
Lire un objet
Récupère un objet identifié par callId.
callId fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Archiver un objet
Déplace un objet identifié par callId le bac de recyclage.
Mettre à jour un objet
Effectue une mise à jour partielle d’un objet identifié par callId.
callId fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Les valeurs de propriété fournies seront remplacées. Les propriétés en lecture seule et inexistantes sont ignorées. Les valeurs des propriétés peuvent être effacées en passant une chaîne vide.
Fusionner deux appels
Fusionne deux appels avec le même type.
Supprimer un appel - RGPD
Supprime définitivement un appel et tout le contenu associé pour suivre le RGPD. Utilisez la propriété idProperty facultative définie pour email identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure.
Appels de recherche
Récupère une liste d’appels.
Créer un lot d’e-mails
Crée un lot d’e-mails.
Obtenir un lot d’e-mails
Récupère un lot d’e-mails par ID interne ou par valeurs de propriété uniques.
Archiver le lot d’e-mails
Archive un lot d’e-mails par ID.
Mettre à jour le lot d’e-mails
Met à jour un lot d’e-mails.
Lister les e-mails
Récupère une page d’e-mails. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Créer un e-mail
Crée un e-mail avec les propriétés données et retourne une copie de l’objet, y compris l’ID.
Obtenir un e-mail
Récupère un objet identifié par emailId.
emailId fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Archiver l’e-mail
Déplace un objet identifié par emailId le bac de recyclage.
Mettre à jour l’e-mail
Effectue une mise à jour partielle d’un objet identifié par emailId.
emailId fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Les valeurs de propriété fournies seront remplacées. Les propriétés en lecture seule et inexistantes sont ignorées. Les valeurs des propriétés peuvent être effacées en passant une chaîne vide.
Fusionner deux e-mails
Fusionne deux e-mails avec le même type.
Supprimer un e-mail - RGPD
Supprime définitivement un e-mail et tout le contenu associé pour suivre le RGPD. Utilisez la propriété idProperty facultative définie pour email identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure.
Rechercher un e-mail
Récupérez une liste d’e-mails.
Mettre à jour le lot de réunions
Met à jour un lot de réunions.
Archiver le lot de réunions
Archive un lot de réunions par ID.
Obtenir le lot de réunions
Récupère un lot de réunions par ID interne ou par valeurs de propriété uniques.
Créer un lot de réunions
Crée un lot de réunions.
Obtenir une réunion
Récupère un objet identifié par meetingId.
meetingId fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Archiver la réunion
Déplace un objet identifié par meetingId le bac de recyclage.
Mettre à jour la réunion
Effectue une mise à jour partielle d’un objet identifié par meetingId.
meetingId fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Les valeurs de propriété fournies seront remplacées. Les propriétés en lecture seule et inexistantes sont ignorées. Les valeurs des propriétés peuvent être effacées en passant une chaîne vide.
Répertorier les réunions
Récupère une page de réunions. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Créer une réunion
Crée une réunion avec les propriétés données et retourne une copie de l’objet, y compris l’ID.
Fusionner deux réunions
Fusionne deux réunions avec le même type.
Supprimer une réunion - RGPD
Supprime définitivement une réunion et tout le contenu associé pour suivre le RGPD. Utilisez la propriété idProperty facultative définie pour email identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure.
Rechercher des réunions
Récupérez une liste de réunions.
Obtenir un lot de notes
Récupère un lot de notes par ID interne ou par valeurs de propriété uniques.
Archiver le lot de notes
Archive un lot de notes par ID.
Mettre à jour le lot de notes
Met à jour un lot de notes.
Créer un lot de notes
Crée un lot de notes.
Lister les notes
Récupère une page de notes. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Créer une note
Crée une note avec les propriétés données et retourne une copie de l’objet, y compris l’ID.
Obtenir une note
Récupère un objet identifié par noteId.
noteId fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Note d’archivage
Déplace un objet identifié par noteId le bac de recyclage.
Remarque de mise à jour
Effectue une mise à jour partielle d’un objet identifié par noteId.
noteId fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Les valeurs de propriété fournies seront remplacées. Les propriétés en lecture seule et inexistantes sont ignorées. Les valeurs des propriétés peuvent être effacées en passant une chaîne vide.
Fusionner deux notes
Fusionne deux notes avec le même type.
Supprimer une note - RGPD
Supprime définitivement une note et tout le contenu associé à suivre le RGPD. Utilisez la propriété idProperty facultative définie pour email identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure.
Notes de recherche
Récupère une liste de notes.
Obtenir un lot de courrier postal
Récupère un lot de courrier postal par ID interne ou par valeurs de propriété uniques.
Archiver le lot de courrier postal
Archive un lot de courrier postal par ID.
Créer un lot de courrier postal
Crée un lot de courrier postal.
Mettre à jour le lot de courrier postal
Met à jour un lot de courrier postal.
Répertorier le courrier postal
Récupère une page de courrier postal. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Créer un courrier postal
Crée un courrier postal avec les propriétés données et retourne une copie de l’objet, y compris l’ID.
Obtenir le courrier postal
Récupère un objet identifié par postalMailId.
postalMailId fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Archiver le courrier postal
Déplace un objet identifié par postalMailId le bac de recyclage.
Mettre à jour le courrier postal
Effectue une mise à jour partielle d’un objet identifié par postalMailId.
postalMailId fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Les valeurs de propriété fournies seront remplacées. Les propriétés en lecture seule et inexistantes sont ignorées. Les valeurs des propriétés peuvent être effacées en passant une chaîne vide.
Fusionner deux courriers postaux
Fusionne deux courriers postaux avec le même type.
Supprimer un courrier postal - RGPD
Supprime définitivement un courrier postal et tout le contenu associé pour suivre le RGPD. Utilisez la propriété idProperty facultative définie pour email identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure.
Rechercher un courrier postal
Récupérez une liste de courriers postaux.
Archiver le lot de tâches
Archive un lot de tâches par ID.
Créer un lot de tâches
Crée un lot de tâches.
Mettre à jour le lot de tâches
Met à jour un lot de tâches.
Obtenir le lot de tâches
Récupère un lot de tâches par ID interne ou par valeurs de propriété uniques.
Obtenir une tâche
Récupère un objet identifié par taskId.
taskId fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Tâche d’archivage
Déplace un objet identifié par taskId le bac de recyclage.
Mettre à jour une tâche
Effectue une mise à jour partielle d’un objet identifié par taskId.
taskId fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Les valeurs de propriété fournies seront remplacées. Les propriétés en lecture seule et inexistantes sont ignorées. Les valeurs des propriétés peuvent être effacées en passant une chaîne vide.
Répertorier les tâches
Récupère une page de tâches. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Créer une tâche
Crée une tâche avec les propriétés données et retourne une copie de l’objet, y compris l’ID. La documentation et les exemples de création de tâches standard sont fournis.
Fusionner deux tâches
Fusionne deux tâches avec le même type.
Supprimer une tâche - RGPD
Supprime définitivement une tâche et tout le contenu associé pour suivre le RGPD. Utilisez la propriété idProperty facultative définie pour email identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure.
Tâches de recherche
Récupérez une liste de tâches.
Mettre à jour le lot de communications
Met à jour un lot de communications.
Archiver le lot de communications
Archive un lot de communications par ID.
Créer un lot de communications
Crée un lot de communications.
Obtenir un lot de communications
Récupère un lot de communications par ID interne ou par valeurs de propriété uniques.
Répertorier les communications
Récupère une page de communications. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Créer une communication
Crée une communication avec les propriétés données et retourne une copie de l’objet, y compris l’ID.
Obtenir la communication
Récupère un objet identifié par communicationId.
communicationId fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Archiver la communication
Déplace un objet identifié par communicationId le bac de recyclage.
Mettre à jour la communication
Effectue une mise à jour partielle d’un objet identifié par communicationId.
communicationId fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Les valeurs de propriété fournies seront remplacées. Les propriétés en lecture seule et inexistantes sont ignorées. Les valeurs des propriétés peuvent être effacées en passant une chaîne vide.
Fusionner deux communications
Fusionne deux communications avec le même type.
Supprimer une communication - RGPD
Supprime définitivement une communication et tout le contenu associé pour suivre le RGPD. Utilisez la propriété idProperty facultative définie pour email identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure.
Rechercher des communications
Récupérez une liste de communications.
Problèmes connus et limitations
Il n’y a pas de problèmes connus pour l’instant.
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| Jeton d’accès (sous la forme « Porteur YOUR_ACCESS_TOKEN ») | securestring | Jeton d’accès (sous la forme « Porteur YOUR_ACCESS_TOKEN ») pour cette API | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Appels de recherche |
Récupère une liste d’appels. |
| Archiver la communication |
Déplace un objet identifié par « communicationId » vers la corbeille. |
| Archiver la réunion |
Déplace un objet identifié par « meetingId » vers la corbeille. |
| Archiver le courrier postal |
Déplace un objet identifié par « postalMailId » vers la corbeille. |
| Archiver le lot de communications |
Archive un lot de communications par ID. |
| Archiver le lot de courrier postal |
Archive un lot de courrier postal par ID. |
| Archiver le lot de notes |
Archive un lot de notes par ID. |
| Archiver le lot de réunions |
Archive un lot de réunions par ID. |
| Archiver le lot de tâches |
Archive un lot de tâches par ID. |
| Archiver le lot d’appels |
Archive un lot d’appels par ID. |
| Archiver le lot d’e-mails |
Archive un lot d’e-mails par ID. |
| Archiver l’e-mail |
Déplace un objet identifié par « emailId » vers la corbeille. |
| Archiver un objet |
Déplace un objet identifié par « callId » vers la corbeille. |
| Créer un appel |
Crée un appel avec les propriétés données et retourne une copie de l’objet, y compris l’ID. |
| Créer un courrier postal |
Crée un courrier postal avec les propriétés données et retourne une copie de l’objet, y compris l’ID. |
| Créer un e-mail |
Crée un e-mail avec les propriétés données et retourne une copie de l’objet, y compris l’ID. |
| Créer un lot de communications |
Crée un lot de communications. |
| Créer un lot de courrier postal |
Crée un lot de courrier postal. |
| Créer un lot de notes |
Crée un lot de notes. |
| Créer un lot de réunions |
Crée un lot de réunions. |
| Créer un lot de tâches |
Crée un lot de tâches. |
| Créer un lot d’appels |
Crée un lot d’appels. |
| Créer un lot d’e-mails |
Crée un lot d’e-mails. |
| Créer une communication |
Crée une communication avec les propriétés données et retourne une copie de l’objet, y compris l’ID. |
| Créer une note |
Crée une note avec les propriétés données et retourne une copie de l’objet, y compris l’ID. |
| Créer une réunion |
Crée une réunion avec les propriétés données et retourne une copie de l’objet, y compris l’ID. |
| Créer une tâche |
Crée une tâche avec les propriétés données et retourne une copie de l’objet, y compris l’ID. La documentation et les exemples de création de tâches standard sont fournis. |
| Fusionner deux appels |
Fusionne deux appels avec le même type. |
| Fusionner deux communications |
Fusionne deux communications avec le même type. |
| Fusionner deux courriers postaux |
Fusionne deux courriers postaux avec le même type. |
| Fusionner deux e-mails |
Fusionne deux e-mails avec le même type. |
| Fusionner deux notes |
Fusionne deux notes avec le même type. |
| Fusionner deux réunions |
Fusionne deux réunions avec le même type. |
| Fusionner deux tâches |
Fusionne deux tâches avec le même type. |
| Lire un objet |
Récupère un objet identifié par « callId ». 'callId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur |
| Lister les e-mails |
Récupère une page d’e-mails. Contrôlez ce qui est retourné via l’analyseur de |
| Lister les notes |
Récupère une page de notes. Contrôlez ce qui est retourné via l’analyseur de |
| Mettre à jour la communication |
Effectue une mise à jour partielle d’un objet identifié par « communicationId ». 'communicationId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur |
| Mettre à jour la réunion |
Effectue une mise à jour partielle d’un objet identifié par « meetingId ». 'meetingId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur |
| Mettre à jour le courrier postal |
Effectue une mise à jour partielle d’un objet identifié par « postalMailId ». « postalMailId » fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur |
| Mettre à jour le lot de communications |
Met à jour un lot de communications. |
| Mettre à jour le lot de courrier postal |
Met à jour un lot de courrier postal. |
| Mettre à jour le lot de notes |
Met à jour un lot de notes. |
| Mettre à jour le lot de réunions |
Met à jour un lot de réunions. |
| Mettre à jour le lot de tâches |
Met à jour un lot de tâches. |
| Mettre à jour le lot d’appels |
Met à jour un lot d’appels. |
| Mettre à jour le lot d’e-mails |
Met à jour un lot d’e-mails. |
| Mettre à jour l’e-mail |
Effectue une mise à jour partielle d’un objet identifié par « emailId ». 'emailId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur |
| Mettre à jour un objet |
Effectue une mise à jour partielle d’un objet identifié par « callId ». 'callId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur |
| Mettre à jour une tâche |
Effectue une mise à jour partielle d’un objet identifié par « taskId ». 'taskId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur |
| Note d’archivage |
Déplace un objet identifié par « noteId » vers la corbeille. |
| Notes de recherche |
Récupère une liste de notes. |
| Obtenir la communication |
Récupère un objet identifié par « communicationId ». 'communicationId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur |
| Obtenir le courrier postal |
Récupère un objet identifié par « postalMailId ». « postalMailId » fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur |
| Obtenir le lot de réunions |
Récupère un lot de réunions par ID interne ou par valeurs de propriété uniques. |
| Obtenir le lot de tâches |
Récupère un lot de tâches par ID interne ou par valeurs de propriété uniques. |
| Obtenir un e-mail |
Récupère un objet identifié par « emailId ». 'emailId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur |
| Obtenir un lot de communications |
Récupère un lot de communications par ID interne ou par valeurs de propriété uniques. |
| Obtenir un lot de courrier postal |
Récupère un lot de courrier postal par ID interne ou par valeurs de propriété uniques. |
| Obtenir un lot de notes |
Récupère un lot de notes par ID interne ou par valeurs de propriété uniques. |
| Obtenir un lot d’appels |
Récupère un lot d’appels par ID interne ou par valeurs de propriété uniques. |
| Obtenir un lot d’e-mails |
Récupère un lot d’e-mails par ID interne ou par valeurs de propriété uniques. |
| Obtenir une note |
Récupère un objet identifié par 'noteId'. 'noteId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur |
| Obtenir une réunion |
Récupère un objet identifié par « meetingId ». 'meetingId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur |
| Obtenir une tâche |
Récupère un objet identifié par 'taskId'. 'taskId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur |
| Rechercher des communications |
Récupérez une liste de communications. |
| Rechercher des réunions |
Récupérez une liste de réunions. |
| Rechercher un courrier postal |
Récupérez une liste de courriers postaux. |
| Rechercher un e-mail |
Récupérez une liste d’e-mails. |
| Remarque de mise à jour |
Effectue une mise à jour partielle d’un objet identifié par « noteId ». 'noteId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur |
| Répertorier le courrier postal |
Récupère une page de courrier postal. Contrôlez ce qui est retourné via l’analyseur de |
| Répertorier les appels |
Récupère une page d’appels. Contrôlez ce qui est retourné via l’analyseur de |
| Répertorier les communications |
Récupère une page de communications. Contrôlez ce qui est retourné via l’analyseur de |
| Répertorier les réunions |
Récupère une page de réunions. Contrôlez ce qui est retourné via l’analyseur de |
| Répertorier les tâches |
Récupère une page de tâches. Contrôlez ce qui est retourné via l’analyseur de |
| Supprimer un appel - RGPD |
Supprime définitivement un appel et tout le contenu associé pour suivre le RGPD. Utilisez la propriété facultative « idProperty » définie sur « email » pour identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure. |
| Supprimer un courrier postal - RGPD |
Supprime définitivement un courrier postal et tout le contenu associé pour suivre le RGPD. Utilisez la propriété facultative « idProperty » définie sur « email » pour identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure. |
| Supprimer un e-mail - RGPD |
Supprime définitivement un e-mail et tout le contenu associé pour suivre le RGPD. Utilisez la propriété facultative « idProperty » définie sur « email » pour identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure. |
| Supprimer une communication - RGPD |
Supprime définitivement une communication et tout le contenu associé pour suivre le RGPD. Utilisez la propriété facultative « idProperty » définie sur « email » pour identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure. |
| Supprimer une note - RGPD |
Supprime définitivement une note et tout le contenu associé à suivre le RGPD. Utilisez la propriété facultative « idProperty » définie sur « email » pour identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure. |
| Supprimer une réunion - RGPD |
Supprime définitivement une réunion et tout le contenu associé pour suivre le RGPD. Utilisez la propriété facultative « idProperty » définie sur « email » pour identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure. |
| Supprimer une tâche - RGPD |
Supprime définitivement une tâche et tout le contenu associé pour suivre le RGPD. Utilisez la propriété facultative « idProperty » définie sur « email » pour identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure. |
| Tâche d’archivage |
Déplace un objet identifié par « taskId » vers la corbeille. |
| Tâches de recherche |
Récupérez une liste de tâches. |
Appels de recherche
Récupère une liste d’appels.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Après
|
after | string |
Après. |
|
|
Operator
|
operator | string |
Opérateur. |
|
|
Nom de la propriété
|
propertyName | string |
Nom de la propriété. |
|
|
Valeur
|
value | string |
Valeur. |
|
|
Valeur élevée
|
highValue | string |
Valeur élevée. |
|
|
Valeurs
|
values | array of string |
Valeurs. |
|
|
Limit
|
limit | string |
La limite. |
|
|
Propriétés
|
properties | array of string |
Propriétés. |
|
|
Sortes
|
sorts | array of string |
Tris. |
|
|
Query
|
query | string |
Requête. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Total
|
total | integer |
Total. |
|
Après
|
paging.next.after | string |
Après. |
|
Lien
|
paging.next.link | string |
Lien. |
Archiver la communication
Déplace un objet identifié par « communicationId » vers la corbeille.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Communication ID
|
communicationId | True | string |
Identificateur de communication. |
Retours
- response
- string
Archiver la réunion
Déplace un objet identifié par « meetingId » vers la corbeille.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de réunion
|
meetingId | True | string |
Identificateur de réunion. |
Retours
- response
- string
Archiver le courrier postal
Déplace un objet identifié par « postalMailId » vers la corbeille.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de courrier postal
|
postalMailId | True | string |
Identificateur de courrier postal. |
Retours
- response
- string
Archiver le lot de communications
Archive un lot de communications par ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
Retours
- response
- string
Archiver le lot de courrier postal
Archive un lot de courrier postal par ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
Retours
- response
- string
Archiver le lot de notes
Archive un lot de notes par ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
Retours
- response
- string
Archiver le lot de réunions
Archive un lot de réunions par ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
Retours
- response
- string
Archiver le lot de tâches
Archive un lot de tâches par ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
Retours
- response
- string
Archiver le lot d’appels
Archive un lot d’appels par ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
Retours
- response
- string
Archiver le lot d’e-mails
Archive un lot d’e-mails par ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
Retours
- response
- string
Archiver l’e-mail
Déplace un objet identifié par « emailId » vers la corbeille.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de courrier électronique
|
emailId | True | string |
Identificateur d’e-mail. |
Retours
- response
- string
Archiver un objet
Déplace un objet identifié par « callId » vers la corbeille.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’appel
|
callId | True | string |
Identificateur d’appel. |
Retours
- response
- string
Créer un appel
Crée un appel avec les propriétés données et retourne une copie de l’objet, y compris l’ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
|
Catégorie d’association
|
associationCategory | string |
Catégorie d’association. |
|
|
ID de type d’association
|
associationTypeId | string |
Identificateur de type d’association. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Créer un courrier postal
Crée un courrier postal avec les propriétés données et retourne une copie de l’objet, y compris l’ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
|
Catégorie d’association
|
associationCategory | string |
Catégorie d’association. |
|
|
ID de type d’association
|
associationTypeId | string |
Identificateur de type d’association. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Créer un e-mail
Crée un e-mail avec les propriétés données et retourne une copie de l’objet, y compris l’ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
|
Catégorie d’association
|
associationCategory | string |
Catégorie d’association. |
|
|
ID de type d’association
|
associationTypeId | string |
Identificateur de type d’association. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Créer un lot de communications
Crée un lot de communications.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
|
Catégorie d’association
|
associationCategory | string |
Catégorie d’association. |
|
|
ID de type d’association
|
associationTypeId | string |
Identificateur de type d’association. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Créer un lot de courrier postal
Crée un lot de courrier postal.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
|
Catégorie d’association
|
associationCategory | string |
Catégorie d’association. |
|
|
ID de type d’association
|
associationTypeId | string |
Identificateur de type d’association. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Créer un lot de notes
Crée un lot de notes.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
|
Catégorie d’association
|
associationCategory | string |
Catégorie d’association. |
|
|
ID de type d’association
|
associationTypeId | string |
Identificateur de type d’association. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Créer un lot de réunions
Crée un lot de réunions.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
|
Catégorie d’association
|
associationCategory | string |
Catégorie d’association. |
|
|
ID de type d’association
|
associationTypeId | string |
Identificateur de type d’association. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Créer un lot de tâches
Crée un lot de tâches.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
|
Catégorie d’association
|
associationCategory | string |
Catégorie d’association. |
|
|
ID de type d’association
|
associationTypeId | string |
Identificateur de type d’association. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Créer un lot d’appels
Crée un lot d’appels.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
|
Catégorie d’association
|
associationCategory | string |
Catégorie d’association. |
|
|
ID de type d’association
|
associationTypeId | string |
Identificateur de type d’association. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Créer un lot d’e-mails
Crée un lot d’e-mails.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
|
Catégorie d’association
|
associationCategory | string |
Catégorie d’association. |
|
|
ID de type d’association
|
associationTypeId | string |
Identificateur de type d’association. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Créer une communication
Crée une communication avec les propriétés données et retourne une copie de l’objet, y compris l’ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
|
Catégorie d’association
|
associationCategory | string |
Catégorie d’association. |
|
|
ID de type d’association
|
associationTypeId | string |
Identificateur de type d’association. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Créer une note
Crée une note avec les propriétés données et retourne une copie de l’objet, y compris l’ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
|
Catégorie d’association
|
associationCategory | string |
Catégorie d’association. |
|
|
ID de type d’association
|
associationTypeId | string |
Identificateur de type d’association. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Créer une réunion
Crée une réunion avec les propriétés données et retourne une copie de l’objet, y compris l’ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
|
Catégorie d’association
|
associationCategory | string |
Catégorie d’association. |
|
|
ID de type d’association
|
associationTypeId | string |
Identificateur de type d’association. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Créer une tâche
Crée une tâche avec les propriétés données et retourne une copie de l’objet, y compris l’ID. La documentation et les exemples de création de tâches standard sont fournis.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
|
Catégorie d’association
|
associationCategory | string |
Catégorie d’association. |
|
|
ID de type d’association
|
associationTypeId | string |
Identificateur de type d’association. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Fusionner deux appels
Fusionne deux appels avec le même type.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’objet à fusionner
|
objectIdToMerge | string |
Identificateur d’objet à fusionner. |
|
|
ID d’objet principal
|
primaryObjectId | string |
Identificateur d’objet principal. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Fusionner deux communications
Fusionne deux communications avec le même type.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’objet à fusionner
|
objectIdToMerge | string |
Identificateur d’objet à fusionner. |
|
|
ID d’objet principal
|
primaryObjectId | string |
Identificateur d’objet principal. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Fusionner deux courriers postaux
Fusionne deux courriers postaux avec le même type.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’objet à fusionner
|
objectIdToMerge | string |
Identificateur d’objet à fusionner. |
|
|
ID d’objet principal
|
primaryObjectId | string |
Identificateur d’objet principal. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Fusionner deux e-mails
Fusionne deux e-mails avec le même type.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’objet à fusionner
|
objectIdToMerge | string |
Identificateur d’objet à fusionner. |
|
|
ID d’objet principal
|
primaryObjectId | string |
Identificateur d’objet principal. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Fusionner deux notes
Fusionne deux notes avec le même type.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’objet à fusionner
|
objectIdToMerge | string |
Identificateur d’objet à fusionner. |
|
|
ID d’objet principal
|
primaryObjectId | string |
Identificateur d’objet principal. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Fusionner deux réunions
Fusionne deux réunions avec le même type.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’objet à fusionner
|
objectIdToMerge | string |
Identificateur d’objet à fusionner. |
|
|
ID d’objet principal
|
primaryObjectId | string |
Identificateur d’objet principal. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Fusionner deux tâches
Fusionne deux tâches avec le même type.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’objet à fusionner
|
objectIdToMerge | string |
Identificateur d’objet à fusionner. |
|
|
ID d’objet principal
|
primaryObjectId | string |
Identificateur d’objet principal. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Lire un objet
Récupère un objet identifié par « callId ». 'callId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Propriétés
|
properties | string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | string |
Propriétés avec l’historique. |
|
|
Associations
|
associations | string |
Les associations. |
|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
|
|
ID d’appel
|
callId | True | string |
Identificateur d’appel. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Lister les e-mails
Récupère une page d’e-mails. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
La limite. |
|
|
Après
|
after | string |
Après. |
|
|
Propriétés
|
properties | string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | string |
Propriétés avec l’historique. |
|
|
Associations
|
associations | string |
Les associations. |
|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Après
|
paging.next.after | string |
Après. |
|
Lien
|
paging.next.link | string |
Lien. |
Lister les notes
Récupère une page de notes. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
La limite. |
|
|
Après
|
after | string |
Après. |
|
|
Propriétés
|
properties | string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | string |
Propriétés avec l’historique. |
|
|
Associations
|
associations | string |
Les associations. |
|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Après
|
paging.next.after | string |
Après. |
|
Lien
|
paging.next.link | string |
Lien. |
Mettre à jour la communication
Effectue une mise à jour partielle d’un objet identifié par « communicationId ». 'communicationId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Les valeurs de propriété fournies seront remplacées. Les propriétés en lecture seule et inexistantes sont ignorées. Les valeurs des propriétés peuvent être effacées en passant une chaîne vide.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
|
|
Communication ID
|
communicationId | True | string |
Identificateur de communication. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Mettre à jour la réunion
Effectue une mise à jour partielle d’un objet identifié par « meetingId ». 'meetingId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Les valeurs de propriété fournies seront remplacées. Les propriétés en lecture seule et inexistantes sont ignorées. Les valeurs des propriétés peuvent être effacées en passant une chaîne vide.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
|
|
ID de réunion
|
meetingId | True | string |
Identificateur de réunion. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Mettre à jour le courrier postal
Effectue une mise à jour partielle d’un objet identifié par « postalMailId ». « postalMailId » fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Les valeurs de propriété fournies seront remplacées. Les propriétés en lecture seule et inexistantes sont ignorées. Les valeurs des propriétés peuvent être effacées en passant une chaîne vide.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
|
|
ID de courrier postal
|
postalMailId | True | string |
Identificateur de courrier postal. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Mettre à jour le lot de communications
Met à jour un lot de communications.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Mettre à jour le lot de courrier postal
Met à jour un lot de courrier postal.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Mettre à jour le lot de notes
Met à jour un lot de notes.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Mettre à jour le lot de réunions
Met à jour un lot de réunions.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Mettre à jour le lot de tâches
Met à jour un lot de tâches.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Mettre à jour le lot d’appels
Met à jour un lot d’appels.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Mettre à jour le lot d’e-mails
Met à jour un lot d’e-mails.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Mettre à jour l’e-mail
Effectue une mise à jour partielle d’un objet identifié par « emailId ». 'emailId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Les valeurs de propriété fournies seront remplacées. Les propriétés en lecture seule et inexistantes sont ignorées. Les valeurs des propriétés peuvent être effacées en passant une chaîne vide.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
|
|
ID de courrier électronique
|
emailId | True | string |
Identificateur d’e-mail. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Mettre à jour un objet
Effectue une mise à jour partielle d’un objet identifié par « callId ». 'callId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Les valeurs de propriété fournies seront remplacées. Les propriétés en lecture seule et inexistantes sont ignorées. Les valeurs des propriétés peuvent être effacées en passant une chaîne vide.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
|
|
ID d’appel
|
callId | True | string |
Identificateur d’appel. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Mettre à jour une tâche
Effectue une mise à jour partielle d’un objet identifié par « taskId ». 'taskId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Les valeurs de propriété fournies seront remplacées. Les propriétés en lecture seule et inexistantes sont ignorées. Les valeurs des propriétés peuvent être effacées en passant une chaîne vide.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
|
|
ID de tâche
|
taskId | True | string |
Identificateur de tâche. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Note d’archivage
Déplace un objet identifié par « noteId » vers la corbeille.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Note ID
|
noteId | True | string |
Identificateur de note. |
Retours
- response
- string
Notes de recherche
Récupère une liste de notes.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Après
|
after | string |
Après. |
|
|
Operator
|
operator | string |
Opérateur. |
|
|
Nom de la propriété
|
propertyName | string |
Nom de la propriété. |
|
|
Valeur
|
value | string |
Valeur. |
|
|
Valeur élevée
|
highValue | string |
Valeur élevée. |
|
|
Valeurs
|
values | array of string |
Valeurs. |
|
|
Limit
|
limit | string |
La limite. |
|
|
Propriétés
|
properties | array of string |
Propriétés. |
|
|
Sortes
|
sorts | array of string |
Tris. |
|
|
Query
|
query | string |
Requête. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Total
|
total | integer |
Total. |
|
Après
|
paging.next.after | string |
Après. |
|
Lien
|
paging.next.link | string |
Lien. |
Obtenir la communication
Récupère un objet identifié par « communicationId ». 'communicationId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Propriétés
|
properties | string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | string |
Propriétés avec l’historique. |
|
|
Associations
|
associations | string |
Les associations. |
|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
|
|
Communication ID
|
communicationId | True | string |
Identificateur de communication. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Obtenir le courrier postal
Récupère un objet identifié par « postalMailId ». « postalMailId » fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Propriétés
|
properties | string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | string |
Propriétés avec l’historique. |
|
|
Associations
|
associations | string |
Les associations. |
|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
|
|
ID de courrier postal
|
postalMailId | True | string |
Identificateur de courrier postal. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Obtenir le lot de réunions
Récupère un lot de réunions par ID interne ou par valeurs de propriété uniques.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
|
ID
|
id | string |
Identificateur. |
|
|
Propriétés
|
properties | array of string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | array of string |
Propriétés avec l’historique. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Obtenir le lot de tâches
Récupère un lot de tâches par ID interne ou par valeurs de propriété uniques.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
|
ID
|
id | string |
Identificateur. |
|
|
Propriétés
|
properties | array of string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | array of string |
Propriétés avec l’historique. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Obtenir un e-mail
Récupère un objet identifié par « emailId ». 'emailId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Propriétés
|
properties | string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | string |
Propriétés avec l’historique. |
|
|
Associations
|
associations | string |
Les associations. |
|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
|
|
ID de courrier électronique
|
emailId | True | string |
Identificateur d’e-mail. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Obtenir un lot de communications
Récupère un lot de communications par ID interne ou par valeurs de propriété uniques.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
|
ID
|
id | string |
Identificateur. |
|
|
Propriétés
|
properties | array of string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | array of string |
Propriétés avec l’historique. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Obtenir un lot de courrier postal
Récupère un lot de courrier postal par ID interne ou par valeurs de propriété uniques.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
|
ID
|
id | string |
Identificateur. |
|
|
Propriétés
|
properties | array of string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | array of string |
Propriétés avec l’historique. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Obtenir un lot de notes
Récupère un lot de notes par ID interne ou par valeurs de propriété uniques.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
|
ID
|
id | string |
Identificateur. |
|
|
Propriétés
|
properties | array of string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | array of string |
Propriétés avec l’historique. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Obtenir un lot d’appels
Récupère un lot d’appels par ID interne ou par valeurs de propriété uniques.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
|
ID
|
id | string |
Identificateur. |
|
|
Propriétés
|
properties | array of string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | array of string |
Propriétés avec l’historique. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Obtenir un lot d’e-mails
Récupère un lot d’e-mails par ID interne ou par valeurs de propriété uniques.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
|
ID
|
id | string |
Identificateur. |
|
|
Propriétés
|
properties | array of string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | array of string |
Propriétés avec l’historique. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Terminé à
|
completedAt | string |
Une fois terminé. |
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Démarré à
|
startedAt | string |
Quand il a commencé à. |
|
Statut
|
status | string |
État. |
|
Demandé à
|
requestedAt | string |
Lorsqu’il est demandé à l’adresse. |
Obtenir une note
Récupère un objet identifié par 'noteId'. 'noteId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Propriétés
|
properties | string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | string |
Propriétés avec l’historique. |
|
|
Associations
|
associations | string |
Les associations. |
|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
|
|
Note ID
|
noteId | True | string |
Identificateur de note. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Obtenir une réunion
Récupère un objet identifié par « meetingId ». 'meetingId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Propriétés
|
properties | string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | string |
Propriétés avec l’historique. |
|
|
Associations
|
associations | string |
Les associations. |
|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
|
|
ID de réunion
|
meetingId | True | string |
Identificateur de réunion. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Obtenir une tâche
Récupère un objet identifié par 'taskId'. 'taskId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Propriétés
|
properties | string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | string |
Propriétés avec l’historique. |
|
|
Associations
|
associations | string |
Les associations. |
|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
|
|
ID de tâche
|
taskId | True | string |
Identificateur de tâche. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Rechercher des communications
Récupérez une liste de communications.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Après
|
after | string |
Après. |
|
|
Operator
|
operator | string |
Opérateur. |
|
|
Nom de la propriété
|
propertyName | string |
Nom de la propriété. |
|
|
Valeur
|
value | string |
Valeur. |
|
|
Valeur élevée
|
highValue | string |
Valeur élevée. |
|
|
Valeurs
|
values | array of string |
Valeurs. |
|
|
Limit
|
limit | string |
La limite. |
|
|
Propriétés
|
properties | array of string |
Propriétés. |
|
|
Sortes
|
sorts | array of string |
Tris. |
|
|
Query
|
query | string |
Requête. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Total
|
total | integer |
Total. |
|
Après
|
paging.next.after | string |
Après. |
|
Lien
|
paging.next.link | string |
Lien. |
Rechercher des réunions
Récupérez une liste de réunions.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Après
|
after | string |
Après. |
|
|
Operator
|
operator | string |
Opérateur. |
|
|
Nom de la propriété
|
propertyName | string |
Nom de la propriété. |
|
|
Valeur
|
value | string |
Valeur. |
|
|
Valeur élevée
|
highValue | string |
Valeur élevée. |
|
|
Valeurs
|
values | array of string |
Valeurs. |
|
|
Limit
|
limit | string |
La limite. |
|
|
Propriétés
|
properties | array of string |
Propriétés. |
|
|
Sortes
|
sorts | array of string |
Tris. |
|
|
Query
|
query | string |
Requête. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Total
|
total | integer |
Total. |
|
Après
|
paging.next.after | string |
Après. |
|
Lien
|
paging.next.link | string |
Lien. |
Rechercher un courrier postal
Récupérez une liste de courriers postaux.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Après
|
after | string |
Après. |
|
|
Operator
|
operator | string |
Opérateur. |
|
|
Nom de la propriété
|
propertyName | string |
Nom de la propriété. |
|
|
Valeur
|
value | string |
Valeur. |
|
|
Valeur élevée
|
highValue | string |
Valeur élevée. |
|
|
Valeurs
|
values | array of string |
Valeurs. |
|
|
Limit
|
limit | string |
La limite. |
|
|
Propriétés
|
properties | array of string |
Propriétés. |
|
|
Sortes
|
sorts | array of string |
Tris. |
|
|
Query
|
query | string |
Requête. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Total
|
total | integer |
Total. |
|
Après
|
paging.next.after | string |
Après. |
|
Lien
|
paging.next.link | string |
Lien. |
Rechercher un e-mail
Récupérez une liste d’e-mails.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Après
|
after | string |
Après. |
|
|
Operator
|
operator | string |
Opérateur. |
|
|
Nom de la propriété
|
propertyName | string |
Nom de la propriété. |
|
|
Valeur
|
value | string |
Valeur. |
|
|
Valeur élevée
|
highValue | string |
Valeur élevée. |
|
|
Valeurs
|
values | array of string |
Valeurs. |
|
|
Limit
|
limit | string |
La limite. |
|
|
Propriétés
|
properties | array of string |
Propriétés. |
|
|
Sortes
|
sorts | array of string |
Tris. |
|
|
Query
|
query | string |
Requête. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Total
|
total | integer |
Total. |
|
Après
|
paging.next.after | string |
Après. |
|
Lien
|
paging.next.link | string |
Lien. |
Remarque de mise à jour
Effectue une mise à jour partielle d’un objet identifié par « noteId ». 'noteId' fait référence à l’ID d’objet interne par défaut, ou éventuellement toute valeur de propriété unique spécifiée par l’analyseur idProperty de requête. Les valeurs de propriété fournies seront remplacées. Les propriétés en lecture seule et inexistantes sont ignorées. Les valeurs des propriétés peuvent être effacées en passant une chaîne vide.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
|
|
Note ID
|
noteId | True | string |
Identificateur de note. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé à
|
createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
id | string |
Identificateur. |
|
Mise à jour à
|
updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
archivedAt | string |
Lors de l’archivage à l’adresse. |
Répertorier le courrier postal
Récupère une page de courrier postal. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
La limite. |
|
|
Après
|
after | string |
Après. |
|
|
Propriétés
|
properties | string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | string |
Propriétés avec l’historique. |
|
|
Associations
|
associations | string |
Les associations. |
|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Après
|
paging.next.after | string |
Après. |
|
Lien
|
paging.next.link | string |
Lien. |
Répertorier les appels
Récupère une page d’appels. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
La limite. |
|
|
Après
|
after | string |
Après. |
|
|
Propriétés
|
properties | string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | string |
Propriétés avec l’historique. |
|
|
Associations
|
associations | string |
Les associations. |
|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Après
|
paging.next.after | string |
Après. |
|
Lien
|
paging.next.link | string |
Lien. |
Répertorier les communications
Récupère une page de communications. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
La limite. |
|
|
Après
|
after | string |
Après. |
|
|
Propriétés
|
properties | string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | string |
Propriétés avec l’historique. |
|
|
Associations
|
associations | string |
Les associations. |
|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Après
|
paging.next.after | string |
Après. |
|
Lien
|
paging.next.link | string |
Lien. |
Répertorier les réunions
Récupère une page de réunions. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
La limite. |
|
|
Après
|
after | string |
Après. |
|
|
Propriétés
|
properties | string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | string |
Propriétés avec l’historique. |
|
|
Associations
|
associations | string |
Les associations. |
|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Après
|
paging.next.after | string |
Après. |
|
Lien
|
paging.next.link | string |
Lien. |
Répertorier les tâches
Récupère une page de tâches. Contrôlez ce qui est retourné via l’analyseur de properties requête.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
La limite. |
|
|
Après
|
after | string |
Après. |
|
|
Propriétés
|
properties | string |
Propriétés. |
|
|
Propriétés avec historique
|
propertiesWithHistory | string |
Propriétés avec l’historique. |
|
|
Associations
|
associations | string |
Les associations. |
|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Après
|
paging.next.after | string |
Après. |
|
Lien
|
paging.next.link | string |
Lien. |
Supprimer un appel - RGPD
Supprime définitivement un appel et tout le contenu associé pour suivre le RGPD. Utilisez la propriété facultative « idProperty » définie sur « email » pour identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’objet
|
objectId | string |
Identificateur d’objet. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
Retours
- response
- string
Supprimer un courrier postal - RGPD
Supprime définitivement un courrier postal et tout le contenu associé pour suivre le RGPD. Utilisez la propriété facultative « idProperty » définie sur « email » pour identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’objet
|
objectId | string |
Identificateur d’objet. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
Retours
- response
- string
Supprimer un e-mail - RGPD
Supprime définitivement un e-mail et tout le contenu associé pour suivre le RGPD. Utilisez la propriété facultative « idProperty » définie sur « email » pour identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’objet
|
objectId | string |
Identificateur d’objet. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
Retours
- response
- string
Supprimer une communication - RGPD
Supprime définitivement une communication et tout le contenu associé pour suivre le RGPD. Utilisez la propriété facultative « idProperty » définie sur « email » pour identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’objet
|
objectId | string |
Identificateur d’objet. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
Retours
- response
- string
Supprimer une note - RGPD
Supprime définitivement une note et tout le contenu associé à suivre le RGPD. Utilisez la propriété facultative « idProperty » définie sur « email » pour identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’objet
|
objectId | string |
Identificateur d’objet. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
Retours
- response
- string
Supprimer une réunion - RGPD
Supprime définitivement une réunion et tout le contenu associé pour suivre le RGPD. Utilisez la propriété facultative « idProperty » définie sur « email » pour identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’objet
|
objectId | string |
Identificateur d’objet. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
Retours
- response
- string
Supprimer une tâche - RGPD
Supprime définitivement une tâche et tout le contenu associé pour suivre le RGPD. Utilisez la propriété facultative « idProperty » définie sur « email » pour identifier le contact par adresse e-mail. Si l’adresse e-mail est introuvable, l’adresse e-mail est ajoutée à une liste de blocage et empêche son utilisation ultérieure.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’objet
|
objectId | string |
Identificateur d’objet. |
|
|
ID, propriété
|
idProperty | string |
Propriété d’identificateur. |
Retours
- response
- string
Tâche d’archivage
Déplace un objet identifié par « taskId » vers la corbeille.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de tâche
|
taskId | True | string |
Identificateur de tâche. |
Retours
- response
- string
Tâches de recherche
Récupérez une liste de tâches.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Après
|
after | string |
Après. |
|
|
Operator
|
operator | string |
Opérateur. |
|
|
Nom de la propriété
|
propertyName | string |
Nom de la propriété. |
|
|
Valeur
|
value | string |
Valeur. |
|
|
Valeur élevée
|
highValue | string |
Valeur élevée. |
|
|
Valeurs
|
values | array of string |
Valeurs. |
|
|
Limit
|
limit | string |
La limite. |
|
|
Propriétés
|
properties | array of string |
Propriétés. |
|
|
Sortes
|
sorts | array of string |
Tris. |
|
|
Query
|
query | string |
Requête. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Créé à
|
results.createdAt | string |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Mise à jour à
|
results.updatedAt | string |
Lorsqu’il est mis à jour à l’adresse. |
|
Archivés
|
results.archived | boolean |
Indique s’il est archivé. |
|
Archiver At
|
results.archivedAt | string |
Lors de l’archivage à l’adresse. |
|
Total
|
total | integer |
Total. |
|
Après
|
paging.next.after | string |
Après. |
|
Lien
|
paging.next.link | string |
Lien. |
Définitions
ficelle
Il s’agit du type de données de base « string ».