Freigeben über


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

Mit dem einfach zu verwendenden HubSpot CRM müssen Sie keine Berichte manuell aktualisieren oder sich fragen, wie Ihr Team Kontingente verfolgt. Erhalten Sie eine Echtzeitansicht Ihrer gesamten Vertriebspipeline auf einem visuellen Dashboard. HubSpot CRM organisiert, erweitert und verfolgt jeden Kontakt automatisch in einer übersichtlichen Zeitachse.

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 hhttps://legal.hubspot.com/privacy-policy
Kategorien Vertrieb und CRM

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_TOKEN}') securestring Das Zugriffstoken (im Format "Bearer ${YOUR_TOKEN}") für diese API Richtig

Drosselungsgrenzwerte

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

Aktionen

Abbrechen eines aktiven Imports

Auf diese Weise kann ein Entwickler einen aktiven Import abbrechen.

Abrufen aktiver Importe

Gibt eine seitenseitige Liste der aktiven Importe für dieses Konto zurück.

Abrufen aller Karten

Gibt eine Liste von Karten für eine bestimmte App zurück.

Abrufen der Informationen zu jedem Import

Eine vollständige Zusammenfassung eines Importdatensatzes, einschließlich aller Aktualisierungen.

Abrufen einer Feedbackübermittlung

Rufen Sie ein objekt ab, das durch feedbackSubmissionidentifier identifiziert wurde. "feedbackSubmissionId" bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty-Abfrageparameter angegeben. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Abrufen einer Reihe von Anführungszeichen nach ID

Rufen Sie eine Reihe von Anführungszeichen nach internem Bezeichner oder eindeutigen Eigenschaftswerten ab.

Abrufen einer Reihe von Deals nach ID

Rufen Sie einen Batch von Deals nach interner ID oder eindeutigen Eigenschaftswerten ab.

Abrufen einer Reihe von Gebühren nach ID

Rufen Sie eine Reihe von Gebühren nach interner ID oder eindeutigen Eigenschaftswerten ab.

Abrufen einer Reihe von Produkten nach ID

Rufen Sie einen Batch von Produkten nach interner ID oder eindeutigen Eigenschaftswerten ab.

Abrufen einer Reihe von Rabatten nach ID

Rufen Sie einen Batch von Rabatten nach internen Bezeichnern oder eindeutigen Eigenschaftswerten ab.

Abrufen einer Reihe von Zeilenelementen nach ID

Dient zum Abrufen einer Reihe von Zeilenelementen nach internem Bezeichner oder eindeutigen Eigenschaftswerten.

Abrufen einer Steuer nach ID

Rufen Sie ein objekt ab, das durch steueridentifizierer identifiziert wird. taxId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Abrufen eines Angebots nach ID

Rufen Sie ein Objekt ab, das durch Anführungszeichen identifiziert wird. quoteId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Abrufen eines Batches von Feedbackübermittlungen nach ID

Rufen Sie einen Batch von Feedbackübermittlungen nach interner ID oder eindeutigen Eigenschaftswerten ab.

Abrufen eines Batches von Kontakten nach ID

Dient zum Abrufen eines Batches von Kontakten nach internem Bezeichner oder eindeutigen Eigenschaftswerten.

Abrufen eines Batches von Tickets nach ID

Rufen Sie einen Batch von Tickets nach interner ID oder eindeutigen Eigenschaftswerten ab.

Abrufen eines Batches von Zielzielen nach ID

Rufen Sie einen Batch von Zielzielen anhand des internen Bezeichners oder eindeutiger Eigenschaftswerte ab.

Abrufen eines Besitzers nach ID

Abrufen eines Besitzers durch einen bestimmten Bezeichner oder Benutzeridentifizierer.

Abrufen eines Kontakts nach ID

Rufen Sie ein objekt ab, das durch kontaktidentifizierer identifiziert wurde. contactId bezieht sich auf den internen Objektbezeichner. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Abrufen eines Objekts nach ID

Rufen Sie ein Objekt ab, das durch den Objektidentifizierer identifiziert wird. objectId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Abrufen eines Stapels von Objekten nach ID

Dient zum Abrufen eines Stapels von Objekten anhand des internen Bezeichners oder eindeutiger Eigenschaftswerte.

Abrufen eines Steuerbatches nach ID

Rufen Sie einen Batch von Steuern nach interner ID oder eindeutigen Eigenschaftswerten ab.

Abrufen eines Unternehmens nach ID

Rufen Sie ein objekt ab, das durch den Firmenidentifizierer identifiziert wurde. companyId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Abrufen eines Zielziels nach ID

Rufen Sie ein objekt ab, das durch goalTargetidentifier identifiziert wurde. goalTargetId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Abrufen von Importfehlern

Dient zum Abrufen einer Liste von Fehlern für einen Import.

Abrufen von Listenmitgliedschaften

Ruft die Mitgliedschaften einer Liste in der Reihenfolge ab, die nach den recordId Datensätzen in der Liste sortiert ist. Die recordIds werden in aufsteigender Reihenfolge sortiert, wenn ein after Offset oder kein Offset bereitgestellt wird. Wenn nur ein before Offset bereitgestellt wird, werden die Datensätze in absteigender Reihenfolge sortiert. Der after Offsetparameter hat Vorrang vor dem before Offset in einem Fall, in dem beide bereitgestellt werden.

Abrufen von Objekten

Dient zum Abrufen einer Seite mit Objekten. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Abrufen von Zeilenelementen

Dient zum Abrufen einer Seite mit Zeilenelementen. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Aktualisieren einer Feedbackübermittlung

Führen Sie eine teilweise Aktualisierung eines Objekts durch feedbackSubmissionidentifier aus. "feedbackSubmissionId" bezieht sich standardmäßig auf den internen Objektbezeichner 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 einer Gebühr nach ID

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch den Gebührenidentifizierer identifiziert wird. feeId bezieht sich standardmäßig auf den internen Objektbezeichner 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 einer Karte

Aktualisieren sie eine Kartendefinition mit neuen Details.

Aktualisieren einer Reihe von Anführungszeichen

Aktualisieren Sie eine Reihe von Anführungszeichen.

Aktualisieren einer Reihe von Deals

Aktualisieren Sie eine Reihe von Deals.

Aktualisieren einer Reihe von Feedbackübermittlungen

Aktualisieren Sie einen Batch von Feedbackübermittlungen.

Aktualisieren einer Reihe von Gebühren

Aktualisieren Sie eine Reihe von Gebühren.

Aktualisieren einer Reihe von Produkten

Aktualisieren sie eine Reihe von Produkten.

Aktualisieren einer Reihe von Rabatten

Aktualisieren Sie eine Reihe von Rabatten.

Aktualisieren einer Reihe von Steuern

Aktualisieren Sie eine Reihe von Steuern.

Aktualisieren einer Reihe von Unternehmen

Aktualisieren Sie eine Reihe von Unternehmen.

Aktualisieren einer Reihe von Zeilenelementen

Aktualisieren sie eine Reihe von Zeilenelementen.

Aktualisieren einer Steuer

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch den Steueridentifizierer identifiziert wird. taxId bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Aktualisieren eines Angebots

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch Anführungszeichen identifiziert wird. quoteId bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Aktualisieren eines Batches von Kontakten

Aktualisieren sie einen Batch von Kontakten.

Aktualisieren eines Batches von Tickets

Aktualisieren sie eine Reihe von Tickets.

Aktualisieren eines Batches von Zielzielen

Aktualisieren sie eine Reihe von Zielzielen.

Aktualisieren eines Deals

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch dealidentifier identifiziert wird. dealId bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Aktualisieren eines Kontakts anhand der ID

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch den Kontaktidentifizierer identifiziert wird. contactId bezieht sich auf den internen Objektbezeichner. 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 eines Objekts

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch den Objektidentifizierer identifiziert wird. objectId bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Aktualisieren eines Produkts

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch productidentifier identifiziert wird. productId bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Aktualisieren eines Rabatts

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch Discountidentifier identifiziert wird. discountId bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Aktualisieren eines Stapels von Objekten

Dient zum Aktualisieren eines Stapels von Objekten.

Aktualisieren eines Tickets

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch ticketidentifier identifiziert wird. "ticketId" bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Aktualisieren eines Unternehmens anhand der ID

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch den Firmenidentifizierer identifiziert wird. companyId bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Aktualisieren eines Zeilenelements

Führen Sie eine partielle Aktualisierung eines Objekts durch lineItemidentifier aus. lineItemId bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Aktualisieren eines Zielziels

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch goalTargetidentifier identifiziert wird. goalTargetId bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Anfordern einer Gebühr nach ID

Rufen Sie ein objekt ab, das durch den Gebührenidentifizierer identifiziert wird. feeId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty-Abfrageparameter angegeben. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Anführungszeichen auflisten

Rufen Sie eine Seite mit Anführungszeichen ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Anführungszeichen erstellen

Erstellen Sie ein Anführungszeichen mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

Angebote abrufen

Rufen Sie eine Seite mit Deals ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Angebote durchsuchen

Dient zum Abrufen einer Liste von Deals.

Archiv a batch of companies by ID

Archiv a batch of companies by identifier.

Archiv a batch of contacts by ID

Archiv a batch of contacts by identifier.

Archiv a batch of deals by ID

Archiv a batch of deals by identifier.

Archiv a batch of discounts by ID

Archiv a batch of discounts by identifier.

Archiv a batch of feedback submissions by ID

Archiv a batch of feedback submissions by identifier.

Archiv a batch of fees by ID

Archiv a batch of fees by identifier.

Archiv a batch of goal targets by ID

Archiv a batch of goal targets by identifier.

Archiv a batch of line items by ID

Archiv a batch of line items by identifier.

Archiv a batch of objects by ID

Archiv a batch of objects by identifier.

Archiv a batch of products by ID

Archiv a batch of products by identifier.

Archiv a batch of tax by ID

Archiv a batch of tax by identifier.

Archiv a batch of tickets by ID

Archiv a batch of tickets by identifier.

Archiv a company by ID

Verschieben eines objekts, das von "companyId" identifiziert wird, in den Papierkorb.

Archiv a deal by ID

Verschieben Eines objekts, das durch dealId identifiziert wird, in den Papierkorb.

Archiv a fee by ID

Verschieben Sie ein objekt, das durch feeId identifiziert wird, in den Papierkorb.

Archiv a feedback submission

Verschieben Sie ein durch feedbackSubmissionId identifiziertes Objekt in den Papierkorb.

Archiv a tax

Verschieben sie ein objekt, das durch taxId identifiziert wird, in den Papierkorb.

Archiv eines Kontakts nach ID

Verschieben Eines objekts, das durch contactId identifiziert wird, in den Papierkorb.

Archiv eines Produkts

Verschieben eines objekts, das durch productId identifiziert wird, in den Papierkorb.

Archiv eines Rabatts

Verschieben Sie ein objekt, das durch discountId identifiziert wird, in den Papierkorb.

Archiv eines Tickets

Verschieben Eines objekts, das durch ticketId identifiziert wird, in den Papierkorb.

Archiv eines Zeilenelements

