Freigeben über


HubSpot Engagements V2 (Unabhängiger Herausgeber) (Vorschau)

HubSpot Engagements wird verwendet, um Ihre CRM-Datensätze up-to-Datum für alle Interaktionen zu speichern, die außerhalb von HubSpot stattfinden. Aktivitätsberichte im CRM werden ebenfalls von diesen Daten abgespeist.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connectormetadaten
Herausgeber Troy Taylor
Webseite https://www.hubspot.com/products/crm
Datenschutzrichtlinie https://legal.hubspot.com/privacy-policy
Kategorien Vertrieb und CRM; Kommunikation

HubSpot Engagements V2

HubSpot Engagements wird verwendet, um Ihre CRM-Datensätze up-to-Datum für alle Interaktionen zu speichern, die außerhalb von HubSpot stattfinden. Aktivitätsberichte im CRM werden ebenfalls von diesen Daten abgespeist.

Herausgeber: Troy Taylor, Hitachi Solutions

Voraussetzungen

Sie müssen über ein Konto mit HubSpot verfügen und ein Super-Administrator sein.

Abrufen von Anmeldeinformationen

Sobald Sie bei Ihrem Konto angemeldet sind, wechseln Sie zu "Einstellungen" –> Kontoeinrichtung –> Integrationen –> Private Apps. Sie müssen eine private App erstellen und nur die Bereiche zuweisen, für die Sie Aktionen verwenden. Nachdem Ihre private App erstellt wurde, verfügen Sie im Abschnitt "Authentifizierung" der privaten App über ein Zugriffstoken.

Unterstützte Vorgänge

Erstellen eines Batches von Anrufen

Erstellt einen Batch von Aufrufen.

Abrufen eines Batches von Anrufen

Ruft einen Batch von Aufrufen nach interner ID oder eindeutigen Eigenschaftswerten ab.

Aktualisieren eines Batches von Anrufen

Aktualisiert einen Batch von Anrufen.

Archivbatch von Anrufen

Archiviert einen Batch von Anrufen nach ID.

Auflisten von Anrufen

Ruft eine Seite mit Anrufen ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Erstellen eines Anrufs

Erstellt einen Aufruf mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID.

Lesen eines Objekts

Ruft ein objekt ab, das von callId. callId bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty Abfrageparameter angegeben wird. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Archivieren eines Objekts

Verschiebt ein objekt, das durch callId den Papierkorb identifiziert wird.

Aktualisieren eines Objekts

Führt eine teilweise Aktualisierung eines durch callId. callId bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty Abfrageparameter angegeben wird. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Zusammenführen von zwei Aufrufen

Führt zwei Aufrufe mit demselben Typ zusammen.

Löschen eines Anrufs – DSGVO

Löscht einen Aufruf und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie optionalen Eigenschaftensatz idProperty , um den Kontakt nach E-Mail-Adresse zu email identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Suchen von Anrufen

Ruft eine Liste von Anrufen ab.

Erstellen eines Batches von E-Mails

Erstellt einen Batch von E-Mails.

Abrufen eines Batches von E-Mails

Ruft einen Batch von E-Mails nach interner ID oder eindeutigen Eigenschaftswerten ab.

Archivbatch von E-Mails

Archiviert einen Batch von E-Mails nach ID.

Aktualisieren eines Batches von E-Mails

Aktualisiert einen Batch von E-Mails.

E-Mails auflisten

Ruft eine Seite mit E-Mails ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Erstellen einer E-Mail

Erstellt eine E-Mail mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID.

E-Mail abrufen

Ruft ein objekt ab, das von emailId. emailId bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty Abfrageparameter angegeben wird. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

E-Mail archiven

Verschiebt ein objekt, das durch emailId den Papierkorb identifiziert wird.

E-Mail aktualisieren

Führt eine teilweise Aktualisierung eines durch emailId. emailId bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty Abfrageparameter angegeben wird. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Zusammenführen von zwei E-Mails

Führt zwei E-Mails mit demselben Typ zusammen.

Löschen einer E-Mail – DSGVO

Löscht eine E-Mail und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie optionalen Eigenschaftensatz idProperty , um den Kontakt nach E-Mail-Adresse zu email identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

E-Mail durchsuchen

Dient zum Abrufen einer Liste von E-Mails.

Aktualisieren eines Batches von Besprechungen

Aktualisiert einen Batch von Besprechungen.

Archivbatch von Besprechungen

Archiviert eine Reihe von Besprechungen nach ID.

Abrufen eines Batches von Besprechungen

Ruft einen Batch von Besprechungen nach interner ID oder eindeutigen Eigenschaftswerten ab.

Erstellen eines Batches von Besprechungen

Erstellt einen Batch von Besprechungen.

Besprechung abrufen

Ruft ein objekt ab, das von meetingId. meetingId bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty Abfrageparameter angegeben wird. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Archivbesprechung

Verschiebt ein objekt, das durch meetingId den Papierkorb identifiziert wird.

Besprechung aktualisieren

Führt eine teilweise Aktualisierung eines durch meetingId. meetingId bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty Abfrageparameter angegeben wird. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Besprechungen auflisten