Verschieben Eines objekts, das durch lineItemId identifiziert wird, in den Papierkorb.

Archivieren eines Objekts

Verschieben eines objekts, das durch objectId identifiziert wird, in den Papierkorb.

Archivieren eines Zielziels

Verschieben Eines objekts, das durch goalTargetId identifiziert wird, in den Papierkorb.

Archivierung einer Reihe von Anführungszeichen nach ID

Archiv a batch of quotes by identifier.

Archivierung eines Anführungszeichens nach ID

Verschieben Eines objekts, das durch quoteId identifiziert wird, in den Papierkorb.

Auflisten von Zuordnungen für ein Objekt

Listet alle Zuordnungen eines Objekts nach Objekttyp auf. Begrenzen Sie 500 pro Anruf.

Batchzuordnungen lesen

Batchlesezuordnungen für Objekte zu einem bestimmten Objekttyp. Das Feld "after" in einem zurückgegebenen Paging-Objekt kann neben der "ID" hinzugefügt werden, um die nächste Seite von Zuordnungen aus diesem Objektidentifier abzurufen. Das Feld "Link" ist veraltet und sollte ignoriert werden.

Beispielkartendetailseite-Antwort abrufen

Gibt eine Beispiel-Kartendetailseite zurück. Dies ist die Nutzlast mit angezeigten Details für eine Karte, die einem Benutzer angezeigt wird. Eine App sollte dies als Reaktion auf die Datenabrufanforderung senden.

Besitzer abrufen

Dient zum Abrufen einer Liste von Besitzern.

Ein Produkt erstellen

Erstellen Sie ein Produkt mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

Einen Deal erhalten

Rufen Sie ein objekt ab, das durch dealidentifier identifiziert wird. dealId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Einen Kontakt erstellen

Erstellen Sie einen Kontakt mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

Entfernen von Datensätzen aus einer Liste

Entfernen Sie die in der Liste bereitgestellten Datensätze. Datensätze, die nicht vorhanden sind oder keine Mitglieder der Liste sind, werden ignoriert. Dieser Endpunkt funktioniert nur für Listen mit einer processingType oder MANUAL .SNAPSHOT

Erstellen einer Feedbackübermittlung

Erstellen Sie eine Feedbackübermittlung mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

Erstellen einer Gebühr

Erstellen Sie eine Gebühr mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

Erstellen einer neuen Karte

Definiert eine neue Karte, die bei der Installation dieser App auf einem Konto aktiv wird.

Erstellen einer Reihe von Anführungszeichen

Erstellen Sie eine Reihe von Anführungszeichen.

Erstellen einer Reihe von Deals

Erstellen Sie eine Reihe von Deals.

Erstellen einer Reihe von Gebühren

Erstellen Sie eine Reihe von Gebühren.

Erstellen einer Reihe von Produkten

Erstellen Sie eine Reihe von Produkten.

Erstellen einer Reihe von Rabatten

Erstellen Sie eine Reihe von Rabatten.

Erstellen einer Reihe von Steuern

Erstellen Sie eine Reihe von Steuern.

Erstellen einer Reihe von Unternehmen

Erstellen Sie eine Reihe von Unternehmen.

Erstellen einer Reihe von Zeilenelementen

Erstellen Sie eine Reihe von Zeilenelementen.

Erstellen einer Reihe von Zielzielen

Erstellen Sie eine Reihe von Zielzielen.

Erstellen einer Steuer

Erstellen Sie eine Steuer mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

Erstellen eines -Objekts

Erstellen Sie ein CRM-Objekt mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

Erstellen eines Batches von Feedbackübermittlungen

Erstellen Sie einen Batch von Feedbackübermittlungen.

Erstellen eines Batches von Kontakten

Erstellen Sie einen Batch von Kontakten.

Erstellen eines Batches von Tickets

Erstellen Sie eine Reihe von Tickets.

Erstellen eines Deals

Erstellen Sie einen Deal mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

Erstellen eines Rabatts

Erstellen Sie einen Rabatt mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

Erstellen eines Stapels von Objekten

Erstellen Sie einen Stapel von Objekten.

Erstellen eines Unternehmens

Erstellen Sie ein Unternehmen mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

Erstellen eines Zeilenelements

Erstellen Sie ein Zeilenelement mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

Erstellen eines Zielziels

Erstellen Sie ein Zielziel mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

Erstellen von Batchzuordnungen

Batcherstellungszuordnungen für Objekte.

Erstellen von Standardzuordnungen

Erstellen Sie den Standardmäßigen (generischsten) Zuordnungstyp zwischen zwei Objekttypen.

Erstellen von Zuordnungsbezeichnungen

Legen Sie Zuordnungsbezeichnungen zwischen zwei Datensätzen fest.

Feedbackübermittlungen auflisten

Rufen Sie eine Seite mit Feedbackübermittlungen ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Gebühren erhalten

Rufen Sie eine Seite mit Gebühren ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Hinzufügen aller Datensätze aus einer Quellliste zu einer Zielliste

Add all of the records from a source list (specified by the sourceListId) to a destination list (specified by the listId). Datensätze, die bereits Mitglieder der Zielliste sind, werden ignoriert. Die Ziel- und Quelllisten-IDs müssen unterschiedlich sein. Die Ziel- und Quelllisten müssen Datensätze desselben Typs enthalten (z. B. Kontakte, Unternehmen usw.). Dieser Endpunkt funktioniert nur für Ziellisten mit einer processingType oderMANUAL.SNAPSHOT Die Quellliste kann beliebig processingTypesein.

Hinzufügen und Entfernen von Datensätzen aus einer Liste

Hinzufügen und oder Entfernen von Datensätzen, die bereits im System erstellt wurden, zu und oder aus einer Liste. Dieser Endpunkt funktioniert nur für Listen mit einer processingType oder MANUAL .SNAPSHOT

Hinzufügen von Datensätzen zu einer Liste

Fügen Sie die in der Liste bereitgestellten Datensätze hinzu. Datensätze, die nicht vorhanden sind oder bereits Mitglieder der Liste sind, werden ignoriert. Dieser Endpunkt funktioniert nur für Listen mit einer processingType oder MANUAL .SNAPSHOT

Karte abrufen

Gibt die Definition für eine Karte mit dem angegebenen Bezeichner zurück.

Karte löschen

Löscht eine Kartendefinition dauerhaft mit dem angegebenen Bezeichner. Nach dem Löschen werden Datenabrufanforderungen für diese Karte nicht mehr an Ihren Dienst gesendet. Dies kann nicht rückgängig gemacht werden.

Kontakte abrufen

Dient zum Abrufen einer Seite mit Kontakten. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Löschen aller Datensätze aus einer Liste

Entfernen Sie alle Datensätze aus einer Liste. Hinweis: Die Liste wird nicht gelöscht. Dieser Endpunkt funktioniert nur für Listen mit einer processingType oder MANUAL .SNAPSHOT

Löschen bestimmter Zuordnungsbezeichnungen

Batchlöscht bestimmte Zuordnungsbezeichnungen für Objekte. Durch das Löschen einer nicht bezeichneten Zuordnung werden auch alle beschrifteten Zuordnungen zwischen diesen beiden Objekten gelöscht.

Löschen einer Feedbackübermittlung zur Folge der DSGVO

Löschen Sie eine Feedbackübermittlung und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Gebühr zur Folge der DSGVO

Löschen Sie eine Gebühr und alle zugehörigen Inhalte dauerhaft, um die DSGVO zu befolgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Steuer zur Folge der DSGVO

Löschen Sie eine Steuer und alle damit verbundenen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Deals zur Folge der DSGVO

Löschen Sie einen Deal und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Kontakts zur Folge der DSGVO

Löschen Sie einen Kontakt und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Objekttyps zur Folge der DSGVO

Löschen Sie einen Objekttyp und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Produkts zur Folge der DSGVO

Löschen Sie ein Produkt und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Rabatts zur Folge der DSGVO

Löschen Sie einen Rabatt und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Tickets zur Folge der DSGVO

Löschen Sie ein Ticket und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Unternehmens, das der DSGVO folgt

Löschen Sie ein Unternehmen und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Zeilenelements zur Folge der DSGVO

Löschen Sie ein Zeilenelement und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Zielziels zur Folge der DSGVO

Löschen Sie dauerhaft ein Zielziel und alle zugehörigen Inhalte, die der DSGVO folgen sollen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Zitats zur Folge der DSGVO

Löschen Sie ein Zitat und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 von Batchzuordnungen

Batchlöschzuordnungen für Objekte.

Produkt abrufen

Rufen Sie ein objekt ab, das durch productidentifier identifiziert wurde. productId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Produkte abrufen

Rufen Sie eine Seite mit Produkten ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Rabatt erhalten

Rufen Sie ein objekt ab, das durch Discountidentifier identifiziert wird. discountId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Rabatte auflisten

Rufen Sie eine Seite mit Rabatten ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Standardzuordnung erstellen

Erstellen Sie den Standardmäßigen (generischsten) Zuordnungstyp zwischen zwei Objekttypen.

Starten eines Exports

Beginnt mit dem Exportieren von CRM-Daten für das Portal, wie im Anforderungstext angegeben.

Starten eines neuen Imports

Beginnt mit dem Importieren von Daten aus den angegebenen Dateiressourcen. Dadurch wird die entsprechende Datei hochgeladen und das Importanforderungsobjekt verwendet, um Zeilen in die Dateien in Objekte zu konvertieren.

Steuern durchsuchen

Dient zum Abrufen einer Liste von Steuern.

Steuern erhalten

Rufen Sie eine Seite mit Steuern ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Suchen nach Gebühren

Abrufen einer Liste von Gebühren.

Suchen nach Kontakten

Dient zum Abrufen einer Liste von Kontakten.

Suchen nach Objekttyp

Dient zum Abrufen einer Liste von Objekten nach Objekttyp.

Suchen von Anführungszeichen

Dient zum Abrufen einer Liste von Anführungszeichen.

Suchen von Produkten

Dient zum Abrufen einer Liste von Produkten.

Suchen von Unternehmen

Dient zum Abrufen einer Liste von Unternehmen.

Suchlisten

Durchsuchen sie Listen nach Listenname oder Seite durch alle Listen, indem Sie einen leeren query Wert angeben.

Suchrabatte

Dient zum Abrufen einer Liste von Rabatten.

Suchzeilenelemente

Dient zum Abrufen einer Liste von Zeilenelementen.

Ticket abrufen

Rufen Sie ein objekt ab, das durch ticketidentifier identifiziert wurde. "ticketId" bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Ticket erstellen

Erstellen Sie ein Ticket mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

Tickets abrufen

Rufen Sie eine Seite mit Tickets ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Tickets suchen

Dient zum Abrufen einer Liste von Tickets.

Unternehmen abrufen

Rufen Sie eine Seite von Unternehmen ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Unternehmen nach ID abrufen

Rufen Sie einen Batch von Unternehmen anhand der internen ID oder eindeutiger Eigenschaftswerte ab.

Vorgangs-ID-Status abrufen

Rufen Sie den Status für einen Vorgangsbezeichner ab.

Zeilenelement abrufen

Rufen Sie ein objekt ab, das durch lineItemidentifier identifiziert wurde. lineItemId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Zielziele abrufen

Rufen Sie eine Seite mit Zielzielen ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Zielziele für die Suche

Dient zum Abrufen einer Liste von Zielzielen.

Zuordnungen löschen

Löscht alle Zuordnungen zwischen zwei Datensätzen.

Zuordnungstypen auflisten

Listet alle gültigen Zuordnungstypen auf, die zwischen zwei Objekttypen verfügbar sind.

Zusammenführen von zwei Anführungszeichen

Führen Sie zwei Anführungszeichen mit demselben Typ zusammen.

Zusammenführen von zwei Deals

Führen Sie zwei Deals mit demselben Typ aus.

Zusammenführen von zwei Feedbackübermittlungen

Führen Sie zwei Feedbackübermittlungen mit demselben Typ zusammen.

Zusammenführen von zwei Gebühren

Führen Sie zwei Gebühren mit demselben Typ zusammen.

Zusammenführen von zwei Kontakten

Führen Sie zwei Kontakte mit demselben Typ zusammen.

Zusammenführen von zwei Objekten

Führen Sie zwei Objekte mit demselben Typ zusammen.

Zusammenführen von zwei Produkten

Führen Sie zwei Produkte mit demselben Typ zusammen.

Zusammenführen von zwei Rabatten

Führen Sie zwei Rabatte mit demselben Typ zusammen.

Zusammenführen von zwei Steuern

Führen Sie zwei Steuern mit demselben Typ zusammen.

Zusammenführen von zwei Tickets

Führen Sie zwei Tickets mit demselben Typ zusammen.

Zusammenführen von zwei Zeilenelementen

Führen Sie zwei Zeilenelemente mit demselben Typ zusammen.

Zusammenführen von zwei Zielzielen

Führen Sie zwei Zielziele mit demselben Typ zusammen.

Zwei Unternehmen zusammenführen

Führen Sie zwei Unternehmen mit demselben Typ zusammen.

Übermittlungen von Suchfeedback

Dient zum Abrufen einer Liste von Feedbackübermittlungen.

Abbrechen eines aktiven Imports

Auf diese Weise kann ein Entwickler einen aktiven Import abbrechen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Import-ID
importId True string

Der Importbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Abrufen aktiver Importe

Gibt eine seitenseitige Liste der aktiven Importe für dieses Konto zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Das Nachher.

Vorher
before string

Das vorher.

Limit
limit string

Die Grenze.

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.

Datei-IDs
results.metadata.fileIds array of string

Die Datei-IDs.

Objektlisten
results.metadata.objectLists array of object
Listen-ID
results.metadata.objectLists.listId string

Der Listenbezeichner.

Objekttyp
results.metadata.objectLists.objectType string

Der Objekttyp.

Opt-Out Importieren
results.optOutImport string

Der Import wird abgemeldet.

Staat
results.state string

Das Land/die Region.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Vorlagen-ID
results.importTemplate.templateId string

Der Vorlagenbezeichner.

Vorlagentyp
results.importTemplate.templateType string

Der Vorlagentyp.

Quelle importieren
results.importSource string

Die Importquelle.

Importname
results.importName string

Der Importname.

Nach
paging.next.after string

Das Nachher.

Link
paging.next.link string

Der Link.

Vorher
paging.prev.before string

Das vorher.

Link
paging.prev.link string

Der Link.

Abrufen aller Karten

Gibt eine Liste von Karten für eine bestimmte App zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
appId True string

Der App-Bezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of object
Basis-URLs
results.actions.baseUrls array of string

Die Basis-URL-Adressen.

Überwachungsverlauf
results.auditHistory array of object
Aktionstyp
results.auditHistory.actionType string

Der Aktionstyp.

Anwendungs-ID
results.auditHistory.applicationId string

Der Anwendungsbezeichner.

Authentifizierungsquelle
results.auditHistory.authSource string

Die Autorisierungsquelle.

Geändert am
results.auditHistory.changedAt string

Wenn geändert bei.

Initiieren der Benutzer-ID
results.auditHistory.initiatingUserId string

Der initiierende Benutzerbezeichner.

Objekttyp-ID
results.auditHistory.objectTypeId string

Der Objekttypbezeichner.

Eigenschaften
results.display.properties array of object
Datentyp
results.display.properties.dataType string

Der Datentyp.

Etikett
results.display.properties.label string

Die Bezeichnung.

Name
results.display.properties.name string

Der Name.

Options
results.display.properties.options array of object
Etikett
results.display.properties.options.label string

Die Bezeichnung.

Name
results.display.properties.options.name string

Der Name.

Typ
results.display.properties.options.type string

Der Typ.

Objekttypen
results.fetch.objectTypes array of object
Name
results.fetch.objectTypes.name string

Der Name.

Zu sendende Eigenschaften
results.fetch.objectTypes.propertiesToSend array of string

Die zu sendenden Eigenschaften.

Ziel-URL
results.fetch.targetUrl string

Die Ziel-URL-Adresse.

ID
results.id string

Der Bezeichner.

Title
results.title string

Der Titel.

Erstellt unter
results.createdAt string

Beim Erstellen bei.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Abrufen der Informationen zu jedem Import

Eine vollständige Zusammenfassung eines Importdatensatzes, einschließlich aller Aktualisierungen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Import-ID
importId True string

Der Importbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Datei-IDs
metadata.fileIds array of string

Die Datei-IDs.

Objektlisten
metadata.objectLists array of object
Listen-ID
metadata.objectLists.listId string

Der Listenbezeichner.

Objekttyp
metadata.objectLists.objectType string

Der Objekttyp.

Opt-Out Importieren
optOutImport string

Der Import wird abgemeldet.

Staat
state string

Das Land/die Region.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Vorlagen-ID
importTemplate.templateId string

Der Vorlagenbezeichner.

Vorlagentyp
importTemplate.templateType string

Der Vorlagentyp.

Quelle importieren
importSource string

Die Importquelle.

Importname
importName string

Der Importname.

Abrufen einer Feedbackübermittlung

Rufen Sie ein objekt ab, das durch feedbackSubmissionidentifier identifiziert wurde. "feedbackSubmissionId" bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty-Abfrageparameter angegeben. Steuern, was über den Eigenschaftenabfrageparameter 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 nur Ergebnisse zurück, die archiviert wurden.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Feedbackübermittlungs-ID
feedbackSubmissionId True string

Die Feedbackübermittlungs-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.

Abrufen einer Reihe von Anführungszeichen nach ID

Rufen Sie eine Reihe von Anführungszeichen nach internem Bezeichner oder eindeutigen Eigenschaftswerten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Das Eigenschaftenobjekt.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit dem Verlaufsobjekt.

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 einer Reihe von Deals nach ID

Rufen Sie einen Batch von Deals nach interner ID oder eindeutigen Eigenschaftswerten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Das Eigenschaftenobjekt.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit dem Verlaufsobjekt.

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 einer Reihe von Gebühren nach ID

Rufen Sie eine Reihe von Gebühren nach interner ID oder eindeutigen Eigenschaftswerten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Das Eigenschaftenobjekt.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit dem Verlaufsobjekt.

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 einer Reihe von Produkten nach ID

Rufen Sie einen Batch von Produkten nach interner ID oder eindeutigen Eigenschaftswerten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Das Eigenschaftenobjekt.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit dem Verlaufsobjekt.

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 einer Reihe von Rabatten nach ID

Rufen Sie einen Batch von Rabatten nach internen Bezeichnern oder eindeutigen Eigenschaftswerten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Das Eigenschaftenobjekt.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit dem Verlaufsobjekt.

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 einer Reihe von Zeilenelementen nach ID

Dient zum Abrufen einer Reihe von Zeilenelementen nach internem Bezeichner oder eindeutigen Eigenschaftswerten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Das Eigenschaftenobjekt.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit dem Verlaufsobjekt.

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 einer Steuer nach ID

Rufen Sie ein objekt ab, das durch steueridentifizierer identifiziert wird. taxId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter 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 nur Ergebnisse zurück, die archiviert wurden.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Steuernummer
taxId True string

Der Steuerbezeichner.

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.

Abrufen eines Angebots nach ID

Rufen Sie ein Objekt ab, das durch Anführungszeichen identifiziert wird. quoteId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter 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 nur Ergebnisse zurück, die archiviert wurden.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Anführungszeichen-ID
quoteId True string

Der Anführungszeichenbezeichner.

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.

Abrufen eines Batches von Feedbackübermittlungen nach ID

Rufen Sie einen Batch von Feedbackübermittlungen nach interner ID oder eindeutigen Eigenschaftswerten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Das Eigenschaftenobjekt.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit dem Verlaufsobjekt.

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 Kontakten nach ID

Dient zum Abrufen eines Batches von Kontakten nach internem Bezeichner oder eindeutigen Eigenschaftswerten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Das Eigenschaftenobjekt.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit dem Verlaufsobjekt.

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 Tickets nach ID

Rufen Sie einen Batch von Tickets nach interner ID oder eindeutigen Eigenschaftswerten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Das Eigenschaftenobjekt.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit dem Verlaufsobjekt.

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 Zielzielen nach ID

Rufen Sie einen Batch von Zielzielen anhand des internen Bezeichners oder eindeutiger Eigenschaftswerte ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Das Eigenschaftenobjekt.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit dem Verlaufsobjekt.

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 Besitzers nach ID

Abrufen eines Besitzers durch einen bestimmten Bezeichner oder Benutzeridentifizierer.

Parameter

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

Die Id-Eigenschaft.

Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

Besitzer-ID
ownerId True string

Der Besitzerbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Archived
archived boolean

Gibt an, ob archiviert.

Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Email
email string

Die E-Mail-Adresse.

Vorname
firstName string

Der Vorname.

Nachname
lastName string

Der Nachname.

Benutzer-ID
userId string

Der Benutzerbezeichner.

Mannschaften
teams array of object
ID
teams.id string

Der Bezeichner.

Name
teams.name string

Der Name.

Primary
teams.primary string

Die primäre.

Abrufen eines Kontakts nach ID

Rufen Sie ein objekt ab, das durch kontaktidentifizierer identifiziert wurde. contactId bezieht sich auf den internen Objektbezeichner. Steuern, was über den Eigenschaftenabfrageparameter 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 nur Ergebnisse zurück, die archiviert wurden.

Kontakt-ID
contactId True string

Der Kontaktbezeichner.

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.

Ergebnisse
associations.etc.results array of object
ID
associations.etc.results.id string

Der Bezeichner.

Typ
associations.etc.results.type string

Der Typ.

Nach
associations.etc.paging.next.after string

Die Nachseite.

Link
associations.etc.paging.next.link string

Die Linkseite.

Vorher
associations.etc.paging.prev.before string

Die Vorseite.

Link
associations.etc.paging.prev.link string

Die Linkseite.

Abrufen eines Objekts nach ID

Rufen Sie ein Objekt ab, das durch den Objektidentifizierer identifiziert wird. objectId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter 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 nur Ergebnisse zurück, die archiviert wurden.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Objekttyp
objectType True string