Ruft eine Seite mit Besprechungen ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Besprechung erstellen

Erstellt eine Besprechung mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID.

Zusammenführen von zwei Besprechungen

Führt zwei Besprechungen mit demselben Typ zusammen.

Löschen einer Besprechung – DSGVO

Löscht eine Besprechung und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie optionalen Eigenschaftensatz idProperty , um den Kontakt nach E-Mail-Adresse zu email identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Durchsuchen von Besprechungen

Dient zum Abrufen einer Liste von Besprechungen.

Abrufen eines Batches von Notizen

Ruft einen Batch von Notizen anhand der internen ID oder eindeutiger Eigenschaftswerte ab.

Archivbatch von Notizen

Archiviert einen Batch von Notizen nach ID.

Batch von Notizen aktualisieren

Aktualisiert einen Batch von Notizen.

Erstellen eines Batches von Notizen

Erstellt einen Batch von Notizen.

Notizen auflisten

Ruft eine Seite mit Notizen ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Notiz erstellen

Erstellt eine Notiz mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID.

Notiz abrufen

Ruft ein objekt ab, das von noteId. noteId bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty Abfrageparameter angegeben wird. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Archivnotiz

Verschiebt ein objekt, das durch noteId den Papierkorb identifiziert wird.

Notiz aktualisieren

Führt eine teilweise Aktualisierung eines durch noteId. noteId bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty Abfrageparameter angegeben wird. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Zusammenführen von zwei Notizen

Führt zwei Notizen mit demselben Typ zusammen.

Löschen einer Notiz – DSGVO

Löscht eine Notiz und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie optionalen Eigenschaftensatz idProperty , um den Kontakt nach E-Mail-Adresse zu email identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Durchsuchen von Notizen

Ruft eine Liste von Notizen ab.

Abrufen eines Batches von Postsendungen

Ruft einen Batch von Postsendungen nach interner ID oder eindeutigen Eigenschaftswerten ab.

Archivbatch von Postsendungen

Archiviert einen Batch von Postsendungen nach ID.

Erstellen eines Batches von Postsendungen

Erstellt einen Batch von Postsendungen.

Batch der Postsendung aktualisieren

Aktualisiert einen Batch von Postsendungen.

Postpost auflisten

Ruft eine Seite mit Postsendungen ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Erstellen von Postsendungen

Erstellt eine Post-E-Mail mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID.

Postsendung abrufen

Ruft ein objekt ab, das von postalMailId. postalMailId bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty Abfrageparameter angegeben wird. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Postpost archiven

Verschiebt ein objekt, das durch postalMailId den Papierkorb identifiziert wird.

Aktualisieren von Postsendungen

Führt eine teilweise Aktualisierung eines durch postalMailId. postalMailId bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty Abfrageparameter angegeben wird. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Seriendruck mit zwei Postsendungen

Führt zwei Postsendungen mit demselben Typ zusammen.

Löschen einer Postsendung – DSGVO

Löscht eine Postsendung und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie optionalen Eigenschaftensatz idProperty , um den Kontakt nach E-Mail-Adresse zu email identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Postsendungen durchsuchen

Dient zum Abrufen einer Liste von Postsendungen.

Archivbatch von Aufgaben

Archiviert einen Batch von Aufgaben nach ID.

Erstellen einer Reihe von Aufgaben

Erstellt einen Batch von Vorgängen.

Aktualisieren eines Aufgabenbatches

Aktualisiert einen Aufgabenbatch.

Abrufen eines Batches von Aufgaben

Ruft einen Aufgabenbatch nach interner ID oder eindeutigen Eigenschaftswerten ab.

Aufgabe abrufen

Ruft ein objekt ab, das von taskId. taskId bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty Abfrageparameter angegeben wird. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Archivaufgabe

Verschiebt ein objekt, das durch taskId den Papierkorb identifiziert wird.

Aufgabe aktualisieren

Führt eine teilweise Aktualisierung eines durch taskId. taskId bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty Abfrageparameter angegeben wird. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Aufgaben auflisten

Ruft eine Seite mit Aufgaben ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Aufgabe erstellen

Erstellt eine Aufgabe mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID. Dokumentation und Beispiele zum Erstellen von Standardaufgaben werden bereitgestellt.

Zusammenführen von zwei Aufgaben

Führt zwei Vorgänge mit demselben Typ zusammen.

Löschen einer Aufgabe – DSGVO

Löscht eine Aufgabe und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie optionalen Eigenschaftensatz idProperty , um den Kontakt nach E-Mail-Adresse zu email identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Suchaufgaben

Dient zum Abrufen einer Liste von Aufgaben.

Batch der Kommunikation aktualisieren

Aktualisiert eine Reihe von Kommunikationen.

Archivbatch der Kommunikation

Archiviert eine Reihe von Kommunikationen nach ID.

Erstellen einer Reihe von Kommunikationen

Erstellt einen Batch von Kommunikationen.

Abrufen von Kommunikationsbatch

Ruft eine Reihe von Kommunikationen nach interner ID oder eindeutigen Eigenschaftswerten ab.

Kommunikation auflisten