Der Objekttyp.

Objekt-ID
objectId True string

Der 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.

Abrufen eines Stapels von Objekten nach ID

Dient zum Abrufen eines Stapels von Objekten anhand des internen Bezeichners oder eindeutiger Eigenschaftswerte.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

Objekttyp
objectType True string

Der Objekttyp.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Das Eigenschaftenobjekt.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit dem Verlaufsobjekt.

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 Steuerbatches nach ID

Rufen Sie einen Batch von Steuern nach interner ID oder eindeutigen Eigenschaftswerten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Das Eigenschaftenobjekt.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit dem Verlaufsobjekt.

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 Unternehmens nach ID

Rufen Sie ein objekt ab, das durch den Firmenidentifizierer identifiziert wurde. companyId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter 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 nur Ergebnisse zurück, die archiviert wurden.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Unternehmens-ID
companyId True string

Der Firmenbezeichner.

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.

Abrufen eines Zielziels nach ID

Rufen Sie ein objekt ab, das durch goalTargetidentifier identifiziert wurde. goalTargetId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter 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 nur Ergebnisse zurück, die archiviert wurden.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Zielziel-ID
goalTargetId True string

Der Zielzielbezeichner.

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.

Abrufen von Importfehlern

Dient zum Abrufen einer Liste von Fehlern für einen Import.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Das Nachher.

Limit
limit string

Die Grenze.

Import-ID
importId True string

Der Importbezeichner.

Gibt zurück

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

Beim Erstellen bei.

Fehlertyp
results.errorType string

Der Fehlertyp.

ID
results.id string

Der Bezeichner.

Datei-ID
results.sourceData.fileId string

Der Dateibezeichner.

Zeilennummer
results.sourceData.lineNumber string

Die Zeilennummer.

Zeilendaten
results.sourceData.rowData array of string

Die Zeilendaten.

Seitenname
results.sourceData.pageName string

Der Seitenname.

Objekttyp
results.objectType string

Der Objekttyp.

Ungültiger Wert
results.invalidValue string

Der ungültige Wert.

Zusätzlicher Kontext
results.extraContext string

Der zusätzliche Kontext.

Objekttyp-ID
results.objectTypeId string

Der Objekttypbezeichner.

Bekannte Spaltennummer
results.knownColumnNumber string

Die bekannte Spaltennummer.

Nach
paging.next.after string

Das Nachher.

Link
paging.next.link string

Der Link.

Abrufen von Listenmitgliedschaften

Ruft die Mitgliedschaften einer Liste in der Reihenfolge ab, die nach den recordId Datensätzen in der Liste sortiert ist. Die recordIds werden in aufsteigender Reihenfolge sortiert, wenn ein after Offset oder kein Offset bereitgestellt wird. Wenn nur ein before Offset bereitgestellt wird, werden die Datensätze in absteigender Reihenfolge sortiert. Der after Offsetparameter hat Vorrang vor dem before Offset in einem Fall, in dem beide bereitgestellt werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Das Nachher.

Vorher
before string

Das vorher.

Limit
limit string

Die Grenze.

Listen-ID
listId True string

Der Listenbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of string

Die Ergebnisse.

Nach
paging.next.after string

Das Nachher.

Link
paging.next.link string

Der Link.

Vorher
paging.prev.before string

Das vorher.

Link
paging.prev.link string

Der Link.

Abrufen von Objekten

Dient zum Abrufen einer Seite mit Objekten. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit string

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 nur Ergebnisse zurück, die archiviert wurden.

Objekttyp
objectType True string

Der Objekttyp.

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

Die Nachseite.

Link
paging.next.link string

Der Link.

Abrufen von Zeilenelementen

Dient zum Abrufen einer Seite mit Zeilenelementen. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit string

Die Grenze.

Nach
after string

Die Nachseite.

Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

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

Die Nachseite.

Link
paging.next.link string

Der Link.

Aktualisieren einer Feedbackübermittlung

Führen Sie eine teilweise Aktualisierung eines Objekts durch feedbackSubmissionidentifier aus. "feedbackSubmissionId" bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Feedbackübermittlungs-ID
feedbackSubmissionId True string

Die Feedbackübermittlungs-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.

Aktualisieren einer Gebühr nach ID

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch den Gebührenidentifizierer identifiziert wird. feeId bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Gebühren-ID
feeId True string

Der Gebührenbezeichner.

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 einer Karte

Aktualisieren sie eine Kartendefinition mit neuen Details.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
appId True string

Der App-Bezeichner.

Kartenkennung
cardId True string

Der Kartenbezeichner.

Title
title string

Der Titel.

Name
name string

Der Name.

Zu sendende Eigenschaften
propertiesToSend array of string

Die zu sendenden Eigenschaften.

Kartentyp
cardType string

Der Kartentyp.

Ziel-URL
targetUrl string

Die Ziel-URL-Adresse.

Serverless-Funktion
serverlessFunction string

Die serverlose Funktion.

Datentyp
dataType string

Der Datentyp.

Etikett
label string

Die Bezeichnung.

Name
name string

Der Name.

Etikett
label string

Die Bezeichnung.

Name
name string

Der Name.

Typ
type string

Der Typ.

Basis-URLs
baseUrls array of string

Die Basis-URL-Adressen.

Gibt zurück

Name Pfad Typ Beschreibung
Basis-URLs
actions.baseUrls array of string

Die Basis-URL-Adressen.

Überwachungsverlauf
auditHistory array of object
Aktionstyp
auditHistory.actionType string

Der Aktionstyp.

Anwendungs-ID
auditHistory.applicationId string

Der Anwendungsbezeichner.

Autorisierungsquelle
auditHistory.authSource string

Die Autorisierungsquelle.

Geändert am
auditHistory.changedAt string

Wenn geändert bei.

Initiieren der Benutzer-ID
auditHistory.initiatingUserId string

Der initiierende Benutzerbezeichner.

Objekttyp-ID
auditHistory.objectTypeId string

Der Objekttypbezeichner.

Eigenschaften
display.properties array of object
Datentyp
display.properties.dataType string

Der Datentyp.

Etikett
display.properties.label string

Die Bezeichnung.

Name
display.properties.name string

Der Name.

Options
display.properties.options array of object
Etikett
display.properties.options.label string

Die Bezeichnung.

Name
display.properties.options.name string

Der Name.

Typ
display.properties.options.type string

Der Typ.

Objekttypen
fetch.objectTypes array of object
Name
fetch.objectTypes.name string

Der Name.

Zu sendende Eigenschaften
fetch.objectTypes.propertiesToSend array of string

Die zu sendenden Eigenschaften.

Ziel-URL
fetch.targetUrl string

Die Ziel-URL-Adresse.

ID
id string

Der Bezeichner.

Title
title string

Der Titel.

Erstellt unter
createdAt string

Beim Erstellen bei.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Aktualisieren einer Reihe von Anführungszeichen

Aktualisieren Sie eine Reihe von Anführungszeichen.

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 einer Reihe von Deals

Aktualisieren Sie eine Reihe von Deals.

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 einer Reihe von Feedbackübermittlungen

Aktualisieren Sie einen Batch von Feedbackübermittlungen.

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 einer Reihe von Gebühren

Aktualisieren Sie eine Reihe von Gebühren.

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 einer Reihe von Produkten

Aktualisieren sie eine Reihe von Produkten.

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 einer Reihe von Rabatten

Aktualisieren Sie eine Reihe von Rabatten.

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 einer Reihe von Steuern

Aktualisieren Sie eine Reihe von Steuern.

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 einer Reihe von Unternehmen

Aktualisieren Sie eine Reihe von Unternehmen.

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 einer Reihe von Zeilenelementen

Aktualisieren sie eine Reihe von Zeilenelementen.

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 einer Steuer

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch den Steueridentifizierer identifiziert wird. taxId bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Parameter

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

Die Id-Eigenschaft.

Steuernummer
taxId True string

Der Steuerbezeichner.

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 eines Angebots

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch Anführungszeichen identifiziert wird. quoteId bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Parameter

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

Die Id-Eigenschaft.

Anführungszeichen-ID
quoteId True string

Der Anführungszeichenbezeichner.

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 eines Batches von Kontakten

Aktualisieren sie einen Batch von Kontakten.

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 Tickets

Aktualisieren sie eine Reihe von Tickets.

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 Zielzielen

Aktualisieren sie eine Reihe von Zielzielen.

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 Deals

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch dealidentifier identifiziert wird. dealId bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Parameter

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

Die Id-Eigenschaft.

Deal-ID
dealId True string

Der Dealbezeichner.

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 eines Kontakts anhand der ID

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch den Kontaktidentifizierer identifiziert wird. contactId bezieht sich auf den internen Objektbezeichner. 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
Kontakt-ID
contactId True string

Der Kontaktbezeichner.

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 eines Objekts

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch den Objektidentifizierer identifiziert wird. objectId bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Parameter

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

Die Id-Eigenschaft.

Objekttyp
objectType True string

Der Objekttyp.

Objekt-ID
objectId True string

Der 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.

Aktualisieren eines Produkts

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch productidentifier identifiziert wird. productId bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Parameter

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

Die Id-Eigenschaft.

Produkt-ID
productId True string

Der Produktbezeichner.

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 eines Rabatts

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch Discountidentifier identifiziert wird. discountId bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Parameter

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

Die Id-Eigenschaft.

Rabattkennung
discountId True string

Der Rabattbezeichner.

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 eines Stapels von Objekten

Dient zum Aktualisieren eines Stapels von Objekten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objekttyp
objectType True string

Der Objekttyp.

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 Tickets

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch ticketidentifier identifiziert wird. "ticketId" bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Parameter

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

Die Id-Eigenschaft.

Ticket-ID
ticketId True string

Der Ticketbezeichner.

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 eines Unternehmens anhand der ID

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch den Firmenidentifizierer identifiziert wird. companyId bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Parameter

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

Die Id-Eigenschaft.

Unternehmens-ID
companyId True string

Der Firmenbezeichner.

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 eines Zeilenelements

Führen Sie eine partielle Aktualisierung eines Objekts durch lineItemidentifier aus. lineItemId bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Parameter

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

Die Id-Eigenschaft.

Zeilenelement-ID
lineItemId True string

Der Zeilenelementbezeichner.

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 eines Zielziels

Führen Sie eine teilweise Aktualisierung eines Objekts durch, das durch goalTargetidentifier identifiziert wird. goalTargetId bezieht sich standardmäßig auf den internen Objektbezeichner 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.

Parameter

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

Die Id-Eigenschaft.

Zielziel-ID
goalTargetId True string

Der Zielzielbezeichner.

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.

Anfordern einer Gebühr nach ID

Rufen Sie ein objekt ab, das durch den Gebührenidentifizierer identifiziert wird. feeId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, wie durch den idProperty-Abfrageparameter angegeben. Steuern, was über den Eigenschaftenabfrageparameter 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 nur Ergebnisse zurück, die archiviert wurden.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Gebühren-ID
feeId True string

Der Gebührenbezeichner.

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.

Anführungszeichen auflisten

Rufen Sie eine Seite mit Anführungszeichen ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit string

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 nur Ergebnisse zurück, die archiviert wurden.

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

Die Nachseite.

Link
paging.next.link string

Der Link.

Anführungszeichen erstellen

Erstellen Sie ein Anführungszeichen mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Zuordnungskategorie
associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
associationTypeId string

Der Zuordnungstypbezeichner.

elit_26
elit_26 string

elit_26.

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.

Angebote abrufen

Rufen Sie eine Seite mit Deals ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit string

Die Grenze.

Nach
after string

Die Nachseite.

Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

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

Die Nachseite.

Link
paging.next.link string

Der Link.

Angebote durchsuchen

Dient zum Abrufen einer Liste von Deals.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Die Nachseite.

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

Das Eigenschaftenobjekt.

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 string

Die Summe.

Nach
paging.next.after string

Die Nachseite.

Link
paging.next.link string

Der Link.

Archiv a batch of companies by ID

Archiv a batch of companies by identifier.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archiv a batch of contacts by ID

Archiv a batch of contacts by identifier.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archiv a batch of deals by ID

Archiv a batch of deals by identifier.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archiv a batch of discounts by ID

Archiv a batch of discounts by identifier.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archiv a batch of feedback submissions by ID

Archiv a batch of feedback submissions by identifier.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archiv a batch of fees by ID

Archiv a batch of fees by identifier.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archiv a batch of goal targets by ID

Archiv a batch of goal targets by identifier.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archiv a batch of line items by ID

Archiv a batch of line items by identifier.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archiv a batch of objects by ID

Archiv a batch of objects by identifier.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objekttyp
objectType True string

Der Objekttyp.

ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archiv a batch of products by ID

Archiv a batch of products by identifier.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archiv a batch of tax by ID

Archiv a batch of tax by identifier.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archiv a batch of tickets by ID

Archiv a batch of tickets by identifier.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archiv a company by ID

Verschieben eines objekts, das von "companyId" identifiziert wird, in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Unternehmens-ID
companyId True string

Der Firmenbezeichner.

Gibt zurück

response
string

Archiv a deal by ID

Verschieben Eines objekts, das durch dealId identifiziert wird, in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Deal-ID
dealId True string

Der Dealbezeichner.

Gibt zurück

response
string

Archiv a fee by ID

Verschieben Sie ein objekt, das durch feeId identifiziert wird, in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gebühren-ID
feeId True string

Der Gebührenbezeichner.

Gibt zurück

response
string

Archiv a feedback submission

Verschieben Sie ein durch feedbackSubmissionId identifiziertes Objekt in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Feedbackübermittlungs-ID
feedbackSubmissionId True string

Die Feedbackübermittlungs-ID.

Gibt zurück

response
string

Archiv a tax

Verschieben sie ein objekt, das durch taxId identifiziert wird, in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Steuernummer
taxId True string

Der Steuerbezeichner.

Gibt zurück

response
string

Archiv eines Kontakts nach ID

Verschieben Eines objekts, das durch contactId identifiziert wird, in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Kontakt-ID
contactId True string

Der Kontaktbezeichner.

Gibt zurück

response
string

Archiv eines Produkts

Verschieben eines objekts, das durch productId identifiziert wird, in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Produkt-ID
productId True string

Der Produktbezeichner.

Gibt zurück

response
string

Archiv eines Rabatts

Verschieben Sie ein objekt, das durch discountId identifiziert wird, in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Rabattkennung
discountId True string

Der Rabattbezeichner.

Gibt zurück

response
string

Archiv eines Tickets

Verschieben Eines objekts, das durch ticketId identifiziert wird, in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Ticket-ID
ticketId True string

Der Ticketbezeichner.

Gibt zurück

response
string

Archiv eines Zeilenelements

Verschieben Eines objekts, das durch lineItemId identifiziert wird, in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Zeilenelement-ID
lineItemId True string

Der Zeilenelementbezeichner.

Gibt zurück

response
string

Archivieren eines Objekts

Verschieben eines objekts, das durch objectId identifiziert wird, in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objekttyp
objectType True string

Der Objekttyp.

Objekt-ID
objectId True string

Der Objektbezeichner.

Gibt zurück

response
string

Archivieren eines Zielziels

Verschieben Eines objekts, das durch goalTargetId identifiziert wird, in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Zielziel-ID
goalTargetId True string

Der Zielzielbezeichner.

Gibt zurück

response
string

Archivierung einer Reihe von Anführungszeichen nach ID

Archiv a batch of quotes by identifier.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Gibt zurück

response
string

Archivierung eines Anführungszeichens nach ID

Verschieben Eines objekts, das durch quoteId identifiziert wird, in den Papierkorb.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Anführungszeichen-ID
quoteId True string

Der Anführungszeichenbezeichner.

Gibt zurück

response
string

Auflisten von Zuordnungen für ein Objekt

Listet alle Zuordnungen eines Objekts nach Objekttyp auf. Begrenzen Sie 500 pro Anruf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Das Nachher.

Limit
limit string

Die Grenze.

Objekttyp
objectType True string

Der Objekttyp.

Objekt-ID
objectId True string

Der Objektbezeichner.

An-Objekttyp
toObjectType True string

Der To-Objekttyp.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of object
Zuordnungstypen
results.associationTypes array of object
Kategorie
results.associationTypes.category string

Die Kategorie.

Typ-ID
results.associationTypes.typeId string

Der Typbezeichner.

Etikett
results.associationTypes.label string

Die Bezeichnung.

To-Objekt-ID
results.toObjectId string

Der To-Objektbezeichner.

Nach
paging.next.after string

Das Nachher.

Link
paging.next.link string

Der Link.

Batchzuordnungen lesen

Batchlesezuordnungen für Objekte zu einem bestimmten Objekttyp. Das Feld "after" in einem zurückgegebenen Paging-Objekt kann neben der "ID" hinzugefügt werden, um die nächste Seite von Zuordnungen aus diesem Objektidentifier abzurufen. Das Feld "Link" ist veraltet und sollte ignoriert werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Vom Objekttyp
fromObjectType True string

Der From-Objekttyp.

An-Objekttyp
toObjectType True string

Der To-Objekttyp.

ID
id string

Der Bezeichner.

Nach
after string

Der Nachlink.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
ID
results.from.id string

Der Bezeichner.

Bis
results.to array of object
Zuordnungstypen
results.to.associationTypes array of object
Kategorie
results.to.associationTypes.category string

Die Kategorie.

Typ-ID
results.to.associationTypes.typeId string

Der Typbezeichner.

Etikett
results.to.associationTypes.label string

Die Bezeichnung.

To-Objekt-ID
results.to.toObjectId string

Der To-Objektbezeichner.

Nach
results.paging.next.after string

Der Nachlink.

Link
results.paging.next.link string

Der Link.

Vorher
results.paging.prev.before string

Der Vorlink.

Link
results.paging.prev.link string

Der Link.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Beispielkartendetailseite-Antwort abrufen

Gibt eine Beispiel-Kartendetailseite zurück. Dies ist die Nutzlast mit angezeigten Details für eine Karte, die einem Benutzer angezeigt wird. Eine App sollte dies als Reaktion auf die Datenabrufanforderung senden.

Gibt zurück

Name Pfad Typ Beschreibung
Gesamtanzahl
totalCount string

Die Gesamtanzahl.

Url "Alle Elemente verknüpfen"
allItemsLinkUrl string

Die URL-Adresse des Links für alle Elemente.

Kartenetikett
cardLabel string

Das Kartenetikett.

Secondary
topLevelActions.secondary array of object
HTTP-Methode
topLevelActions.secondary.httpMethod string

Die HTTP-Methode.

Enthaltene Eigenschaftsnamen
topLevelActions.secondary.propertyNamesIncluded array of string

Die enthaltenen Eigenschaftennamen.

Typ
topLevelActions.secondary.type string

Der Typ.

URL
topLevelActions.secondary.url string

Die URL-Adresse.

Schaltflächenbezeichnung abbrechen
topLevelActions.secondary.confirmation.cancelButtonLabel string

Die Schaltflächenbezeichnung "Abbrechen".

Schaltflächenbezeichnung bestätigen
topLevelActions.secondary.confirmation.confirmButtonLabel string

Die Schaltflächenbezeichnung "Bestätigen".

Prompt
topLevelActions.secondary.confirmation.prompt string

Die Eingabeaufforderung.

Etikett
topLevelActions.secondary.label string

Die Bezeichnung.

Höhe
topLevelActions.settings.height string

Die Höhe.

Enthaltene Eigenschaftsnamen
topLevelActions.settings.propertyNamesIncluded array of string

Die enthaltenen Eigenschaftennamen.

Typ
topLevelActions.settings.type string

Der Typ.

URL
topLevelActions.settings.url string

Die URL-Adresse.

Breite
topLevelActions.settings.width string

Die Breite.

Etikett
topLevelActions.settings.label string

Die Bezeichnung.

HTTP-Methode
topLevelActions.primary.httpMethod string

Die HTTP-Methode.

Enthaltene Eigenschaftsnamen
topLevelActions.primary.propertyNamesIncluded array of string

Die enthaltenen Eigenschaftennamen.

Typ
topLevelActions.primary.type string

Der Typ.

URL
topLevelActions.primary.url string

Die URL-Adresse.

Schaltflächenbezeichnung abbrechen
topLevelActions.primary.confirmation.cancelButtonLabel string

Die Schaltflächenbezeichnung "Abbrechen".

Schaltflächenbezeichnung bestätigen
topLevelActions.primary.confirmation.confirmButtonLabel string

Die Schaltflächenbezeichnung "Bestätigen".

Prompt
topLevelActions.primary.confirmation.prompt string

Die Eingabeaufforderung.

Etikett
topLevelActions.primary.label string

Die Bezeichnung.

Abschnitte
sections array of object
Aktionen
sections.actions array of object
HTTP-Methode
sections.actions.httpMethod string

Die HTTP-Methode.

Enthaltene Eigenschaftsnamen
sections.actions.propertyNamesIncluded array of string

Die enthaltenen Eigenschaftennamen.

Typ
sections.actions.type string

Der Typ.

URL
sections.actions.url string

Die URL-Adresse.

Schaltflächenbezeichnung abbrechen
sections.actions.confirmation.cancelButtonLabel string

Die Schaltflächenbezeichnung "Abbrechen".

Schaltflächenbezeichnung bestätigen
sections.actions.confirmation.confirmButtonLabel string

Die Schaltflächenbezeichnung "Bestätigen".

Prompt
sections.actions.confirmation.prompt string

Die Eingabeaufforderung.

Etikett
sections.actions.label string

Die Bezeichnung.

ID
sections.id string

Der Bezeichner.

Title
sections.title string

Der Titel.

Tokenen
sections.tokens array of object
Wert
sections.tokens.value string

Der Wert.

Name
sections.tokens.name string

Der Name.

Etikett
sections.tokens.label string

Die Bezeichnung.

Datentyp
sections.tokens.dataType string

Der Datentyp.

Link-URL
sections.linkUrl string