Ruft eine Seite der Kommunikation ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Kommunikation erstellen

Erstellt eine Kommunikation mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID.

Kommunikation abrufen

Ruft ein objekt ab, das von communicationId. communicationId bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty Abfrageparameter angegeben wird. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Archivkommunikation

Verschiebt ein objekt, das durch communicationId den Papierkorb identifiziert wird.

Kommunikation aktualisieren

Führt eine teilweise Aktualisierung eines durch communicationId. communicationId bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty Abfrageparameter angegeben wird. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Zusammenführen von zwei Kommunikationen

Führt zwei Kommunikationen mit demselben Typ zusammen.

Löschen einer Kommunikation – DSGVO

Löscht eine Kommunikation und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie optionalen Eigenschaftensatz idProperty , um den Kontakt nach E-Mail-Adresse zu email identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Suchkommunikation

Dient zum Abrufen einer Liste von Kommunikationen.

Bekannte Probleme und Einschränkungen

Derzeit gibt es keine bekannten Probleme.

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:

Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name Typ Description Erforderlich
Zugriffstoken (im Format "Bearer YOUR_ACCESS_TOKEN") securestring Das Zugriffstoken (im Format "Bearer YOUR_ACCESS_TOKEN") für diese API Richtig

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Abrufen eines Batches von Anrufen

Ruft einen Batch von Aufrufen nach interner ID oder eindeutigen Eigenschaftswerten ab.

Abrufen eines Batches von Aufgaben

Ruft einen Aufgabenbatch nach interner ID oder eindeutigen Eigenschaftswerten ab.

Abrufen eines Batches von Besprechungen

Ruft einen Batch von Besprechungen nach interner ID oder eindeutigen Eigenschaftswerten ab.

Abrufen eines Batches von E-Mails

Ruft einen Batch von E-Mails nach interner ID oder eindeutigen Eigenschaftswerten ab.

Abrufen eines Batches von Notizen

Ruft einen Batch von Notizen anhand der internen ID oder eindeutiger Eigenschaftswerte ab.

Abrufen eines Batches von Postsendungen

Ruft einen Batch von Postsendungen nach interner ID oder eindeutigen Eigenschaftswerten ab.

Abrufen von Kommunikationsbatch

Ruft eine Reihe von Kommunikationen nach interner ID oder eindeutigen Eigenschaftswerten ab.

Aktualisieren eines Aufgabenbatches

Aktualisiert einen Aufgabenbatch.

Aktualisieren eines Batches von Anrufen

Aktualisiert einen Batch von Anrufen.

Aktualisieren eines Batches von Besprechungen

Aktualisiert einen Batch von Besprechungen.

Aktualisieren eines Batches von E-Mails

Aktualisiert einen Batch von E-Mails.

Aktualisieren eines Objekts

Führt eine teilweise Aktualisierung eines objekts durch 'callId' identifiziert. "callId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Aktualisieren von Postsendungen

Führt eine teilweise Aktualisierung eines objekts durch "postalMailId" identifiziert. "postalMailId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Archivaufgabe

Verschiebt ein durch "taskId" identifiziertes Objekt in den Papierkorb.

Archivbatch der Kommunikation

Archiviert eine Reihe von Kommunikationen nach ID.

Archivbatch von Anrufen

Archiviert einen Batch von Anrufen nach ID.

Archivbatch von Aufgaben

Archiviert einen Batch von Aufgaben nach ID.

Archivbatch von Besprechungen

Archiviert eine Reihe von Besprechungen nach ID.

Archivbatch von E-Mails

Archiviert einen Batch von E-Mails nach ID.

Archivbatch von Notizen

Archiviert einen Batch von Notizen nach ID.

Archivbatch von Postsendungen

Archiviert einen Batch von Postsendungen nach ID.

Archivbesprechung

Verschiebt ein durch "meetingId" identifiziertes Objekt in den Papierkorb.

Archivieren eines Objekts

Verschiebt ein durch "callId" identifiziertes Objekt in den Papierkorb.

Archivkommunikation

Verschiebt ein durch "communicationId" identifiziertes Objekt in den Papierkorb.

Archivnotiz

Verschiebt ein durch "noteId" identifiziertes Objekt in den Papierkorb.

Aufgabe abrufen

Ruft ein objekt ab, das durch "taskId" identifiziert wird. "taskId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Aufgabe aktualisieren

Führt eine partielle Aktualisierung eines objekts durch 'taskId' identifiziert. "taskId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Aufgabe erstellen

Erstellt eine Aufgabe mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID. Dokumentation und Beispiele zum Erstellen von Standardaufgaben werden bereitgestellt.

Aufgaben auflisten

Ruft eine Seite mit Aufgaben ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Auflisten von Anrufen

Ruft eine Seite mit Anrufen ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Batch der Kommunikation aktualisieren

Aktualisiert eine Reihe von Kommunikationen.

Batch der Postsendung aktualisieren

Aktualisiert einen Batch von Postsendungen.

Batch von Notizen aktualisieren

Aktualisiert einen Batch von Notizen.

Besprechung abrufen

Ruft ein objekt ab, das durch "meetingId" identifiziert wird. "meetingId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Besprechung aktualisieren