Die URL-Adresse des Links.

Antwortversion
responseVersion string

Die Antwortversion.

Besitzer abrufen

Dient zum Abrufen einer Liste von Besitzern.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Email
email True string

Die E-Mail-Adresse.

Nach
after string

Die Nachseite.

Limit
limit string

Die Grenze.

Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of object
Archived
results.archived boolean

Gibt an, ob archiviert.

Erstellt unter
results.createdAt string

Beim Erstellen bei.

ID
results.id string

Der Bezeichner.

Aktualisiert unter
results.updatedAt string

Wenn aktualisiert unter.

Email
results.email string

Die E-Mail-Adresse.

Vorname
results.firstName string

Der Vorname.

Nachname
results.lastName string

Der Nachname.

Benutzer-ID
results.userId string

Der Benutzerbezeichner.

Mannschaften
results.teams array of object
ID
results.teams.id string

Der Bezeichner.

Name
results.teams.name string

Der Name.

Primary
results.teams.primary string

Die primäre.

Nach
paging.next.after string

Die Nachseite.

Link
paging.next.link string

Der Link.

Ein Produkt erstellen

Erstellen Sie ein Produkt mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

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.

Einen Deal erhalten

Rufen Sie ein objekt ab, das durch dealidentifier identifiziert wird. dealId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter 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 nur Ergebnisse zurück, die archiviert wurden.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Deal-ID
dealId True string

Der Dealbezeichner.

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.

Einen Kontakt erstellen

Erstellen Sie einen Kontakt mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

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.

Entfernen von Datensätzen aus einer Liste

Entfernen Sie die in der Liste bereitgestellten Datensätze. Datensätze, die nicht vorhanden sind oder keine Mitglieder der Liste sind, werden ignoriert. Dieser Endpunkt funktioniert nur für Listen mit einer processingType oder MANUAL .SNAPSHOT

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Listen-ID
listId True string

Der Listenbezeichner.

body
body True array of string

Gibt zurück

Name Pfad Typ Beschreibung
Fehlende Datensatz-IDs
recordIdsMissing array of string

Die Datensatzbezeichner fehlen.

Datensatz-IDs entfernt
recordIdsRemoved array of string

Die Datensatzbezeichner wurden entfernt.

Hinzugefügte Datensatz-IDs
recordsIdsAdded array of string

Die hinzugefügten Datensatzbezeichner.

Erstellen einer Feedbackübermittlung

Erstellen Sie eine Feedbackübermittlung mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

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 Gebühr

Erstellen Sie eine Gebühr mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

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 neuen Karte

Definiert eine neue Karte, die bei der Installation dieser App auf einem Konto aktiv wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
appId True string

Der App-Bezeichner.

Basis-URLs
baseUrls array of string

Die Basis-URL-Adressen.

Datentyp
dataType string

Der Datentyp.

Etikett
label string

Die Bezeichnung.

Name
name string

Der Name.

Etikett
label string

Die Bezeichnung.

Name
name string

Der Name.

Typ
type string

Der Typ.

Name
name string

Der Name.

Zu sendende Eigenschaften
propertiesToSend array of string

Die zu sendenden Eigenschaften.

Ziel-URL
targetUrl string

Die Ziel-URL-Adresse.

Kartentyp
cardType string

Der Kartentyp.

Serverless-Funktion
serverlessFunction string

Die serverlose Funktion.

Title
title string

Der Titel.

Gibt zurück

Name Pfad Typ Beschreibung
Basis-URLs
actions.baseUrls array of string

Die Basis-URL-Adressen.

Überwachungsverlauf
auditHistory array of object
Aktionstyp
auditHistory.actionType string

Der Aktionstyp.

Anwendungs-ID
auditHistory.applicationId string

Der Anwendungsbezeichner.

Autorisierungsquelle
auditHistory.authSource string

Die Autorisierungsquelle.

Geändert am
auditHistory.changedAt string

Wenn geändert bei.

Initiieren der Benutzer-ID
auditHistory.initiatingUserId string

Der initiierende Benutzerbezeichner.

Objekttyp-ID
auditHistory.objectTypeId string

Der Objekttypbezeichner.

Eigenschaften
display.properties array of object
Datentyp
display.properties.dataType string

Der Datentyp.

Etikett
display.properties.label string

Die Bezeichnung.

Name
display.properties.name string

Der Name.

Options
display.properties.options array of object
Etikett
display.properties.options.label string

Die Bezeichnung.

Name
display.properties.options.name string

Der Name.

Typ
display.properties.options.type string

Der Typ.

Objekttypen
fetch.objectTypes array of object
Name
fetch.objectTypes.name string

Der Name.

Zu sendende Eigenschaften
fetch.objectTypes.propertiesToSend array of string

Die zu sendenden Eigenschaften.

Ziel-URL
fetch.targetUrl string

Die Ziel-URL-Adresse.

ID
id string

Der Bezeichner.

Title
title string

Der Titel.

Erstellt unter
createdAt string

Beim Erstellen bei.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Erstellen einer Reihe von Anführungszeichen

Erstellen Sie eine Reihe von Anführungszeichen.

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 Deals

Erstellen Sie eine Reihe von Deals.

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 Gebühren

Erstellen Sie eine Reihe von Gebühren.

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 Produkten

Erstellen Sie eine Reihe von Produkten.

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 Rabatten

Erstellen Sie eine Reihe von Rabatten.

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 Steuern

Erstellen Sie eine Reihe von Steuern.

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 Unternehmen

Erstellen Sie eine Reihe von Unternehmen.

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 Zeilenelementen

Erstellen Sie eine Reihe von Zeilenelementen.

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 Zielzielen

Erstellen Sie eine Reihe von Zielzielen.

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 Steuer

Erstellen Sie eine Steuer mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

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 -Objekts

Erstellen Sie ein CRM-Objekt mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objekttyp
objectType True string

Der Objekttyp.

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 Feedbackübermittlungen

Erstellen Sie einen Batch von Feedbackübermittlungen.

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 Kontakten

Erstellen Sie einen Batch von Kontakten.

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 Tickets

Erstellen Sie eine Reihe von Tickets.

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 Deals

Erstellen Sie einen Deal mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

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 Rabatts

Erstellen Sie einen Rabatt mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id string

Der Bezeichner.

Zuordnungskategorie
associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
associationTypeId string

Der Zuordnungstypbezeichner.

nostrudcf
nostrudcf string

nostrudcf.

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 Stapels von Objekten

Erstellen Sie einen Stapel von Objekten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objekttyp
objectType True string

Der Objekttyp.

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 Unternehmens

Erstellen Sie ein Unternehmen mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

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 Zeilenelements

Erstellen Sie ein Zeilenelement mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

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 Zielziels

Erstellen Sie ein Zielziel mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

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 von Batchzuordnungen

Batcherstellungszuordnungen für Objekte.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Vom Objekttyp
fromObjectType True string

Der From-Objekttyp.

An-Objekttyp
toObjectType True string

Der To-Objekttyp.

ID
id string

Der Bezeichner.

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
Von Objekt-ID
results.fromObjectId string

Der From-Objektidentfiier.

Aus Objekttyp-ID
results.fromObjectTypeId string

Der Bezeichner des From-Objekttyps.

Labels
results.labels array of string

Die Bezeichnungen.

To-Objekt-ID
results.toObjectId string

Der To-Objektbezeichner.

Objekttyp-ID
results.toObjectTypeId string

Der To-Objekttypbezeichner.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Erstellen von Standardzuordnungen

Erstellen Sie den Standardmäßigen (generischsten) Zuordnungstyp zwischen zwei Objekttypen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Vom Objekttyp
fromObjectType True string

Der From-Objekttyp.

An-Objekttyp
toObjectType True string

Der To-Objekttyp.

ID
id string

Der Bezeichner.

ID
id string

Der Bezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Zuordnungskategorie
results.associationSpec.associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
results.associationSpec.associationTypeId string

Der Zuordnungstypbezeichner.

ID
results.from.id string

Der Bezeichner.

ID
results.to.id string

Der Bezeichner.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Errors
numErrors string

Die Anzahl der Fehler.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Errors
errors array of object
Kategorie
errors.category string

Die Kategorie.

Errors
errors.errors array of object
Nachricht
errors.errors.message string

Die Nachricht.

Unterkategorie
errors.errors.subCategory string

Die Unterkategorie.

Code
errors.errors.code string

Der Code.

In
errors.errors.in string

Das In.

Nachricht
errors.message string

Die Nachricht.

Der Status
errors.status string

Der Status.

ID
errors.id string

Der Bezeichner.

Erstellen von Zuordnungsbezeichnungen

Legen Sie Zuordnungsbezeichnungen zwischen zwei Datensätzen fest.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objekttyp
objectType True string

Der Objekttyp.

Objekt-ID
objectId True string

Der Objektbezeichner.

An-Objekttyp
toObjectType True string

Der To-Objekttyp.

To-Objekt-ID
toObjectId True string

Der To-Objektbezeichner.

Zuordnungskategorie
associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
associationTypeId string

Der Zuordnungstypbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Von Objekt-ID
fromObjectId string

Der From-Objektbezeichner.

Aus Objekttyp-ID
fromObjectTypeId string

Der Bezeichner des From-Objekttyps.

Labels
labels array of string

Die Bezeichnungen.

To-Objekt-ID
toObjectId string

Der To-Objektbezeichner.

Objekttyp-ID
toObjectTypeId string

Der To-Objekttypbezeichner.

Feedbackübermittlungen auflisten

Rufen Sie eine Seite mit Feedbackübermittlungen ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit string

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 nur Ergebnisse zurück, die archiviert wurden.

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

Die Nachseite.

Link
paging.next.link string

Der Link.

Gebühren erhalten

Rufen Sie eine Seite mit Gebühren ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit string

Die Grenze.

Nach
after string

Die Nachseite.

Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

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

Die Nachseite.

Link
paging.next.link string

Der Link.

Hinzufügen aller Datensätze aus einer Quellliste zu einer Zielliste

Add all of the records from a source list (specified by the sourceListId) to a destination list (specified by the listId). Datensätze, die bereits Mitglieder der Zielliste sind, werden ignoriert. Die Ziel- und Quelllisten-IDs müssen unterschiedlich sein. Die Ziel- und Quelllisten müssen Datensätze desselben Typs enthalten (z. B. Kontakte, Unternehmen usw.). Dieser Endpunkt funktioniert nur für Ziellisten mit einer processingType oderMANUAL.SNAPSHOT Die Quellliste kann beliebig processingTypesein.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Listen-ID
listId True string

Der Listenbezeichner.

Quelllisten-ID
sourceListId True string

Der Quelllistenbezeichner.

Gibt zurück

response
string

Hinzufügen und Entfernen von Datensätzen aus einer Liste

Hinzufügen und oder Entfernen von Datensätzen, die bereits im System erstellt wurden, zu und oder aus einer Liste. Dieser Endpunkt funktioniert nur für Listen mit einer processingType oder MANUAL .SNAPSHOT

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Listen-ID
listId True string

Der Listenbezeichner.

Hinzufügende IDs aufzeichnen
recordIdsToAdd array of string

Die hinzuzufügenden Datensatz-IDs.

Zu entfernende IDs aufzeichnen
recordIdsToRemove array of string

Die zu entfernenden Datensatzbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Fehlende Datensatz-IDs
recordIdsMissing array of string

Die Datensatzbezeichner fehlen.

Datensatz-IDs entfernt
recordIdsRemoved array of string

Die Datensatzbezeichner wurden entfernt.

Hinzugefügte Datensatz-IDs
recordsIdsAdded array of string

Die hinzugefügten Datensatzbezeichner.

Hinzufügen von Datensätzen zu einer Liste

Fügen Sie die in der Liste bereitgestellten Datensätze hinzu. Datensätze, die nicht vorhanden sind oder bereits Mitglieder der Liste sind, werden ignoriert. Dieser Endpunkt funktioniert nur für Listen mit einer processingType oder MANUAL .SNAPSHOT

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Listen-ID
listId True string

Der Listenbezeichner.

body
body True array of string

Gibt zurück

Name Pfad Typ Beschreibung
Fehlende Datensatz-IDs
recordIdsMissing array of string

Die Datensatzbezeichner fehlen.

Datensatz-IDs entfernt
recordIdsRemoved array of string

Die Datensatzbezeichner wurden entfernt.

Hinzugefügte Datensatz-IDs
recordsIdsAdded array of string

Die hinzugefügten Datensatzbezeichner.

Karte abrufen

Gibt die Definition für eine Karte mit dem angegebenen Bezeichner zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
appId True string

Der App-Bezeichner.

Kartenkennung
cardId True string

Der Kartenbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Basis-URLs
actions.baseUrls array of string

Die Basis-URL-Adressen.

Überwachungsverlauf
auditHistory array of object
Aktionstyp
auditHistory.actionType string

Der Aktionstyp.

Anwendungs-ID
auditHistory.applicationId string

Der Anwendungsbezeichner.

Autorisierungsquelle
auditHistory.authSource string

Die Autorisierungsquelle.

Geändert am
auditHistory.changedAt string

Wenn geändert bei.

Initiieren der Benutzer-ID
auditHistory.initiatingUserId string

Der initiierende Benutzerbezeichner.

Objekttyp-ID
auditHistory.objectTypeId string

Der Objekttypbezeichner.

Eigenschaften
display.properties array of object
Datentyp
display.properties.dataType string

Der Datentyp.

Etikett
display.properties.label string

Die Bezeichnung.

Name
display.properties.name string

Der Name.

Options
display.properties.options array of object
Etikett
display.properties.options.label string

Die Bezeichnung.

Name
display.properties.options.name string

Der Name.

Typ
display.properties.options.type string

Der Typ.

Objekttypen
fetch.objectTypes array of object
Name
fetch.objectTypes.name string

Der Name.

Zu sendende Eigenschaften
fetch.objectTypes.propertiesToSend array of string

Die zu sendenden Eigenschaften.

Ziel-URL
fetch.targetUrl string

Die Ziel-URL-Adresse.

ID
id string

Der Bezeichner.

Title
title string

Der Titel.

Erstellt unter
createdAt string

Beim Erstellen bei.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Karte löschen

Löscht eine Kartendefinition dauerhaft mit dem angegebenen Bezeichner. Nach dem Löschen werden Datenabrufanforderungen für diese Karte nicht mehr an Ihren Dienst gesendet. Dies kann nicht rückgängig gemacht werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
appId True string

Der App-Bezeichner.

Kartenkennung
cardId True string

Der Kartenbezeichner.

Gibt zurück

response
string

Kontakte abrufen

Dient zum Abrufen einer Seite mit Kontakten. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit string

Die Grenze.

Nach
after string

Die Nachseite.

Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

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

Die Nachseite.

Link
paging.next.link string

Der Link.

Löschen aller Datensätze aus einer Liste

Entfernen Sie alle Datensätze aus einer Liste. Hinweis: Die Liste wird nicht gelöscht. Dieser Endpunkt funktioniert nur für Listen mit einer processingType oder MANUAL .SNAPSHOT

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Listen-ID
listId True string

Der Listenbezeichner.

Gibt zurück

response
string

Löschen bestimmter Zuordnungsbezeichnungen

Batchlöscht bestimmte Zuordnungsbezeichnungen für Objekte. Durch das Löschen einer nicht bezeichneten Zuordnung werden auch alle beschrifteten Zuordnungen zwischen diesen beiden Objekten gelöscht.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Vom Objekttyp
fromObjectType True string

Der From-Objekttyp.

An-Objekttyp
toObjectType True string

Der To-Objekttyp.

ID
id string

Der Bezeichner.

ID
id string

Der Bezeichner.

Zuordnungskategorie
associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
associationTypeId string

Der Zuordnungstypbezeichner.

Gibt zurück

response
string

Löschen einer Feedbackübermittlung zur Folge der DSGVO

Löschen Sie eine Feedbackübermittlung und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Gebühr zur Folge der DSGVO

Löschen Sie eine Gebühr und alle zugehörigen Inhalte dauerhaft, um die DSGVO zu befolgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Steuer zur Folge der DSGVO

Löschen Sie eine Steuer und alle damit verbundenen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Deals zur Folge der DSGVO

Löschen Sie einen Deal und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Kontakts zur Folge der DSGVO

Löschen Sie einen Kontakt und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Objekttyps zur Folge der DSGVO

Löschen Sie einen Objekttyp und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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
Objekttyp
objectType True string

Der Objekttyp.

Objekt-ID
objectId string

Der Objektbezeichner.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Gibt zurück

response
string

Löschen eines Produkts zur Folge der DSGVO

Löschen Sie ein Produkt und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Rabatts zur Folge der DSGVO

Löschen Sie einen Rabatt und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Tickets zur Folge der DSGVO

Löschen Sie ein Ticket und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Unternehmens, das der DSGVO folgt

Löschen Sie ein Unternehmen und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Zeilenelements zur Folge der DSGVO

Löschen Sie ein Zeilenelement und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Zielziels zur Folge der DSGVO

Löschen Sie dauerhaft ein Zielziel und alle zugehörigen Inhalte, die der DSGVO folgen sollen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 Zitats zur Folge der DSGVO

Löschen Sie ein Zitat und alle zugehörigen Inhalte dauerhaft, um der DSGVO zu folgen. Verwenden Sie die optionale Eigenschaft "ID-Eigenschaft", die auf "email" festgelegt ist, 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 von Batchzuordnungen

Batchlöschzuordnungen für Objekte.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Vom Objekttyp
fromObjectType True string

Der From-Objekttyp.

An-Objekttyp
toObjectType True string

Der To-Objekttyp.

ID
id string

Der Bezeichner.

ID
id string

Der Bezeichner.

Gibt zurück

response
string

Produkt abrufen

Rufen Sie ein objekt ab, das durch productidentifier identifiziert wurde. productId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter 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 nur Ergebnisse zurück, die archiviert wurden.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Produkt-ID
productId True string

Der Produktbezeichner.

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.

Produkte abrufen

Rufen Sie eine Seite mit Produkten ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit string

Die Grenze.

Nach
after string

Die Nachseite.

Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

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

Die Nachseite.

Link
paging.next.link string

Der Link.

Rabatt erhalten

Rufen Sie ein objekt ab, das durch Discountidentifier identifiziert wird. discountId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter 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 nur Ergebnisse zurück, die archiviert wurden.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Rabattkennung
discountId True string

Der Rabattbezeichner.

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.

Rabatte auflisten

Rufen Sie eine Seite mit Rabatten ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit string

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 nur Ergebnisse zurück, die archiviert wurden.

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

Die Nachseite.

Link
paging.next.link string

Der Link.

Standardzuordnung erstellen

Erstellen Sie den Standardmäßigen (generischsten) Zuordnungstyp zwischen zwei Objekttypen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Vom Objekttyp
fromObjectType True string

Der From-Objekttyp.

Von Objekt-ID
fromObjectId True string

Der From-Objektbezeichner.

An-Objekttyp
toObjectType True string

Der To-Objekttyp.

To-Objekt-ID
toObjectId True string

Der To-Objektbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Ergebnisse
results array of object
Zuordnungskategorie
results.associationSpec.associationCategory string

Die Zuordnungskategorie.

Zuordnungstyp-ID
results.associationSpec.associationTypeId string

Der Zuordnungstypbezeichner.

ID
results.from.id string

Der Bezeichner.

ID
results.to.id string

Der Bezeichner.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Errors
numErrors string

Die Anzahl der Fehler.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Errors
errors array of object
Kategorie
errors.category string

Die Kategorie.

Errors
errors.errors array of object
Nachricht
errors.errors.message string

Die Nachricht.

Unterkategorie
errors.errors.subCategory string

Die Unterkategorie.

Code
errors.errors.code string

Der Code.

In
errors.errors.in string

Das In.

Nachricht
errors.message string

Die Nachricht.

Der Status
errors.status string

Der Status.

ID
errors.id string

Der Bezeichner.

Starten eines Exports

Beginnt mit dem Exportieren von CRM-Daten für das Portal, wie im Anforderungstext angegeben.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Exportname
exportName string

Der Exportname.

Exporttyp
exportType string

Der Exporttyp.

Format
format string

Das Format.

Language
language string

Die Sprache.

Objekteigenschaften
objectProperties array of string

Die Objekteigenschaften.

Objekttyp
objectType string

Das Objekt tyep.

Zugeordneter Objekttyp
associatedObjectType string

Der zugeordnete Objekttyp.

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.

Query
query string

Die Abfrage.

Sorten
sorts array of string

Die Sortierungen.

Gibt zurück

Name Pfad Typ Beschreibung
ID
id string

Der Bezeichner.

Starten eines neuen Imports

Beginnt mit dem Importieren von Daten aus den angegebenen Dateiressourcen. Dadurch wird die entsprechende Datei hochgeladen und das Importanforderungsobjekt verwendet, um Zeilen in die Dateien in Objekte zu konvertieren.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Inhaltstyp
Content-Type True string

Inhaltstyp.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellt unter
createdAt string

Beim Erstellen bei.

ID
id string

Der Bezeichner.

Datei-IDs
metadata.fileIds array of string

Die Datei-IDs.

Objektlisten
metadata.objectLists array of object
Listen-ID
metadata.objectLists.listId string

Der Listenbezeichner.

Objekttyp
metadata.objectLists.objectType string

Der Objekttyp.

Opt-Out Importieren
optOutImport string

Der Import wird abgemeldet.

Staat
state string

Das Land/die Region.

Aktualisiert unter
updatedAt string

Wenn aktualisiert unter.

Vorlagen-ID
importTemplate.templateId string

Der Vorlagenbezeichner.

Vorlagentyp
importTemplate.templateType string

Der Vorlagentyp.

Quelle importieren
importSource string

Die Importquelle.

Importname
importName string

Der Importname.

Steuern durchsuchen

Dient zum Abrufen einer Liste von Steuern.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Die Nachseite.

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

Das Eigenschaftenobjekt.

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 string

Die Summe.

Nach
paging.next.after string

Die Nachseite.