Führt eine teilweise Aktualisierung eines objekts durch "meetingId" identifiziert. "meetingId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Besprechung erstellen

Erstellt eine Besprechung mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID.

Besprechungen auflisten

Ruft eine Seite mit Besprechungen ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Durchsuchen von Besprechungen

Dient zum Abrufen einer Liste von Besprechungen.

Durchsuchen von Notizen

Ruft eine Liste von Notizen ab.

E-Mail abrufen

Ruft ein objekt ab, das durch "emailId" identifiziert wurde. "emailId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

E-Mail aktualisieren

Führt eine teilweise Aktualisierung eines objekts durch "emailId" identifiziert. "emailId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

E-Mail archiven

Verschiebt ein durch "emailId" identifiziertes Objekt in den Papierkorb.

E-Mail durchsuchen

Dient zum Abrufen einer Liste von E-Mails.

E-Mails auflisten

Ruft eine Seite mit E-Mails ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Erstellen einer E-Mail

Erstellt eine E-Mail mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID.

Erstellen einer Reihe von Aufgaben

Erstellt einen Batch von Vorgängen.

Erstellen einer Reihe von Kommunikationen

Erstellt einen Batch von Kommunikationen.

Erstellen eines Anrufs

Erstellt einen Aufruf mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID.

Erstellen eines Batches von Anrufen

Erstellt einen Batch von Aufrufen.

Erstellen eines Batches von Besprechungen

Erstellt einen Batch von Besprechungen.

Erstellen eines Batches von E-Mails

Erstellt einen Batch von E-Mails.

Erstellen eines Batches von Notizen

Erstellt einen Batch von Notizen.

Erstellen eines Batches von Postsendungen

Erstellt einen Batch von Postsendungen.

Erstellen von Postsendungen

Erstellt eine Post-E-Mail mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID.

Kommunikation abrufen

Ruft ein durch "communicationId" identifiziertes Objekt ab. "communicationId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Kommunikation aktualisieren

Führt eine teilweise Aktualisierung eines objekts durch 'communicationId' identifiziert. "communicationId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Kommunikation auflisten

Ruft eine Seite der Kommunikation ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Kommunikation erstellen

Erstellt eine Kommunikation mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID.

Lesen eines Objekts

Ruft ein durch "callId" identifiziertes Objekt ab. "callId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Löschen einer Aufgabe – DSGVO

Löscht eine Aufgabe und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "idProperty" auf "email", um den Kontakt nach E-Mail-Adresse zu identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Löschen einer Besprechung – DSGVO

Löscht eine Besprechung und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "idProperty" auf "email", um den Kontakt nach E-Mail-Adresse zu identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Löschen einer E-Mail – DSGVO

Löscht eine E-Mail und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "idProperty" auf "email", um den Kontakt nach E-Mail-Adresse zu identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Löschen einer Kommunikation – DSGVO

Löscht eine Kommunikation und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "idProperty" auf "email", um den Kontakt nach E-Mail-Adresse zu identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Löschen einer Notiz – DSGVO

Löscht eine Notiz und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "idProperty" auf "email", um den Kontakt nach E-Mail-Adresse zu identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Löschen einer Postsendung – DSGVO

Löscht eine Postsendung und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "idProperty" auf "email", um den Kontakt nach E-Mail-Adresse zu identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Löschen eines Anrufs – DSGVO

Löscht einen Aufruf und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "idProperty" auf "email", um den Kontakt nach E-Mail-Adresse zu identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Notiz abrufen

Ruft ein durch "noteId" identifiziertes Objekt ab. "noteId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Notiz aktualisieren

Führt eine teilweise Aktualisierung eines objekts durch "noteId" identifiziert. "noteId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Notiz erstellen

Erstellt eine Notiz mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID.

Notizen auflisten

Ruft eine Seite mit Notizen ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Postpost archiven

Verschiebt ein durch "postalMailId" identifiziertes Objekt in den Papierkorb.

Postpost auflisten

Ruft eine Seite mit Postsendungen ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Postsendung abrufen

Ruft ein Objekt ab, das durch "postalMailId" identifiziert wird. "postalMailId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Postsendungen durchsuchen

Dient zum Abrufen einer Liste von Postsendungen.

Seriendruck mit zwei Postsendungen

Führt zwei Postsendungen mit demselben Typ zusammen.

Suchaufgaben

Dient zum Abrufen einer Liste von Aufgaben.

Suchen von Anrufen

Ruft eine Liste von Anrufen ab.

Suchkommunikation

Dient zum Abrufen einer Liste von Kommunikationen.

Zusammenführen von zwei Aufgaben

Führt zwei Vorgänge mit demselben Typ zusammen.

Zusammenführen von zwei Aufrufen

Führt zwei Aufrufe mit demselben Typ zusammen.

Zusammenführen von zwei Besprechungen

Führt zwei Besprechungen mit demselben Typ zusammen.

Zusammenführen von zwei E-Mails

Führt zwei E-Mails mit demselben Typ zusammen.

Zusammenführen von zwei Kommunikationen

Führt zwei Kommunikationen mit demselben Typ zusammen.

Zusammenführen von zwei Notizen

Führt zwei Notizen mit demselben Typ zusammen.

Abrufen eines Batches von Anrufen

Ruft einen Batch von Aufrufen nach interner ID oder eindeutigen Eigenschaftswerten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt an, ob archiviert.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit verlauf.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Abrufen eines Batches von Aufgaben

Ruft einen Aufgabenbatch nach interner ID oder eindeutigen Eigenschaftswerten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt an, ob archiviert.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit verlauf.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Abrufen eines Batches von Besprechungen

Ruft einen Batch von Besprechungen nach interner ID oder eindeutigen Eigenschaftswerten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt an, ob archiviert.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit verlauf.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Abrufen eines Batches von E-Mails

Ruft einen Batch von E-Mails nach interner ID oder eindeutigen Eigenschaftswerten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt an, ob archiviert.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit verlauf.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Abrufen eines Batches von Notizen

Ruft einen Batch von Notizen anhand der internen ID oder eindeutiger Eigenschaftswerte ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt an, ob archiviert.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit verlauf.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Abrufen eines Batches von Postsendungen

Ruft einen Batch von Postsendungen nach interner ID oder eindeutigen Eigenschaftswerten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt an, ob archiviert.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit verlauf.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Abrufen von Kommunikationsbatch

Ruft eine Reihe von Kommunikationen nach interner ID oder eindeutigen Eigenschaftswerten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt an, ob archiviert.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit verlauf.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Aktualisieren eines Aufgabenbatches

Aktualisiert einen Aufgabenbatch.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Aktualisieren eines Batches von Anrufen

Aktualisiert einen Batch von Anrufen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Aktualisieren eines Batches von Besprechungen

Aktualisiert einen Batch von Besprechungen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Aktualisieren eines Batches von E-Mails

Aktualisiert einen Batch von E-Mails.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Aktualisieren eines Objekts

Führt eine teilweise Aktualisierung eines objekts durch 'callId' identifiziert. "callId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Anruf-ID
callId True string

Der Anrufbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Aktualisieren von Postsendungen

Führt eine teilweise Aktualisierung eines objekts durch "postalMailId" identifiziert. "postalMailId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Post-E-Mail-ID
postalMailId True string

Die Post-E-Mail-ID.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Archivaufgabe

Verschiebt ein durch "taskId" identifiziertes Objekt in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Vorgangsnummer
taskId True string

Der Vorgangsbezeichner.

Gibt zurück

response
string

Archivbatch der Kommunikation

Archiviert eine Reihe von Kommunikationen nach ID.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archivbatch von Anrufen

Archiviert einen Batch von Anrufen nach ID.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archivbatch von Aufgaben

Archiviert einen Batch von Aufgaben nach ID.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archivbatch von Besprechungen

Archiviert eine Reihe von Besprechungen nach ID.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archivbatch von E-Mails

Archiviert einen Batch von E-Mails nach ID.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archivbatch von Notizen

Archiviert einen Batch von Notizen nach ID.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archivbatch von Postsendungen

Archiviert einen Batch von Postsendungen nach ID.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archivbesprechung

Verschiebt ein durch "meetingId" identifiziertes Objekt in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Besprechungs-ID
meetingId True string

Der Besprechungsbezeichner.

Gibt zurück

response
string

Archivieren eines Objekts

Verschiebt ein durch "callId" identifiziertes Objekt in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Anruf-ID
callId True string

Der Anrufbezeichner.

Gibt zurück

response
string

Archivkommunikation

Verschiebt ein durch "communicationId" identifiziertes Objekt in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Kommunikations-ID
communicationId True string

Der Kommunikationsbezeichner.

Gibt zurück

response
string

Archivnotiz

Verschiebt ein durch "noteId" identifiziertes Objekt in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Notiz-ID
noteId True string

Der Notizbezeichner.

Gibt zurück

response
string

Aufgabe abrufen

Ruft ein objekt ab, das durch "taskId" identifiziert wird. "taskId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt an, ob archiviert.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Vorgangsnummer
taskId True string

Der Vorgangsbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Aufgabe aktualisieren

Führt eine partielle Aktualisierung eines objekts durch 'taskId' identifiziert. "taskId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Vorgangsnummer
taskId True string

Der Vorgangsbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Aufgabe erstellen

Erstellt eine Aufgabe mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID. Dokumentation und Beispiele zum Erstellen von Standardaufgaben werden bereitgestellt.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Zuordnungskategorie
associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
associationTypeId string

Der Zuordnungstypbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Aufgaben auflisten

Ruft eine Seite mit Aufgaben ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit integer

Die Grenze.

Nach
after string

Das Nachher.

Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt an, ob archiviert.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Nach
paging.next.after string

Das Nachher.

Link
paging.next.link string

Der Link.

Auflisten von Anrufen

Ruft eine Seite mit Anrufen ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit integer

Die Grenze.

Nach
after string

Das Nachher.

Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt an, ob archiviert.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Nach
paging.next.after string

Das Nachher.

Link
paging.next.link string

Der Link.

Batch der Kommunikation aktualisieren

Aktualisiert eine Reihe von Kommunikationen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Batch der Postsendung aktualisieren