Link
paging.next.link string

Der Link.

Steuern erhalten

Rufen Sie eine Seite mit Steuern ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit string

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 nur Ergebnisse zurück, die archiviert wurden.

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

Die Nachseite.

Link
paging.next.link string

Der Link.

Suchen nach Gebühren

Abrufen einer Liste von Gebühren.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Die Nachseite.

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

Das Eigenschaftenobjekt.

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 string

Die Summe.

Nach
paging.next.after string

Die Nachseite.

Link
paging.next.link string

Der Link.

Suchen nach Kontakten

Dient zum Abrufen einer Liste von Kontakten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Die Nachseite.

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

Das Eigenschaftenobjekt.

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 string

Die Summe.

Nach
paging.next.after string

Die Nachseite.

Link
paging.next.link string

Der Link.

Suchen nach Objekttyp

Dient zum Abrufen einer Liste von Objekten nach Objekttyp.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objekttyp
objectType True string

Der Objekttyp.

Nach
after string

Die Nachseite.

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

Das Eigenschaftenobjekt.

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 string

Die Summe.

Nach
paging.next.after string

Die Nachseite.

Link
paging.next.link string

Der Link.

Suchen von Anführungszeichen

Dient zum Abrufen einer Liste von Anführungszeichen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Die Nachseite.

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

Das Eigenschaftenobjekt.

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 string

Die Summe.

Nach
paging.next.after string

Die Nachseite.

Link
paging.next.link string

Der Link.

Suchen von Produkten

Dient zum Abrufen einer Liste von Produkten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Die Nachseite.

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

Das Eigenschaftenobjekt.

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 string

Die Summe.

Nach
paging.next.after string

Die Nachseite.

Link
paging.next.link string

Der Link.

Suchen von Unternehmen

Dient zum Abrufen einer Liste von Unternehmen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Die Nachseite.

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

Das Eigenschaftenobjekt.

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 string

Die Summe.

Nach
paging.next.after string

Die Nachseite.

Link
paging.next.link string

Der Link.

Suchlisten

Durchsuchen sie Listen nach Listenname oder Seite durch alle Listen, indem Sie einen leeren query Wert angeben.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Weitere Eigenschaften
additionalProperties array of string

Die zusätzlichen Eigenschaften.

Offset
offset string

Der Offset.

Query
query string

Die Abfrage.

Anzahl
count string

Die Anzahl.

Gibt zurück

Name Pfad Typ Beschreibung
Hat mehr
hasMore boolean

Ob mehr.

Lists
lists array of object
Listen-ID
lists.listId string

Der Listenbezeichner.

Version auflisten
lists.listVersion string

Die Listenversion.

Name
lists.name string

Der Name.

Objekttyp-ID
lists.objectTypeId string

Der Objekttypbezeichner.

Verarbeitungsstatus
lists.processingStatus string

Der Verarbeitungsstatus.

Verarbeitungstyp
lists.processingType string

Der Verarbeitungstyp.

Aktualisiert nach ID
lists.updatedById string

Der nach Bezeichner aktualisierte.

Filter aktualisiert unter
lists.filtersUpdatedAt string

Wann die Filter aktualisiert wurden unter.

Erstellt unter
lists.createdAt string

Beim Erstellen bei.

Gelöscht am
lists.deletedAt string

Beim Löschen bei.

Erstellt anhand der ID
lists.createdById string

Der durch bezeichner erstellte Bezeichner.

Aktualisiert unter
lists.updatedAt string

Wenn aktualisiert unter.

Offset
offset string

Der Offset.

Total
total string

Die Summe.

Suchrabatte

Dient zum Abrufen einer Liste von Rabatten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Die Nachseite.

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

Das Eigenschaftenobjekt.

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 string

Die Summe.

Nach
paging.next.after string

Die Nachseite.

Link
paging.next.link string

Der Link.

Suchzeilenelemente

Dient zum Abrufen einer Liste von Zeilenelementen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Die Nachseite.

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

Das Eigenschaftenobjekt.

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 string

Die Summe.

Nach
paging.next.after string

Die Nachseite.

Link
paging.next.link string

Der Link.

Ticket abrufen

Rufen Sie ein objekt ab, das durch ticketidentifier identifiziert wurde. "ticketId" bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter 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 nur Ergebnisse zurück, die archiviert wurden.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Ticket-ID
ticketId True string

Der Ticketbezeichner.

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.

Ticket erstellen

Erstellen Sie ein Ticket mit den angegebenen Eigenschaften, und geben Sie eine Kopie des Objekts zurück, einschließlich des Bezeichners.

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.

Tickets abrufen

Rufen Sie eine Seite mit Tickets ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit string

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 nur Ergebnisse zurück, die archiviert wurden.

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

Die Nachseite.

Link
paging.next.link string

Der Link.

Tickets suchen

Dient zum Abrufen einer Liste von Tickets.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Die Nachseite.

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

Das Eigenschaftenobjekt.

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 string

Die Summe.

Nach
paging.next.after string

Die Nachseite.

Link
paging.next.link string

Der Link.

Unternehmen abrufen

Rufen Sie eine Seite von Unternehmen ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit string

Die Grenze.

Nach
after string

Die Nachseite.

Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

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

Die Nachseite.

Link
paging.next.link string

Der Link.

Unternehmen nach ID abrufen

Rufen Sie einen Batch von Unternehmen anhand der internen ID oder eindeutiger Eigenschaftswerte ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

ID
id string

Der Bezeichner.

Eigenschaften
properties array of string

Das Eigenschaftenobjekt.

Eigenschaften mit Verlauf
propertiesWithHistory array of string

Die Eigenschaften mit dem Verlaufsobjekt.

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.

Vorgangs-ID-Status abrufen

Rufen Sie den Status für einen Vorgangsbezeichner ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Vorgangsnummer
taskId True string

Der Vorgangsbezeichner.

Gibt zurück

Name Pfad Typ Beschreibung
Abgeschlossen bei
completedAt string

Nach Abschluss bei.

Begonnen am
startedAt string

Wann beginnen sie bei.

Der Status
status string

Der Status.

Ergebnis
result string

Das Ergebnis.

Errors
numErrors string

Die Anzahl der Fehler.

Errors
errors array of object
Kategorie
errors.category string

Die Kategorie.

Errors
errors.errors array of object
Nachricht
errors.errors.message string

Die Nachricht.

In
errors.errors.in string

Das In.

Code
errors.errors.code string

Der Code.

Unterkategorie
errors.errors.subCategory string

Die Unterkategorie.

Nachricht
errors.message string

Die Nachricht.

Der Status
errors.status string

Der Status.

ID
errors.id string

Der Bezeichner.

Angefordert bei
requestedAt string

Bei Bedarf bei.

Zeilenelement abrufen

Rufen Sie ein objekt ab, das durch lineItemidentifier identifiziert wurde. lineItemId bezieht sich standardmäßig auf den internen Objektbezeichner oder optional auf einen eindeutigen Eigenschaftswert, der durch den idProperty-Abfrageparameter angegeben wird. Steuern, was über den Eigenschaftenabfrageparameter 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 nur Ergebnisse zurück, die archiviert wurden.

ID-Eigenschaft
idProperty string

Die Id-Eigenschaft.

Zeilenelement-ID
lineItemId True string

Der Zeilenelementbezeichner.

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.

Zielziele abrufen

Rufen Sie eine Seite mit Zielzielen ab. Steuern, was über den Eigenschaftenabfrageparameter zurückgegeben wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit string

Die Grenze.

Nach
after string

Die Nachseite.

Eigenschaften
properties string

Die Eigenschaften.

Eigenschaften mit Verlauf
propertiesWithHistory string

Die Eigenschaften mit verlauf.

Associations
associations string

Die Zuordnungen.

Archived
archived boolean

Gibt nur Ergebnisse zurück, die archiviert wurden.

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

Die Nachseite.

Link
paging.next.link string

Der Link.

Zielziele für die Suche

Dient zum Abrufen einer Liste von Zielzielen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Die Nachseite.

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

Das Eigenschaftenobjekt.

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 string

Die Summe.

Nach
paging.next.after string

Die Nachseite.

Link
paging.next.link string

Der Link.

Zuordnungen löschen

Löscht alle Zuordnungen zwischen zwei Datensätzen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objekttyp
objectType True string

Der Objekttyp.

Objekt-ID
objectId True string

Der Objektbezeichner.

An-Objekttyp
toObjectType True string

Der To-Objekttyp.

To-Objekt-ID
toObjectId True string

Der To-Objektbezeichner.

Gibt zurück

response
string

Zuordnungstypen auflisten

Listet alle gültigen Zuordnungstypen auf, die zwischen zwei Objekttypen verfügbar sind.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Vom Objekttyp
fromObjectType True string

Der From-Objekttyp.

An-Objekttyp
toObjectType True string

Der To-Objekttyp.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of object
ID
results.id string

Der Bezeichner.

Name
results.name string

Der Name.

Zusammenführen von zwei Anführungszeichen

Führen Sie zwei Anführungszeichen mit demselben Typ zusammen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objektbezeichner zum Zusammenführen
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 Deals

Führen Sie zwei Deals mit demselben Typ aus.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objektbezeichner zum Zusammenführen
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 Feedbackübermittlungen

Führen Sie zwei Feedbackübermittlungen mit demselben Typ zusammen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objektbezeichner zum Zusammenführen
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 Gebühren

Führen Sie zwei Gebühren mit demselben Typ zusammen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objektbezeichner zum Zusammenführen
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 Kontakten

Führen Sie zwei Kontakte mit demselben Typ zusammen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objektbezeichner zum Zusammenführen
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 Objekten

Führen Sie zwei Objekte mit demselben Typ zusammen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objekttyp
objectType True string

Der Objekttyp.

Objektbezeichner zum Zusammenführen
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 Produkten

Führen Sie zwei Produkte mit demselben Typ zusammen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objektbezeichner zum Zusammenführen
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 Rabatten

Führen Sie zwei Rabatte mit demselben Typ zusammen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objektbezeichner zum Zusammenführen
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 Steuern

Führen Sie zwei Steuern mit demselben Typ zusammen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objektbezeichner zum Zusammenführen
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 Tickets

Führen Sie zwei Tickets mit demselben Typ zusammen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objektbezeichner zum Zusammenführen
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 Zeilenelementen

Führen Sie zwei Zeilenelemente mit demselben Typ zusammen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objektbezeichner zum Zusammenführen
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 Zielzielen

Führen Sie zwei Zielziele mit demselben Typ zusammen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objektbezeichner zum Zusammenführen
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.

Zwei Unternehmen zusammenführen

Führen Sie zwei Unternehmen mit demselben Typ zusammen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Objektbezeichner zum Zusammenführen
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.

Übermittlungen von Suchfeedback

Dient zum Abrufen einer Liste von Feedbackübermittlungen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach
after string

Die Nachseite.

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

Das Eigenschaftenobjekt.

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 string

Die Summe.

Nach
paging.next.after string

Die Nachseite.

Link
paging.next.link string

Der Link.

Definitionen

Schnur

Dies ist der grundlegende Datentyp "string".