Aktualisiert einen Batch von Postsendungen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Batch von Notizen aktualisieren

Aktualisiert einen Batch von Notizen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Besprechung abrufen

Ruft ein objekt ab, das durch "meetingId" identifiziert wird. "meetingId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt an, ob archiviert.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Besprechungs-ID
meetingId True string

Der Besprechungsbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Besprechung aktualisieren

Führt eine teilweise Aktualisierung eines objekts durch "meetingId" identifiziert. "meetingId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Besprechungs-ID
meetingId True string

Der Besprechungsbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Besprechung erstellen

Erstellt eine Besprechung mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Zuordnungskategorie
associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
associationTypeId string

Der Zuordnungstypbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Besprechungen auflisten

Ruft eine Seite mit Besprechungen ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit integer

Die Grenze.

Nach
after string

Das Nachher.

Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt an, ob archiviert.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Nach
paging.next.after string

Das Nachher.

Link
paging.next.link string

Der Link.

Durchsuchen von Besprechungen

Dient zum Abrufen einer Liste von Besprechungen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Das Nachher.

Bediener
operator string

Der Operator.

Objektname
propertyName string

Der Eigenschaftsname.

Wert
value string

Der Wert.

Hoher Wert
highValue string

Der hohe Wert.

Werte
values array of string

Die Werte.

Limit
limit string

Die Grenze.

Eigenschaften
properties array of string

Die Eigenschaften.

Sorten
sorts array of string

Die Sortierungen.

Query
query string

Die Abfrage.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Total
total integer

Die Summe.

Nach
paging.next.after string

Das Nachher.

Link
paging.next.link string

Der Link.

Durchsuchen von Notizen

Ruft eine Liste von Notizen ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Das Nachher.

Bediener
operator string

Der Operator.

Objektname
propertyName string

Der Eigenschaftsname.

Wert
value string

Der Wert.

Hoher Wert
highValue string

Der hohe Wert.

Werte
values array of string

Die Werte.

Limit
limit string

Die Grenze.

Eigenschaften
properties array of string

Die Eigenschaften.

Sorten
sorts array of string

Die Sortierungen.

Query
query string

Die Abfrage.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Total
total integer

Die Summe.

Nach
paging.next.after string

Das Nachher.

Link
paging.next.link string

Der Link.

E-Mail abrufen

Ruft ein objekt ab, das durch "emailId" identifiziert wurde. "emailId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt an, ob archiviert.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Email-ID
emailId True string

Der E-Mail-Bezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

E-Mail aktualisieren

Führt eine teilweise Aktualisierung eines objekts durch "emailId" identifiziert. "emailId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Email-ID
emailId True string

Der E-Mail-Bezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

E-Mail archiven

Verschiebt ein durch "emailId" identifiziertes Objekt in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Email-ID
emailId True string

Der E-Mail-Bezeichner.

Gibt zurück

response
string

E-Mail durchsuchen

Dient zum Abrufen einer Liste von E-Mails.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Das Nachher.

Bediener
operator string

Der Operator.

Objektname
propertyName string

Der Eigenschaftsname.

Wert
value string

Der Wert.

Hoher Wert
highValue string

Der hohe Wert.

Werte
values array of string

Die Werte.

Limit
limit string

Die Grenze.

Eigenschaften
properties array of string

Die Eigenschaften.

Sorten
sorts array of string

Die Sortierungen.

Query
query string

Die Abfrage.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Total
total integer

Die Summe.

Nach
paging.next.after string

Das Nachher.

Link
paging.next.link string

Der Link.

E-Mails auflisten

Ruft eine Seite mit E-Mails ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit integer

Die Grenze.

Nach
after string

Das Nachher.

Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt an, ob archiviert.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Nach
paging.next.after string

Das Nachher.

Link
paging.next.link string

Der Link.

Erstellen einer E-Mail

Erstellt eine E-Mail mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Zuordnungskategorie
associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
associationTypeId string

Der Zuordnungstypbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Erstellen einer Reihe von Aufgaben

Erstellt einen Batch von Vorgängen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Zuordnungskategorie
associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
associationTypeId string

Der Zuordnungstypbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Erstellen einer Reihe von Kommunikationen

Erstellt einen Batch von Kommunikationen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Zuordnungskategorie
associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
associationTypeId string

Der Zuordnungstypbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Erstellen eines Anrufs

Erstellt einen Aufruf mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Zuordnungskategorie
associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
associationTypeId string

Der Zuordnungstypbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Erstellen eines Batches von Anrufen

Erstellt einen Batch von Aufrufen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Zuordnungskategorie
associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
associationTypeId string

Der Zuordnungstypbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Erstellen eines Batches von Besprechungen

Erstellt einen Batch von Besprechungen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Zuordnungskategorie
associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
associationTypeId string

Der Zuordnungstypbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Erstellen eines Batches von E-Mails

Erstellt einen Batch von E-Mails.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Zuordnungskategorie
associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
associationTypeId string

Der Zuordnungstypbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Erstellen eines Batches von Notizen

Erstellt einen Batch von Notizen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Zuordnungskategorie
associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
associationTypeId string

Der Zuordnungstypbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Erstellen eines Batches von Postsendungen

Erstellt einen Batch von Postsendungen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Zuordnungskategorie
associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
associationTypeId string

Der Zuordnungstypbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Erstellen von Postsendungen

Erstellt eine Post-E-Mail mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Zuordnungskategorie
associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
associationTypeId string

Der Zuordnungstypbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Kommunikation abrufen

Ruft ein durch "communicationId" identifiziertes Objekt ab. "communicationId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt an, ob archiviert.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Kommunikations-ID
communicationId True string

Der Kommunikationsbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Kommunikation aktualisieren

Führt eine teilweise Aktualisierung eines objekts durch 'communicationId' identifiziert. "communicationId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Kommunikations-ID
communicationId True string

Der Kommunikationsbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Kommunikation auflisten

Ruft eine Seite der Kommunikation ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit integer

Die Grenze.

Nach
after string

Das Nachher.

Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt an, ob archiviert.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Nach
paging.next.after string

Das Nachher.

Link
paging.next.link string

Der Link.

Kommunikation erstellen

Erstellt eine Kommunikation mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Zuordnungskategorie
associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
associationTypeId string

Der Zuordnungstypbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Lesen eines Objekts

Ruft ein durch "callId" identifiziertes Objekt ab. "callId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt an, ob archiviert.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Anruf-ID
callId True string

Der Anrufbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Löschen einer Aufgabe – DSGVO

Löscht eine Aufgabe und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "idProperty" auf "email", um den Kontakt nach E-Mail-Adresse zu identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objekt-ID
objectId string

Der Objektbezeichner.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Gibt zurück

response
string

Löschen einer Besprechung – DSGVO

Löscht eine Besprechung und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "idProperty" auf "email", um den Kontakt nach E-Mail-Adresse zu identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objekt-ID
objectId string

Der Objektbezeichner.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Gibt zurück

response
string

Löschen einer E-Mail – DSGVO

Löscht eine E-Mail und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "idProperty" auf "email", um den Kontakt nach E-Mail-Adresse zu identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objekt-ID
objectId string

Der Objektbezeichner.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Gibt zurück

response
string

Löschen einer Kommunikation – DSGVO

Löscht eine Kommunikation und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "idProperty" auf "email", um den Kontakt nach E-Mail-Adresse zu identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objekt-ID
objectId string

Der Objektbezeichner.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Gibt zurück

response
string

Löschen einer Notiz – DSGVO

Löscht eine Notiz und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "idProperty" auf "email", um den Kontakt nach E-Mail-Adresse zu identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objekt-ID
objectId string

Der Objektbezeichner.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Gibt zurück

response
string

Löschen einer Postsendung – DSGVO

Löscht eine Postsendung und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "idProperty" auf "email", um den Kontakt nach E-Mail-Adresse zu identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objekt-ID
objectId string

Der Objektbezeichner.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Gibt zurück

response
string

Löschen eines Anrufs – DSGVO

Löscht einen Aufruf und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "idProperty" auf "email", um den Kontakt nach E-Mail-Adresse zu identifizieren. Wenn keine E-Mail-Adresse gefunden wird, wird die E-Mail-Adresse einer Sperrliste hinzugefügt und verhindert, dass sie in Zukunft verwendet wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objekt-ID
objectId string

Der Objektbezeichner.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Gibt zurück

response
string

Notiz abrufen

Ruft ein durch "noteId" identifiziertes Objekt ab. "noteId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt an, ob archiviert.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Notiz-ID
noteId True string

Der Notizbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Notiz aktualisieren

Führt eine teilweise Aktualisierung eines objekts durch "noteId" identifiziert. "noteId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Die bereitgestellten Eigenschaftswerte werden überschrieben. Schreibgeschützte und nicht vorhandene Eigenschaften werden ignoriert. Eigenschaftenwerte können durch Übergeben einer leeren Zeichenfolge gelöscht werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Notiz-ID
noteId True string

Der Notizbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Notiz erstellen

Erstellt eine Notiz mit den angegebenen Eigenschaften und gibt eine Kopie des Objekts zurück, einschließlich der ID.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Zuordnungskategorie
associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
associationTypeId string

Der Zuordnungstypbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Notizen auflisten

Ruft eine Seite mit Notizen ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit integer

Die Grenze.

Nach
after string

Das Nachher.

Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt an, ob archiviert.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Nach
paging.next.after string

Das Nachher.

Link
paging.next.link string

Der Link.

Postpost archiven

Verschiebt ein durch "postalMailId" identifiziertes Objekt in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Post-E-Mail-ID
postalMailId True string

Die Post-E-Mail-ID.

Gibt zurück

response
string

Postpost auflisten

Ruft eine Seite mit Postsendungen ab. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit integer

Die Grenze.

Nach
after string

Das Nachher.

Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt an, ob archiviert.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Nach
paging.next.after string

Das Nachher.

Link
paging.next.link string

Der Link.

Postsendung abrufen

Ruft ein Objekt ab, das durch "postalMailId" identifiziert wird. "postalMailId" bezieht sich standardmäßig auf die interne Objekt-ID oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty Abfrageparameter angegeben. Steuern Sie, was über den properties Abfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt an, ob archiviert.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Post-E-Mail-ID
postalMailId True string

Die Post-E-Mail-ID.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Postsendungen durchsuchen

Dient zum Abrufen einer Liste von Postsendungen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Das Nachher.

Bediener
operator string

Der Operator.

Objektname
propertyName string

Der Eigenschaftsname.

Wert
value string

Der Wert.

Hoher Wert
highValue string

Der hohe Wert.

Werte
values array of string

Die Werte.

Limit
limit string

Die Grenze.

Eigenschaften
properties array of string

Die Eigenschaften.

Sorten
sorts array of string

Die Sortierungen.

Query
query string

Die Abfrage.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Total
total integer

Die Summe.

Nach
paging.next.after string

Das Nachher.

Link
paging.next.link string

Der Link.

Seriendruck mit zwei Postsendungen

Führt zwei Postsendungen mit demselben Typ zusammen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Zusammenführende Objekt-ID
objectIdToMerge string

Der zusammenzuführende Objektbezeichner.

Primäre Objekt-ID
primaryObjectId string

Der primäre Objektbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Suchaufgaben

Dient zum Abrufen einer Liste von Aufgaben.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Das Nachher.

Bediener
operator string

Der Operator.

Objektname
propertyName string

Der Eigenschaftsname.

Wert
value string

Der Wert.

Hoher Wert
highValue string

Der hohe Wert.

Werte
values array of string

Die Werte.

Limit
limit string

Die Grenze.

Eigenschaften
properties array of string

Die Eigenschaften.

Sorten
sorts array of string

Die Sortierungen.

Query
query string

Die Abfrage.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Total
total integer

Die Summe.

Nach
paging.next.after string

Das Nachher.

Link
paging.next.link string

Der Link.

Suchen von Anrufen

Ruft eine Liste von Anrufen ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Das Nachher.

Bediener
operator string

Der Operator.

Objektname
propertyName string

Der Eigenschaftsname.

Wert
value string

Der Wert.

Hoher Wert
highValue string

Der hohe Wert.

Werte
values array of string

Die Werte.

Limit
limit string

Die Grenze.

Eigenschaften
properties array of string

Die Eigenschaften.

Sorten
sorts array of string

Die Sortierungen.

Query
query string

Die Abfrage.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Total
total integer

Die Summe.

Nach
paging.next.after string

Das Nachher.

Link
paging.next.link string

Der Link.

Suchkommunikation

Dient zum Abrufen einer Liste von Kommunikationen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Das Nachher.

Bediener
operator string

Der Operator.

Objektname
propertyName string

Der Eigenschaftsname.

Wert
value string

Der Wert.

Hoher Wert
highValue string

Der hohe Wert.

Werte
values array of string

Die Werte.

Limit
limit string

Die Grenze.

Eigenschaften
properties array of string

Die Eigenschaften.

Sorten
sorts array of string

Die Sortierungen.

Query
query string

Die Abfrage.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of object
Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Archived
results.archived boolean

Gibt an, ob archiviert.

Archiviert unter
results.archivedAt string

Bei archivierung bei.

Total
total integer

Die Summe.

Nach
paging.next.after string

Das Nachher.

Link
paging.next.link string

Der Link.

Zusammenführen von zwei Aufgaben

Führt zwei Vorgänge mit demselben Typ zusammen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Zusammenführende Objekt-ID
objectIdToMerge string

Der zusammenzuführende Objektbezeichner.

Primäre Objekt-ID
primaryObjectId string

Der primäre Objektbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Zusammenführen von zwei Aufrufen

Führt zwei Aufrufe mit demselben Typ zusammen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Zusammenführende Objekt-ID
objectIdToMerge string

Der zusammenzuführende Objektbezeichner.

Primäre Objekt-ID
primaryObjectId string

Der primäre Objektbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Zusammenführen von zwei Besprechungen

Führt zwei Besprechungen mit demselben Typ zusammen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Zusammenführende Objekt-ID
objectIdToMerge string

Der zusammenzuführende Objektbezeichner.

Primäre Objekt-ID
primaryObjectId string

Der primäre Objektbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Zusammenführen von zwei E-Mails

Führt zwei E-Mails mit demselben Typ zusammen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Zusammenführende Objekt-ID
objectIdToMerge string

Der zusammenzuführende Objektbezeichner.

Primäre Objekt-ID
primaryObjectId string

Der primäre Objektbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Zusammenführen von zwei Kommunikationen

Führt zwei Kommunikationen mit demselben Typ zusammen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Zusammenführende Objekt-ID
objectIdToMerge string

Der zusammenzuführende Objektbezeichner.

Primäre Objekt-ID
primaryObjectId string

Der primäre Objektbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Zusammenführen von zwei Notizen

Führt zwei Notizen mit demselben Typ zusammen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Zusammenführende Objekt-ID
objectIdToMerge string

Der zusammenzuführende Objektbezeichner.

Primäre Objekt-ID
primaryObjectId string

Der primäre Objektbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Archived
archived boolean

Gibt an, ob archiviert.

Archiviert unter
archivedAt string

Bei archivierung bei.

Definitionen

Schnur

Dies ist der grundlegende Datentyp "string".