Blackbaud Raisers Edge NXT (Vorschau)

Blackbaud Raiser es Edge NXT ist eine umfassende cloudbasierte Spenden- und Spendermanagement-Softwarelösung, die speziell für gemeinnützige Organisationen und die gesamte soziale Gute Community entwickelt wurde.

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	Blackbaud Support
URL	https://www.blackbaud.com/support
Email	skyapi@blackbaud.com

Connectormetadaten
Herausgeber	Blackbaud, Inc.
Webseite	https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
Datenschutzrichtlinie	https://www.blackbaud.com/privacy-shield
Kategorien	Vertrieb und CRM; Produktivität

Raisers Edge NXT ist eine umfassende cloudbasierte Spenden- und Spendermanagement-Softwarelösung, die speziell für gemeinnützige Organisationen und die gesamte soziale Gute Community entwickelt wurde.

Dieser Connector basiert auf der SKY-API von Blackbaud und bietet Vorgänge zur Verwaltung von Entitäten, die in The Raiser es Edge NXT gefunden wurden, einschließlich:

Bestandteile
Geschenke
Aktionen
Hinweise
Benutzerdefinierte Felder
Feldzüge
Geldmittel
Einsprüche
und mehr…

Weitere Informationen finden Sie in der Dokumentation.

Voraussetzungen

Um diesen Connector zu verwenden, müssen Sie über ein Blackbaud ID-Konto mit Zugriff auf eine oder mehrere Blackbaud-Umgebungen verfügen.

Darüber hinaus muss der Administrator Ihrer Organisation auch eine Aktion auf Administratorebene innerhalb des Systems ausführen, damit dieser Connector auf Edge NXT von Raiser zugreifen kann. Weitere Informationen zu diesen Voraussetzungen finden Sie in der Ersteinrichtungsdokumentation .

Wie erhalten Sie Anmeldeinformationen?

Der Administrator Ihrer Organisation sendet Ihnen eine Einladung zur Edge NXT-Umgebung der Organisation und konfiguriert Ihre Benutzerkontoberechtigungen innerhalb der Umgebung. Für die Verwendung dieses Connectors sind keine zusätzlichen Anmeldeinformationen erforderlich.

Bekannte Probleme und Einschränkungen

Der Connector wird im Kontext Ihres Benutzerkontos ausgeführt und unterliegt daher Ihren Benutzerberechtigungen innerhalb der Umgebung.

Drosselungsgrenzwerte

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

Aktionen

Abrufen der Lebenszeit des Bestandteils	Gibt die Lebensdauer zurück, die eine Zusammenfassung für einen Bestandteil angibt.
Abrufen des Status des konstituierenden Aussichts	Gibt den aktuellen Aussichtsstatus für einen Bestandteil zurück.
Abrufen einer Kampagne	Gibt Informationen zu einer Kampagne zurück.
Abrufen einer konstituierenden Aktion	Gibt Informationen zu einer konstituierenden Aktion zurück.
Abrufen eines Bestandteils	Gibt Informationen zu einem Bestandteil zurück.
Abrufen eines Ereignisses	Gibt Informationen zu einem Ereignis zurück.
Abrufen eines Fonds	Gibt Informationen zu einem Fonds zurück.
Abrufen eines Konstituierenden Profilbilds	Gibt das aktuelle Profilbild für einen Bestandteil zurück.
Abrufen eines Pakets	Gibt Informationen zu einem Paket zurück.
Abrufen eines Teilnehmers	Gibt Informationen zu einem bestimmten Ereignisteilnehmer zurück.
Aktualisieren der Details zur Geschenkbestätigung	Aktualisiert die Bestätigungsdetails für ein Geschenk.
Aktualisieren einer Aktionsanlage	Aktualisiert eine Aktionsanlage.
Aktualisieren einer Beschwerdeanfügung	Aktualisiert eine Beschwerdeanfügung.
Aktualisieren einer Bestandteil-Onlinepräsenz	Aktualisiert eine Bestandteil-Onlinepräsenz.
Aktualisieren einer Bestandteiladresse	Aktualisiert eine Bestandteiladresse.
Aktualisieren einer Bestandteilanlage	Aktualisiert eine Bestandteilanlage.
Aktualisieren einer bestandteilen E-Mail-Adresse	Aktualisiert eine konstituierende E-Mail-Adresse.
Aktualisieren einer bestandteilen Notiz	Aktualisiert eine konstituierende Notiz.
Aktualisieren einer Fondsanlage	Aktualisiert eine Fondsanlage.
Aktualisieren einer Geschenkanlage	Aktualisiert eine Geschenkanlage.
Aktualisieren einer Kampagnenanlage	Aktualisiert eine Kampagnenanlage.
Aktualisieren einer konstituierenden Aktion	Aktualisiert eine konstituierende Aktion.
Aktualisieren einer Konstituierenden Beziehung	Aktualisiert eine Beziehung für einen Bestandteil. Wenn eine gegenseitige Beziehung vorhanden ist, wird sie auch geändert, um die Änderungen widerzuspiegeln. Dies schließt keine Änderungen an der Eigenschaft "comments" ein, die für jeden Datensatz spezifisch ist und unabhängig von jedem Datensatz geändert werden kann.
Aktualisieren einer Teilerziehung	Aktualisiert eine teilgebende Ausbildung.
Aktualisieren einer Teilnehmeroption	Aktualisiert die Details zu einer Teilnehmeroption.
Aktualisieren einer Verkaufschance	Aktualisiert eine Verkaufschance.
Aktualisieren einer Verkaufschancenanlage	Aktualisiert eine Verkaufschancenanlage.
Aktualisieren eines benutzerdefinierten Aktionsfelds	Aktualisiert ein benutzerdefiniertes Aktionsfeld.
Aktualisieren eines benutzerdefinierten Berufungsfelds	Aktualisiert ein benutzerdefiniertes Berufungsfeld.
Aktualisieren eines benutzerdefinierten Bestandteilfelds	Aktualisiert ein benutzerdefiniertes Bestandteilfeld.
Aktualisieren eines benutzerdefinierten Fondsfelds	Aktualisiert ein benutzerdefiniertes Fondsfeld.
Aktualisieren eines benutzerdefinierten Geschenkfelds	Aktualisiert ein benutzerdefiniertes Geschenkfeld.
Aktualisieren eines benutzerdefinierten Kampagnenfelds	Aktualisiert ein benutzerdefiniertes Kampagnenfeld.
Aktualisieren eines benutzerdefinierten Verkaufschancenfelds	Aktualisiert ein benutzerdefiniertes Verkaufschancenfeld.
Aktualisieren eines Bestandteilalias	Aktualisiert einen Bestandteilalias.
Aktualisieren eines Bestandteilcodes	Aktualisiert einen Bestandteilcode.
Aktualisieren eines Bestandteils	Aktualisiert einen Bestandteil.
Aktualisieren eines Bestandteiltelefons	Aktualisiert ein Bestandteiltelefon.
Aktualisieren eines Bilds für ein Konstituierendes Profil	Aktualisiert das aktuelle Profilbild für einen Bestandteil.
Aktualisieren eines Ereignisses	Aktualisiert die Details zu einem Ereignis.
Aktualisieren eines konstituierenden Solicit-Codes	Aktualisiert einen konstituierenden Solicit-Code.
Aktualisieren eines Teilnehmers	Aktualisiert die Details zu einem Teilnehmer.
Aktualisieren von Geschenkbestätigungsdetails	Aktualisiert die Belegdetails für ein Geschenk.
Anlagen auflisten	Listet die Anlagen für einen Bestandteil auf.
Anlagen für Verkaufschancen auflisten	Listet die Anlagen für eine Verkaufschance auf.
Auflisten von benutzerdefinierten Verkaufschancenfeldern	Listet die benutzerdefinierten Felder für eine Verkaufschance auf.
Auflisten von Berufungsanhängern	Listet die Anlagen für eine Beschwerde auf.
Auflisten von Bestandteiladressen	Listet die Adressen für einen Bestandteil auf.
Auflisten von Bestandteilaliasen	Listet die Aliase für einen Bestandteil auf.
Auflisten von Bestandteilnotizen	Listet die Notizen für einen Bestandteil auf.
Auflisten von Bestandteiltelefonen	Listet die Telefone für einen Bestandteil auf.
Auflisten von Bildungseinrichtungen	Listet die Education-Datensätze für einen Bestandteil auf.
Auflisten von E-Mail-Adressen	Listet die E-Mail-Adressen für einen Bestandteil auf.
Auflisten von Einzelaktionen	Listet die Aktionen für einen Bestandteil auf.
Auflisten von Fondsanlagen	Listet die Anlagen für einen Fonds auf.
Auflisten von Fundraisern	Listet die Fundraiserzuweisungen für einen Bestandteil auf.
Auflisten von Fundraiserzuweisungen	Auflisten der Zuordnungen für einen Fundraiser.
Auflisten von Geschenkbatches	Listen Sie die Geschenkbatches auf.
Auflisten von Guthaben	Gibt eine Liste von Guthaben zurück.
Auflisten von Konstituierenden Beziehungen	Listet die Beziehungen für einen Bestandteil auf.
Auflisten von Paketen	Gibt eine Liste von Paketen zurück.
Auflisten von Veranstaltungsgebühren	Listet die Gebühren für ein Ereignis auf.
Auflisten von Werbecodes für Bestandteile	Listet die Solicit Codes für einen Bestandteil auf.
Auflisten von Zustimmungsdatensätzen für Bestandteile	Listet die Zustimmungsdatensätze für einen Bestandteil auf.
Aufrufe auflisten	Gibt eine Liste von Rechtsmitteln zurück.
Benutzerdefinierte Felder auflisten	Listet die benutzerdefinierten Felder für einen Aufruf auf.
Benutzerdefinierte Felder des Fonds auflisten	Listet die benutzerdefinierten Felder für einen Fonds auf.
Benutzerdefinierte Felder für Geschenk auflisten	Listet die benutzerdefinierten Felder für ein Geschenk auf.
Benutzerdefinierte Felder für Listenkampagnen	Listet die benutzerdefinierten Felder für eine Kampagne auf.
Benutzerdefinierte Listenaktionsfelder	Listet die benutzerdefinierten Felder für eine Aktion auf.
Benutzerdefinierte Listenfelder	Listet die benutzerdefinierten Felder für einen Bestandteil auf.
Bewertungen von Bestandteilen auflisten	Gibt die Liste der Bewertungen für einen Bestandteil zurück.
Einen Aufruf anfordern	Gibt Informationen zu einer Beschwerde zurück.
Ereignis erstellen	Erstellt ein neues Ereignis.
Ereignisse auflisten	Gibt eine Liste von Ereignissen zurück.
Ereignisteilnehmer auflisten	Listet die Teilnehmer für ein Ereignis auf.
Erhalten Sie eine Chance	Gibt Informationen zu einer Verkaufschance zurück. Hinweis: Dieser Endpunkt gibt die Statuseigenschaft mit einer Latenz von ca. 10 Minuten zurück.
Erstellen einer Aktionsanlage	Erstellt eine neue Aktionsanlage.
Erstellen einer Berufungsanlage	Erstellt eine neue Anziehungsanlage.
Erstellen einer Bestandteil-Onlinepräsenz	Erstellt eine neue Onlinepräsenz.
Erstellen einer Bestandteiladresse	Erstellt eine neue Konstituierende Adresse.
Erstellen einer Bestandteilanlage	Erstellt eine neue Anlage.
Erstellen einer bestandteilen Ausbildung	Erstellt eine neue bestandteilische Ausbildung.
Erstellen einer bestandteilen E-Mail-Adresse	Erstellt eine neue E-Mail-Adresse.
Erstellen einer einzelnen Beziehung	Erstellt eine neue einzelne Beziehung. Wenn die Beziehung mit einem anderen Bestandteil besteht, wird für diesen Bestandteil eine gegenseitige Beziehung erstellt.
Erstellen einer einzelnen Komponente	Erstellt einen neuen einzelnen Bestandteil.
Erstellen einer Ereignisteilnehmeroption	Erstellt eine neue Teilnehmeroption für ein Ereignis.
Erstellen einer Fondsanlage	Erstellt eine neue Fondsanlage.
Erstellen einer Fundraiserzuweisung	Erstellt eine neue Fundraiserzuordnung.
Erstellen einer Geschenkanlage	Erstellt eine neue Geschenkanlage.
Erstellen einer Kampagnenanlage	Erstellt eine neue Kampagnenanlage.
Erstellen einer konstituierenden Aktion	Erstellt eine neue konstituierende Aktion.
Erstellen einer Konstituierenden Bewertung	Erstellt eine neue Bewertung.
Erstellen einer Konstituierenden Notiz	Erstellt eine neue Konstituierende Notiz.
Erstellen einer Liste aus einer Gruppe von Datensätzen	Erstellt eine neue Liste, die auf die angegebene Datensatzgruppe gefiltert ist.
Erstellen einer Organisationsbeziehung	Erstellt eine neue Organisationsbeziehung. Wenn die Beziehung mit einem anderen Bestandteil besteht, wird für diesen Bestandteil eine gegenseitige Beziehung erstellt.
Erstellen einer Organisationskomponente	Erstellt einen neuen Organisationsbestandteil.
Erstellen einer Teilnehmergebühr	Erstellt eine neue Gebühr für einen Teilnehmer.
Erstellen einer Teilnehmergebühr	Erstellt eine neue Gebührenzahlung für einen Teilnehmer.
Erstellen einer Teilnehmeroption	Erstellt eine neue Teilnehmeroption für einen Teilnehmer.
Erstellen einer Teilnehmerspende	Erstellt eine neue Spende für einen Teilnehmer.
Erstellen einer Veranstaltungsgebühr	Erstellt eine neue Gebühr für ein Ereignis.
Erstellen einer Verkaufschancenanlage	Erstellt eine neue Verkaufschancenanlage.
Erstellen eines benutzerdefinierten Aktionsfelds	Erstellt ein neues benutzerdefiniertes Aktionsfeld.
Erstellen eines benutzerdefinierten Berufungsfelds	Erstellt ein neues benutzerdefiniertes Berufungsfeld.
Erstellen eines benutzerdefinierten Bestandteilfelds	Erstellt ein neues benutzerdefiniertes Benutzerdefiniertes Feld.
Erstellen eines benutzerdefinierten Fondsfelds	Erstellt ein neues benutzerdefiniertes Fondsfeld.
Erstellen eines benutzerdefinierten Geschenkfelds	Erstellt ein neues benutzerdefiniertes Geschenkfeld.
Erstellen eines benutzerdefinierten Kampagnenfelds	Erstellt ein neues benutzerdefiniertes Kampagnenfeld.
Erstellen eines benutzerdefinierten Verkaufschancenfelds	Erstellt ein neues benutzerdefiniertes Verkaufschancenfeld.
Erstellen eines Bestandteil-Zustimmungsdatensatzes	Erstellt einen neuen zustimmungsgebenden Datensatz.
Erstellen eines Bestandteilcodes	Erstellt einen neuen Komponentencode.
Erstellen eines Bestandteiltelefons	Erstellt ein neues Bestandteiltelefon.
Erstellen eines Dokumentspeicherorts	Erstellt einen neuen eindeutigen Dokumentbezeichner und uploadspeicherort für die Verwendung mit physischen Anlagen. Die Antwort enthält Anweisungen dazu, wo und wie die Dokumentinhalte hochgeladen werden.
Erstellen eines Geschenkbatches	Erstellt einen neuen Geschenkbatch.
Erstellen eines Geschenks	Erstellt ein neues Geschenk.
Erstellen eines konstituierenden Solicit-Codes	Erstellt einen neuen Konstituierenden Solicit-Code.
Erstellen eines Teilalias	Erstellt einen neuen Bestandteilalias.
Erstellen eines Teilnehmers	Erstellt einen neuen Teilnehmer für ein Ereignis.
Erstes Geschenk erhalten	Gibt das erste Geschenk für einen Bestandteil zurück.
Geschenk erhalten	Gibt Informationen zu einem Geschenk zurück.
Geschenke auflisten	Gibt eine Liste von Geschenken zurück.
Geschenkgutschriften auflisten	Listet die Anlagen für ein Geschenk auf.
Hinzufügen eines Geschenks zum Batch	Fügen Sie dem angegebenen Geschenkbatch ein Geschenk hinzu.
Hinzufügen von Datensätzen zu einer Liste	Fügen Sie einer vorhandenen Liste eine Gruppe von Datensätzen hinzu.
Holen Sie sich das beste Geschenk	Gibt das größte Geschenk für einen Bestandteil zurück.
Holen Sie sich das neueste Geschenk	Gibt das neueste Geschenk für einen Bestandteil zurück.
Kampagnen auflisten	Gibt eine Liste von Kampagnen zurück.
Listen von Kampagnenanlagen	Listet die Anlagen für eine Kampagne auf.
Listenaktionen	Gibt eine Liste von Aktionen zurück.
Listenaktionsanlagen	Listet die Anlagen für eine Aktion auf.
Listenkomponenten	Gibt eine Liste von Bestandteilen zurück.
Listenkomponentencodes	Listet die Komponentencodes für einen Bestandteil auf.
Löschen eines Bestandteilcodes	Löscht einen Bestandteilcode.
Onlinepräsenzen auflisten	Listet die Onlinepräsenzen für einen Bestandteil auf.
Optionen für Ereignisteilnehmer auflisten	Listet die Teilnehmeroptionen für ein Ereignis auf.
Suchen nach einem Bestandteil	Führt eine konstituierende Suche basierend auf dem bereitgestellten Suchtext aus. Unterstützt Vorname, Nachname, bevorzugter Name, früherer Name, Alias, E-Mail-Adresse, Telefonnummer, Adresse oder Nachschlage-ID. Namenskombinationen wie Vorname und Nachname oder bevorzugter Name und Nachname sind gültig, andernfalls unterstützt die Suche nur jeweils einen Parameter. Standardmäßig enthalten Suchvorgänge Ergebnisse, die ihren Kriterien ähneln. Suchvorgänge nach "Smith" enthalten z. B. Übereinstimmungen für "Smyth" und andere alternative Schreibweisen. Diese Suche unterstützt keine Wildcardzeichen wie * oder ?. Suchergebnisse sind auf 500 Datensätze beschränkt.
Teilnehmergebühren auflisten	Listet die Gebühren für einen Teilnehmer auf.
Teilnehmergebührzahlungen auflisten	Listet die Gebührenzahlungen für einen Teilnehmer auf.
Teilnehmeroptionen auflisten	Listet die Teilnehmeroptionen für einen Teilnehmer auf.
Teilnehmerspenden auflisten	Listet die Spenden für einen Teilnehmer auf.
Verkaufschance erstellen	Erstellt eine neue Chance.
Verkaufschancen auflisten	Gibt eine Liste der Verkaufschancen zurück.

Abrufen der Lebenszeit des Bestandteils

Vorgangs-ID:: GetConstituentLifetimeGiving

Gibt die Lebensdauer zurück, die eine Zusammenfassung für einen Bestandteil angibt.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Lebenslanges Geben

Body: ConstituentApi.LifetimeGivingRead

Abrufen des Status des konstituierenden Aussichts

Vorgangs-ID:: GetConstituentProspectStatus

Gibt den aktuellen Aussichtsstatus für einen Bestandteil zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils, für den der Aussichtsstatus abgerufen werden soll.

Gibt zurück

Status des Prospekts

Body: ConstituentApi.ProspectStatusRead

Abrufen einer Kampagne

Vorgangs-ID:: GetCampaign

Gibt Informationen zu einer Kampagne zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Kampagnen-ID	campaign_id	True	string	Die Systemdatensatz-ID der abzurufenden Kampagne.

Gibt zurück

Kampagne

Body: FundraisingApi.CampaignRead

Abrufen einer konstituierenden Aktion

Vorgangs-ID:: GetAction

Gibt Informationen zu einer konstituierenden Aktion zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Aktions-ID	action_id	True	string	Die Systemdatensatz-ID der abzurufenden Aktion.

Gibt zurück

Maßnahme

Body: ConstituentApi.ActionRead

Abrufen eines Bestandteils

Vorgangs-ID:: GetConstituent

Gibt Informationen zu einem Bestandteil zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des abzurufenden Bestandteils.

Gibt zurück

Bestandteil

Body: ConstituentApi.ConstituentRead

Abrufen eines Ereignisses

Vorgangs-ID:: GetEvent

Gibt Informationen zu einem Ereignis zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Ereignis-ID	event_id	True	string	Die Systemdatensatz-ID des abzurufenden Ereignisses.

Gibt zurück

Event

Body: EventApi.Event

Abrufen eines Fonds

Vorgangs-ID:: GetFund

Gibt Informationen zu einem Fonds zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Fund-ID	fund_id	True	string	Die Systemdatensatz-ID des zu erhaltenden Fonds.

Gibt zurück

Fonds

Body: FundraisingApi.FundRead

Abrufen eines Konstituierenden Profilbilds

Vorgangs-ID:: GetConstituentProfilePicture

Gibt das aktuelle Profilbild für einen Bestandteil zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils, für den das Profilbild abgerufen werden soll.

Gibt zurück

Profilbild

Body: ConstituentApi.ProfilePictureRead

Abrufen eines Pakets

Vorgangs-ID:: GetPackage

Gibt Informationen zu einem Paket zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	package_id	True	string	Die Systemdatensatz-ID des abzurufenden Pakets.

Gibt zurück

Package

Body: FundraisingApi.PackageRead

Abrufen eines Teilnehmers

Vorgangs-ID:: GetParticipant

Gibt Informationen zu einem bestimmten Ereignisteilnehmer zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Teilnehmer-ID	participant_id	True	string	Die Systemdatensatz-ID des Teilnehmers.

Gibt zurück

Teilnehmer

Body: EventApi.Participant

Aktualisieren der Details zur Geschenkbestätigung

Vorgangs-ID:: EditGiftAcknowledgement

Aktualisiert die Bestätigungsdetails für ein Geschenk.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestätigungs-ID	acknowledgement_id	True	string	Die Systemdatensatz-ID der zu aktualisierenden Geschenkbestätigung. Sie verwendet die ID des Übergeordneten Geschenks als Wert.
Der Status	status		string	Der Status der Bestätigung. Wenn der Status auf "DoNotAcknowledge" festgelegt ist, sollte der Buchstabe und das Datum null sein. Wenn der Status auf "NeedsAcknowledgement" festgelegt ist, sollte das Datum null sein.
Datum	date		date-time	Das Datum, das der Bestätigung zugeordnet ist (z. B. '2020-09-18T04:13:56Z').
Letter	letter		string	Der Brief, der der Bestätigung zugeordnet ist.

Aktualisieren einer Aktionsanlage

Vorgangs-ID:: EditActionAttachment

Aktualisiert eine Aktionsanlage.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Anlagen-ID	attachment_id	True	string	Die Systemdatensatz-ID der zu aktualisierenden Anlage.
Name	name		string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date		date-time	Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z').
URL	url		string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.

Aktualisieren einer Beschwerdeanfügung

Vorgangs-ID:: EditAppealAttachment

Aktualisiert eine Beschwerdeanfügung.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Anlagen-ID	attachment_id	True	string	Die Systemdatensatz-ID der zu aktualisierenden Anlage.
Name	name		string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date		date-time	Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z').
URL	url		string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.

Aktualisieren einer Bestandteil-Onlinepräsenz

Vorgangs-ID:: EditConstituentOnlinePresence

Aktualisiert eine Bestandteil-Onlinepräsenz.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Onlinepräsenz-ID	online_presence_id	True	string	Die Systemdatensatz-ID der zu aktualisierenden Onlinepräsenz.
Typ	type		string	Der Onlinepräsenztyp.
Link	address		string	Die Webadresse für die Onlinepräsenz.
Primär?	primary		boolean	Ist dies die primäre Onlinepräsenz des Wählers?
Inaktiv?	inactive		boolean	Ist diese Onlinepräsenz inaktiv?

Aktualisieren einer Bestandteiladresse

Vorgangs-ID:: EditConstituentAddress

Aktualisiert eine Bestandteiladresse.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Adress-ID	address_id	True	string	Die Systemdatensatz-ID der zu aktualisierenden Adresse.
Adresstyp	type		string	Der Adresstyp.
Country	country		string	Das Land der Adresse (kann die ID, der Name oder die Abkürzung sein).
Adresszeilen	address_lines		string	Die Adresszeilen.
Stadt	city		string	Die Stadt der Adresse (nicht in Kombination mit dem Feld "Vorort") verwenden.
Staat	state		string	Das Bundesland der Adresse.
Postleitzahl	postal_code		string	Die Postleitzahl der Adresse.
Vorort	suburb		string	Der Vorort der Adresse (nicht in Kombination mit dem Feld "Ort") verwenden.
Bezirk	county		string	Der Landkreis der Adresse.
Informationsquelle	information_source		string	Die Informationsquelle für die Adresse.
Region	region		string	Die Region für die Adresse.
KARREN	cart		string	Die Netzbetreiberroute (CART) für die Adresse.
LOS	lot		string	Die Reisezeile (LOT) für die Adresse.
DPC	dpc		string	Der Zustellungspunktcode (Delivery Point Code, DPC) für die Adresse.
Gültig ab	start		date	Das Datum, an dem der Konstituierende mit dieser Adresse begann (z. B. "2005-09-18").
Gültig bis	end		date	Das Datum, an dem sich der Bestandteil nicht mehr an dieser Adresse befindet (z. B. "2005-09-18").
Primär?	preferred		boolean	Ist dies die bevorzugte Adresse des Wählers?
Keine E-Mail senden?	do_not_mail		boolean	Kann der Bestandteil an dieser Adresse kontaktiert werden?
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.

Aktualisieren einer Bestandteilanlage

Vorgangs-ID:: EditConstituentAttachment

Aktualisiert eine Bestandteilanlage.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Anlagen-ID	attachment_id	True	string	Die Systemdatensatz-ID der zu aktualisierenden Anlage.
Name	name		string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date		date-time	Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z').
URL	url		string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.

Aktualisieren einer bestandteilen E-Mail-Adresse

Vorgangs-ID:: EditConstituentEmailAddress

Aktualisiert eine konstituierende E-Mail-Adresse.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
E-Mail-Adress-ID	email_address_id	True	string	Die Systemdatensatz-ID der zu aktualisierenden E-Mail-Adresse.
E-Mail-Typ	type		string	Der Typ der E-Mail-Adresse.
E-Mail-Adresse	address		string	Die E-Mail-Adresse.
Primär?	primary		boolean	Ist dies die primäre E-Mail-Adresse des Bestandteils?
Keine E-Mail senden?	do_not_email		boolean	Kann der Bestandteil an dieser E-Mail-Adresse kontaktiert werden?
Inaktiv?	inactive		boolean	Ist diese E-Mail-Adresse inaktiv?

Aktualisieren einer bestandteilen Notiz

Vorgangs-ID:: EditConstituentNote

Aktualisiert eine konstituierende Notiz.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Notiz-ID	note_id	True	string	Die Systemdatensatz-ID der zu aktualisierenden Notiz.
Typ	type		string	Der Notiztyp.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Zusammenfassung	summary		string	Die Notizzusammenfassung. Zeichenlimit: 50.
Hinweis	text		string	Der Notiztext.

Aktualisieren einer Fondsanlage

Vorgangs-ID:: EditFundAttachment

Aktualisiert eine Fondsanlage.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Anlagen-ID	attachment_id	True	string	Die Systemdatensatz-ID der zu aktualisierenden Anlage.
Name	name		string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date		date-time	Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z').
URL	url		string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.

Aktualisieren einer Geschenkanlage

Vorgangs-ID:: EditGiftAttachment

Aktualisiert eine Geschenkanlage.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Anlagen-ID	attachment_id	True	string	Die Systemdatensatz-ID der zu aktualisierenden Anlage.
Name	name		string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date		date-time	Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z').
URL	url		string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.

Aktualisieren einer Kampagnenanlage

Vorgangs-ID:: EditCampaignAttachment

Aktualisiert eine Kampagnenanlage.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Anlagen-ID	attachment_id	True	string	Die Systemdatensatz-ID der zu aktualisierenden Anlage.
Name	name		string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date		date-time	Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z').
URL	url		string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.

Aktualisieren einer konstituierenden Aktion

Vorgangs-ID:: EditAction

Aktualisiert eine konstituierende Aktion.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Aktions-ID	action_id	True	string	Die Systemdatensatz-ID der zu aktualisierenden Aktion.
Kategorie	category		string	Der Kanal oder die Absicht der konstituierenden Interaktion.
Abgeschlossen?	completed		boolean	Ist die Aktion abgeschlossen? Wenn das System für die Verwendung von benutzerdefinierten Aktionsstatus konfiguriert ist, basiert dieser Wert auf dem Aktionsstatuswert.
Abgeschlossen am	completed_date		date-time	Das Datum, an dem die Aktion abgeschlossen wurde (z. B. '2020-09-18T04:13:56Z').
Datum	date		date-time	Das Aktionsdatum (z. B. '2020-09-18T04:13:56Z').
Hinweis	description		string	Die ausführliche Erläuterung, die die Aktionszusammenfassung erläutert.
Richtung	direction		string	Die Richtung der Aktion.
Fundraiser(en)	fundraisers		array of string	Der Satz von Systemdatensatz-IDs für die Fundraiser, die mit der Aktion verbunden sind.
Standort	location		string	Die Position der Aktion.
Verkaufschancen-ID	opportunity_id		string	Die Systemdatensatz-ID der Verkaufschance, die der Aktion zugeordnet ist.
Ergebnis	outcome		string	Das Ergebnis der Aktion.
Priority	priority		string	Die Priorität der Aktion.
Startzeit	start_time		string	Die Startzeit der Aktion. Verwendet 24-Stunden-Zeit im HH:mm-Format.
Endzeitpunkt	end_time		string	Die Endzeit der Aktion. Verwendet 24-Stunden-Zeit im HH:mm-Format.
Der Status	status		string	Der Aktionsstatus.
Zusammenfassung	summary		string	Die kurze Beschreibung der Aktion, die oben im Datensatz angezeigt wird. Zeichenlimit: 255.
Typ	type		string	Zusätzliche Beschreibung der Aktion zur Ergänzung der Kategorie.

Aktualisieren einer Konstituierenden Beziehung

Vorgangs-ID:: EditConstituentRelationship

Aktualisiert eine Beziehung für einen Bestandteil. Wenn eine gegenseitige Beziehung vorhanden ist, wird sie auch geändert, um die Änderungen widerzuspiegeln. Dies schließt keine Änderungen an der Eigenschaft "comments" ein, die für jeden Datensatz spezifisch ist und unabhängig von jedem Datensatz geändert werden kann.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Beziehungs-ID	relationship_id	True	string	Die Systemdatensatz-ID der zu aktualisierenden Beziehung.
Typ	type		string	Der Typ der Beziehung, die die Beziehung darstellt.
Gegenseitiger Typ	reciprocal_type		string	Beschreibt die Beziehung des Bestandteils zum zugehörigen Bestandteil. Beispielsweise wäre in einer Beziehung zwischen einem männlichen Bestandteil und einem weiblichen Gleichgeordneten der gegenseitige Beziehungstyp Bruder.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Ist Ehepartner?	is_spouse		boolean	Gilt die verwandte Person des Ehegatten (nur für Beziehungen zwischen Einzelpersonen)?
Ist konstituierender Haushaltschef?	is_constituent_head_of_household		boolean	Ist der Konstituierende der Haushaltschef?
Ist ehegatte Haushaltsleiter?	is_spouse_head_of_household		boolean	Ist der Ehegatte der Kopf des Haushalts?
Hinweise	comment		string	Weitere Hinweise zur Beziehung.
Ist Kontakt?	is_organization_contact		boolean	Stellt die Komponente diese Organisation als Kontakt dar (gilt nur für Beziehungen zwischen Organisationen und Einzelpersonen)?
Ist primäres Geschäft?	is_primary_business		boolean	Ist dies das Hauptgeschäft des Bestandteils (gilt nur für Beziehungen zwischen Organisationen und Einzelpersonen)?
Kontakttyp	organization_contact_type		string	Stellt Kontext für Interaktionen mit der zugehörigen Person bereit, die die Organisation als Kontakt darstellt. Gilt nur für Beziehungen zwischen Organisationen und Einzelpersonen.
Position	position		string	Die Position der Person in der Organisation. Gilt nur für Beziehungen zwischen Organisationen und Einzelpersonen. Zeichenlimit: 50.

Aktualisieren einer Teilerziehung

Vorgangs-ID:: EditConstituentEducation

Aktualisiert eine teilgebende Ausbildung.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Education-ID	education_id	True	string	Die Systemdatensatz-ID des zu aktualisierenden Education-Datensatzes.
Schule	school		string	Der Name der Schule/Einrichtung.
Typ	type		string	Die Art der Ausbildung.
Klasse von	class_of		string	Das Jahr, in dem der Konstituierende abschloss.
Der Status	status		string	Der Status der Ausbildung.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Grad	degree		string	Der Grad, der empfangen wurde.
GPA	gpa		double	Der Notenpunktdurchschnitt.
Studienfach	subject_of_study		string	Das Studienfach.
Primär?	primary		boolean	Ist dies der Grundschulverband der Wähler?
Majore	majors		array of string	Die Hauptstudiengänge.
Minderjährige	minors		array of string	Die Nebenstudiengänge.
Campus	campus		string	Der Campus. Zeichenlimit: 50.
Soziale Organisation	social_organization		string	Die soziale Organisation. Zeichenlimit: 50.
Bekannter Name	known_name		string	Der bekannte Name. Zeichenlimit: 50.
Gradklasse	class_of_degree		string	Die Klasse des Abschlusses.
Abteilung	department		string	Der Name der Bildungsabteilung.
Fakultät	faculty		string	Der Name der Fakultät.
Registrierungsnummer	registration_number		string	Die Registrierungsnummer. Zeichenlimit: 50.

Aktualisieren einer Teilnehmeroption

Vorgangs-ID:: EditParticipantOption

Aktualisiert die Details zu einer Teilnehmeroption.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Teilnehmeroptions-ID	option_id	True	string	Die Systemdatensatz-ID der zu aktualisierenden Teilnehmeroption.
Wert	option_value	True	string	Die Antwort des Teilnehmers auf die Option.

Aktualisieren einer Verkaufschance

Vorgangs-ID:: EditOpportunity

Aktualisiert eine Verkaufschance.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Verkaufschancen-ID	opportunity_id	True	string	Die Systemdatensatz-ID der Möglichkeit zum Aktualisieren.
Zweck	purpose		string	Die beabsichtigte Verwendung für jedes Geld, das infolge der Verkaufschance erhoben wurde.
Name	name		string	Der Name, der die Verkaufschance im gesamten Programm identifiziert, z. B. in Listen oder in Bestandteilen. Zeichenlimit: 255.
Der Status	status		string	Der Status, der angibt, wo sich die Verkaufschance im Solicitation-Prozess befindet.
Deadline	deadline		date-time	Das Zieldatum für die Gelegenheit, ein Geschenk zu erzielen (z. B. '2020-09-18T04:13:56Z').
Fragedatum	ask_date		date-time	Das Datum der Aufforderung (z. B. "2020-09-18T04:13:56Z").
value	value		double	Der Geldwert.
Erwartetes Datum	expected_date		date-time	Das Datum, an dem die Aussicht als Reaktion auf die Verkaufschance erwartet wird (z. B. '2020-09-18T04:13:56Z').
value	value		double	Der Geldwert.
Finanzierter Termin	funded_date		date-time	Das Datum, an dem die Aussicht als Reaktion auf die Chance gegeben hat (z. B. "2020-09-18T04:13:56Z").
value	value		double	Der Geldwert.
Kampagnen-ID	campaign_id		string	Die Systemdatensatz-ID der Kampagne, die der Verkaufschance zugeordnet ist. Die Kampagne legt die Gesamtziele für die Geldbeschaffung fest.
Fund-ID	fund_id		string	Die Systemdatensatz-ID des Fonds, der der Verkaufschance zugeordnet ist. Der Fonds bestimmt den spezifischen finanziellen Zweck eines Geschenks und identifiziert das Finanzkonto für dieses Geschenk.
Bestandteil-ID	constituent_id		string	Die Systemdatensatz-ID des Bestandteils, der dem Fundraiser zugeordnet ist.
value	value		double	Der Geldwert.
Inaktiv?	inactive		boolean	Ist die Chance inaktiv?

Aktualisieren einer Verkaufschancenanlage

Vorgangs-ID:: EditOpportunityAttachment

Aktualisiert eine Verkaufschancenanlage.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Anlagen-ID	attachment_id	True	string	Die Systemdatensatz-ID der zu aktualisierenden Anlage.
Name	name		string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date		date-time	Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z').
URL	url		string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.

Aktualisieren eines benutzerdefinierten Aktionsfelds

Vorgangs-ID:: EditActionCustomField

Aktualisiert ein benutzerdefiniertes Aktionsfeld.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des benutzerdefinierten Felds	custom_field_id	True	string	Die Systemdatensatz-ID des zu aktualisierenden benutzerdefinierten Felds.
body	body	True	dynamic	Ein Objekt, das die Eigenschaften des zu aktualisierenden benutzerdefinierten Felds darstellt.

Aktualisieren eines benutzerdefinierten Berufungsfelds

Vorgangs-ID:: EditAppealCustomField

Aktualisiert ein benutzerdefiniertes Berufungsfeld.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des benutzerdefinierten Felds	custom_field_id	True	string	Die Systemdatensatz-ID des zu aktualisierenden benutzerdefinierten Felds.
body	body	True	dynamic	Ein Objekt, das die Eigenschaften des zu aktualisierenden benutzerdefinierten Felds darstellt.

Aktualisieren eines benutzerdefinierten Bestandteilfelds

Vorgangs-ID:: EditConstituentCustomField

Aktualisiert ein benutzerdefiniertes Bestandteilfeld.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des benutzerdefinierten Felds	custom_field_id	True	string	Die Systemdatensatz-ID des zu aktualisierenden benutzerdefinierten Felds.
body	body	True	dynamic	Ein Objekt, das die Eigenschaften des zu aktualisierenden benutzerdefinierten Felds darstellt.

Aktualisieren eines benutzerdefinierten Fondsfelds

Vorgangs-ID:: EditFundCustomField

Aktualisiert ein benutzerdefiniertes Fondsfeld.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des benutzerdefinierten Felds	custom_field_id	True	string	Die Systemdatensatz-ID des zu aktualisierenden benutzerdefinierten Felds.
body	body	True	dynamic	Ein Objekt, das die Eigenschaften des zu aktualisierenden benutzerdefinierten Felds darstellt.

Aktualisieren eines benutzerdefinierten Geschenkfelds

Vorgangs-ID:: EditGiftCustomField

Aktualisiert ein benutzerdefiniertes Geschenkfeld.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des benutzerdefinierten Felds	custom_field_id	True	string	Die Systemdatensatz-ID des zu aktualisierenden benutzerdefinierten Felds.
body	body	True	dynamic	Ein Objekt, das die Eigenschaften des zu aktualisierenden benutzerdefinierten Felds darstellt.

Aktualisieren eines benutzerdefinierten Kampagnenfelds

Vorgangs-ID:: EditCampaignCustomField

Aktualisiert ein benutzerdefiniertes Kampagnenfeld.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des benutzerdefinierten Felds	custom_field_id	True	string	Die Systemdatensatz-ID des zu aktualisierenden benutzerdefinierten Felds.
body	body	True	dynamic	Ein Objekt, das die Eigenschaften des zu aktualisierenden benutzerdefinierten Felds darstellt.

Aktualisieren eines benutzerdefinierten Verkaufschancenfelds

Vorgangs-ID:: EditOpportunityCustomField

Aktualisiert ein benutzerdefiniertes Verkaufschancenfeld.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des benutzerdefinierten Felds	custom_field_id	True	string	Die Systemdatensatz-ID des zu aktualisierenden benutzerdefinierten Felds.
body	body	True	dynamic	Ein Objekt, das die Eigenschaften des zu aktualisierenden benutzerdefinierten Felds darstellt.

Aktualisieren eines Bestandteilalias

Vorgangs-ID:: EditConstituentAlias

Aktualisiert einen Bestandteilalias.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Alias-ID	alias_id	True	string	Die Systemdatensatz-ID des zu aktualisierenden Alias.
Alias	name		string	Der Name, der als Alias des Bestandteils verwendet werden soll. Zeichenlimit: 100.
Typ	type		string	Der Aliastyp.

Aktualisieren eines Bestandteilcodes

Vorgangs-ID:: EditConstituentCode

Aktualisiert einen Bestandteilcode.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Komponentencode-ID	constituent_code_id	True	string	Die Systemdatensatz-ID des zu aktualisierenden Komponentencodes.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Sequence	sequence		integer	Die numerische Sequenz, die dem Bestandteilcode zugeordnet ist.

Aktualisieren eines Bestandteils

Vorgangs-ID:: EditConstituent

Aktualisiert einen Bestandteil.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des zu aktualisierenden Bestandteils.
Title	title		string	Der Haupttitel des Bestandteils (nur für Einzelpersonen).
Vorname	first		string	Der Vorname des Bestandteils (nur für Einzelpersonen). Zeichenlimit: 50.
Nachname	last		string	Der Nachname des Bestandteils (nur für Einzelpersonen). Zeichenlimit: 100.
Name der Organisation	name		string	Für Einzelpersonen ist dies ein berechnetes Feld, das nicht für Bearbeitungsvorgänge gilt. Für die Organisation ist dieses Feld erforderlich und stellt den Namen der Organisation dar. Zeichenlimit: 100.
Nachsilbe	suffix		string	Das primäre Suffix des Bestandteils (nur für Einzelpersonen).
Bevorzugter Name	preferred_name		string	Der bevorzugte Name des Bestandteils (nur für Einzelpersonen). Zeichenlimit: 50.
Nachschlage-ID	lookup_id		string	Der benutzerdefinierte Bezeichner für den Bestandteil.
Geschlecht	gender		string	Das Geschlecht des Wählers (nur für Einzelpersonen).
Zweiter Vorname	middle		string	Der zweite Vorname des Bestandteils (nur für Einzelpersonen). Zeichenlimit: 50.
Ehemaliger Name	former_name		string	Der ehemalige Name des Wählers (nur für Einzelpersonen). Zeichenlimit: 100.
Titel 2	title_2		string	Der sekundäre Titel des Bestandteils (nur für Einzelpersonen).
Suffix 2	suffix_2		string	Das sekundäre Suffix des Bestandteils (nur für Einzelpersonen).
Familienstand	marital_status		string	Der Familienstand des Wählers (nur für Einzelpersonen).
Gibt anonym?	gives_anonymously		boolean	Gibt der Bestandteil anonym?
Inaktiv?	inactive		boolean	Ist der Bestandteil inaktiv?
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Geburtsort	birthplace		string	Der Geburtsort des Bestandteils (nur für Einzelpersonen).
Ethnizität	ethnicity		string	Die EthnischeItät des Bestandteils (nur für Einzelpersonen).
Erlöse	income		string	Das Einkommen für den Bestandteil (nur für Einzelpersonen).
Religion	religion		string	Die Religion des Bestandteils (nur für Einzelpersonen).
Branche	industry		string	Die Industrie des Bestandteils (nur für Organisationen).
Anzahl der Mitarbeiter	num_employees		integer	Die Anzahl der Mitarbeiter in der Organisation.
Stimmt mit Geschenken überein?	matches_gifts		boolean	Stimmt die Organisation mit Geschenken überein?
Passender Geschenkfaktor	matching_gift_factor		double	Der passende Geschenkfaktor (nur für Organisationen).
Min Match pro Geschenk	value		double	Der mindeste Übereinstimmungsbetrag pro Geschenk für den Bestandteil (nur für Organisationen).
Maximale Übereinstimmung pro Geschenk	value		double	Der maximale Übereinstimmungsbetrag pro Geschenk für den Bestandteil (nur für Organisationen).
Min Übereinstimmung pro Constit	value		double	Die Mindestanzahl der Übereinstimmungen für die Bestandteile (nur für Organisationen).
Maximale Übereinstimmung pro Constit	value		double	Die maximale Übereinstimmungssumme für die Einzelnen (nur für Organisationen).
Abgleichen von Geschenknotizen	matching_gift_notes		string	Die passenden Geschenknotizen für den Bestandteil (nur für Organisationen).
Verstorben?	deceased		boolean	Ist der Teil des Verstorbenen (nur für Einzelpersonen)?
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.

Aktualisieren eines Bestandteiltelefons

Vorgangs-ID:: EditConstituentPhone

Aktualisiert ein Bestandteiltelefon.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Telefon-ID	phone_id	True	string	Die Systemdatensatz-ID des zu aktualisierenden Telefons.
Typ	type		string	Der Telefontyp.
Number	number		string	Die Telefonnummer.
Primär?	primary		boolean	Ist dies das primäre Telefon des Wählers?
Rufen Sie nicht an?	do_not_call		boolean	Kann der Bestandteil an dieser Nummer kontaktiert werden?
Inaktiv?	inactive		boolean	Ist diese Telefonnummer inaktiv?

Aktualisieren eines Bilds für ein Konstituierendes Profil

Vorgangs-ID:: EditConstituentProfilePicture

Aktualisiert das aktuelle Profilbild für einen Bestandteil.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils, dessen Profilbild aktualisiert werden soll.
Dateiname	file_name	True	string	Der Name der Datei.
Dokument-ID	document_id	True	uuid	Der Dokumentbezeichner.
Miniaturansichts-ID	thumbnail_id	True	uuid	Der Bezeichner des Miniaturansichtsdokuments.

Aktualisieren eines Ereignisses

Vorgangs-ID:: EditEvent

Aktualisiert die Details zu einem Ereignis.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Ereignis-ID	event_id	True	string	Die Systemdatensatz-ID des zu aktualisierenden Ereignisses.
Ereignisname	name		string	Der Name des Ereignisses.
Description	description		string	Die Beschreibung des Ereignisses.
Kategorie	name	True	string	Der Kategoriename.
Startdatum	start_date		date	Das Startdatum des Ereignisses (z. B. "2020-09-18").
Startzeit	start_time		string	Die Startzeit des Ereignisses (z. B. "07:30").
Enddatum	end_date		date	Das Enddatum des Ereignisses (z. B. '2020-09-18').
Endzeitpunkt	end_time		string	Die Endzeit des Ereignisses (z. B. "07:30").
Nachschlage-ID	lookup_id		string	Die Nachschlage-ID des Ereignisses.
Kapazität	capacity		integer	Die Anzahl der Personen, die an der Veranstaltung teilnehmen können.
Ziel	goal		double	Das monetäre Ziel des Ereignisses.
Kampagnen-ID	campaign_id		string	Die Systemdatensatz-ID der Kampagne, die dem Ereignis zugeordnet ist.
Fund-ID	fund_id		string	Die Systemdatensatz-ID des Fonds, der dem Ereignis zugeordnet ist.
Inaktiv?	inactive		boolean	Ist das Ereignis aktiv?

Aktualisieren eines konstituierenden Solicit-Codes

Vorgangs-ID:: EditConstituentSolicitCode

Aktualisiert einen konstituierenden Solicit-Code.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Anfordern von Code-ID	constituent_solicit_code_id	True	string	Die Systemdatensatz-ID des zu aktualisierenden Aufforderungscodes.
Anfordern von Code	solicit_code		string	Kommunikationsanweisungen und/oder Einschränkungen für einen Bestandteil.
Startdatum	start_date		date	Das Startdatum des Anmeldecodes (z. B. "2005-09-18").
Enddatum	end_date		date	Das Enddatum des Anmeldecodes (z. B. "2005-09-18").

Aktualisieren eines Teilnehmers

Vorgangs-ID:: EditParticipant

Aktualisiert die Details zu einem Teilnehmer.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Teilnehmer-ID	participant_id	True	string	Die Systemdatensatz-ID des zu aktualisierenden Teilnehmers.
Bestandteil-ID	constituent_id		string	Die Konstituierende ID des Teilnehmers.
Host-ID	host_id		string	Die ID des Teilnehmerdatensatzes des Hosts.
RSVP-Status	rsvp_status		string	Der Status des Engagements des Teilnehmers mit dem Ereignis.
Besucht?	attended		boolean	Hat der Teilnehmer an der Veranstaltung teilgenommen?
Einladungsstatus	invitation_status		string	Der Status der Einladung an den Teilnehmer.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Teilnahmestufe	name	True	string	Der Name der Teilnahmestufe.

Aktualisieren von Geschenkbestätigungsdetails

Vorgangs-ID:: EditGiftReceipt

Aktualisiert die Belegdetails für ein Geschenk.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Eingangskennung	receipt_id	True	string	Die Systemdatensatz-ID des zu aktualisierenden Geschenkbelegs. Sie verwendet die ID des Übergeordneten Geschenks als Wert.
Der Status	status		string	Der Belegstatus des Geschenks. Wenn der Status auf "NeedsReceipt" oder "DoNotReceipt" festgelegt ist, sollte das Belegdatum null sein.
value	value		double	Der Geldwert.
Datum	date		date-time	Das Datum am Beleg (z. B. '2020-09-18T04:13:56Z').
Number	number		integer	Die Nummer des Belegs.

Anlagen auflisten

Vorgangs-ID:: ListConstituentAttachments

Listet die Anlagen für einen Bestandteil auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Attachments

Body: ConstituentApi.ApiCollectionOfConstituentAttachmentRead

Anlagen für Verkaufschancen auflisten

Vorgangs-ID:: ListOpportunityAttachments

Listet die Anlagen für eine Verkaufschance auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Verkaufschancen-ID	opportunity_id	True	string	Die Systemdatensatz-ID der Verkaufschance.

Gibt zurück

Attachments

Body: OpportunityApi.ApiCollectionOfOpportunityAttachmentRead

Auflisten von benutzerdefinierten Verkaufschancenfeldern

Vorgangs-ID:: ListOpportunityCustomFields

Listet die benutzerdefinierten Felder für eine Verkaufschance auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Verkaufschancen-ID	opportunity_id	True	string	Die Systemdatensatz-ID der Verkaufschance.

Gibt zurück

Benutzerdefinierte Felder

Body: OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead

Auflisten von Berufungsanhängern

Vorgangs-ID:: ListAppealAttachments

Listet die Anlagen für eine Beschwerde auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Berufungs-ID	appeal_id	True	string	Die Systemdatensatz-ID des Rechtsmittels.

Gibt zurück

Attachments

Body: FundraisingApi.ApiCollectionOfAppealAttachmentRead

Auflisten von Bestandteiladressen

Vorgangs-ID:: ListConstituentAddresses

Listet die Adressen für einen Bestandteil auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils.
Inaktiv einschließen?	include_inactive		boolean	Inaktive Adressen einschließen?

Gibt zurück

Addresses

Body: ConstituentApi.ApiCollectionOfAddressRead

Auflisten von Bestandteilaliasen

Vorgangs-ID:: ListConstituentAliases

Listet die Aliase für einen Bestandteil auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Decknamen

Body: ConstituentApi.ApiCollectionOfAliasRead

Auflisten von Bestandteilnotizen

Vorgangs-ID:: ListConstituentNotes

Listet die Notizen für einen Bestandteil auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Hinweise

Body: ConstituentApi.ApiCollectionOfNoteRead

Auflisten von Bestandteiltelefonen

Vorgangs-ID:: ListConstituentPhones

Listet die Telefone für einen Bestandteil auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils.
Inaktiv einschließen?	include_inactive		boolean	Inaktive Telefone einschließen?

Gibt zurück

Telefone

Body: ConstituentApi.ApiCollectionOfPhoneRead

Auflisten von Bildungseinrichtungen

Vorgangs-ID:: ListConstituentEducations

Listet die Education-Datensätze für einen Bestandteil auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Ausbildungen

Body: ConstituentApi.ApiCollectionOfEducationRead

Auflisten von E-Mail-Adressen

Vorgangs-ID:: ListConstituentEmailAddresses

Listet die E-Mail-Adressen für einen Bestandteil auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils.
Inaktiv einschließen?	include_inactive		boolean	Inaktive E-Mail-Adressen einschließen?

Gibt zurück

E-Mail-Adressen

Body: ConstituentApi.ApiCollectionOfEmailAddressRead

Auflisten von Einzelaktionen

Vorgangs-ID:: ListConstituentActions

Listet die Aktionen für einen Bestandteil auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Aktionen

Body: ConstituentApi.ApiCollectionOfActionRead

Auflisten von Fondsanlagen

Vorgangs-ID:: ListFundAttachments

Listet die Anlagen für einen Fonds auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Fund-ID	fund_id	True	string	Die Systemdatensatz-ID des Fonds.

Gibt zurück

Attachments

Body: FundraisingApi.ApiCollectionOfFundAttachmentRead

Auflisten von Fundraisern

Vorgangs-ID:: ListConstituentFundraiserAssignments

Listet die Fundraiserzuweisungen für einen Bestandteil auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils.
Inaktiv einschließen?	include_inactive		boolean	Inaktive Fundraiserzuweisungen einschließen?

Gibt zurück

Fundraiser-Zuordnungen

Body: ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

Auflisten von Fundraiserzuweisungen

Vorgangs-ID:: ListFundraiserAssignments

Auflisten der Zuordnungen für einen Fundraiser.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Fundraiser ID	fundraiser_id	True	string	Die Systemdatensatz-ID des Fundraisers, für den Zuordnungen zurückgegeben werden sollen.
Limit	limit		integer	Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 5000.
Offset	offset		integer	Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.

Gibt zurück

Zuweisungen

Body: FundraisingApi.ApiCollectionOfFundraiserAssignmentRead

Auflisten von Geschenkbatches

Vorgangs-ID:: ListGiftBatches

Listen Sie die Geschenkbatches auf.

Parameter

Name	Schlüssel	Typ	Beschreibung
Batchnummer	batch_number	string	Stellt einen Filter für Ergebnisse dar, die der angegebenen Zahl entsprechen.
Gebilligt?	approved	boolean	Stellt einen Filter für den Status des Geschenkbatches dar.
Hat Ausnahmen?	has_exceptions	boolean	Stellt einen Filter dar, nach dem der Geschenkbatch Ausnahmen enthält.
Limit	limit	integer	Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 5000.
Offset	offset	integer	Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.
Suchtext	search_text	string	Stellt einen Filter für Text dar, der in den Batchbeschreibungs- oder Batchzahlenfeldern enthalten ist.
Erstellt von	created_by	string	Stellt einen Filter für Geschenkbatches dar, die vom angegebenen Benutzer erstellt wurden.

Gibt zurück

Geschenkbatches

Body: GiftBatchApi.ApiCollectionOfGiftBatch

Auflisten von Guthaben

Vorgangs-ID:: ListFunds

Gibt eine Liste von Guthaben zurück.

Parameter

Name	Schlüssel	Typ	Beschreibung
Limit	limit	integer	Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 5000.
Offset	offset	integer	Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.
Inaktiv einschließen?	include_inactive	boolean	Inaktive Mittel einschließen?
Hinzugefügt am oder nach	date_added	date-time	Filtern Sie die Ergebnisse nach Fonds, die am oder nach dem angegebenen Datum erstellt wurden (z. B. "2020-09-18T04:13:56Z").
Geändert am oder nach	last_modified	date-time	Filtern Sie die Ergebnisse so, dass Die Ergebnisse an oder nach dem angegebenen Datum geändert wurden (z. B. '2020-09-18T04:13:56Z').

Gibt zurück

Geldmittel

Body: FundraisingApi.ApiCollectionOfFundRead

Auflisten von Konstituierenden Beziehungen

Vorgangs-ID:: ListConstituentRelationships

Listet die Beziehungen für einen Bestandteil auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils.
Limit	limit		integer	Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Es gibt kein Maximum.
Offset	offset		integer	Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.

Gibt zurück

Beziehungen

Body: ConstituentApi.ApiCollectionOfRelationshipRead

Auflisten von Paketen

Vorgangs-ID:: ListPackages

Gibt eine Liste von Paketen zurück.

Parameter

Name	Schlüssel	Typ	Beschreibung
Berufungs-ID	appeal_id	string	Stellt eine durch Trennzeichen getrennte Liste von Berufungsbezeichnern dar, um die Ergebnisse zu filtern. Beispielsweise gibt "506.918" nur Pakete für Rechtsmittel 506 oder Rechtsmittel 918 zurück.
Limit	limit	integer	Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 5000.
Offset	offset	integer	Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.
Inaktiv einschließen?	include_inactive	boolean	Inaktive Pakete einschließen?
Hinzugefügt am oder nach	date_added	date-time	Filtern Sie die Ergebnisse nach Paketen, die am oder nach dem angegebenen Datum erstellt wurden (z. B. '2020-09-18T04:13:56Z').
Geändert am oder nach	last_modified	date-time	Filtern Sie die Ergebnisse nach Paketen, die am oder nach dem angegebenen Datum geändert wurden (z. B. '2020-09-18T04:13:56Z').

Gibt zurück

Pakete

Body: FundraisingApi.ApiCollectionOfPackageRead

Auflisten von Veranstaltungsgebühren

Vorgangs-ID:: ListEventFees

Listet die Gebühren für ein Ereignis auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Ereignis-ID	event_id	True	string	Die Systemdatensatz-ID des Ereignisses.

Gibt zurück

Fees

Body: EventApi.ApiCollectionOfEventFee

Auflisten von Werbecodes für Bestandteile

Vorgangs-ID:: ListConstituentSolicitCodes

Listet die Solicit Codes für einen Bestandteil auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Anwaltscodes

Body: CommPrefApi.ConstituentSolicitCodeReadCollection

Auflisten von Zustimmungsdatensätzen für Bestandteile

Vorgangs-ID:: ListConstituentConsents

Listet die Zustimmungsdatensätze für einen Bestandteil auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils.
Nur die aktuellsten?	most_recent_only		boolean	Fügen Sie nur die neuesten Zustimmungsdatensätze für jede Kanalkategoriekombination in die Antwort ein?

Gibt zurück

Zustimmungsdatensätze

Body: CommPrefApi.ConstituentConsentReadCollection

Aufrufe auflisten

Vorgangs-ID:: ListAppeals

Gibt eine Liste von Rechtsmitteln zurück.

Parameter

Name	Schlüssel	Typ	Beschreibung
Limit	limit	integer	Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 5000.
Offset	offset	integer	Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.
Inaktiv einschließen?	include_inactive	boolean	Inaktive Rechtsmittel einschließen?
Hinzugefügt am oder nach	date_added	date-time	Filtern Sie die Ergebnisse nach Rechtsmitteln, die am oder nach dem angegebenen Datum erstellt wurden (z. B. '2020-09-18T04:13:56Z').
Geändert am oder nach	last_modified	date-time	Filtern Sie die Ergebnisse, um die an oder nach dem angegebenen Datum geänderten Rechtsmittel (z. B. "2020-09-18T04:13:56Z") zu filtern.

Gibt zurück

Einsprüche

Body: FundraisingApi.ApiCollectionOfAppealRead

Benutzerdefinierte Felder auflisten

Vorgangs-ID:: ListAppealCustomFields

Listet die benutzerdefinierten Felder für einen Aufruf auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Berufungs-ID	appeal_id	True	string	Die Systemdatensatz-ID des Rechtsmittels.

Gibt zurück

Benutzerdefinierte Felder

Body: FundraisingApi.ApiCollectionOfAppealCustomFieldRead

Benutzerdefinierte Felder des Fonds auflisten

Vorgangs-ID:: ListFundCustomFields

Listet die benutzerdefinierten Felder für einen Fonds auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Fund-ID	fund_id	True	string	Die Systemdatensatz-ID des Fonds.

Gibt zurück

Benutzerdefinierte Felder

Body: FundraisingApi.ApiCollectionOfFundCustomFieldRead

Benutzerdefinierte Felder für Geschenk auflisten

Vorgangs-ID:: ListGiftCustomFields

Listet die benutzerdefinierten Felder für ein Geschenk auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Geschenk-ID	gift_id	True	string	Die Systemdatensatz-ID des Geschenks.

Gibt zurück

Benutzerdefinierte Felder

Body: GiftApi.ApiCollectionOfGiftCustomFieldRead

Benutzerdefinierte Felder für Listenkampagnen

Vorgangs-ID:: ListCampaignCustomFields

Listet die benutzerdefinierten Felder für eine Kampagne auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Kampagnen-ID	campaign_id	True	string	Die Systemdatensatz-ID der Kampagne.

Gibt zurück

Benutzerdefinierte Felder

Body: FundraisingApi.ApiCollectionOfCampaignCustomFieldRead

Benutzerdefinierte Listenaktionsfelder

Vorgangs-ID:: ListActionCustomFields

Listet die benutzerdefinierten Felder für eine Aktion auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Aktions-ID	action_id	True	string	Die Systemdatensatz-ID der Aktion.

Gibt zurück

Benutzerdefinierte Felder

Body: ConstituentApi.ApiCollectionOfActionCustomFieldRead

Benutzerdefinierte Listenfelder

Vorgangs-ID:: ListConstituentCustomFields

Listet die benutzerdefinierten Felder für einen Bestandteil auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Benutzerdefinierte Felder

Body: ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

Bewertungen von Bestandteilen auflisten

Vorgangs-ID:: ListConstituentRatings

Gibt die Liste der Bewertungen für einen Bestandteil zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils
Inaktiv einschließen?	include_inactive		boolean	Inaktive Bewertungen einschließen?
Nur die neuesten?	most_recent_only		boolean	Nur die neuesten Bewertungen einschließen?

Gibt zurück

Bewertungen

Body: ConstituentApi.ApiCollectionOfRatingRead

Einen Aufruf anfordern

Vorgangs-ID:: GetAppeal

Gibt Informationen zu einer Beschwerde zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Berufungs-ID	appeal_id	True	string	Die Systemdatensatz-ID des abzurufenden Aufrufs.

Gibt zurück

Appeal

Body: FundraisingApi.AppealRead

Ereignis erstellen

Vorgangs-ID:: CreateEvent

Erstellt ein neues Ereignis.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Ereignisname	name	True	string	Der Name des Ereignisses.
Description	description		string	Die Beschreibung des Ereignisses.
Kategorie	name	True	string	Der Kategoriename.
Startdatum	start_date	True	date	Das Startdatum des Ereignisses (z. B. "2020-09-18").
Startzeit	start_time		string	Die Startzeit des Ereignisses (z. B. "07:30").
Enddatum	end_date		date	Das Enddatum des Ereignisses (z. B. '2020-09-18').
Endzeitpunkt	end_time		string	Die Endzeit des Ereignisses (z. B. "07:30)".
Nachschlage-ID	lookup_id		string	Die Nachschlage-ID des Ereignisses.
Kapazität	capacity		integer	Die Anzahl der Personen, die an der Veranstaltung teilnehmen können.
Ziel	goal		double	Das monetäre Ziel des Ereignisses.
Kampagnen-ID	campaign_id		string	Die Systemdatensatz-ID der Kampagne, die dem Ereignis zugeordnet ist.
Fund-ID	fund_id		string	Die Systemdatensatz-ID des Fonds, der dem Ereignis zugeordnet ist.
Inaktiv?	inactive		boolean	Ist das Ereignis aktiv?

Gibt zurück

Created-Ereignis

Body: EventApi.CreatedEvent

Ereignisse auflisten

Vorgangs-ID:: ListEvents

Gibt eine Liste von Ereignissen zurück.

Parameter

Name	Schlüssel	Typ	Beschreibung
Kategorie	category	string	Filter basierend auf der Ereigniskategorie.
Startdatum von	start_date_from	date	Filtern Sie die Ergebnisse nach Ereignissen mit Dem Anfangstermin am oder nach dem angegebenen Datum (z. B. '2020-09-18').
Startdatum bis	start_date_to	date	Filtern Sie die Ergebnisse auf Ereignisse mit dem Startdatum am oder vor dem angegebenen Datum (z. B. "2020-09-18").
Inaktiv einschließen?	include_inactive	boolean	Inaktive Ereignisse einschließen?
Limit	limit	integer	Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 10000.
Offset	offset	integer	Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.
Ereignis-ID	event_id	string	Filtern Sie die Ereignisse, die der angegebenen Systemdatensatz-ID entsprechen.
Name	name	string	Filtern Sie nach Ereignissen, die dem angegebenen Namen entsprechen.
Hinzugefügt am oder nach	date_added	date-time	Filtern Sie die Ergebnisse nach Ereignissen, die am oder nach dem angegebenen Datum erstellt wurden (z. B. '2020-09-18T04:13:56Z').
Geändert am oder nach	last_modified	date-time	Filtern Sie die Ergebnisse nach Ereignissen, die am oder nach dem angegebenen Datum geändert wurden (z. B. '2020-09-18T04:13:56Z').

Gibt zurück

Ereignisse

Body: EventApi.ApiCollectionOfEventListEntry

Ereignisteilnehmer auflisten

Vorgangs-ID:: ListEventParticipants

Listet die Teilnehmer für ein Ereignis auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Ereignis-ID	event_id	True	string	Die Systemdatensatz-ID des Ereignisses.
RSVP-Status	rsvp_status		string	Filtert Teilnehmer basierend auf dem RSVP-Status.
Einladungsstatus	invitation_status		string	Filtert Teilnehmer basierend auf dem Einladungsstatus.
Teilnahmestufe	participation_level		string	Filtern Sie Teilnehmer basierend auf der Beteiligungsstufe.
Besucht?	attended_filter		boolean	Filtern Nach Einschließen oder Ausschließen von Teilnehmern, die als teilnehmergemarkiert gekennzeichnet sind.
Gebühren?	fees_paid_filter		boolean	Filtern Sie nach dem Einschließen oder Ausschließen von Teilnehmern, die ihre Gebühren bezahlt haben.
Limit	limit		integer	Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 10000.
Offset	offset		integer	Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.
Ist ein Bestandteil?	is_constituent_filter		boolean	Filtern Sie nach dem Einschließen oder Ausschließen von Teilnehmern, die Bestandteil sind.
Hat eine berechtigte E-Mail?	email_eligible_filter		boolean	Filtern Sie nach dem Einschließen oder Ausschließen von Teilnehmern basierend darauf, ob sie über eine primäre E-Mail-Adresse verfügen, die nicht als "Keine E-Mail" gekennzeichnet ist?
Hat ein berechtigtes Telefon?	phone_call_eligible_filter		boolean	Filtern Sie nach dem Einschließen oder Ausschließen von Teilnehmern basierend darauf, ob sie über eine primäre Telefonnummer verfügen, die nicht als "Nicht anrufen" gekennzeichnet ist.
Name	name		string	Filtern Sie nach Teilnehmern, die dem angegebenen Namen entsprechen.
Hinzugefügt am oder nach	date_added		date-time	Filtern Sie die Ergebnisse nach Teilnehmern, die am oder nach dem angegebenen Datum erstellt wurden (z. B. '2020-09-18T04:13:56Z').
Geändert am oder nach	last_modified		date-time	Filtern Sie die Ergebnisse nach Teilnehmern, die am oder nach dem angegebenen Datum geändert wurden (z. B. "2020-09-18T04:13:56Z").

Gibt zurück

Teilnehmer

Body: EventApi.ApiCollectionOfParticipantListEntry

Erhalten Sie eine Chance

Vorgangs-ID:: GetOpportunity

Gibt Informationen zu einer Verkaufschance zurück. Hinweis: Dieser Endpunkt gibt die Statuseigenschaft mit einer Latenz von ca. 10 Minuten zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Verkaufschancen-ID	opportunity_id	True	string	Die Systemdatensatz-ID der Möglichkeit zum Abrufen.

Gibt zurück

Gelegenheit

Body: OpportunityApi.OpportunityRead

Erstellen einer Aktionsanlage

Vorgangs-ID:: CreateActionAttachment

Erstellt eine neue Aktionsanlage.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Aktions-ID	parent_id	True	string	Die Systemdatensatz-ID der Aktion, die der Anlage zugeordnet ist.
Typ	type	True	string	Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet.
Name	name		string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date		date-time	Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z'). Dieses Feld wird standardmäßig auf das aktuelle Datum und die aktuelle Uhrzeit festgelegt, wenn nicht angegeben.
URL	url		string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.
Dateiname	file_name		string	Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Datei-ID	file_id		string	Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-ID	thumbnail_id		string	Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen.

Gibt zurück

Erstellte Aktionsanlage

Body: ConstituentApi.CreatedActionAttachment

Erstellen einer Berufungsanlage

Vorgangs-ID:: CreateAppealAttachment

Erstellt eine neue Anziehungsanlage.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Berufungs-ID	parent_id	True	string	Die Systemdatensatz-ID des Mit der Anlage verbundenen Rechtsmittels.
Typ	type	True	string	Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet.
Name	name		string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date		date-time	Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z'). Dieses Feld wird standardmäßig auf das aktuelle Datum und die aktuelle Uhrzeit festgelegt, wenn nicht angegeben.
URL	url		string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.
Dateiname	file_name		string	Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Datei-ID	file_id		string	Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-ID	thumbnail_id		string	Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen.

Gibt zurück

Erstellter Berufungsanhang

Body: FundraisingApi.CreatedAppealAttachment

Erstellen einer Bestandteil-Onlinepräsenz

Vorgangs-ID:: CreateConstituentOnlinePresence

Erstellt eine neue Onlinepräsenz.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils, der der Onlinepräsenz zugeordnet ist.
Typ	type	True	string	Der Onlinepräsenztyp.
Link	address	True	string	Die Webadresse für die Onlinepräsenz.
Primär?	primary		boolean	Ist dies die primäre Onlinepräsenz des Wählers?
Inaktiv?	inactive		boolean	Ist diese Onlinepräsenz inaktiv?

Gibt zurück

Onlinepräsenz erstellt

Body: ConstituentApi.CreatedConstituentOnlinePresence

Erstellen einer Bestandteiladresse

Vorgangs-ID:: CreateConstituentAddress

Erstellt eine neue Konstituierende Adresse.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Mit der Adresse verknüpften Bestandteils.
Adresstyp	type	True	string	Der Adresstyp.
Country	country		string	Das Land der Adresse (kann die ID, der Name oder die Abkürzung sein).
Adresszeilen	address_lines		string	Die Adresszeilen.
Stadt	city		string	Die Stadt der Adresse (nicht in Kombination mit dem Feld "Vorort") verwenden.
Staat	state		string	Das Bundesland der Adresse.
Postleitzahl	postal_code		string	Die Postleitzahl der Adresse.
Vorort	suburb		string	Der Vorort der Adresse (nicht in Kombination mit dem Feld "Ort") verwenden.
Bezirk	county		string	Der Landkreis der Adresse.
Informationsquelle	information_source		string	Die Informationsquelle für die Adresse.
Region	region		string	Die Region für die Adresse.
KARREN	cart		string	Die Netzbetreiberroute (CART) für die Adresse.
LOS	lot		string	Die Reisezeile (LOT) für die Adresse.
DPC	dpc		string	Der Zustellungspunktcode (Delivery Point Code, DPC) für die Adresse.
Gültig ab	start		date	Das Datum, an dem der Konstituierende mit dieser Adresse begann (z. B. "2005-09-18").
Gültig bis	end		date	Das Datum, an dem sich der Bestandteil nicht mehr an dieser Adresse befindet (z. B. "2005-09-18").
Primär?	preferred		boolean	Ist dies die bevorzugte Adresse des Wählers?
Keine E-Mail senden?	do_not_mail		boolean	Kann der Bestandteil an dieser Adresse kontaktiert werden?
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.

Gibt zurück

Erstellte Konstituierende Adresse

Body: ConstituentApi.CreatedConstituentAddress

Erstellen einer Bestandteilanlage

Vorgangs-ID:: CreateConstituentAttachment

Erstellt eine neue Anlage.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	parent_id	True	string	Die Systemdatensatz-ID des Bestandteils, der der Anlage zugeordnet ist.
Typ	type	True	string	Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet.
Name	name		string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date		date-time	Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z'). Dieses Feld wird standardmäßig auf das aktuelle Datum und die aktuelle Uhrzeit festgelegt, wenn nicht angegeben.
URL	url		string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.
Dateiname	file_name		string	Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Datei-ID	file_id		string	Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-ID	thumbnail_id		string	Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen.

Gibt zurück

Anlage erstellt

Body: ConstituentApi.CreatedConstituentAttachment

Erstellen einer bestandteilen Ausbildung

Vorgangs-ID:: CreateConstituentEducation

Erstellt eine neue bestandteilische Ausbildung.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils, der der Ausbildung zugeordnet ist.
Schule	school	True	string	Der Name der Schule/Einrichtung.
Typ	type		string	Die Art der Ausbildung.
Klasse von	class_of		string	Das Jahr, in dem der Konstituierende abschloss.
Der Status	status		string	Der Status der Ausbildung.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Grad	degree		string	Der Grad, der empfangen wurde.
GPA	gpa		double	Der Notenpunktdurchschnitt.
Studienfach	subject_of_study		string	Das Studienfach.
Primär?	primary		boolean	Ist dies der Grundschulverband der Wähler?
Majore	majors		array of string	Die Hauptstudiengänge.
Minderjährige	minors		array of string	Die Nebenstudiengänge.
Campus	campus		string	Der Campus. Zeichenlimit: 50.
Soziale Organisation	social_organization		string	Die soziale Organisation. Zeichenlimit: 50.
Bekannter Name	known_name		string	Der bekannte Name. Zeichenlimit: 50.
Gradklasse	class_of_degree		string	Die Klasse des Abschlusses (gilt nur für britische Versionen).
Abteilung	department		string	Der Name der Bildungsabteilung (gilt nur für britische Versionen).
Fakultät	faculty		string	Der Name der Fakultät (gilt nur für britische Versionen).
Registrierungsnummer	registration_number		string	Die Registrierungsnummer (gilt nur für britische Versionen). Zeichenlimit: 50.

Gibt zurück

Bildung von Bestandteilen erstellt

Body: ConstituentApi.CreatedConstituentEducation

Erstellen einer bestandteilen E-Mail-Adresse

Vorgangs-ID:: CreateConstituentEmailAddress

Erstellt eine neue E-Mail-Adresse.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils, der der E-Mail-Adresse zugeordnet ist.
E-Mail-Typ	type	True	string	Der Typ der E-Mail-Adresse.
E-Mail-Adresse	address	True	string	Die E-Mail-Adresse.
Primär?	primary		boolean	Ist dies die primäre E-Mail-Adresse des Bestandteils?
Keine E-Mail senden?	do_not_email		boolean	Kann der Bestandteil an dieser E-Mail-Adresse kontaktiert werden?
Inaktiv?	inactive		boolean	Ist diese E-Mail-Adresse inaktiv?

Gibt zurück

Erstellte E-Mail-Adresse

Body: ConstituentApi.CreatedConstituentEmailAddress

Erstellen einer einzelnen Beziehung

Vorgangs-ID:: CreateIndividualRelationship

Erstellt eine neue einzelne Beziehung. Wenn die Beziehung mit einem anderen Bestandteil besteht, wird für diesen Bestandteil eine gegenseitige Beziehung erstellt.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Mit der Beziehung verknüpften Bestandteils.
Beziehungs-ID	relation_id	True	string	Die Systemdatensatz-ID der zugehörigen Person.
Typ	type		string	Der Typ der Beziehung, die die Beziehung darstellt.
Gegenseitiger Typ	reciprocal_type		string	Beschreibt die Beziehung des Bestandteils zum zugehörigen Bestandteil. Beispielsweise wäre in einer Beziehung zwischen einem männlichen Bestandteil und einem weiblichen Gleichgeordneten der gegenseitige Beziehungstyp Bruder.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Ist Ehepartner?	is_spouse		boolean	Ist die verwandte Person der Ehegatte?
Ist konstituierender Haushaltschef?	is_constituent_head_of_household		boolean	Ist der Konstituierende der Haushaltschef?
Ist ehegatte Haushaltsleiter?	is_spouse_head_of_household		boolean	Ist der Ehegatte der Kopf des Haushalts?
Hinweise	comment		string	Weitere Hinweise zur Beziehung.

Gibt zurück

Individuelle Beziehung erstellt

Body: ConstituentApi.CreatedIndividualRelationship

Erstellen einer einzelnen Komponente

Vorgangs-ID:: CreateIndividualConstituent

Erstellt einen neuen einzelnen Bestandteil.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Title	title		string	Der Haupttitel des Bestandteils.
Vorname	first		string	Der Vorname des Bestandteils. Zeichenlimit: 50.
Nachname	last	True	string	Der Nachname des Bestandteils. Zeichenlimit: 100.
Nachsilbe	suffix		string	Das primäre Suffix des Bestandteils.
Nachschlage-ID	lookup_id		string	Der benutzerdefinierte Bezeichner für den Bestandteil.
type	type	True	string	Der Adresstyp.
country	country		string	Das Land der Adresse (kann die ID, der Name oder die Abkürzung sein).
Linien	address_lines		string	Die Adresszeilen. Zeichenlimit: 150.
city	city		string	Die Stadt der Adresse (nicht in Kombination mit dem Feld "Vorort") verwenden.
Staat	state		string	Das Bundesland der Adresse.
Postleitzahl	postal_code		string	Die Postleitzahl der Adresse. Zeichenlimit: 12.
Vorort	suburb		string	Der Vorort der Adresse (nicht in Kombination mit dem Feld "Ort") verwenden.
Bezirk	county		string	Der Landkreis der Adresse.
start	start		date	Das Datum, an dem der Konstituierende mit dieser Adresse begann (z. B. "2005-09-18").
Ende	end		date	Das Datum, an dem sich der Bestandteil nicht mehr an dieser Adresse befindet (z. B. "2005-09-18").
type	type	True	string	Der Telefontyp.
number	number	True	string	Die Telefonnummer.
ist primär?	primary		boolean	Ist dies die primäre Telefonnummer des Wählers?
type	type	True	string	Der Typ der E-Mail-Adresse.
address	address	True	string	Die E-Mail-Adresse.
ist primär?	primary		boolean	Ist dies die primäre E-Mail-Adresse des Bestandteils?
type	type	True	string	Der Onlinepräsenztyp.
address	address	True	string	Die Webadresse für die Onlinepräsenz.
ist primär?	primary		boolean	Ist dies die primäre Onlinepräsenz des Wählers?
Bevorzugter Name	preferred_name		string	Der bevorzugte Name des Bestandteils. Zeichenlimit: 50.
Zweiter Vorname	middle		string	Der zweite Vorname des Bestandteils. Zeichenlimit: 50.
Ehemaliger Name	former_name		string	Der frühere Name des Wählers. Zeichenlimit: 100.
Titel 2	title_2		string	Der sekundäre Titel des Bestandteils.
Suffix 2	suffix_2		string	Das sekundäre Suffix des Bestandteils.
Geschlecht	gender		string	Das Geschlecht des Wählers.
Familienstand	marital_status		string	Der Familienstand des Wählers.
Gibt anonym?	gives_anonymously		boolean	Gibt der Bestandteil anonym?
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Geburtsort	birthplace		string	Der Geburtsort des Konstituierenden.
Ethnizität	ethnicity		string	Die Ethnischeität des Wählers.
Erlöse	income		string	Das Einkommen für den Bestandteil.
Religion	religion		string	Die Religion des Bestandteils.
Benutzerdefinierte Adresse?	custom_format		boolean	Ist der primäre Adressempfänger ein benutzerdefiniertes Format?
Adressformat	configuration_id		string	Primäre Adressempfängerkonfiguration (erforderlich, es sei denn, es wird ein benutzerdefiniertes Format verwendet).
Benutzerdefinierter Adressname	formatted_name		string	Primärer adressierter Name (erforderlich, wenn ein benutzerdefiniertes Format verwendet wird). Zeichenlimit: 255.
Benutzerdefinierte Anrede?	custom_format		boolean	Ist die primäre Anrede ein benutzerdefiniertes Format?
Anredeformat	configuration_id		string	Primäre Anredekonfiguration (erforderlich, es sei denn, es wird ein benutzerdefiniertes Format verwendet).
Benutzerdefinierter Anredename	formatted_name		string	Primäre Anrede formatierter Name (erforderlich, wenn ein benutzerdefiniertes Format verwendet wird). Zeichenlimit: 255.

Gibt zurück

Erstellt einzelne Bestandteile

Body: ConstituentApi.CreatedIndividualConstituent

Erstellen einer Ereignisteilnehmeroption

Vorgangs-ID:: CreateEventParticipantOption

Erstellt eine neue Teilnehmeroption für ein Ereignis.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Ereignis-ID	event_id	True	string	Die ID des Ereignisses.
Name	name	True	string	Der Name der Ereignisteilnehmeroption.
Eingabetyp	input_type	True	string	Die Typen von Werten, die Teilnehmer verwenden können, um Antworten bereitzustellen.
Mehrfachauswahl zulassen?	multi_select		boolean	Mehrere Werte für Listen zulassen?
name	name		string	Der Name der Listenoption.
Sequenz	sequence		integer	Die 0-basierte Sequenz, die für die Sortierung verwendet wird.

Gibt zurück

Ereignisteilnehmeroption erstellt

Body: EventApi.CreatedEventParticipantOption

Erstellen einer Fondsanlage

Vorgangs-ID:: CreateFundAttachment

Erstellt eine neue Fondsanlage.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Fund-ID	parent_id	True	string	Die Systemdatensatz-ID des Fonds, der der Anlage zugeordnet ist.
Typ	type	True	string	Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet.
Name	name		string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date		date-time	Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z'). Dieses Feld wird standardmäßig auf das aktuelle Datum und die aktuelle Uhrzeit festgelegt, wenn nicht angegeben.
URL	url		string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.
Dateiname	file_name		string	Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Datei-ID	file_id		string	Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-ID	thumbnail_id		string	Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen.

Gibt zurück

Fondsanlage erstellt

Body: FundraisingApi.CreatedFundAttachment

Erstellen einer Fundraiserzuweisung

Vorgangs-ID:: CreateFundraiserAssignment

Erstellt eine neue Fundraiserzuordnung.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Fundraiser ID	fundraiser_id	True	string	Die Systemdatensatz-ID des Fundraisers.
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID der zugewiesenen Komponente.
Typ	type		string	Die Art des Fundraisers.
Zuordnung beginnt	start		date-time	Der Anfangstermin der Zuordnung.
Zuordnung endet	end		date-time	Das Enddatum der Zuordnung.
Betrag	value	True	double	Der Zielbetrag für den Fundraiser, der vom zugewiesenen Bestandteil angefordert werden soll.
Kampagnen-ID	campaign_id		string	Die Systemdatensatz-ID der Kampagne, auf die resultierende Geschenke angewendet werden.
Fund-ID	fund_id		string	Die Systemdatensatz-ID des Fonds, auf den resultierende Geschenke angewendet werden.
Berufungs-ID	appeal_id		string	Die Systemdatensatz-ID des Aufrufs, auf den resultierende Geschenke angewendet werden.

Gibt zurück

Erstellt fundraiser assignment

Body: FundraisingApi.CreatedFundraiserAssignment

Erstellen einer Geschenkanlage

Vorgangs-ID:: CreateGiftAttachment

Erstellt eine neue Geschenkanlage.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Geschenk-ID	parent_id	True	string	Die Systemdatensatz-ID des Geschenks, das der Anlage zugeordnet ist.
Typ	type	True	string	Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet.
Name	name		string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date		date-time	Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z'). Dieses Feld wird standardmäßig auf das aktuelle Datum und die aktuelle Uhrzeit festgelegt, wenn nicht angegeben.
URL	url		string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.
Dateiname	file_name		string	Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Datei-ID	file_id		string	Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-ID	thumbnail_id		string	Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen.

Gibt zurück

Geschenkanlage erstellt

Body: GiftApi.CreatedGiftAttachment

Erstellen einer Kampagnenanlage

Vorgangs-ID:: CreateCampaignAttachment

Erstellt eine neue Kampagnenanlage.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Kampagnen-ID	parent_id	True	string	Die Systemdatensatz-ID der Kampagne, die der Anlage zugeordnet ist.
Typ	type	True	string	Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet.
Name	name		string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date		date-time	Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z'). Dieses Feld wird standardmäßig auf das aktuelle Datum und die aktuelle Uhrzeit festgelegt, wenn nicht angegeben.
URL	url		string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.
Dateiname	file_name		string	Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Datei-ID	file_id		string	Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-ID	thumbnail_id		string	Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen.

Gibt zurück

Erstellter Kampagnenanhang

Body: FundraisingApi.CreatedCampaignAttachment

Erstellen einer konstituierenden Aktion

Vorgangs-ID:: CreateAction

Erstellt eine neue konstituierende Aktion.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Mit der Aktion verknüpften Bestandteils.
Kategorie	category	True	string	Der Kanal oder die Absicht der konstituierenden Interaktion.
Abgeschlossen?	completed		boolean	Ist die Aktion abgeschlossen? Wenn das System für die Verwendung von benutzerdefinierten Aktionsstatus konfiguriert ist, basiert dieser Wert auf dem Aktionsstatuswert.
Abgeschlossen am	completed_date		date-time	Das Datum, an dem die Aktion abgeschlossen wurde (z. B. '2020-09-18T04:13:56Z').
Datum	date	True	date-time	Das Aktionsdatum (z. B. '2020-09-18T04:13:56Z').
Hinweis	description		string	Die ausführliche Erläuterung, die die Aktionszusammenfassung erläutert.
Richtung	direction		string	Die Richtung der Aktion.
Fundraiser(en)	fundraisers		array of string	Der Satz von Systemdatensatz-IDs für die Fundraiser, die mit der Aktion verbunden sind.
Standort	location		string	Die Position der Aktion.
Verkaufschancen-ID	opportunity_id		string	Die Systemdatensatz-ID der Verkaufschance, die der Aktion zugeordnet ist.
Ergebnis	outcome		string	Das Ergebnis der Aktion.
Priority	priority		string	Die Priorität der Aktion.
Startzeit	start_time		string	Die Startzeit der Aktion. Verwendet 24-Stunden-Zeit im HH:mm-Format.
Endzeitpunkt	end_time		string	Die Endzeit der Aktion. Verwendet 24-Stunden-Zeit im HH:mm-Format.
Der Status	status		string	Der Aktionsstatus.
Zusammenfassung	summary		string	Die kurze Beschreibung der Aktion, die oben im Datensatz angezeigt wird. Zeichenlimit: 255.
Typ	type		string	Zusätzliche Beschreibung der Aktion zur Ergänzung der Kategorie.

Gibt zurück

Erstellte Aktion

Body: ConstituentApi.CreatedAction

Erstellen einer Konstituierenden Bewertung

Vorgangs-ID:: CreateConstituentRating

Erstellt eine neue Bewertung.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
body	body	True	dynamic	Ein Objekt, das die zu erstellende Bewertung darstellt.

Gibt zurück

Erstellte Bewertung der Bestandteile

Body: ConstituentApi.CreatedConstituentRating

Erstellen einer Konstituierenden Notiz

Vorgangs-ID:: CreateConstituentNote

Erstellt eine neue Konstituierende Notiz.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Mit der Notiz verknüpften Bestandteils.
Typ	type	True	string	Der Notiztyp.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Zusammenfassung	summary		string	Die Notizzusammenfassung. Zeichenlimit: 50.
Hinweis	text		string	Der Notiztext.

Gibt zurück

Erstellter Bestandteilhinweis

Body: ConstituentApi.CreatedConstituentNote

Erstellen einer Liste aus einer Gruppe von Datensätzen

Vorgangs-ID:: CreateListFromIDs

Erstellt eine neue Liste, die auf die angegebene Datensatzgruppe gefiltert ist.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Name	name	True	string	Der Name der Liste. Zeichenlimit: 50.
Description	description	True	string	Die Beschreibung der Liste.
Listentyp	list_type	True	string	Bestimmt den Typ der zu erstellenden Liste.
Erlaubnisse	list_permissions	True	string	Bestimmt, ob andere Benutzer auf die Liste zugreifen können.
ID(n)	ids	True	array of string	Die eindeutigen Bezeichner für die Datensätze, die in der Liste enthalten sind (maximal 100.000 Werte).

Gibt zurück

Liste erstellt

Body: ListApi.CreatedList

Erstellen einer Organisationsbeziehung

Vorgangs-ID:: CreateOrganizationRelationship

Erstellt eine neue Organisationsbeziehung. Wenn die Beziehung mit einem anderen Bestandteil besteht, wird für diesen Bestandteil eine gegenseitige Beziehung erstellt.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Mit der Beziehung verknüpften Bestandteils.
Beziehungs-ID	relation_id	True	string	Die Systemdatensatz-ID der zugehörigen Organisation.
Typ	type		string	Der Typ der Beziehung, die die Beziehung darstellt.
Gegenseitiger Typ	reciprocal_type		string	Beschreibt die Beziehung des Bestandteils zur zugehörigen Organisation.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Ist Kontakt?	is_organization_contact		boolean	Stellt die Komponente diese Organisation als Kontakt dar?
Kontakttyp	organization_contact_type		string	Stellt Kontext für Interaktionen mit der zugehörigen Person bereit, die die Organisation als Kontakt darstellt.
Position	position		string	Die Position der Person in der Organisation. Zeichenlimit: 50.
Ist primäres Geschäft?	is_primary_business		boolean	Ist dies das Hauptgeschäft des Wählers?
Hinweise	comment		string	Weitere Hinweise zur Beziehung.

Gibt zurück

Organisationsbeziehung erstellt

Body: ConstituentApi.CreatedOrganizationRelationship

Erstellen einer Organisationskomponente

Vorgangs-ID:: CreateOrganizationConstituent

Erstellt einen neuen Organisationsbestandteil.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Name	name	True	string	Der Name der Organisation. Zeichenlimit: 100.
Nachschlage-ID	lookup_id		string	Der benutzerdefinierte Bezeichner für den Bestandteil.
type	type	True	string	Der Adresstyp.
country	country		string	Das Land der Adresse (kann die ID, der Name oder die Abkürzung sein).
Linien	address_lines		string	Die Adresszeilen. Zeichenlimit: 150.
city	city		string	Die Stadt der Adresse (nicht in Kombination mit dem Feld "Vorort") verwenden.
Staat	state		string	Das Bundesland der Adresse.
Postleitzahl	postal_code		string	Die Postleitzahl der Adresse. Zeichenlimit: 12.
Vorort	suburb		string	Der Vorort der Adresse (nicht in Kombination mit dem Feld "Ort") verwenden.
Bezirk	county		string	Der Landkreis der Adresse.
start	start		date	Das Datum, an dem der Konstituierende mit dieser Adresse begann (z. B. "2005-09-18").
Ende	end		date	Das Datum, an dem sich der Bestandteil nicht mehr an dieser Adresse befindet (z. B. "2005-09-18").
type	type	True	string	Der Telefontyp.
number	number	True	string	Die Telefonnummer.
ist primär?	primary		boolean	Ist dies die primäre Telefonnummer des Wählers?
type	type	True	string	Der Typ der E-Mail-Adresse.
address	address	True	string	Die E-Mail-Adresse.
ist primär?	primary		boolean	Ist dies die primäre E-Mail-Adresse des Bestandteils?
type	type	True	string	Der Onlinepräsenztyp.
address	address	True	string	Die Webadresse für die Onlinepräsenz.
ist primär?	primary		boolean	Ist dies die primäre Onlinepräsenz des Wählers?
Gibt anonym?	gives_anonymously		boolean	Gibt der Bestandteil anonym?
Branche	industry		string	Die Industrie des Bestandteils.
Anzahl der Mitarbeiter	num_employees		integer	Die Anzahl der Mitarbeiter in der Organisation.
Stimmt mit Geschenken überein?	matches_gifts		boolean	Stimmt die Organisation mit Geschenken überein?
Passender Geschenkfaktor	matching_gift_factor		double	Der passende Geschenkfaktor.
Min Match pro Geschenk	value		double	Der mindeste Übereinstimmungsbetrag pro Geschenk für den Bestandteil.
Maximale Übereinstimmung pro Geschenk	value		double	Der maximale Übereinstimmungsbetrag pro Geschenk für den Bestandteil.
Min Übereinstimmung pro Constit	value		double	Die mindeste Übereinstimmungssumme für den Bestandteil.
Maximale Übereinstimmung pro Constit	value		double	Die maximale Übereinstimmungssumme für den Bestandteil.
Abgleichen von Geschenknotizen	matching_gift_notes		string	Die passenden Geschenknotizen für den Bestandteil.

Gibt zurück

Erstellter Organisationsbestandteil

Body: ConstituentApi.CreatedOrganizationConstituent

Erstellen einer Teilnehmergebühr

Vorgangs-ID:: CreateParticipantFee

Erstellt eine neue Gebühr für einen Teilnehmer.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Teilnehmer-ID	participant_id	True	string	Die Systemdatensatz-ID des Teilnehmers.
Ereignis-ID	event_id	True	string	Die Systemdatensatz-ID des Ereignisses.
Gebühr	event_fee_id	True	string	Die Veranstaltungsgebühr.
Menge	quantity	True	integer	Die gekaufte Menge.
Gebührenbetrag	fee_amount	True	double	Der Betrag, der mit der Gebühr verbunden ist.
Beitragsbetrag	contribution_amount	True	double	Der Betrag der Gebühr, die eine Spende über den Kosten der Veranstaltung liegt. Dies ist der Betrag, der in der Regel auf Quittungen angezeigt wird.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.

Gibt zurück

Teilnehmergebühr erstellt

Body: EventApi.CreatedParticipantFee

Erstellen einer Teilnehmergebühr

Vorgangs-ID:: CreateParticipantFeePayment

Erstellt eine neue Gebührenzahlung für einen Teilnehmer.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Teilnehmer-ID	participant_id	True	string	Die Systemdatensatz-ID des Teilnehmers.
Geschenk-ID	gift_id	True	string	Die Systetm Datensatz-ID des Geschenks, mit dem die Teilnehmergebühr verknüpft ist.
Angewendeter Betrag	applied_amount	True	double	Der Betrag der Zahlung, die für die Teilnehmergebühren gilt.

Gibt zurück

Erstellte Teilnehmergebührzahlung

Body: EventApi.CreatedParticipantFeePayment

Erstellen einer Teilnehmeroption

Vorgangs-ID:: CreateParticipantOption

Erstellt eine neue Teilnehmeroption für einen Teilnehmer.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Teilnehmer-ID	participant_id	True	string	Die ID des Teilnehmers.
body	body	True	dynamic	Ein Objekt, das die zu erstellende Teilnehmeroption darstellt.

Gibt zurück

Option "Teilnehmer erstellt"

Body: EventApi.CreatedParticipantOption

Erstellen einer Teilnehmerspende

Vorgangs-ID:: CreateParticipantDonation

Erstellt eine neue Spende für einen Teilnehmer.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Teilnehmer-ID	participant_id	True	string	Die Systemdatensatz-ID des Teilnehmers.
Geschenk-ID	gift_id	True	string	Die Systetm Datensatz-ID des Geschenks, mit dem die Teilnehmerspende verknüpft ist.

Gibt zurück

Beteiligte Spende erstellt

Body: EventApi.CreatedParticipantDonation

Erstellen einer Veranstaltungsgebühr

Vorgangs-ID:: CreateEventFee

Erstellt eine neue Gebühr für ein Ereignis.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Ereignis-ID	event_id	True	string	Die Systemdatensatz-ID des Ereignisses.
Name	name	True	string	Der Name der Gebühr.
Gebührenbetrag	cost	True	double	Der Betrag, der mit der Gebühr verbunden ist.
Beitragsbetrag	contribution_amount	True	double	Der Betrag der Gebühr, die eine Spende über den Kosten der Veranstaltung liegt.

Gibt zurück

Erstellte Veranstaltungsgebühr

Body: EventApi.CreatedEventFee

Erstellen einer Verkaufschancenanlage

Vorgangs-ID:: CreateOpportunityAttachment

Erstellt eine neue Verkaufschancenanlage.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Verkaufschancen-ID	parent_id	True	string	Die Systemdatensatz-ID der Verkaufschance, die der Anlage zugeordnet ist.
Typ	type	True	string	Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet.
Name	name		string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date		date-time	Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z'). Dieses Feld wird standardmäßig auf das aktuelle Datum und die aktuelle Uhrzeit festgelegt, wenn nicht angegeben.
URL	url		string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.
Dateiname	file_name		string	Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Datei-ID	file_id		string	Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-ID	thumbnail_id		string	Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen.

Gibt zurück

Anlage zum Erstellen einer Verkaufschance

Body: OpportunityApi.CreatedOpportunityAttachment

Erstellen eines benutzerdefinierten Aktionsfelds

Vorgangs-ID:: CreateActionCustomField

Erstellt ein neues benutzerdefiniertes Aktionsfeld.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
body	body	True	dynamic	Ein Objekt, das das zu erstellende benutzerdefinierte Feld darstellt.

Gibt zurück

Benutzerdefiniertes Aktionsfeld erstellt

Body: ConstituentApi.CreatedActionCustomField

Erstellen eines benutzerdefinierten Berufungsfelds

Vorgangs-ID:: CreateAppealCustomField

Erstellt ein neues benutzerdefiniertes Berufungsfeld.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
body	body	True	dynamic	Ein Objekt, das das zu erstellende benutzerdefinierte Feld darstellt.

Gibt zurück

Erstelltes benutzerdefiniertes Berufungsfeld

Body: FundraisingApi.CreatedAppealCustomField

Erstellen eines benutzerdefinierten Bestandteilfelds

Vorgangs-ID:: CreateConstituentCustomField

Erstellt ein neues benutzerdefiniertes Benutzerdefiniertes Feld.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
body	body	True	dynamic	Ein Objekt, das das zu erstellende benutzerdefinierte Feld darstellt.

Gibt zurück

Erstelltes benutzerdefiniertes Feld

Body: ConstituentApi.CreatedConstituentCustomField

Erstellen eines benutzerdefinierten Fondsfelds

Vorgangs-ID:: CreateFundCustomField

Erstellt ein neues benutzerdefiniertes Fondsfeld.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
body	body	True	dynamic	Ein Objekt, das das zu erstellende benutzerdefinierte Feld darstellt.

Gibt zurück

Benutzerdefiniertes Fondsfeld erstellt

Body: FundraisingApi.CreatedFundCustomField

Erstellen eines benutzerdefinierten Geschenkfelds

Vorgangs-ID:: CreateGiftCustomField

Erstellt ein neues benutzerdefiniertes Geschenkfeld.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
body	body	True	dynamic	Ein Objekt, das das zu erstellende benutzerdefinierte Feld darstellt.

Gibt zurück

Benutzerdefiniertes Geschenkfeld erstellt

Body: GiftApi.CreatedGiftCustomField

Erstellen eines benutzerdefinierten Kampagnenfelds

Vorgangs-ID:: CreateCampaignCustomField

Erstellt ein neues benutzerdefiniertes Kampagnenfeld.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
body	body	True	dynamic	Ein Objekt, das das zu erstellende benutzerdefinierte Feld darstellt.

Gibt zurück

Benutzerdefiniertes Kampagnenfeld erstellt

Body: FundraisingApi.CreatedCampaignCustomField

Erstellen eines benutzerdefinierten Verkaufschancenfelds

Vorgangs-ID:: CreateOpportunityCustomField

Erstellt ein neues benutzerdefiniertes Verkaufschancenfeld.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
body	body	True	dynamic	Ein Objekt, das das zu erstellende benutzerdefinierte Feld darstellt.

Gibt zurück

Anlage zum Erstellen einer Verkaufschance

Body: OpportunityApi.CreatedOpportunityCustomField

Erstellen eines Bestandteil-Zustimmungsdatensatzes

Vorgangs-ID:: CreateConstituentConsent

Erstellt einen neuen zustimmungsgebenden Datensatz.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Mit dem Zustimmungsdatensatz verknüpften Bestandteils.
Kanal	channel	True	string	Der Kanal, für den die Zustimmungsantwort gilt.
Kategorie	category		string	Die Kategorie, für die die Zustimmungsantwort gilt.
Quelle	source		string	Die Quelle der Zustimmungsantwort des Bestandteils.
Antwort	constituent_consent_response	True	string	Wie der Bestandteil auf die Zustimmung für den angegebenen Kanal/die angegebene Kategorie geantwortet hat.
Datum	consent_date	True	date-time	Das Datum, an dem die Zustimmungsantwort empfangen wurde (z. B. '2020-09-18T04:13:56Z').
Zustimmungserklärung	consent_statement		string	Die Erklärung, auf die der Bestandteil geantwortet hat, wenn er seine Zustimmung erteilt.
Datenschutzbestimmungen	privacy_notice		string	Die Datenschutzhinweise, die dem Bestandteil zur Verfügung gestellt werden.

Gibt zurück

Erstellte Zustimmung zur Komponente

Body: CommPrefApi.CreatedConstituentConsent

Erstellen eines Bestandteilcodes

Vorgangs-ID:: CreateConstituentCode

Erstellt einen neuen Komponentencode.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils, der dem Bestandteilcode zugeordnet ist.
Konstituierender Code	description	True	string	Der Bestandteilcode.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Sequence	sequence		integer	Die numerische Sequenz, die dem Bestandteilcode zugeordnet ist.

Gibt zurück

Erstellter Komponentencode

Body: ConstituentApi.CreatedConstituentCode

Erstellen eines Bestandteiltelefons

Vorgangs-ID:: CreateConstituentPhone

Erstellt ein neues Bestandteiltelefon.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils, der dem Telefon zugeordnet ist.
Typ	type	True	string	Der Telefontyp.
Number	number	True	string	Die Telefonnummer.
Primär?	primary		boolean	Ist dies das primäre Telefon des Wählers?
Rufen Sie nicht an?	do_not_call		boolean	Kann der Bestandteil an dieser Nummer kontaktiert werden?
Inaktiv?	inactive		boolean	Ist diese Telefonnummer inaktiv?

Gibt zurück

Erstelltes Bestandteiltelefon

Body: ConstituentApi.CreatedConstituentPhone

Erstellen eines Dokumentspeicherorts

Vorgangs-ID:: CreateDocument

Erstellt einen neuen eindeutigen Dokumentbezeichner und uploadspeicherort für die Verwendung mit physischen Anlagen. Die Antwort enthält Anweisungen dazu, wo und wie die Dokumentinhalte hochgeladen werden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Dateiname	file_name		string	Der Dateiname des dokuments, das hochgeladen werden soll.
Miniaturansicht einschließen?	upload_thumbnail		boolean	Dokumentspeicherort für Miniaturansichten einschließen?

Gibt zurück

Dateidefinition

Body: ConstituentApi.FileDefinition

Erstellen eines Geschenkbatches

Vorgangs-ID:: CreateGiftBatch

Erstellt einen neuen Geschenkbatch.

Parameter

Name	Schlüssel	Typ	Beschreibung
Description	batch_description	string	Die Beschreibung des Batches.
Erwartete Zahl	expected_number	integer	Die Anzahl der geschenke, die in der Batchmenge erwartet werden.
Erwartete Gesamtsumme	expected_batch_total	double	Der Gesamtwert der Geschenke in der Charge.
Batchnummer	batch_number	string	Der eindeutige Bezeichner, der für den Batch spezifisch ist.

Gibt zurück

Erstellter Geschenkbatch

Body: GiftBatchApi.CreatedBatch

Erstellen eines Geschenks

Vorgangs-ID:: CreateGift

Erstellt ein neues Geschenk.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils, der dem Geschenk zugeordnet ist.
Betrag	value	True	double	Der Geldbetrag des Geschenks.
Datum	date	True	date	Das Geschenkdatum (z. B. '2020-09-18').
Typ	type	True	string	Der Geschenktyp.
Kampagnen-ID	campaign_id		string	Die Systemdatensatz-ID der Kampagne, die mit der Teilung des Geschenks verknüpft ist.
Fonds-ID	fund_id	True	string	Die Systemdatensatz-ID des Fonds, der mit der Geschenkteilung verknüpft ist.
Berufungs-ID	appeal_id		string	Die Systemdatensatz-ID des Aufrufs, der dem Geschenkteil zugeordnet ist.
Paket-ID	package_id		string	Die Systemdatensatz-ID des Pakets, das dem Geschenkteil zugeordnet ist.
Menge	value	True	double	Der Geldbetrag des Geschenks aufgeteilt.
Zahlungsmethode	payment_method	True	string	Die Zahlungsmethode.
Nummer überprüfen	check_number		string	Die Prüfnummer (gilt nur, wenn die Zahlungsmethode "PersonalCheck" lautet).
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Reference	reference		string	Der Zahlungsverweis (gilt nur, wenn die Zahlungsmethode "Sonstige" lautet).
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Ist anonym?	is_anonymous		boolean	Ist das Geschenk anonym? Wenn kein Wert angegeben wird, wird die Standardmäßige Anonymität des Spenders verwendet.
Subtyp	subtype		string	Der Untertyp des Geschenks.
Kommentar	reference		string	Hinweise zum Nachverfolgen spezieller Details zu einem Geschenk wie der Motivation dahinter oder einer detaillierten Beschreibung eines Geschenks.
Nachschlage-ID	lookup_id		string	Der benutzerdefinierte Bezeichner für das Geschenk.
Verwenden Sie Fundraiser-Gutschriften?	default_fundraiser_credits		boolean	Verwenden Sie das Standardmäßige Fundraiserguthaben?
Verwenden Sie Soft Credits?	default_soft_credits		boolean	Verwenden Sie die standardmäßigen Soft Credits?
Wahlkreis	constituency		string	Der Wahlkreis des Geschenks.
Batchpräfix	batch_prefix		string	Das Präfix, das für Batchgeschenke verwendet werden soll. Dies muss mindestens einen Buchstaben enthalten und ist erforderlich, wenn "Batchnummer" einen Wert aufweist.
Batchnummer	batch_number		string	Die Batchnummer. Zeichenlimit: 50 (einschließlich des Batchpräfixes).
Beitragsstatus	post_status		string	Der Beitragsstatus des Geschenks.
Postdatum	post_date		date	Das Datum, an dem das Geschenk gepostet wurde (z. B. '2020-09-18').
Bestätigungsstatus	status	True	string	Der Belegstatus des Geschenks.
Belegsbetrag	value	True	double	Der Geldbetrag des Belegs für das Geschenk.
Wareneingangsdatum	date		date	Das Datum, an dem das Geschenk erhalten wurde (z. B. "2020-09-18").

Gibt zurück

Geschenk erstellt

Body: GiftApi.CreatedGift

Erstellen eines konstituierenden Solicit-Codes

Vorgangs-ID:: CreateConstituentSolicitCode

Erstellt einen neuen Konstituierenden Solicit-Code.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils, der dem Solicit-Code zugeordnet ist.
Anfordern von Code	solicit_code	True	string	Kommunikationsanweisungen und/oder Einschränkungen für einen Bestandteil.
Startdatum	start_date		date	Das Startdatum des Anmeldecodes (z. B. "2005-09-18").
Enddatum	end_date		date	Das Enddatum des Anmeldecodes (z. B. "2005-09-18").

Gibt zurück

Erstellter Einholungscode

Body: CommPrefApi.CreatedConstituentSolicitCode

Erstellen eines Teilalias

Vorgangs-ID:: CreateConstituentAlias

Erstellt einen neuen Bestandteilalias.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Mit dem Alias verknüpften Bestandteils.
Alias	name	True	string	Der Name, der als Alias des Bestandteils verwendet werden soll. Zeichenlimit: 100.
Typ	type		string	Der Aliastyp.

Gibt zurück

Erstellter Bestandteilalias

Body: ConstituentApi.CreatedConstituentAlias

Erstellen eines Teilnehmers

Vorgangs-ID:: CreateParticipant

Erstellt einen neuen Teilnehmer für ein Ereignis.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Ereignis-ID	event_id	True	string	Die Systemdatensatz-ID des Ereignisses.
Bestandteil-ID	constituent_id	True	string	Die Konstituierende ID des Teilnehmers.
Host-ID	host_id		string	Die ID des Teilnehmerdatensatzes des Hosts.
RSVP-Status	rsvp_status		string	Der Status des Engagements des Teilnehmers mit dem Ereignis.
Besucht?	attended		boolean	Hat der Teilnehmer an der Veranstaltung teilgenommen?
Einladungsstatus	invitation_status		string	Der Status der Einladung an den Teilnehmer.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Teilnahmestufe	name	True	string	Der Name der Teilnahmestufe.

Gibt zurück

Erstellter Teilnehmer

Body: EventApi.CreatedParticipant

Erstes Geschenk erhalten

Vorgangs-ID:: GetConstituentFirstGift

Gibt das erste Geschenk für einen Bestandteil zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Zusammenfassung

Body: ConstituentApi.GivingSummaryRead

Geschenk erhalten

Vorgangs-ID:: GetGift

Gibt Informationen zu einem Geschenk zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Geschenk-ID	gift_id	True	string	Die Systemdatensatz-ID des zu erhaltenden Geschenks.

Gibt zurück

Geschenk

Body: GiftApi.GiftRead

Geschenke auflisten

Vorgangs-ID:: ListGifts

Gibt eine Liste von Geschenken zurück.

Parameter

Name	Schlüssel	Typ	Beschreibung
List	list_id	string	Definiert einen Listenbezeichner, mit dem die Gruppe von Geschenken auf die in der angegebenen Liste enthaltenen Geschenke gefiltert wird. Wenn dieser Wert festgelegt ist, werden andere angegebene Filter ignoriert.
Typ	gift_type	string	Stellt eine durch Trennzeichen getrennte Liste von Geschenktypen dar, um die Ergebnisse zu filtern. Beispielsweise gibt "MatchingGiftPledge", RecurringGift" nur Geschenke vom Typ MatchingGiftPledge oder RecurringGift zurück.
Bestandteil-ID	constituent_id	string	Stellt eine durch Trennzeichen getrennte Liste von Komponentenbezeichnern dar, um die Ergebnisse zu filtern. Beispielsweise gibt "280.1232" nur Geschenke aus den Bestandteilen 280 oder Bestandteil 1232 zurück.
Kampagnen-ID	campaign_id	string	Stellt eine durch Trennzeichen getrennte Liste von Kampagnenbezeichnern dar, um die Ergebnisse zu filtern. Beispielsweise gibt "506.918" nur Geschenke für kampagne 506 oder Kampagne 918 zurück.
Fund-ID	fund_id	string	Stellt eine durch Trennzeichen getrennte Liste der Fondsbezeichner dar, um die Ergebnisse zu filtern. Beispielsweise gibt "506.918" nur Geschenke zurück, um 506 oder Fonds 918 zu finanzieren.
Berufungs-ID	appeal_id	string	Stellt eine durch Trennzeichen getrennte Liste von Berufungsbezeichnern dar, um die Ergebnisse zu filtern. Beispielsweise gibt "506.918" nur Geschenke zurück, um 506 oder Rechtsmittel 918 anzulegen.
Limit	limit	integer	Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 5000.
Offset	offset	integer	Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.
Startgeschenkdatum	start_gift_date	date-time	Stellt einen Filter für Geschenke mit einem Geschenkdatum am oder nach dem angegebenen Datum dar (z. B. '2020-09-18T04:13:56Z').
Endgeschenkdatum	end_gift_date	date-time	Stellt einen Filter für Geschenke mit einem Geschenkdatum am oder vor dem angegebenen Datum dar (z. B. '2020-09-18T04:13:56Z').
Geschenkbetrag starten	start_gift_amount	double	Stellt einen Filter für Geschenke dar, deren Betrag größer oder gleich dem angegebenen Betrag ist.
Geschenkbetrag beenden	end_gift_amount	double	Stellt einen Filter für Geschenke dar, deren Betrag kleiner oder gleich dem angegebenen Betrag ist.
Beitragsstatus	post_status	string	Stellt eine durch Trennzeichen getrennte Liste von Geschenkbeitragsstatus dar, um die Ergebnisse zu filtern. Beispielsweise gibt "DoNotPost", "Posted" nur Geschenke zurück, die als DoNotPost oder Posted gekennzeichnet sind.
Bestätigungsstatus	receipt_status	string	Stellt eine durch Trennzeichen getrennte Liste der Status des Geschenkbelegs dar, um die Ergebnisse zu filtern. Beispielsweise gibt "DoNotReceipt", "Receipted" nur Geschenke zurück, die als "DoNotReceipt" oder "Receipted" gekennzeichnet sind.
Bestätigungsstatus	acknowledgement_status	string	Stellt eine durch Trennzeichen getrennte Liste der Status der Geschenkbestätigung dar, um die Ergebnisse zu filtern. Beispielsweise gibt "DoNotAcknowledge" nur Geschenke zurück, die als "DoNotAcknowledge" oder "Bestätigt" gekennzeichnet sind.
Hinzugefügt am oder nach	date_added	date-time	Filtern Sie die Ergebnisse auf Geschenke, die am oder nach dem angegebenen Datum erstellt wurden (z. B. "2020-09-18T04:13:56Z").
Geändert am oder nach	last_modified	date-time	Filtern Sie die Ergebnisse nach Geschenken, die am oder nach dem angegebenen Datum geändert wurden (z. B. '2020-09-18T04:13:56Z').

Gibt zurück

Geschenke

Body: GiftApi.ApiCollectionOfGiftRead

Geschenkgutschriften auflisten

Vorgangs-ID:: ListGiftAttachments

Listet die Anlagen für ein Geschenk auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Geschenk-ID	gift_id	True	string	Die Systemdatensatz-ID des Geschenks.

Gibt zurück

Attachments

Body: GiftApi.ApiCollectionOfGiftAttachmentRead

Hinzufügen eines Geschenks zum Batch

Vorgangs-ID:: AddGiftToBatch

Fügen Sie dem angegebenen Geschenkbatch ein Geschenk hinzu.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Batch	batch_id	True	string	Der Stapel, dem das Geschenk hinzugefügt wird.
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils, der dem Geschenk zugeordnet ist.
Betrag	value	True	double	Der Geldbetrag des Geschenks.
Datum	date	True	date	Das Geschenkdatum (z. B. '2020-09-18').
Typ	type	True	string	Der Geschenktyp.
Kampagnen-ID	campaign_id		string	Die Systemdatensatz-ID der Kampagne, die mit der Teilung des Geschenks verknüpft ist.
Fonds-ID	fund_id	True	string	Die Systemdatensatz-ID des Fonds, der mit der Geschenkteilung verknüpft ist.
Berufungs-ID	appeal_id		string	Die Systemdatensatz-ID des Aufrufs, der dem Geschenkteil zugeordnet ist.
Paket-ID	package_id		string	Die Systemdatensatz-ID des Pakets, das dem Geschenkteil zugeordnet ist.
Menge	value	True	double	Der Geldbetrag des Geschenks aufgeteilt.
Zahlungsmethode	payment_method	True	string	Die Zahlungsmethode.
Nummer überprüfen	check_number		string	Die Prüfnummer (gilt nur, wenn die Zahlungsmethode "PersonalCheck" lautet).
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Reference	reference		string	Der Zahlungsverweis (gilt nur, wenn die Zahlungsmethode "Sonstige" lautet).
Tag	d		integer	Der Tag im Fuzzydatum.
Monat	m		integer	Der Monat im Fuzzydatum.
Jahr	y		integer	Das Jahr im Fuzzydatum.
Ist anonym?	is_anonymous		boolean	Ist das Geschenk anonym? Wenn kein Wert angegeben wird, wird die Standardmäßige Anonymität des Spenders verwendet.
Subtyp	subtype		string	Der Untertyp des Geschenks.
Kommentar	reference		string	Hinweise zum Nachverfolgen spezieller Details zu einem Geschenk wie der Motivation dahinter oder einer detaillierten Beschreibung eines Geschenks.
Nachschlage-ID	lookup_id		string	Der benutzerdefinierte Bezeichner für das Geschenk.
Verwenden Sie Fundraiser-Gutschriften?	default_fundraiser_credits		boolean	Verwenden Sie das Standardmäßige Fundraiserguthaben?
Verwenden Sie Soft Credits?	default_soft_credits		boolean	Verwenden Sie die standardmäßigen Soft Credits?
Wahlkreis	constituency		string	Der Wahlkreis des Geschenks.
Beitragsstatus	post_status		string	Der Beitragsstatus des Geschenks.
Postdatum	post_date		date	Das Datum, an dem das Geschenk gepostet wurde (z. B. '2020-09-18').
Bestätigungsstatus	status	True	string	Der Belegstatus des Geschenks.
Belegsbetrag	value	True	double	Der Geldbetrag des Belegs für das Geschenk.
Wareneingangsdatum	date		date	Das Datum, an dem das Geschenk erhalten wurde (z. B. "2020-09-18").

Gibt zurück

Enthält eine Sammlung von Batch-Geschenkfehlerdatensätzen und die Batchgeschenke, die der Vorgang hinzugefügt hat.

Ergebnisse: GiftApi.BatchGiftAddResults

Hinzufügen von Datensätzen zu einer Liste

Vorgangs-ID:: AppendIDsToList

Fügen Sie einer vorhandenen Liste eine Gruppe von Datensätzen hinzu.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Listentyp	list_type	True	string	Der Listentyp.
List	list_id	True	string	Die Systemdatensatz-ID der Liste.
ID(n)	ids	True	array of string	Die eindeutigen Bezeichner für die Datensätze, die der Liste hinzugefügt werden sollen (maximal 100.000 Werte).

Holen Sie sich das beste Geschenk

Vorgangs-ID:: GetConstituentGreatestGift

Gibt das größte Geschenk für einen Bestandteil zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Zusammenfassung

Body: ConstituentApi.GivingSummaryRead

Holen Sie sich das neueste Geschenk

Vorgangs-ID:: GetConstituentLatestGift

Gibt das neueste Geschenk für einen Bestandteil zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Zusammenfassung

Body: ConstituentApi.GivingSummaryRead

Kampagnen auflisten

Vorgangs-ID:: ListCampaigns

Gibt eine Liste von Kampagnen zurück.

Parameter

Name	Schlüssel	Typ	Beschreibung
Limit	limit	integer	Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 5000.
Offset	offset	integer	Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.
Inaktiv einschließen?	include_inactive	boolean	Inaktive Kampagnen einschließen?
Hinzugefügt am oder nach	date_added	date-time	Filtern Sie die Ergebnisse nach Kampagnen, die am oder nach dem angegebenen Datum erstellt wurden (z. B. '2020-09-18T04:13:56Z').
Geändert am oder nach	last_modified	date-time	Filtern Sie die Ergebnisse nach Kampagnen, die am oder nach dem angegebenen Datum geändert wurden (z. B. '2020-09-18T04:13:56Z').

Gibt zurück

Feldzüge

Body: FundraisingApi.ApiCollectionOfCampaignRead

Listen von Kampagnenanlagen

Vorgangs-ID:: ListCampaignAttachments

Listet die Anlagen für eine Kampagne auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Kampagnen-ID	campaign_id	True	string	Die Systemdatensatz-ID der Kampagne.

Gibt zurück

Attachments

Body: FundraisingApi.ApiCollectionOfCampaignAttachmentRead

Listenaktionen

Vorgangs-ID:: ListActions

Gibt eine Liste von Aktionen zurück.

Parameter

Name	Schlüssel	Typ	Beschreibung
List	list_id	string	Definiert einen Listenbezeichner, der zum Filtern der Gruppe von Aktionen verwendet wird, die in der angegebenen Liste enthalten sind. Wenn dieser Wert festgelegt ist, werden andere angegebene Filter ignoriert.
Berechneter Status	computed_status	string	Stellt einen Filter für Ergebnisse basierend auf dem berechneten Aktionsstatus dar. Verfügbare Werte sind "Open", "Completed" oder "PastDue".
Der Status	status_code	string	Stellt einen Aktionsstatuscode zum Filtern der Ergebnisse dar (gilt nur, wenn das System für die Verwendung von Aktionsstatuscodes konfiguriert ist). Beispielsweise gibt "Ausstehend" Aktionen mit dem Status "Ausstehend" zurück.
Limit	limit	integer	Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 5000.
Offset	offset	integer	Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.
Hinzugefügt am oder nach	date_added	date-time	Filtern Sie die Ergebnisse nach Aktionen, die an oder nach dem angegebenen Datum erstellt wurden (z. B. "2020-09-18T04:13:56Z").
Geändert am oder nach	last_modified	date-time	Filtern Sie die Ergebnisse nach Aktionen, die am oder nach dem angegebenen Datum geändert wurden (z. B. '2020-09-18T04:13:56Z').

Gibt zurück

Aktionen

Body: ConstituentApi.ApiCollectionOfActionRead

Listenaktionsanlagen

Vorgangs-ID:: ListActionAttachments

Listet die Anlagen für eine Aktion auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Aktions-ID	action_id	True	string	Die Systemdatensatz-ID der Aktion.

Gibt zurück

Attachments

Body: ConstituentApi.ApiCollectionOfActionAttachmentRead

Listenkomponenten

Vorgangs-ID:: ListConstituents

Gibt eine Liste von Bestandteilen zurück.

Parameter

Name	Schlüssel	Typ	Beschreibung
List	list_id	string	Definiert einen Listenbezeichner, der zum Filtern der In der angegebenen Liste enthaltenen Komponenten verwendet wird. Wenn dieser Wert festgelegt ist, werden andere angegebene Filter ignoriert.
Limit	limit	integer	Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 5000.
Offset	offset	integer	Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.
Konstituierender Code	constituent_code	string	Stellt einen Bestandteilcode zum Filtern der Liste dar. Beispielsweise gibt "Board Member" nur Bestandteile mit einem Gremiumsmitgliedscode zurück.
Bestandteil-ID	constituent_id	string	Stellt eine durch Trennzeichen getrennte Liste von Komponentenbezeichnern dar, um die Ergebnisse zu filtern. Beispielsweise gibt "280.1232" nur den Bestandteil 280 oder den Bestandteil 1232 zurück.
Benutzerdefinierte Feldkategorie	custom_field_category	string	Stellt eine benutzerdefinierte Feldkategorie zum Filtern der Ergebnisse dar. Beispielsweise gibt "Anniversary" nur Bestandteile mit einem aktiven benutzerdefinierten Anniversary-Feld zurück.
Fundraiser-Status	fundraiser_status	string	Stellt eine durch Trennzeichen getrennte Liste der Fundraiserstatus dar, um die Ergebnisse zu filtern. Beispielsweise gibt "Aktiv", Keine" nur Bestandteile zurück, deren Fundraiserstatus "Aktiv" oder "Keine" ist. Gültige Werte für diesen Filter sind "Aktiv", "Inaktiv" und "None".
Schließe Verstorbene ein?	include_deceased	boolean	Schließen Sie verstorbene Bestandteile in die Antwort ein?
Inaktiv einschließen?	include_inactive	boolean	Inaktive Bestandteile in die Antwort einschließen?
Postleitzahl	postal_code	string	Stellt eine durch Trennzeichen getrennte Liste der Postleitzahlen dar, um die Ergebnisse zu filtern. Beispielsweise gibt "29466.29492" nur Bestandteile zurück, deren bevorzugte Adresse eine Postleitzahl aufweist, die mit 29466 oder 29492 beginnt, z. B. 29466, 29492 oder 29492-0727.
Hinzugefügt am oder nach	date_added	date-time	Filtern Sie die Ergebnisse nach Komponenten, die am oder nach dem angegebenen Datum erstellt wurden (z. B. '2020-09-18T04:13:56Z').
Geändert am oder nach	last_modified	date-time	Filtern Sie die Ergebnisse nach komponenten, die am oder nach dem angegebenen Datum geändert wurden (z. B. '2020-09-18T04:13:56Z').
Sortiert nach	sort	string	Stellt eine Liste von Feldern dar, nach denen die Ergebnisse sortiert werden sollen. Die Ergebnisse sind standardmäßig in aufsteigender Reihenfolge und ein "-"-Zeichen zeigt absteigende Reihenfolge an. Beispielsweise sortiert "date_added,-last" Bestandteile nach dem Feld "date_added" in aufsteigender Reihenfolge und dann nach dem Feld "zuletzt" in absteigender Reihenfolge.

Gibt zurück

Bestandteile

Body: ConstituentApi.ApiCollectionOfConstituentRead

Listenkomponentencodes

Vorgangs-ID:: ListConstituentCodes

Listet die Komponentencodes für einen Bestandteil auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Komponentencodes

Body: ConstituentApi.ApiCollectionOfConstituentCodeRead

Löschen eines Bestandteilcodes

Vorgangs-ID:: DeleteConstituentCode

Löscht einen Bestandteilcode.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Komponentencode-ID	constituent_code_id	True	string	Die Systemdatensatz-ID des zu löschenden Komponentencodes.

Onlinepräsenzen auflisten

Vorgangs-ID:: ListConstituentOnlinePresences

Listet die Onlinepräsenzen für einen Bestandteil auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils.
Inaktiv einschließen?	include_inactive		boolean	Inaktive Onlinepräsenzen einschließen?

Gibt zurück

Onlinepräsenzen

Body: ConstituentApi.ApiCollectionOfOnlinePresenceRead

Optionen für Ereignisteilnehmer auflisten

Vorgangs-ID:: ListEventParticipantOptions

Listet die Teilnehmeroptionen für ein Ereignis auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Ereignis-ID	event_id	True	string	Die ID des Ereignisses.

Gibt zurück

Optionen für Ereignisteilnehmer

Body: EventApi.ApiCollectionOfEventParticipantOption

Suchen nach einem Bestandteil

Vorgangs-ID:: SearchConstituent

Führt eine konstituierende Suche basierend auf dem bereitgestellten Suchtext aus. Unterstützt Vorname, Nachname, bevorzugter Name, früherer Name, Alias, E-Mail-Adresse, Telefonnummer, Adresse oder Nachschlage-ID. Namenskombinationen wie Vorname und Nachname oder bevorzugter Name und Nachname sind gültig, andernfalls unterstützt die Suche nur jeweils einen Parameter. Standardmäßig enthalten Suchvorgänge Ergebnisse, die ihren Kriterien ähneln. Suchvorgänge nach "Smith" enthalten z. B. Übereinstimmungen für "Smyth" und andere alternative Schreibweisen. Diese Suche unterstützt keine Wildcardzeichen wie * oder ?. Suchergebnisse sind auf 500 Datensätze beschränkt.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Suchtext	search_text	True	string	Der Suchtext. Unterstützt Vorname, Nachname, bevorzugter Name, früherer Name, Alias, E-Mail-Adresse, Telefonnummer, Adresse oder Nachschlage-ID. Namenskombinationen wie Vorname und Nachname oder bevorzugter Name und Nachname sind gültig, andernfalls unterstützt die Suche nur jeweils einen Parameter. Standardmäßig enthalten Suchvorgänge Ergebnisse, die ihren Kriterien ähneln. Suchvorgänge nach "Smith" enthalten z. B. Übereinstimmungen für "Smyth" und andere alternative Schreibweisen. Diese Suche unterstützt keine Wildcardzeichen wie * oder ?. Suchergebnisse sind auf 500 Datensätze beschränkt.
Fundraiser statuses	fundraiser_status		string	Stellt eine durch Trennzeichen getrennte Liste der Fundraiserstatus dar, um die Ergebnisse zu filtern. Beispielsweise gibt "Aktiv", Keine" nur Bestandteile zurück, deren Fundraiserstatus "Aktiv" oder "Keine" ist. Gültige Werte für diesen Filter sind "Aktiv", "Inaktiv" und "None".
Inaktiv einschließen?	include_inactive		boolean	Inaktive Bestandteile in die Antwort einschließen?
Suchfeld	search_field		string	Represents a field to search on. Derzeit unterstützt es nur lookup_id. Wenn sie mit search_text bereitgestellt wird, wird ein Bestandteil mit lookup_id zurückgegeben, der dem search_text entspricht.
Strenge Suche verwenden?	strict_search		boolean	Bestandteile ausschließen, deren Namen wie der Suchtext klingen, aber anders geschrieben sind?
Limit	limit		integer	Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 5000.
Offset	offset		integer	Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.

Gibt zurück

Suchergebnisse

Body: ConstituentApi.ApiCollectionOfSearchResultRead

Teilnehmergebühren auflisten

Vorgangs-ID:: ListParticipantFees

Listet die Gebühren für einen Teilnehmer auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Teilnehmer-ID	participant_id	True	string	Die Systemdatensatz-ID des Teilnehmers.
Limit	limit		integer	Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 10000.
Offset	offset		integer	Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung. Der Standardwert ist 0.

Gibt zurück

Fees

Body: EventApi.ApiCollectionOfParticipantFee

Teilnehmergebührzahlungen auflisten

Vorgangs-ID:: ListParticipantFeePayments

Listet die Gebührenzahlungen für einen Teilnehmer auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Teilnehmer-ID	participant_id	True	string	Die Systemdatensatz-ID des Teilnehmers.
Limit	limit		integer	Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 10000.
Offset	offset		integer	Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung. Der Standardwert ist 0.

Gibt zurück

Gebührenzahlungen

Body: EventApi.ApiCollectionOfParticipantFeePayment

Teilnehmeroptionen auflisten

Vorgangs-ID:: ListParticipantOptions

Listet die Teilnehmeroptionen für einen Teilnehmer auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Teilnehmer-ID	participant_id	True	string	Die Systemdatensatz-ID des Teilnehmers.

Gibt zurück

Teilnehmeroptionen

Body: EventApi.ApiCollectionOfParticipantOption

Teilnehmerspenden auflisten

Vorgangs-ID:: ListParticipantDonations

Listet die Spenden für einen Teilnehmer auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Teilnehmer-ID	participant_id	True	string	Die Systemdatensatz-ID des Teilnehmers.
Limit	limit		integer	Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 10000.
Offset	offset		integer	Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung. Der Standardwert ist 0.

Gibt zurück

Spenden

Body: EventApi.ApiCollectionOfParticipantDonation

Verkaufschance erstellen

Vorgangs-ID:: CreateOpportunity

Erstellt eine neue Chance.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bestandteil-ID	constituent_id	True	string	Die Systemdatensatz-ID des Bestandteils, der der Verkaufschance zugeordnet ist.
Zweck	purpose	True	string	Die beabsichtigte Verwendung für jedes Geld, das infolge der Verkaufschance erhoben wurde.
Name	name	True	string	Der Name, der die Verkaufschance im gesamten Programm identifiziert, z. B. in Listen oder in Bestandteilen. Zeichenlimit: 255.
Der Status	status		string	Der Status, der angibt, wo sich die Verkaufschance im Solicitation-Prozess befindet.
Deadline	deadline		date-time	Das Zieldatum für die Gelegenheit, ein Geschenk zu erzielen (z. B. '2020-09-18T04:13:56Z').
Fragedatum	ask_date		date-time	Das Datum der Aufforderung (z. B. "2020-09-18T04:13:56Z").
value	value		double	Der Geldwert.
Erwartetes Datum	expected_date		date-time	Das Datum, an dem die Aussicht als Reaktion auf die Verkaufschance erwartet wird (z. B. '2020-09-18T04:13:56Z').
value	value		double	Der Geldwert.
Finanzierter Termin	funded_date		date-time	Das Datum, an dem die Aussicht als Reaktion auf die Chance gegeben hat (z. B. "2020-09-18T04:13:56Z").
value	value		double	Der Geldwert.
Kampagnen-ID	campaign_id		string	Die Systemdatensatz-ID der Kampagne, die der Verkaufschance zugeordnet ist. Die Kampagne legt die Gesamtziele für die Geldbeschaffung fest.
Fund-ID	fund_id		string	Die Systemdatensatz-ID des Fonds, der der Verkaufschance zugeordnet ist. Der Fonds bestimmt den spezifischen finanziellen Zweck eines Geschenks und identifiziert das Finanzkonto für dieses Geschenk.
Bestandteil-ID	constituent_id		string	Die Systemdatensatz-ID des Bestandteils, der dem Fundraiser zugeordnet ist.
value	value		double	Der Geldwert.
Inaktiv?	inactive		boolean	Ist die Chance inaktiv?

Gibt zurück

Erstellte Verkaufschance

Body: OpportunityApi.CreatedOpportunity

Verkaufschancen auflisten

Vorgangs-ID:: ListOpportunities

Gibt eine Liste der Verkaufschancen zurück.

Parameter

Name	Schlüssel	Typ	Beschreibung
List	list_id	string	Definiert einen Listenbezeichner, der zum Filtern der In der angegebenen Liste enthaltenen Verkaufschancen verwendet wird. Wenn dieser Wert festgelegt ist, werden andere angegebene Filter ignoriert.
Bestandteil-ID	constituent_id	string	Stellt eine durch Trennzeichen getrennte Liste von Komponentenbezeichnern dar, um die Ergebnisse zu filtern. Beispielsweise gibt "280.1232" nur Verkaufschancen aus der Komponente 280 oder dem Bestandteil 1232 zurück.
Limit	limit	integer	Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 5000.
Offset	offset	integer	Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.
Inaktiv einschließen?	include_inactive	boolean	Inaktive Verkaufschancen einschließen?
Hinzugefügt am oder nach	date_added	date-time	Filtern Sie die Ergebnisse nach Verkaufschancen, die am oder nach dem angegebenen Datum erstellt wurden (z. B. '2020-09-18T04:13:56Z').
Geändert am oder nach	last_modified	date-time	Filtern Sie die Ergebnisse nach Verkaufschancen, die am oder nach dem angegebenen Datum geändert wurden (z. B. '2020-09-18T04:13:56Z').

Gibt zurück

Gelegenheiten

Body: OpportunityApi.ApiCollectionOfOpportunityRead

Definitionen

CommPrefApi.ConstituentConsentRead

Stellt eine Zustimmungsentität für einen Bestandteil dar.

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des Zustimmungsdatensatzes.
Kanal	channel	string	Der Kanal, für den die Zustimmungsantwort gilt.
Kategorie	category	string	Die Kategorie, für die die Zustimmungsantwort gilt.
Quelle	source	string	Die Quelle der Zustimmungsantwort des Bestandteils.
Antwort	constituent_consent_response	string	Wie der Bestandteil auf die Zustimmung für den angegebenen Kanal/die angegebene Kategorie geantwortet hat.
Datum	consent_date	date-time	Das Datum, an dem die Zustimmungsantwort empfangen wurde.
Zustimmungserklärung	consent_statement	string	Die Erklärung, auf die der Bestandteil geantwortet hat, wenn er seine Zustimmung erteilt.
Datenschutzbestimmungen	privacy_notice	string	Die Datenschutzhinweise, die dem Bestandteil zur Verfügung gestellt werden.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem die Zustimmungsantwort hinzugefügt wurde.
Hinzugefügt von	user_name	string	Der Benutzer, der die Zustimmungsantwort hinzugefügt hat.

CommPrefApi.ConstituentConsentReadCollection

Zustimmungsdatensätze

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Zustimmungsdatensätze in der Liste.
value	value	array of CommPrefApi.ConstituentConsentRead	Der Satz von Zustimmungsdatensätzen, die in der Antwort enthalten sind.

CommPrefApi.ConstituentSolicitCodeRead

Anfordern von Code

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des konstituierenden Solicit-Codes.
Anfordern von Code	solicit_code	string	Kommunikationsanweisungen und/oder Einschränkungen für einen Bestandteil.
Startdatum	start_date	date	Das Startdatum des Anmeldecodes (z. B. "2005-09-18").
Enddatum	end_date	date	Das Enddatum des Anmeldecodes (z. B. "2005-09-18").

CommPrefApi.ConstituentSolicitCodeReadCollection

Anwaltscodes

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der in der Liste aufgeführten Konstituierenden Solicit Codes.
value	value	array of CommPrefApi.ConstituentSolicitCodeRead	Die Gruppe der in der Antwort enthaltenen Konstituierenden Solicit-Codes.

CommPrefApi.CreatedConstituentConsent

Erstellte Zustimmung zur Komponente

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID des neu erstellten Zustimmungsdatensatzes.

CommPrefApi.CreatedConstituentSolicitCode

Erstellter Einholungscode

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID des neu erstellten Konstituierenden Solicit-Codes.

ConstituentApi.ActionAttachmentRead

Attachment

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Anlage.
Aktions-ID	parent_id	string	Die Systemdatensatz-ID der Aktion, die der Anlage zugeordnet ist.
Typ	type	string	Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet.
Name	name	string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date	date-time	Das Datum der Anlage.
URL	url	string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.
Dateiname	file_name	string	Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Datei-ID	file_id	string	Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-ID	thumbnail_id	string	Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-URL	thumbnail_url	string	Die URL für eine Miniaturansicht. Nur für physische Anlagen, die Bilder sind. Enthält eine zeitgebundene Signatur, die den Zugriff auf 60 Minuten beschränkt.
Inhaltstyp	content_type	string	Der Inhaltstyp. Nur für physische Anlagen.
Dateigröße	file_size	integer	Die Dateigröße in Byte. Nur für physische Anlagen.

ConstituentApi.ActionCustomFieldRead

Benutzerdefiniertes Feld

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des benutzerdefinierten Felds.
Aktions-ID	parent_id	string	Die Systemdatensatz-ID der Aktion, die dem benutzerdefinierten Feld zugeordnet ist.
Kategorie	category	string	Die Kategorie des benutzerdefinierten Felds.
Typ	type	string	Der Datentyp, den das benutzerdefinierte Feld darstellt.
Wert	value		Der Wert des benutzerdefinierten Felds.
Datum	date	date	Das Datum im benutzerdefinierten Feld.
Kommentar	comment	string	Der Kommentar für das benutzerdefinierte Feld. Zeichenlimit: 50.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem das benutzerdefinierte Feld erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem das benutzerdefinierte Feld zuletzt geändert wurde.

ConstituentApi.ActionRead

Maßnahme

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Aktion.
Bestandteil-ID	constituent_id	string	Die Systemdatensatz-ID des Mit der Aktion verknüpften Bestandteils.
Kategorie	category	string	Der Kanal oder die Absicht der konstituierenden Interaktion.
Abgeschlossen?	completed	boolean	Ist die Aktion abgeschlossen? Wenn das System für die Verwendung von benutzerdefinierten Aktionsstatus konfiguriert ist, basiert dieser Wert auf dem Aktionsstatuswert.
Abgeschlossen am	completed_date	date-time	Das Datum, an dem die Aktion abgeschlossen wurde.
Datum	date	date-time	Das Aktionsdatum.
Hinweis	description	string	Die ausführliche Erläuterung, die die Aktionszusammenfassung erläutert.
Richtung	direction	string	Die Richtung der Aktion.
Fundraiser(en)	fundraisers	array of string	Der Satz von Systemdatensatz-IDs für die Fundraiser, die mit der Aktion verbunden sind.
Standort	location	string	Die Position der Aktion.
Verkaufschancen-ID	opportunity_id	string	Die Systemdatensatz-ID der Verkaufschance, die der Aktion zugeordnet ist.
Ergebnis	outcome	string	Das Ergebnis der Aktion.
Priority	priority	string	Die Priorität der Aktion.
Startzeit	start_time	string	Die Startzeit der Aktion. Verwendet 24-Stunden-Zeit im HH:mm-Format.
Endzeitpunkt	end_time	string	Die Endzeit der Aktion. Verwendet 24-Stunden-Zeit im HH:mm-Format.
Der Status	status	string	Der Aktionsstatus.
Statuscode	status_code	string	Der Aktionsstatuscode. Diese Eigenschaft wird nur zurückgegeben, wenn das System für die Verwendung von benutzerdefinierten Aktionsstatus konfiguriert ist.
Berechneter Status	computed_status	string	Der berechnete Aktionsstatus. Wenn das System nicht für die Verwendung von benutzerdefinierten Aktionsstatus konfiguriert ist, berechnet dieses Feld den Status basierend auf den Eigenschaften "Abgeschlossen" und "Datum". Andernfalls berechnet das Feld den Status basierend auf der Datumseigenschaft der Aktion und ob die Aktionsstatuseigenschaft der Aktion als abgeschlossen konfiguriert ist.
Zusammenfassung	summary	string	Die kurze Beschreibung der Aktion, die oben im Datensatz angezeigt wird. Zeichenlimit: 255.
Typ	type	string	Zusätzliche Beschreibung der Aktion zur Ergänzung der Kategorie.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem die Aktion erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem die Aktion zuletzt geändert wurde.

ConstituentApi.AddressRead

Adresse

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Adresse.
Typ	type	string	Der Adresstyp.
Country	country	string	Das Land der Adresse (kann die ID, der Name oder die Abkürzung sein).
Adresszeilen	address_lines	string	Die Adresszeilen.
Stadt	city	string	Die Stadt der Adresse (nicht in Kombination mit dem Feld "Vorort") verwenden.
Staat	state	string	Das Bundesland der Adresse.
Postleitzahl	postal_code	string	Die Postleitzahl der Adresse.
Vorort	suburb	string	Der Vorort der Adresse (nicht in Kombination mit dem Feld "Ort") verwenden.
Bezirk	county	string	Der Landkreis der Adresse.
Formatierte Adresse	formatted_address	string	Die formatierte Adresse im konfigurierten Format des Landes.
Informationsquelle	information_source	string	Die Informationsquelle für die Adresse.
Region	region	string	Die Region für die Adresse.
KARREN	cart	string	Die Netzbetreiberroute (CART) für die Adresse.
LOS	lot	string	Die Reisezeile (LOT) für die Adresse.
DPC	dpc	string	Der Zustellungspunktcode (Delivery Point Code, DPC) für die Adresse.
Gültig ab	start	date-time	Das Datum, an dem der Konstituierende an dieser Adresse wohnte.
Gültig bis	end	date-time	Das Datum, an dem der Bestandteil nicht mehr an dieser Adresse ansässig ist.
Primär?	preferred	boolean	Ist dies die bevorzugte Adresse des Wählers?
Inaktiv?	inactive	boolean	Ist die Adresse inaktiv (d. h., das aktuelle Datum liegt vor einem Enddatum)?
Keine E-Mail senden?	do_not_mail	boolean	Kann der Bestandteil an dieser Adresse kontaktiert werden?
Tag	seasonal_start.d	integer	Der Tag im Fuzzydatum.
Monat	seasonal_start.m	integer	Der Monat im Fuzzydatum.
Jahr	seasonal_start.y	integer	Das Jahr im Fuzzydatum.
Tag	seasonal_end.d	integer	Der Tag im Fuzzydatum.
Monat	seasonal_end.m	integer	Der Monat im Fuzzydatum.
Jahr	seasonal_end.y	integer	Das Jahr im Fuzzydatum.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem die Adresse erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem die Adresse zuletzt geändert wurde.

ConstituentApi.AliasRead

Alias

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des Alias.
Alias	name	string	Der Name, der als Alias des Bestandteils verwendet werden soll.
Typ	type	string	Der Aliastyp.

ConstituentApi.ApiCollectionOfAddressRead

Addresses

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of ConstituentApi.AddressRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfActionAttachmentRead

Attachments

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of ConstituentApi.ActionAttachmentRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfActionCustomFieldRead

Benutzerdefinierte Felder

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of ConstituentApi.ActionCustomFieldRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfActionRead

Aktionen

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of ConstituentApi.ActionRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfAliasRead

Decknamen

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of ConstituentApi.AliasRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfConstituentAttachmentRead

Attachments

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of ConstituentApi.ConstituentAttachmentRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfConstituentCodeRead

Komponentencodes

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of ConstituentApi.ConstituentCodeRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

Benutzerdefinierte Felder

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of ConstituentApi.ConstituentCustomFieldRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfConstituentRead

Bestandteile

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of ConstituentApi.ConstituentRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfEducationRead

Ausbildungen

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of ConstituentApi.EducationRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfEmailAddressRead

E-Mail-Adressen

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of ConstituentApi.EmailAddressRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

Fundraiser-Zuordnungen

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of ConstituentApi.FundraiserAssignmentRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfNoteRead

Hinweise

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of ConstituentApi.NoteRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfOnlinePresenceRead

Onlinepräsenzen

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of ConstituentApi.OnlinePresenceRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfPhoneRead

Telefone

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of ConstituentApi.PhoneRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfRatingRead

Bewertungen

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of ConstituentApi.RatingRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfRelationshipRead

Beziehungen

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of ConstituentApi.RelationshipRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfSearchResultRead

Suchergebnisse

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of ConstituentApi.SearchResultRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.AppealRead

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des Rechtsmittels.
Beschreibung	description	string	Die Beschwerdebeschreibung.

ConstituentApi.CampaignRead

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Kampagne.
Beschreibung	description	string	Die Kampagnenbeschreibung.

ConstituentApi.ConstituentAttachmentRead

Attachment

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Anlage.
Bestandteil-ID	parent_id	string	Die Systemdatensatz-ID des Bestandteils, der der Anlage zugeordnet ist.
Typ	type	string	Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet.
Name	name	string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date	date-time	Das Datum der Anlage.
URL	url	string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.
Dateiname	file_name	string	Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Datei-ID	file_id	string	Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-ID	thumbnail_id	string	Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-URL	thumbnail_url	string	Die URL für eine Miniaturansicht. Nur für physische Anlagen, die Bilder sind. Enthält eine zeitgebundene Signatur, die den Zugriff auf 60 Minuten beschränkt.
Inhaltstyp	content_type	string	Der Inhaltstyp. Nur für physische Anlagen.
Dateigröße	file_size	integer	Die Dateigröße in Byte. Nur für physische Anlagen.

ConstituentApi.ConstituentCodeRead

Konstituierender Code

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des Komponentencodes.
Bestandteil-ID	constituent_id	string	Die Systemdatensatz-ID des Bestandteils, der dem Bestandteilcode zugeordnet ist.
Konstituierender Code	description	string	Der Bestandteilcode.
Tag	start.d	integer	Der Tag im Fuzzydatum.
Monat	start.m	integer	Der Monat im Fuzzydatum.
Jahr	start.y	integer	Das Jahr im Fuzzydatum.
Tag	end.d	integer	Der Tag im Fuzzydatum.
Monat	end.m	integer	Der Monat im Fuzzydatum.
Jahr	end.y	integer	Das Jahr im Fuzzydatum.
Inaktiv?	inactive	boolean	Ist der Bestandteilcode inaktiv?
Sequence	sequence	integer	Die numerische Sequenz, die dem Bestandteilcode zugeordnet ist.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem der Konstituierende Code erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem der Konstituierende Code zuletzt geändert wurde.

ConstituentApi.ConstituentCustomFieldRead

Benutzerdefiniertes Feld

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des benutzerdefinierten Felds.
Bestandteil-ID	parent_id	string	Die Systemdatensatz-ID des Bestandteils, der dem benutzerdefinierten Feld zugeordnet ist.
Kategorie	category	string	Die Kategorie des benutzerdefinierten Felds.
Typ	type	string	Der Datentyp, den das benutzerdefinierte Feld darstellt.
Wert	value		Der Wert des benutzerdefinierten Felds.
Datum	date	date	Das Datum im benutzerdefinierten Feld.
Kommentar	comment	string	Der Kommentar für das benutzerdefinierte Feld. Zeichenlimit: 50.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem das benutzerdefinierte Feld erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem das benutzerdefinierte Feld zuletzt geändert wurde.

ConstituentApi.ConstituentRead

Bestandteil

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID für den Bestandteil. Dies entspricht nicht dem benutzerdefinierten Bestandteilbezeichner, der im lookup_id gespeichert wird.
Typ	type	string	Der Typ des Bestandteils.
Title	title	string	Der Haupttitel des Bestandteils (nur für Einzelpersonen).
Vorname	first	string	Der Vorname des Bestandteils (nur für Einzelpersonen).
Nachname	last	string	Der Nachname des Bestandteils (nur für Einzelpersonen).
Name	name	string	Bei Einzelpersonen ist dieses Feld der vollständige Name des Bestandteils basierend auf den Anzeigenameneinstellungen der Zielorganisation. Für Organisationen ist dies der Name der Organisation.
Bevorzugter Name	preferred_name	string	Der bevorzugte Name des Bestandteils (nur für Einzelpersonen).
Nachsilbe	suffix	string	Das primäre Suffix des Bestandteils (nur für Einzelpersonen).
Nachschlage-ID	lookup_id	string	Der benutzerdefinierte Bezeichner für den Bestandteil.
ID	email.id	string	Die Systemdatensatz-ID der E-Mail-Adresse.
type	email.type	string	Der Typ der E-Mail-Adresse.
address	email.address	string	Die E-Mail-Adresse.
keine E-Mail senden?	email.do_not_email	boolean	Kann der Bestandteil an dieser E-Mail-Adresse kontaktiert werden?
inaktiv?	email.inactive	boolean	Ist diese E-Mail-Adresse inaktiv?
hinzugefügtes Datum	email.date_added	date-time	Das Datum, an dem die E-Mail-Adresse erstellt wurde.
Änderungsdatum	email.date_modified	date-time	Das Datum, an dem die E-Mail-Adresse zuletzt geändert wurde.
ID	phone.id	string	Die Systemdatensatz-ID des Telefons.
type	phone.type	string	Der Telefontyp.
number	phone.number	string	Die Telefonnummer.
nicht anrufen?	phone.do_not_call	boolean	Kann der Bestandteil an dieser Nummer kontaktiert werden?
inaktiv?	phone.inactive	boolean	Ist diese Telefonnummer inaktiv?
hinzugefügtes Datum	phone.date_added	date-time	Das Datum, an dem das Telefon erstellt wurde.
Änderungsdatum	phone.date_modified	date-time	Das Datum, an dem das Telefon zuletzt geändert wurde.
ID	online_presence.id	string	Die Systemdatensatz-ID der Onlinepräsenz.
type	online_presence.type	string	Der Onlinepräsenztyp.
link	online_presence.address	string	Die Webadresse für die Onlinepräsenz.
inaktiv?	online_presence.inactive	boolean	Ist diese Onlinepräsenz inaktiv?
hinzugefügtes Datum	online_presence.date_added	date-time	Das Datum, an dem die Onlinepräsenz erstellt wurde.
Änderungsdatum	online_presence.date_modified	date-time	Das Datum, an dem die Onlinepräsenz zuletzt geändert wurde.
ID	address.id	string	Die Systemdatensatz-ID der Adresse.
type	address.type	string	Der Adresstyp.
country	address.country	string	Das Land der Adresse (kann die ID, der Name oder die Abkürzung sein).
Linien	address.address_lines	string	Die Adresszeilen.
city	address.city	string	Die Stadt der Adresse (nicht in Kombination mit dem Feld "Vorort") verwenden.
Staat	address.state	string	Das Bundesland der Adresse.
Postleitzahl	address.postal_code	string	Die Postleitzahl der Adresse.
Vorort	address.suburb	string	Der Vorort der Adresse (nicht in Kombination mit dem Feld "Ort") verwenden.
Bezirk	address.county	string	Der Landkreis der Adresse.
formatiert	address.formatted_address	string	Die formatierte Adresse im konfigurierten Format des Landes.
gültig von	address.start	date-time	Das Datum, an dem der Konstituierende an dieser Adresse wohnte.
gültig für	address.end	date-time	Das Datum, an dem der Bestandteil nicht mehr an dieser Adresse ansässig ist.
inaktiv?	address.inactive	boolean	Ist die Adresse inaktiv (d. h., das aktuelle Datum liegt vor einem Enddatum)?
keine E-Mail senden?	address.do_not_mail	boolean	Kann der Bestandteil an dieser Adresse kontaktiert werden?
Tag	address.seasonal_start.d	integer	Der Tag im Fuzzydatum.
Monat	address.seasonal_start.m	integer	Der Monat im Fuzzydatum.
Jahr	address.seasonal_start.y	integer	Das Jahr im Fuzzydatum.
Tag	address.seasonal_end.d	integer	Der Tag im Fuzzydatum.
Monat	address.seasonal_end.m	integer	Der Monat im Fuzzydatum.
Jahr	address.seasonal_end.y	integer	Das Jahr im Fuzzydatum.
hinzugefügtes Datum	address.date_added	date-time	Das Datum, an dem die Adresse erstellt wurde.
Änderungsdatum	address.date_modified	date-time	Das Datum, an dem die Adresse zuletzt geändert wurde.
Geschlecht	gender	string	Das Geschlecht des Wählers (nur für Einzelpersonen).
Zweiter Vorname	middle	string	Der zweite Vorname des Bestandteils (nur für Einzelpersonen).
Ehemaliger Name	former_name	string	Der ehemalige Name des Wählers (nur für Einzelpersonen).
Titel 2	title_2	string	Der sekundäre Titel des Bestandteils (nur für Einzelpersonen).
Suffix 2	suffix_2	string	Das sekundäre Suffix des Bestandteils (nur für Einzelpersonen).
Marital staus	marital_status	string	Der Familienstand des Wählers (nur für Einzelpersonen).
Gibt anonym?	gives_anonymously	boolean	Gibt der Bestandteil anonym?
Inaktiv?	inactive	boolean	Ist der Bestandteil inaktiv?
Tag	birthdate.d	integer	Der Tag im Fuzzydatum.
Monat	birthdate.m	integer	Der Monat im Fuzzydatum.
Jahr	birthdate.y	integer	Das Jahr im Fuzzydatum.
Geburtsort	birthplace	string	Der Geburtsort des Bestandteils (nur für Einzelpersonen).
Ethnizität	ethnicity	string	Die EthnischeItät des Bestandteils (nur für Einzelpersonen).
Erlöse	income	string	Das Einkommen für den Bestandteil (nur für Einzelpersonen).
Religion	religion	string	Die Religion des Bestandteils (nur für Einzelpersonen).
Branche	industry	string	Die Industrie des Bestandteils (nur für Organisationen).
Anzahl der Mitarbeiter	num_employees	integer	Die Anzahl der Mitarbeiter in der Organisation.
Stimmt mit Geschenken überein?	matches_gifts	boolean	Stimmt die Organisation mit Geschenken überein?
Passender Geschenkfaktor	matching_gift_factor	double	Der passende Geschenkfaktor (nur für Organisationen).
Min Match pro Geschenk	matching_gift_per_gift_min.value	double	Der mindeste Übereinstimmungsbetrag pro Geschenk für den Bestandteil (nur für Organisationen).
Maximale Übereinstimmung pro Geschenk	matching_gift_per_gift_max.value	double	Der maximale Übereinstimmungsbetrag pro Geschenk für den Bestandteil (nur für Organisationen).
Min Übereinstimmung pro Constit	matching_gift_total_min.value	double	Die Mindestanzahl der Übereinstimmungen für die Bestandteile (nur für Organisationen).
Maximale Übereinstimmung pro Constit	matching_gift_total_max.value	double	Die maximale Übereinstimmungssumme für die Einzelnen (nur für Organisationen).
Abgleichen von Geschenknotizen	matching_gift_notes	string	Die passenden Geschenknotizen für den Bestandteil (nur für Organisationen).
Alter	age	integer	Das Alter des Bestandteils, wie auf der Grundlage des Geburtsdatums (nur für Einzelpersonen) berechnet.
Verstorben?	deceased	boolean	Ist der Teil des Verstorbenen (nur für Einzelpersonen)?
Tag	deceased_date.d	integer	Der Tag im Fuzzydatum.
Monat	deceased_date.m	integer	Der Monat im Fuzzydatum.
Jahr	deceased_date.y	integer	Das Jahr im Fuzzydatum.
Fundraiser-Status	fundraiser_status	string	Gibt an, ob der Bestandteil ein Fundraiser ist (nur für Einzelpersonen).
ID	spouse.id	string	Die Systemdatensatz-ID des Ehepartners.
Vorname	spouse.first	string	Vorname des Ehepartners.
Nachname	spouse.last	string	Der Nachname des Ehegatten.
ist Haushaltsleiter?	spouse.is_head_of_household	boolean	Ist der Ehegatte der Kopf des Haushalts?
Datum hinzugefügt	date_added	date-time	Das Datum, an dem die Komponente erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem die Komponente zuletzt geändert wurde.

ConstituentApi.CreatedAction

Erstellte Aktion

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Aktion.

ConstituentApi.CreatedActionAttachment

Erstellte Aktionsanlage

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Aktionsanlage.

ConstituentApi.CreatedActionCustomField

Benutzerdefiniertes Aktionsfeld erstellt

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID des neu erstellten benutzerdefinierten Aktionsfelds.

ConstituentApi.CreatedConstituentAddress

Erstellte Konstituierende Adresse

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Bestandteiladresse.

ConstituentApi.CreatedConstituentAlias

Erstellter Bestandteilalias

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID des neu erstellten Komponentenalias.

ConstituentApi.CreatedConstituentAttachment

Anlage erstellt

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Anlage.

ConstituentApi.CreatedConstituentCode

Erstellter Komponentencode

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID des neu erstellten Komponentencodes.

ConstituentApi.CreatedConstituentCustomField

Erstelltes benutzerdefiniertes Feld

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID des neu erstellten benutzerdefinierten Felds.

ConstituentApi.CreatedConstituentEducation

Bildung von Bestandteilen erstellt

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Bildung.

ConstituentApi.CreatedConstituentEmailAddress

Erstellte E-Mail-Adresse

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten E-Mail-Adresse.

ConstituentApi.CreatedConstituentNote

Erstellter Bestandteilhinweis

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Konstituierenden Notiz.

ConstituentApi.CreatedConstituentOnlinePresence

Onlinepräsenz erstellt

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Onlinepräsenz.

ConstituentApi.CreatedConstituentPhone

Erstelltes Bestandteiltelefon

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID des neu erstellten Bestandteiltelefons.

ConstituentApi.CreatedConstituentRating

Erstellte Bewertung der Bestandteile

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Konstituierenden Bewertung.

ConstituentApi.CreatedIndividualConstituent

Erstellt einzelne Bestandteile

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID des neu erstellten einzelnen Bestandteils.

ConstituentApi.CreatedIndividualRelationship

Individuelle Beziehung erstellt

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten individuellen Beziehung.

ConstituentApi.CreatedOrganizationConstituent

Erstellter Organisationsbestandteil

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Organisationskomponente.

ConstituentApi.CreatedOrganizationRelationship

Organisationsbeziehung erstellt

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Organisationsbeziehung.

ConstituentApi.EducationRead

Education

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Bildungseinrichtungen.
Bestandteil-ID	constituent_id	string	Die Systemdatensatz-ID des Bestandteils, der der Ausbildung zugeordnet ist.
Schule	school	string	Der Name der Schule/Einrichtung.
Typ	type	string	Die Art der Ausbildung.
Klasse von	class_of	string	Das Jahr, in dem der Konstituierende abschloss.
Der Status	status	string	Der Status der Ausbildung.
Tag	date_entered.d	integer	Der Tag im Fuzzydatum.
Monat	date_entered.m	integer	Der Monat im Fuzzydatum.
Jahr	date_entered.y	integer	Das Jahr im Fuzzydatum.
Tag	date_left.d	integer	Der Tag im Fuzzydatum.
Monat	date_left.m	integer	Der Monat im Fuzzydatum.
Jahr	date_left.y	integer	Das Jahr im Fuzzydatum.
Tag	date_graduated.d	integer	Der Tag im Fuzzydatum.
Monat	date_graduated.m	integer	Der Monat im Fuzzydatum.
Jahr	date_graduated.y	integer	Das Jahr im Fuzzydatum.
Grad	degree	string	Der Grad, der empfangen wurde.
GPA	gpa	double	Der Notenpunktdurchschnitt.
Majore	majors	array of string	Die Hauptstudiengänge.
Minderjährige	minors	array of string	Die Nebenstudiengänge.
Ist die Grundschulbildung?	primary	boolean	Ist dies der Grundschulverband der Wähler?
Campus	campus	string	Der Campus.
Soziale Organisation	social_organization	string	Die soziale Organisation.
Bekannter Name	known_name	string	Der bekannte Name.
Gradklasse	class_of_degree	string	Die Klasse des Abschlusses.
Abteilung	department	string	Der Name der Bildungsabteilung.
Fakultät	faculty	string	Der Name der Fakultät.
Registrierungsnummer	registration_number	string	Die Registrierungsnummer.
Studienfach	subject_of_study	string	Das Studienfach.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem die Ausbildung erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem die Ausbildung zuletzt geändert wurde.

ConstituentApi.EmailAddressRead

E-Mail-Adresse

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der E-Mail-Adresse.
Bestandteil-ID	constituent_id	string	Die Systemdatensatz-ID des Bestandteils, der der E-Mail-Adresse zugeordnet ist.
E-Mail-Typ	type	string	Der Typ der E-Mail-Adresse.
E-Mail-Adresse	address	string	Die E-Mail-Adresse.
Primär?	primary	boolean	Ist dies die primäre E-Mail-Adresse des Bestandteils?
Keine E-Mail senden?	do_not_email	boolean	Kann der Bestandteil an dieser E-Mail-Adresse kontaktiert werden?
Inaktiv?	inactive	boolean	Ist diese E-Mail-Adresse inaktiv?
Datum hinzugefügt	date_added	date-time	Das Datum, an dem die E-Mail-Adresse erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem die E-Mail-Adresse zuletzt geändert wurde.

ConstituentApi.FileDefinition

Dateidefinition

Name	Pfad	Typ	Beschreibung
Datei-ID	file_id	string	Der Bezeichner der Datei.
URL	file_upload_request.url	string	Die URL, die für die Uploadanforderung verwendet werden soll.
method	file_upload_request.method	string	Die HTTP-Methode, die mit der Uploadanforderung verwendet werden soll.
headers	file_upload_request.headers	array of ConstituentApi.Header	Die Header, die beim Stellen der Anforderung angegeben werden sollen.
Miniaturansichts-ID	thumbnail_id	string	Der Bezeichner der Miniaturansicht.
URL	thumbnail_upload_request.url	string	Die URL, die für die Uploadanforderung verwendet werden soll.
method	thumbnail_upload_request.method	string	Die HTTP-Methode, die mit der Uploadanforderung verwendet werden soll.
headers	thumbnail_upload_request.headers	array of ConstituentApi.Header	Die Header, die beim Stellen der Anforderung angegeben werden sollen.

ConstituentApi.FundraiserAssignmentRead

Fundraiserzuweisung

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Fundraiser-Zuordnung.
Bestandteil-ID	constituent_id	string	Die Systemdatensatz-ID des Bestandteils, der dem Fundraiser zugewiesen ist.
Fundraiser ID	fundraiser_id	string	Die Systemdatensatz-ID des Fundraisers.
Typ	type	string	Die Art des Fundraisers.
value	amount.value	double	Der Geldwert.
Kampagnen-ID	campaign_id	string	Die Systemdatensatz-ID der Kampagne, auf die resultierende Geschenke angewendet werden sollen.
Fund-ID	fund_id	string	Die Systemdatensatz-ID des Fonds sollten alle resultierenden Geschenke angewendet werden. Wenn ein eingeschränkter Fonds ausgewählt wird, können nur Kampagnen und Rechtsmittel im Zusammenhang mit diesem Fonds ausgewählt werden.
Berufungs-ID	appeal_id	string	Die Systemdatensatz-ID des Appells, den der Fundraiser zum Anfordern von Geschenken verwenden sollte.
Startdatum	start	date-time	Der Starttermin der Fundraiserzuweisung.
Enddatum	end	date-time	Endtermin der Fundraiserzuweisung.

ConstituentApi.FundRead

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des Fonds.
Beschreibung	description	string	Die Fondsbeschreibung.

ConstituentApi.GivingSummaryRead

Zusammenfassung

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des Geschenks.
Typ	type	string	Der Geschenktyp.
Datum	date	date-time	Das Geschenkdatum.
value	amount.value	double	Der Geldwert.
Appeal	appeals	array of ConstituentApi.AppealRead	Der Satz von Rechtsmitteln, die mit dem Geschenk verbunden sind.
Kampagne	campaigns	array of ConstituentApi.CampaignRead	Die Gruppe der Kampagnen, die dem Geschenk zugeordnet sind.
Fonds	funds	array of ConstituentApi.FundRead	Die Gruppe der Mittel, die mit dem Geschenk verbunden sind.

Anforderungsheader, der zum Hochladen der physischen Anlage verwendet wird.

Name	Pfad	Typ	Beschreibung
name	name	string	Der Name für die Kopfzeile.
value	value	string	Der Wert für die Kopfzeile.

ConstituentApi.LifetimeGivingRead

Lebenslanges Geben

Name	Pfad	Typ	Beschreibung
Aufeinander folgende Jahre angegeben	consecutive_years_given	integer	Die Anzahl der aufeinander folgenden Jahre, die der Bestandteil angegeben hat.
Gesamtanzahl der angegebenen Jahre	total_years_given	integer	Die Gesamtzahl der Jahre, die der Bestandteil gegeben hat.
value	total_giving.value	double	Der Geldwert.
value	total_pledge_balance.value	double	Der Geldwert.
value	total_received_giving.value	double	Der Geldwert.
value	total_committed_matching_gifts.value	double	Der Geldwert.
value	total_received_matching_gifts.value	double	Der Geldwert.
value	total_soft_credits.value	double	Der Geldwert.

ConstituentApi.NoteRead

Hinweis

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Notiz.
Bestandteil-ID	constituent_id	string	Die Systemdatensatz-ID des Mit der Notiz verknüpften Bestandteils.
Typ	type	string	Der Notiztyp.
Tag	date.d	integer	Der Tag im Fuzzydatum.
Monat	date.m	integer	Der Monat im Fuzzydatum.
Jahr	date.y	integer	Das Jahr im Fuzzydatum.
Zusammenfassung	summary	string	Die Notizzusammenfassung.
Hinweis	text	string	Der Notiztext.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem die Notiz erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem die Notiz zuletzt geändert wurde.

ConstituentApi.OnlinePresenceRead

Onlinepräsenz

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Onlinepräsenz.
Bestandteil-ID	constituent_id	string	Die Systemdatensatz-ID des Bestandteils, der der Onlinepräsenz zugeordnet ist.
Typ	type	string	Der Onlinepräsenztyp.
Link	address	string	Die Webadresse für die Onlinepräsenz.
Primär?	primary	boolean	Ist dies die primäre Onlinepräsenz des Wählers?
Inaktiv?	inactive	boolean	Ist diese Onlinepräsenz inaktiv?
Datum hinzugefügt	date_added	date-time	Das Datum, an dem die Onlinepräsenz erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem die Onlinepräsenz zuletzt geändert wurde.

ConstituentApi.PhoneRead

Telefonnummer

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des Telefons.
Bestandteil-ID	constituent_id	string	Die Systemdatensatz-ID des Bestandteils, der dem Telefon zugeordnet ist.
Typ	type	string	Der Telefontyp.
Number	number	string	Die Telefonnummer.
Primär?	primary	boolean	Ist dies das primäre Telefon des Wählers?
Rufen Sie nicht an?	do_not_call	boolean	Kann der Bestandteil an dieser Nummer kontaktiert werden?
Inaktiv?	inactive	boolean	Ist diese Telefonnummer inaktiv?
Datum hinzugefügt	date_added	date-time	Das Datum, an dem das Telefon erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem das Telefon zuletzt geändert wurde.

ConstituentApi.ProfilePictureRead

Profilbild

Name	Pfad	Typ	Beschreibung
Bestandteil-ID	constituent_id	string	Die Systemdatensatz-ID des Mit dem Profilbild verknüpften Bestandteils.
URL	url	string	Die URL für das Profilbild. Die URL enthält eine zeitgebundene Signatur, die den Zugriff auf 60 Minuten beschränkt.
Miniaturansichts-URL	thumbnail_url	string	Die URL für eine Miniaturansicht des Profilbilds. Enthält eine zeitgebundene Signatur, die den Zugriff auf 60 Minuten beschränkt.

ConstituentApi.ProspectStatusRead

Status des Prospekts

Name	Pfad	Typ	Beschreibung
Der Status	status	string	Der aktuelle Aussichtsstatus des Wählers.
Verstrichene Tage	days_elapsed	integer	Die Gesamtzahl der Tage im aktuellen Aussichtsstatus basierend auf dem Startdatum.
Startdatum	start	date-time	Das Startdatum des Aussichtsstatus.
Kommentare	comments	string	Die Kommentare zum Status der Aussicht.

ConstituentApi.RatingRead

Rating

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Bewertung.
Bestandteil-ID	constituent_id	string	Die Systemdatensatz-ID des Mit der Bewertung verknüpften Bestandteils.
Quelle	source	string	Die Quelle der neuen Bewertung.
Kategorie	category	string	Die Kategorie der Bewertung.
Datum	date	date-time	Das Datum der Bewertung.
Description	value		Der Wert der Bewertung.
Kommentare	comment	string	Ein Kommentar zur Bewertung.
Inaktiv?	inactive	boolean	Ist die Bewertung inaktiv?
Typ	type	string	Dieses berechnete Feld gibt den Typ der Daten an, die die Bewertung basierend auf der Kategorieeigenschaft darstellt.

ConstituentApi.RelationshipRead

Beziehung

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Beziehung.
Bestandteil-ID	constituent_id	string	Die Systemdatensatz-ID des Mit der Beziehung verknüpften Bestandteils.
Beziehungs-ID	relation_id	string	Die Systemdatensatz-ID der zugehörigen Person oder Organisation.
Gegenseitige Beziehungs-ID	reciprocal_relationship_id	string	Der Bezeichner für den gegenseitigen Beziehungsdatensatz. Dieser Wert ist schreibgeschützt und wird automatisch generiert, wenn die Beziehung erstellt wird. Änderungen, die an diesem Datensatz vorgenommen wurden, werden auch auf den Gegenseitigkeitswechsel mit Ausnahme der Kommentareigenschaft widerzuspiegeln.
Name	name	string	Der Name des zugehörigen Bestandteils. Wenn es sich bei dem zugehörigen Bestandteil um eine Einzelperson handelt, ist dies der vollständige Name des Bestandteils basierend auf den Anzeigenameneinstellungen der Zielorganisation.
Typ	type	string	Der Typ der Beziehung, die die Beziehung darstellt.
Gegenseitiger Typ	reciprocal_type	string	Beschreibt die Beziehung des Bestandteils zum zugehörigen Bestandteil. Beispielsweise wäre in einer Beziehung zwischen einem männlichen Bestandteil und einem weiblichen Gleichgeordneten der gegenseitige Beziehungstyp Bruder.
Tag	start.d	integer	Der Tag im Fuzzydatum.
Monat	start.m	integer	Der Monat im Fuzzydatum.
Jahr	start.y	integer	Das Jahr im Fuzzydatum.
Tag	end.d	integer	Der Tag im Fuzzydatum.
Monat	end.m	integer	Der Monat im Fuzzydatum.
Jahr	end.y	integer	Das Jahr im Fuzzydatum.
Ist Ehepartner?	is_spouse	boolean	Gilt die verwandte Person des Ehegatten (nur für Beziehungen zwischen Einzelpersonen)?
Ist konstituierender Haushaltschef?	is_constituent_head_of_household	boolean	Ist der Konstituierende der Haushaltschef?
Ist ehegatte Haushaltsleiter?	is_spouse_head_of_household	boolean	Ist der Ehegatte der Kopf des Haushalts?
Hinweise	comment	string	Der Kommentar zur Beziehung.
Ist Kontakt?	is_organization_contact	boolean	Stellt die Komponente diese Organisation als Kontakt dar (gilt nur für Beziehungen zwischen Organisationen und Einzelpersonen)?
Ist primäres Geschäft?	is_primary_business	boolean	Ist dies das Hauptgeschäft des Bestandteils (gilt nur für Beziehungen zwischen Organisationen und Einzelpersonen)?
Kontakttyp	organization_contact_type	string	Stellt Kontext für Interaktionen mit der zugehörigen Person bereit, die die Organisation als Kontakt darstellt. Gilt nur für Beziehungen zwischen Organisationen und Einzelpersonen.
Position	position	string	Die Position der Person in der Organisation. Gilt nur für Beziehungen zwischen Organisationen und Einzelpersonen.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem die Beziehung erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem die Beziehung zuletzt geändert wurde.

ConstituentApi.SearchResultRead

Suchergebnis

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des Bestandteils.
Name	name	string	Der Name des Bestandteils. Bei Einzelpersonen gibt dieses berechnete Feld den vollständigen Namen des Bestandteils basierend auf den Anzeigenameneinstellungen der Zielorganisation an.
Adresse	address	string	Die bevorzugte Adresse des Bestandteils.
Verstorben?	deceased	boolean	Ist der Bestandteil verstorben?
Email	email	string	Die E-Mail-Adresse des Bestandteils.
Fundraiser-Status	fundraiser_status	string	Der Fundraiserstatus des Wählers. Bei Einzelpersonen gibt dieses berechnete Feld an, ob der Bestandteil "Aktiv", "Inaktiv" oder "None" ist. Für Organisationen lautet dieser Wert immer "None".
Inaktiv?	inactive	boolean	Ist der Bestandteil inaktiv?
Nachschlage-ID	lookup_id	string	Der benutzerdefinierte Bezeichner für den Bestandteil.

EventApi.AdministrativeArea

Definiert das Datenmodell, das für den Administrativen Bereich einer Adresse (z. B. Bundesland in den USA) verwendet wird.

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Datensatz-ID des Verwaltungsbereichs.
name	name	string	Der Name des Verwaltungsbereichs.
Kurzbeschreibung	short_description	string	Die kurze Beschreibung des Verwaltungsbereichs.

EventApi.ApiCollectionOfEventFee

Fees

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of EventApi.EventFee	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

EventApi.ApiCollectionOfEventListEntry

Ereignisse

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of EventApi.EventListEntry	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

EventApi.ApiCollectionOfEventParticipantOption

Optionen für Ereignisteilnehmer

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of EventApi.EventParticipantOption	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

EventApi.ApiCollectionOfParticipantDonation

Spenden

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of EventApi.ParticipantDonation	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

EventApi.ApiCollectionOfParticipantFee

Fees

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of EventApi.ParticipantFee	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

EventApi.ApiCollectionOfParticipantFeePayment

Gebührenzahlungen

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of EventApi.ParticipantFeePayment	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

EventApi.ApiCollectionOfParticipantListEntry

Teilnehmer

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of EventApi.ParticipantListEntry	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

EventApi.ApiCollectionOfParticipantOption

Teilnehmeroptionen

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of EventApi.ParticipantOption	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

EventApi.Country

Definiert das Datenmodell, das für das Land einer Adresse verwendet wird.

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID des Länderdatensatzes.
Anzeigename	display_name	string	Der Anzeigename des Landes.
ISO-Code	iso_alpha2_code	string	Der ISO 3166-1-Alpha-2-Code für das Land.

EventApi.CreatedEvent

Created-Ereignis

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID des neu erstellten Ereignisses.

EventApi.CreatedEventFee

Erstellte Veranstaltungsgebühr

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Veranstaltungsgebühr.

EventApi.CreatedEventParticipantOption

Ereignisteilnehmeroption erstellt

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Ereignisteilnehmeroption.

EventApi.CreatedParticipant

Erstellter Teilnehmer

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID des neu erstellten Teilnehmers.

EventApi.CreatedParticipantDonation

Beteiligte Spende erstellt

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Teilnehmerspende.

EventApi.CreatedParticipantFee

Teilnehmergebühr erstellt

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Teilnehmergebühr.

EventApi.CreatedParticipantFeePayment

Erstellte Teilnehmergebührzahlung

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Teilnehmergebühr.

EventApi.CreatedParticipantOption

Option "Teilnehmer erstellt"

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Teilnehmeroption.

EventApi.Event

Event

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des Ereignisses. Dies ist nicht mit dem benutzerdefinierten Ereignisbezeichner identisch, der im lookup_id gespeichert wird.
Name	name	string	Der Name des Ereignisses.
Description	description	string	Die Beschreibung des Ereignisses.
Startdatum	start_date	date	Das Startdatum des Ereignisses.
Startzeit	start_time	string	Die Startzeit des Ereignisses.
Enddatum	end_date	date	Das Enddatum des Ereignisses.
Endzeitpunkt	end_time	string	Die Endzeit des Ereignisses.
Kategorie	category	EventApi.EventCategory	Die Ereigniskategorie ist die benutzerdefinierte Kategorisierung für das Ereignis.
Nachschlage-ID	lookup_id	string	Die Nachschlage-ID des Ereignisses.
Standort	location	EventApi.Location	Definiert das für einen Speicherort verwendete Datenmodell.
Kapazität	capacity	integer	Die Anzahl der Personen, die an der Veranstaltung teilnehmen können.
Ziel	goal	double	Das monetäre Ziel des Ereignisses.
Kampagnen-ID	campaign_id	string	Die Systemdatensatz-ID der Kampagne, die dem Ereignis zugeordnet ist.
Fund-ID	fund_id	string	Die Systemdatensatz-ID des Fonds, der dem Ereignis zugeordnet ist.
Inaktiv?	inactive	boolean	Ist das Ereignis inaktiv?
Datum hinzugefügt	date_added	date-time	Das Datum, an dem das Ereignis erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem das Ereignis zuletzt geändert wurde.

EventApi.EventCategory

Die Ereigniskategorie ist die benutzerdefinierte Kategorisierung für das Ereignis.

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Ereigniskategorie.
name	name	string	Der Name der Ereigniskategorie.
inaktiv?	inactive	boolean	Ist diese Kategorie inaktiv?

EventApi.EventFee

Ereignisgebühren sind, wie viel eine Organisation für Einzelpersonen oder Organisationen berechnet, um an der Veranstaltung teilzunehmen oder daran teilzunehmen.

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Veranstaltungsgebühr.
name	name	string	Der Name der Veranstaltungsgebühr.
Menge	cost	double	Die Kosten der Gebühr.
Beitragsbetrag	contribution_amount	double	Der Steuerabzugsbetrag für diese Gebühr.
Verkaufte Nummer	number_sold	integer	Die Anzahl der verkauften Gebühren.

EventApi.EventListEntry

Event

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des Ereignisses.
Name	name	string	Der Name des Ereignisses.
Startdatum	start_date	date	Das Startdatum des Ereignisses.
Startzeit	start_time	string	Die Startzeit des Ereignisses.
Enddatum	end_date	date	Das Enddatum des Ereignisses.
Endzeitpunkt	end_time	string	Die Endzeit des Ereignisses.
Kategorie	category	EventApi.EventCategory	Die Ereigniskategorie ist die benutzerdefinierte Kategorisierung für das Ereignis.
Nachschlage-ID	lookup_id	string	Die Nachschlage-ID des Ereignisses.
Kapazität	capacity	integer	Die Anzahl der Personen, die an der Veranstaltung teilnehmen können.
Oberarzt	attending_count	integer	Die Anzahl der Teilnehmer, die teilnehmen möchten.
Beaufsichtigt	attended_count	integer	Die Anzahl der Ereignisteilnehmer.
Eingeladen	invited_count	integer	Die Anzahl der eingeladenen Ereignisse.
Einnahme	revenue	double	Der realisierte Umsatz der Veranstaltung.
Ziel	goal	double	Das monetäre Ziel des Ereignisses.
Prozent des Ziels	percent_of_goal	integer	Der realisierte Umsatz als Prozentsatz des Zielumsatzes.
Inaktiv?	inactive	boolean	Ist das Ereignis inaktiv?
Datum hinzugefügt	date_added	date-time	Das Datum, an dem das Ereignis erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem das Ereignis zuletzt geändert wurde.

EventApi.EventParticipantOption

Ereignisteilnehmeroptionen sind Felder, in denen Details zu Teilnehmern gesammelt werden, z. B. T-Shirt-Größen, Essenspräferenzen oder Sitzanforderungen. Legen Sie Optionen und deren Werte für ein Ereignis fest, und fügen Sie dann Antworten für jeden Teilnehmer hinzu.

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Ereignisteilnehmeroption.
name	name	string	Der Name der Ereignisteilnehmeroption.
Eingabetyp	input_type	string	Der Typ der Ereignisteilnehmeroption.
Mehrfachauswahl zulassen?	multi_select	boolean	Mehrere Werte für Listen zulassen?
list_options	list_options	array of EventApi.EventParticipantOptionListOption	Die verfügbaren Listenoptionen.
Vom Benutzer hinzugefügt	added_by_user	string	Die ID des Benutzers, der die Option hinzugefügt hat.
vom Benutzer geändert	updated_by_user	string	Die ID des Benutzers, der die Option geändert hat.
vom Dienst hinzugefügt	added_by_service	string	Der Name des Diensts, der diese Option hinzugefügt hat.
von Dienst geändert	updated_by_service	string	Der Name des Diensts, der diese Option geändert hat.
hinzugefügtes Datum	date_added	date-time	Das Datum, an dem die Option erstellt wurde.
Änderungsdatum	date_updated	date-time	Das Datum, an dem die Option zuletzt geändert wurde.
Ausgabe	version	integer	Die Versionsnummer der Option.

EventApi.EventParticipantOptionListOption

Eine Listenoption für Ereignisteilnehmer

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der Listenoption
name	name	string	Der Name der Listenoption
Sequenz	sequence	integer	Die Sequenz, die zum Sortieren der Listenoptionen verwendet wird

EventApi.Locality

Definiert das Datenmodell, das für die Lokalität einer Adresse verwendet wird.

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Datensatz-ID des Gebietsschemadatensatzes.
name	name	string	Der Name der Gebietsschemas.

EventApi.Location

Definiert das für einen Speicherort verwendete Datenmodell.

Name	Pfad	Typ	Beschreibung
name	name	string	Der Name des Speicherorts.
Adresszeilen	address_lines	string	Die Adresszeilen des Speicherorts.
Postleitzahl	postal_code	string	Die Postleitzahl des Standorts.
Örtlichkeit	locality	EventApi.Locality	Definiert das Datenmodell, das für die Lokalität einer Adresse verwendet wird.
Verwaltungsbereich	administrative_area	EventApi.AdministrativeArea	Definiert das Datenmodell, das für den Administrativen Bereich einer Adresse (z. B. Bundesland in den USA) verwendet wird.
Unterverwaltungsbereich	sub_administrative_area	EventApi.SubAdministrativeArea	Definiert das Datenmodell, das für den Unterverwaltungsbereich einer Adresse (z. B. Stadt in den USA) verwendet wird.
country	country	EventApi.Country	Definiert das Datenmodell, das für das Land einer Adresse verwendet wird.
formatierte Adresse	formatted_address	string	Formatierte Adresse des Speicherorts

EventApi.Membership

Mitgliedschaftsinformationen für den Teilnehmer.

Name	Pfad	Typ	Beschreibung
Mitgliedschaftskategorie	category	EventApi.MembershipCategory	Die Mitgliedschaftskategorie der Person.

EventApi.MembershipCategory

Die Mitgliedschaftskategorie der Person.

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Mitgliedschaftskategorie.
name	name	string	Der Name der Mitgliedschaftskategorie.

EventApi.Participant

Teilnehmer

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des Teilnehmers.
Bestandteil-ID	constituent_id	string	Die Konstituierende ID des Teilnehmers.
Ereignis-ID	event_id	string	Die Systemdatensatz-ID des Ereignisses, an dem teilgenommen wird.
Host-ID	host_id	string	Die ID des Teilnehmerdatensatzes des Hosts.
RSVP-Status	rsvp_status	string	Der Status des Engagements des Teilnehmers mit dem Ereignis.
Besucht?	attended	boolean	Hat der Teilnehmer an der Veranstaltung teilgenommen?
Einladungsstatus	invitation_status	string	Der Status der Einladung an den Teilnehmer.
Tag	rsvp_date.d	integer	Der Tag im Fuzzydatum.
Monat	rsvp_date.m	integer	Der Monat im Fuzzydatum.
Jahr	rsvp_date.y	integer	Das Jahr im Fuzzydatum.
Tag	invitation_date.d	integer	Der Tag im Fuzzydatum.
Monat	invitation_date.m	integer	Der Monat im Fuzzydatum.
Jahr	invitation_date.y	integer	Das Jahr im Fuzzydatum.
Teilnahmestufe	participation_level	EventApi.ParticipationLevel	Teilnahmestufen sind die Beteiligungsteilnehmer in einem Ereignis.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem der Teilnehmer erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem der Teilnehmer zuletzt geändert wurde.

EventApi.ParticipantDonation

Definiert ein Datenmodell für eine Teilnehmerspende.

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Teilnehmerspende.
Geschenk-ID	gift_id	string	Die Systemdatensatz-ID des Geschenks, mit dem die Teilnehmerspende verknüpft ist.

EventApi.ParticipantFee

Definiert ein Datenmodell für eine Teilnehmergebühr

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der Teilnehmergebühr.
Teilnehmer-ID	participant_id	string	Die ID des Datensatzes, mit dem die Teilnehmergebühr verknüpft ist.
Menge	quantity	integer	Die gekaufte Menge.
Gebührenbetrag	fee_amount	double	Der Betrag der Teilnehmergebühr.
Beitragsbetrag	tax_receiptable_amount	double	Der Steuerabzugsbetrag für diese Gebühr.
Tag	date.d	integer	Der Tag im Fuzzydatum.
Monat	date.m	integer	Der Monat im Fuzzydatum.
Jahr	date.y	integer	Das Jahr im Fuzzydatum.
Veranstaltungsgebühr	event_fee	EventApi.EventFee	Ereignisgebühren sind, wie viel eine Organisation für Einzelpersonen oder Organisationen berechnet, um an der Veranstaltung teilzunehmen oder daran teilzunehmen.

EventApi.ParticipantFeePayment

Definiert ein Datenmodell für die Zahlung einer Teilnehmergebühr

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Teilnehmergebührzahlung.
Teilnehmer-ID	participant_id	string	Die Systemdatensatz-ID des Teilnehmers, mit dem die Teilnehmergebühr verbunden ist.
Geschenk-ID	gift_id	string	Die Systemdatensatz-ID des Geschenks, mit dem die Teilnehmergebührzahlung verknüpft ist.
angewendeter Betrag	applied_amount	double	Der angewendete Betrag der Teilnehmergebühr.

EventApi.ParticipantListEntry

Teilnehmer

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des Teilnehmers.
Kontakt-ID	contact_id	string	Die ID des Kontakts, der an der Veranstaltung teilnimmt.
RSVP-Status	rsvp_status	string	Der Status des Engagements des Teilnehmers mit dem Ereignis.
Besucht?	attended	boolean	Hat der Teilnehmer an der Veranstaltung teilgenommen?
Einladungsstatus	invitation_status	string	Der Status der Einladung an den Teilnehmer.
Tag	rsvp_date.d	integer	Der Tag im Fuzzydatum.
Monat	rsvp_date.m	integer	Der Monat im Fuzzydatum.
Jahr	rsvp_date.y	integer	Das Jahr im Fuzzydatum.
Teilnahmestufe	participation_level	EventApi.ParticipationLevel	Teilnahmestufen sind die Beteiligungsteilnehmer in einem Ereignis.
Title	title	string	Der Titel des Teilnehmers.
Vorname	first_name	string	Vorname des Teilnehmers.
Nachname	last_name	string	Der Nachname des Teilnehmers.
Name	name	string	Der vollständige Name des Teilnehmers.
Bevorzugter Name	preferred_name	string	Der bevorzugte Name des Teilnehmers.
Nachsilbe	suffix	string	Das Suffix des Teilnehmers.
Nachschlage-ID	lookup_id	string	Die Nachschlage-ID des Teilnehmers.
Email	email	string	Die E-Mail-Adresse des Teilnehmers.
Keine E-Mail senden?	do_not_email	boolean	Kann der Teilnehmer an dieser E-Mail-Adresse kontaktiert werden?
Telefonnummer	phone	string	Die Telefonnummer des Teilnehmers.
Rufen Sie nicht an?	do_not_call	boolean	Kann der Teilnehmer an dieser Nummer kontaktiert werden?
Zweiter Vorname	middle_name	string	Der zweite Name des Teilnehmers.
Ehemaliger Name	former_name	string	Der frühere Name des Teilnehmers.
Ist ein Bestandteil?	is_constituent	boolean	Ist der Teilnehmer bestandteil?
Klasse von	class_of	string	Der Abschlusskurs des Teilnehmers.
Registrierungsgebühren insgesamt	total_registration_fees	double	Die Summe der Gebührenbeträge des Teilnehmers.
Bezahlte Summe	total_paid	double	Die Summe der bezahlten Geschenke des Teilnehmers mit einer Art von Registrierungsgebühren.
Sitz	seat	string	Die Sitzzuweisung für den Teilnehmer.
Namenstag	name_tag	string	Das Namenstag für den Teilnehmer
Datum hinzugefügt	date_added	date-time	Das Datum, an dem der Teilnehmer erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem der Teilnehmer zuletzt geändert wurde.
Kontakt-ID	host.contact_id	string	Die ID des Kontakts, der an der Veranstaltung teilnimmt.
Teilnehmer-ID	host.participant_id	string	Die ID des Teilnehmers.
name	host.name	string	Der vollständige Name des Teilnehmers.
Gäste	guests	array of EventApi.ParticipantListParticipantSummary	Die Gäste des Teilnehmers.
Mitgliedschaften	memberships	array of EventApi.Membership	Die Mitgliedschaftsinformationen für den Teilnehmer.

EventApi.ParticipantListParticipantSummary

Grundlegende Zusammenfassungsinformationen des Teilnehmers.

Name	Pfad	Typ	Beschreibung
Kontakt-ID	contact_id	string	Die ID des Kontakts, der an der Veranstaltung teilnimmt.
Teilnehmer-ID	participant_id	string	Die ID des Teilnehmers.
name	name	string	Der vollständige Name des Teilnehmers.

EventApi.ParticipantOption

Die Teilnehmeroption, die einem bestimmten Teilnehmer zugeordnet ist

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Teilnehmeroption.
Teilnehmer-ID	participant_id	string	Die Systemdatensatz-ID des Teilnehmers.
Ereignis-ID	event_id	string	Die Systemdatensatz-ID des Ereignisses.
Ereignisteilnehmer-Options-ID	event_participant_option_id	string	Die Systemdatensatz-ID der Ereignisteilnehmeroption.
value	option_value	string	Die Antwort des Teilnehmers auf die Option.
Vom Benutzer hinzugefügt	added_by_user	string	Die ID des Benutzers, der die Teilnehmeroption hinzugefügt hat.
vom Benutzer geändert	updated_by_user	string	Die ID des Benutzers, der die Teilnehmeroption geändert hat.
vom Dienst hinzugefügt	added_by_service	string	Der Name des Diensts, der diese Teilnehmeroption hinzugefügt hat.
von Dienst geändert	updated_by_service	string	Der Name des Diensts, der diese Teilnehmeroption geändert hat.
hinzugefügtes Datum	date_added	date-time	Das Datum, an dem die Teilnehmeroption erstellt wurde.
Änderungsdatum	date_updated	date-time	Das Datum, an dem die Teilnehmeroption zuletzt geändert wurde.

EventApi.ParticipationLevel

Teilnahmestufen sind die Beteiligungsteilnehmer in einem Ereignis.

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Teilnahmestufe.
name	name	string	Der Name der Teilnahmestufe.
inaktiv?	is_inactive	boolean	Ist die Teilnahmestufe inaktiv?

EventApi.SubAdministrativeArea

Definiert das Datenmodell, das für den Unterverwaltungsbereich einer Adresse (z. B. Stadt in den USA) verwendet wird.

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID des Unterverwaltungsbereichs.
name	name	string	Der Name des Unterverwaltungsbereichs.

FundraisingApi.ApiCollectionOfAppealAttachmentRead

Attachments

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of FundraisingApi.AppealAttachmentRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

FundraisingApi.ApiCollectionOfAppealCustomFieldRead

Benutzerdefinierte Felder

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of FundraisingApi.AppealCustomFieldRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

FundraisingApi.ApiCollectionOfAppealRead

Einsprüche

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of FundraisingApi.AppealRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

FundraisingApi.ApiCollectionOfCampaignAttachmentRead

Attachments

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of FundraisingApi.CampaignAttachmentRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

FundraisingApi.ApiCollectionOfCampaignCustomFieldRead

Benutzerdefinierte Felder

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of FundraisingApi.CampaignCustomFieldRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

FundraisingApi.ApiCollectionOfCampaignRead

Feldzüge

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of FundraisingApi.CampaignRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

FundraisingApi.ApiCollectionOfFundAttachmentRead

Attachments

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of FundraisingApi.FundAttachmentRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

FundraisingApi.ApiCollectionOfFundCustomFieldRead

Benutzerdefinierte Felder

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of FundraisingApi.FundCustomFieldRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

FundraisingApi.ApiCollectionOfFundRead

Geldmittel

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of FundraisingApi.FundRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

FundraisingApi.ApiCollectionOfFundraiserAssignmentRead

Zuweisungen

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of FundraisingApi.FundraiserAssignmentRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

FundraisingApi.ApiCollectionOfPackageRead

Pakete

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of FundraisingApi.PackageRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

FundraisingApi.AppealAttachmentRead

Attachment

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Anlage.
Berufungs-ID	parent_id	string	Die Systemdatensatz-ID des Mit der Anlage verbundenen Rechtsmittels.
Typ	type	string	Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet.
Name	name	string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date	date-time	Das Datum der Anlage.
URL	url	string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.
Dateiname	file_name	string	Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Datei-ID	file_id	string	Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-ID	thumbnail_id	string	Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-URL	thumbnail_url	string	Die URL für eine Miniaturansicht. Nur für physische Anlagen, die Bilder sind. Enthält eine zeitgebundene Signatur, die den Zugriff auf 60 Minuten beschränkt.
Inhaltstyp	content_type	string	Der Inhaltstyp. Nur für physische Anlagen.
Dateigröße	file_size	integer	Die Dateigröße in Byte. Nur für physische Anlagen.

FundraisingApi.AppealCustomFieldRead

Benutzerdefiniertes Feld

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des benutzerdefinierten Felds.
Berufungs-ID	parent_id	string	Die Systemdatensatz-ID des Mit dem benutzerdefinierten Feld verknüpften Rechtsmittels.
Kategorie	category	string	Die Kategorie des benutzerdefinierten Felds.
Typ	type	string	Der Datentyp, den das benutzerdefinierte Feld darstellt.
Wert	value		Der Wert des benutzerdefinierten Felds.
Datum	date	date	Das Datum im benutzerdefinierten Feld.
Kommentar	comment	string	Der Kommentar für das benutzerdefinierte Feld. Zeichenlimit: 50.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem das benutzerdefinierte Feld erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem das benutzerdefinierte Feld zuletzt geändert wurde.

FundraisingApi.AppealRead

Appeal

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des Rechtsmittels.
Kategorie	category	string	Die Kategorie des Rechtsmittels.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem die Beschwerde erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem die Beschwerde zuletzt geändert wurde.
Description	description	string	Der Anzeigename des Rechtsmittels.
Enddatum	end_date	date-time	Das Enddatum des Rechtsmittels.
value	goal.value	double	Der Geldwert.
Inaktiv?	inactive	boolean	Ist die Beschwerde aktiv (d. h., das aktuelle Datum liegt nach einem Anfangstermin und vor einem Enddatum)?
Nachschlage-ID	lookup_id	string	Der benutzerdefinierte Bezeichner für die Beschwerde.
Startdatum	start_date	date-time	Das Startdatum des Rechtsmittels.

FundraisingApi.CampaignAttachmentRead

Attachment

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Anlage.
Kampagnen-ID	parent_id	string	Die Systemdatensatz-ID der Kampagne, die der Anlage zugeordnet ist.
Typ	type	string	Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet.
Name	name	string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date	date-time	Das Datum der Anlage.
URL	url	string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.
Dateiname	file_name	string	Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Datei-ID	file_id	string	Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-ID	thumbnail_id	string	Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-URL	thumbnail_url	string	Die URL für eine Miniaturansicht. Nur für physische Anlagen, die Bilder sind. Enthält eine zeitgebundene Signatur, die den Zugriff auf 60 Minuten beschränkt.
Inhaltstyp	content_type	string	Der Inhaltstyp. Nur für physische Anlagen.
Dateigröße	file_size	integer	Die Dateigröße in Byte. Nur für physische Anlagen.

FundraisingApi.CampaignCustomFieldRead

Benutzerdefiniertes Feld

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des benutzerdefinierten Felds.
Kampagnen-ID	parent_id	string	Die Systemdatensatz-ID der Kampagne, die dem benutzerdefinierten Feld zugeordnet ist.
Kategorie	category	string	Die Kategorie des benutzerdefinierten Felds.
Typ	type	string	Der Datentyp, den das benutzerdefinierte Feld darstellt.
Wert	value		Der Wert des benutzerdefinierten Felds.
Datum	date	date	Das Datum im benutzerdefinierten Feld.
Kommentar	comment	string	Der Kommentar für das benutzerdefinierte Feld. Zeichenlimit: 50.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem das benutzerdefinierte Feld erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem das benutzerdefinierte Feld zuletzt geändert wurde.

FundraisingApi.CampaignRead

Kampagne

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Kampagne.
Kategorie	category	string	Die Kategorie der Kampagne.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem die Kampagne erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem die Kampagne zuletzt geändert wurde.
Description	description	string	Der Anzeigename der Kampagne.
Enddatum	end_date	date-time	Das Enddatum der Kampagne.
value	goal.value	double	Der Geldwert.
Inaktiv?	inactive	boolean	Ist die Kampagne inaktiv (d. h., das aktuelle Datum liegt nach einem Startdatum und vor einem Enddatum)?
Nachschlage-ID	lookup_id	string	Der benutzerdefinierte Bezeichner für die Kampagne.
Startdatum	start_date	date-time	Das Startdatum der Kampagne.

FundraisingApi.CreatedAppealAttachment

Erstellter Berufungsanhang

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Beschwerdeanfügung.

FundraisingApi.CreatedAppealCustomField

Erstelltes benutzerdefiniertes Berufungsfeld

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID des neu erstellten benutzerdefinierten Berufungsfelds.

FundraisingApi.CreatedCampaignAttachment

Erstellter Kampagnenanhang

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Kampagnenanlage.

FundraisingApi.CreatedCampaignCustomField

Benutzerdefiniertes Kampagnenfeld erstellt

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID des neu erstellten benutzerdefinierten Kampagnenfelds.

FundraisingApi.CreatedFundraiserAssignment

Erstellt fundraiser assignment

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Fundraiserzuweisung.

FundraisingApi.CreatedFundAttachment

Fondsanlage erstellt

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Fondsanlage.

FundraisingApi.CreatedFundCustomField

Benutzerdefiniertes Fondsfeld erstellt

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID des neu erstellten benutzerdefinierten Fondsfelds.

FundraisingApi.FundraiserAssignmentRead

Zuweisung

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Fundraiser-Zuordnung.
Bestandteil-ID	constituent_id	string	Die Systemdatensatz-ID der zugewiesenen Komponente.
Typ	type	string	Der Fundraisertyp.
Zuordnung beginnt	start	date-time	Der Anfangstermin der Zuordnung.
Zuordnung endet	end	date-time	Das Enddatum der Zuordnung.
value	amount.value	double	Der Geldwert.
Kampagnen-ID	campaign_id	string	Die Systemdatensatz-ID der Kampagne, auf die resultierende Geschenke angewendet werden.
Fund-ID	fund_id	string	Die Systemdatensatz-ID des Fonds, auf den resultierende Geschenke angewendet werden.
Berufungs-ID	appeal_id	string	Die Systemdatensatz-ID des Aufrufs, auf den resultierende Geschenke angewendet werden.

FundraisingApi.FundAttachmentRead

Attachment

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Anlage.
Fund-ID	parent_id	string	Die Systemdatensatz-ID des Fonds, der der Anlage zugeordnet ist.
Typ	type	string	Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet.
Name	name	string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date	date-time	Das Datum der Anlage.
URL	url	string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.
Dateiname	file_name	string	Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Datei-ID	file_id	string	Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-ID	thumbnail_id	string	Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-URL	thumbnail_url	string	Die URL für eine Miniaturansicht. Nur für physische Anlagen, die Bilder sind. Enthält eine zeitgebundene Signatur, die den Zugriff auf 60 Minuten beschränkt.
Inhaltstyp	content_type	string	Der Inhaltstyp. Nur für physische Anlagen.
Dateigröße	file_size	integer	Die Dateigröße in Byte. Nur für physische Anlagen.

FundraisingApi.FundCustomFieldRead

Benutzerdefiniertes Feld

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des benutzerdefinierten Felds.
Fund-ID	parent_id	string	Die Systemdatensatz-ID des Fonds, der dem benutzerdefinierten Feld zugeordnet ist.
Kategorie	category	string	Die Kategorie des benutzerdefinierten Felds.
Typ	type	string	Der Datentyp, den das benutzerdefinierte Feld darstellt.
Wert	value		Der Wert des benutzerdefinierten Felds.
Datum	date	date	Das Datum im benutzerdefinierten Feld.
Kommentar	comment	string	Der Kommentar für das benutzerdefinierte Feld. Zeichenlimit: 50.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem das benutzerdefinierte Feld erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem das benutzerdefinierte Feld zuletzt geändert wurde.

FundraisingApi.FundRead

Fonds

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des Fonds.
Kategorie	category	string	Die Kategorie des Fonds.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem der Fonds erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem der Fonds zuletzt geändert wurde.
Description	description	string	Der Anzeigename des Fonds.
Enddatum	end_date	date-time	Das Enddatum des Fonds.
value	goal.value	double	Der Geldwert.
Inaktiv?	inactive	boolean	Ist der Fonds inaktiv (d. h. das aktuelle Datum liegt nach einem Anfangstermin und vor einem Enddatum)?
Nachschlage-ID	lookup_id	string	Der benutzerdefinierte Bezeichner für den Fonds.
Startdatum	start_date	date-time	Der Starttermin des Fonds.
Typ	type	string	Die Art des Fonds.

FundraisingApi.PackageRead

Package

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des Pakets.
Berufungs-ID	appeal_id	string	Die Systemdatensatz-ID des Rechtsmittels, das diesem Paket zugeordnet ist.
Kategorie	category	string	Die Kategorie des Pakets.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem das Paket erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem das Paket zuletzt geändert wurde.
value	default_gift_amount.value	double	Der Geldwert.
Description	description	string	Der Anzeigename des Pakets.
Enddatum	end	date-time	Das Enddatum des Pakets.
value	goal.value	double	Der Geldwert.
Inaktiv?	inactive	boolean	Ist das Paket inaktiv (d. h., das aktuelle Datum liegt nach einem Startdatum und vor einem Enddatum)?
Nachschlage-ID	lookup_id	string	Der benutzerdefinierte Bezeichner für das Paket.
Hinweise	notes	string	Die Notizen im Paket.
Empfängeranzahl	recipient_count	integer	Die Anzahl der Empfänger des Pakets.
Startdatum	start	date-time	Das Startdatum des Pakets.

GiftApi.AcknowledgementRead

Anerkennung

Name	Pfad	Typ	Beschreibung
date	date	date-time	Das Datum, das der Bestätigung zugeordnet ist.
Buchstabe	letter	string	Der Brief, der der Bestätigung zugeordnet ist.
status	status	string	Der Status der Bestätigung. Verfügbare Werte sind: ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT und DONOTACKNOWLEDGE.

GiftApi.ApiCollectionOfGiftAttachmentRead

Attachments

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of GiftApi.GiftAttachmentRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

GiftApi.ApiCollectionOfGiftCustomFieldRead

Benutzerdefinierte Felder

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of GiftApi.GiftCustomFieldRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

GiftApi.ApiCollectionOfGiftRead

Geschenke

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of GiftApi.GiftRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

GiftApi.BatchGiftAddResults

Enthält eine Sammlung von Batch-Geschenkfehlerdatensätzen und die Batchgeschenke, die der Vorgang hinzugefügt hat.

Name	Pfad	Typ	Beschreibung
Irrtümer	errors	array of GiftApi.GiftBatchGiftError	Die Batch-Geschenkfehler im Zusammenhang mit dem Batch-Geschenk-Add-Vorgang
Geschenke	gifts	array of GiftApi.BatchGiftRead	Die Sammlung von Batchgeschenken, die vom Stapelgeschenk-Add-Vorgang hinzugefügt wurden

GiftApi.GiftBatchGiftError

Stellt Ausnahmen dar, die verhindern, dass elemente dem Batch hinzugefügt werden.

Name	Pfad	Typ	Beschreibung
Betroffenes Feld	affected_field	string	Das vom Fehler betroffene Feld
Batch-ID	batch_id	string	Die Systemdatensatz-ID des Batches
Ausnahmefehlercode	exception_error_code	integer	Der Ausnahmefehlercode
Ausnahmefehlermeldung	exception_error_message	string	Ausnahmefehlermeldung
Ausnahmefehlername	exception_error_name	string	Der Name des Ausnahmefehlers
Geschenk-ID	gift_id	string	Die Systemdatensatz-ID des Geschenks
Nachschlage-ID	lookup_id	string	Der benutzerdefinierte Bezeichner für das Geschenk.

GiftApi.BatchGiftRead

Batchgeschenk

Name	Pfad	Typ	Beschreibung
Batch-ID	batch_id	string	Die ID des Batches, dem das Geschenk hinzugefügt wurde.
Irrtümer	errors	array of GiftApi.GiftBatchGiftError	Die Fehler im Zusammenhang mit dem Batchgeschenk.
ID	id	string	Die Systemdatensatz-ID des Batchgeschenks.
Bestandteil-ID	constituent_id	string	Die Systemdatensatz-ID des Bestandteils, der dem Geschenk zugeordnet ist.
type	type	string	Der Geschenktyp.
subtyp	subtype	string	Der Untertyp des Geschenks.
date	date	date-time	Das Geschenkdatum.
value	amount.value	double	Der Geldwert.
value	balance.value	double	Der Geldwert.
Batchnummer	batch_number	string	Die Batchnummer, die diesem Geschenk zugeordnet ist.
status	gift_status	string	Der Status des Geschenks.
anonym?	is_anonymous	boolean	Ist das Geschenk anonym?
Wahlkreis	constituency	string	Der Wahlkreis des Geschenks.
Nachschlage-ID	lookup_id	string	Der benutzerdefinierte Bezeichner für das Geschenk.
origin	origin	string	Der Ursprung des Geschenks.
Beitragsstatus	post_status	string	Das Hauptbuch nach dem Status des Geschenks. Verfügbare Werte sind "Posted", "NotPosted" und "DoNotPost". Wenn post_status auf DoNotPost> festgelegt ist, sollte post_date null sein. Wenn sie auf "NotPosted" festgelegt ist, ist post_date erforderlich, bleibt aber bearbeitbar. Wenn sie auf "Bereitgestellt" festgelegt ist, ist post_date erforderlich und kann nicht mehr bearbeitet werden.
Postdatum	post_date	date-time	Das Datum, an dem das Geschenk in das Hauptbuch gebucht wurde.
reference	reference	string	Hinweise zum Nachverfolgen spezieller Details zu einem Geschenk wie der Motivation dahinter oder einer detaillierten Beschreibung eines Geschenks.
Tag	recurring_gift_status_date.d	integer	Der Tag im Fuzzydatum.
Monat	recurring_gift_status_date.m	integer	Der Monat im Fuzzydatum.
Jahr	recurring_gift_status_date.y	integer	Das Jahr im Fuzzydatum.
frequency	recurring_gift_schedule.frequency	string	Ratehäufigkeit des wiederkehrenden Geschenks, das angezeigt werden soll. Verfügbare Werte sind WÖCHENTLICH, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONATLICH, VIERTELJÄHRLICH, JÄHRLICH.
start	recurring_gift_schedule.start_date	date-time	Datum, an dem das wiederkehrende Geschenk beginnen soll.
Ende	recurring_gift_schedule.end_date	date-time	Datum, an dem das wiederkehrende Geschenk enden soll.
value	gift_aid_amount.value	double	Der Geldwert.
Qualifikationsstatus der Geschenkbeihilfe	gift_aid_qualification_status	string	Dieses berechnete Feld bestimmt den Qualifikationsstatus der Geschenkhilfe basierend auf Steuererklärungsinformationen und dem Datenbankformat. Verfügbare Werte sind: "Qualified", "NotQualified" und "PartQualified". Nur für Großbritannien.
Geschenkcode	gift_code	string	Der Geschenkcodewert, der dem Geschenk zugeordnet ist.
Geschenkteilungen	gift_splits	array of GiftApi.GiftSplitRead	Der Satz von Geschenksteilungen, die dem Geschenk zugeordnet sind.
Fundraiser	fundraisers	array of GiftApi.GiftFundraiserRead	Die Gruppe der Fundraiser, die Kredit für das Geschenk erhalten.
Soft Credits	soft_credits	array of GiftApi.SoftCreditRead	Der Satz von Soft Credits, die dem Geschenk zugeordnet sind.
Einnahmen	receipts	array of GiftApi.ReceiptRead	Der Satz von Quittungen, die dem Geschenk zugeordnet sind.
Danksagung	acknowledgements	array of GiftApi.AcknowledgementRead	Der Satz von Bestätigungen, die dem Geschenk zugeordnet sind.
Zahlungen	payments	array of GiftApi.PaymentRead	Die Zahlungen an das Geschenk.
Verknüpfte Geschenke	linked_gifts	array of string	Die Bezeichner anderer Geschenke, die mit diesem Geschenk verknüpft sind.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem das Geschenk erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem das Geschenk zuletzt geändert wurde.

GiftApi.CreatedGift

Geschenk erstellt

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID des neu erstellten Geschenks.

GiftApi.CreatedGiftAttachment

Geschenkanlage erstellt

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Geschenkanlage.

GiftApi.CreatedGiftCustomField

Benutzerdefiniertes Geschenkfeld erstellt

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID des neu erstellten benutzerdefinierten Geschenkfelds.

GiftApi.GiftAttachmentRead

Attachment

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Anlage.
Geschenk-ID	parent_id	string	Die Systemdatensatz-ID des Geschenks, das der Anlage zugeordnet ist.
Typ	type	string	Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet.
Name	name	string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date	date-time	Das Datum der Anlage.
URL	url	string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.
Dateiname	file_name	string	Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Datei-ID	file_id	string	Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-ID	thumbnail_id	string	Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-URL	thumbnail_url	string	Die URL für eine Miniaturansicht. Nur für physische Anlagen, die Bilder sind. Enthält eine zeitgebundene Signatur, die den Zugriff auf 60 Minuten beschränkt.
Inhaltstyp	content_type	string	Der Inhaltstyp. Nur für physische Anlagen.
Dateigröße	file_size	integer	Die Dateigröße in Byte. Nur für physische Anlagen.

GiftApi.GiftCustomFieldRead

Benutzerdefiniertes Feld

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des benutzerdefinierten Felds.
Geschenk-ID	parent_id	string	Die Systemdatensatz-ID des Geschenks, das dem benutzerdefinierten Feld zugeordnet ist.
Kategorie	category	string	Die Kategorie des benutzerdefinierten Felds.
Typ	type	string	Der Datentyp, den das benutzerdefinierte Feld darstellt.
Wert	value		Der Wert des benutzerdefinierten Felds.
Datum	date	date	Das Datum im benutzerdefinierten Feld.
Kommentar	comment	string	Der Kommentar für das benutzerdefinierte Feld. Zeichenlimit: 50.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem das benutzerdefinierte Feld erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem das benutzerdefinierte Feld zuletzt geändert wurde.

GiftApi.GiftFundraiserRead

Geschenk-Fundraiser

Name	Pfad	Typ	Beschreibung
value	amount.value	double	Der Geldwert.
Fundraiser-ID	constituent_id	string	Die Id des bestandteilen Systemdatensatzes für den Fundraiser, der dem Geschenk zugeordnet ist.

GiftApi.GiftRead

Geschenk

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des Geschenks.
Bestandteil-ID	constituent_id	string	Die Systemdatensatz-ID des Bestandteils, der dem Geschenk zugeordnet ist.
Typ	type	string	Der Geschenktyp.
Subtyp	subtype	string	Der Untertyp des Geschenks.
Datum	date	date-time	Das Geschenkdatum.
value	amount.value	double	Der Geldwert.
value	balance.value	double	Der Geldwert.
Batchnummer	batch_number	string	Die Batchnummer, die diesem Geschenk zugeordnet ist.
Der Status	gift_status	string	Der Status des Geschenks.
Anonym?	is_anonymous	boolean	Ist das Geschenk anonym?
Wahlkreis	constituency	string	Der Wahlkreis des Geschenks.
Nachschlage-ID	lookup_id	string	Der benutzerdefinierte Bezeichner für das Geschenk.
Ursprung	origin	string	Der Ursprung des Geschenks.
Beitragsstatus	post_status	string	Das Hauptbuch nach dem Status des Geschenks. Verfügbare Werte sind "Posted", "NotPosted" und "DoNotPost". Wenn post_status auf DoNotPost> festgelegt ist, sollte post_date null sein. Wenn sie auf "NotPosted" festgelegt ist, ist post_date erforderlich, bleibt aber bearbeitbar. Wenn sie auf "Bereitgestellt" festgelegt ist, ist post_date erforderlich und kann nicht mehr bearbeitet werden.
Postdatum	post_date	date-time	Das Datum, an dem das Geschenk in das Hauptbuch gebucht wurde.
Reference	reference	string	Hinweise zum Nachverfolgen spezieller Details zu einem Geschenk wie der Motivation dahinter oder einer detaillierten Beschreibung eines Geschenks.
Tag	recurring_gift_status_date.d	integer	Der Tag im Fuzzydatum.
Monat	recurring_gift_status_date.m	integer	Der Monat im Fuzzydatum.
Jahr	recurring_gift_status_date.y	integer	Das Jahr im Fuzzydatum.
frequency	recurring_gift_schedule.frequency	string	Ratehäufigkeit des wiederkehrenden Geschenks, das angezeigt werden soll. Verfügbare Werte sind WÖCHENTLICH, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONATLICH, VIERTELJÄHRLICH, JÄHRLICH.
start	recurring_gift_schedule.start_date	date-time	Datum, an dem das wiederkehrende Geschenk beginnen soll.
Ende	recurring_gift_schedule.end_date	date-time	Datum, an dem das wiederkehrende Geschenk enden soll.
value	gift_aid_amount.value	double	Der Geldwert.
Qualifikationsstatus der Geschenkbeihilfe	gift_aid_qualification_status	string	Dieses berechnete Feld bestimmt den Qualifikationsstatus der Geschenkhilfe basierend auf Steuererklärungsinformationen und dem Datenbankformat. Verfügbare Werte sind: "Qualified", "NotQualified" und "PartQualified". Nur für Großbritannien.
Geschenkcode	gift_code	string	Der Geschenkcodewert, der dem Geschenk zugeordnet ist.
Geschenkteilungen	gift_splits	array of GiftApi.GiftSplitRead	Der Satz von Geschenksteilungen, die dem Geschenk zugeordnet sind.
Fundraiser	fundraisers	array of GiftApi.GiftFundraiserRead	Die Gruppe der Fundraiser, die Kredit für das Geschenk erhalten.
Soft Credits	soft_credits	array of GiftApi.SoftCreditRead	Der Satz von Soft Credits, die dem Geschenk zugeordnet sind.
Einnahmen	receipts	array of GiftApi.ReceiptRead	Der Satz von Quittungen, die dem Geschenk zugeordnet sind.
Danksagung	acknowledgements	array of GiftApi.AcknowledgementRead	Der Satz von Bestätigungen, die dem Geschenk zugeordnet sind.
Zahlungen	payments	array of GiftApi.PaymentRead	Die Zahlungen an das Geschenk.
Verknüpfte Geschenke	linked_gifts	array of string	Die Bezeichner anderer Geschenke, die mit diesem Geschenk verknüpft sind.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem das Geschenk erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem das Geschenk zuletzt geändert wurde.

GiftApi.GiftSplitRead

Geschenk geteilt

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des Geteilten Geschenks.
value	amount.value	double	Der Geldwert.
Berufungs-ID	appeal_id	string	Die Systemdatensatz-ID des Aufrufs, der dem Geschenkteil zugeordnet ist.
Kampagnen-ID	campaign_id	string	Die Systemdatensatz-ID der Kampagne, die mit der Teilung des Geschenks verknüpft ist.
Fonds-ID	fund_id	string	Die Systemdatensatz-ID des Fonds, der mit der Geschenkteilung verknüpft ist.
value	gift_aid_amount.value	double	Der Geldwert.
Qualifikationsstatus der Geschenkbeihilfe	gift_aid_qualification_status	string	Der Qualifikationsstatus der Geschenkhilfe für die Geschenkteilung. Verfügbare Werte sind: "Qualified" und "NotQualified". Nur für Großbritannien.
Paket-ID	package_id	string	Die Systemdatensatz-ID des Pakets, das dem Geschenkteil zugeordnet ist.

GiftApi.ReceiptRead

Rechnung

Name	Pfad	Typ	Beschreibung
value	amount.value	double	Der Geldwert.
date	date	date-time	Das Datum für den Beleg.
number	number	integer	Die Nummer des Belegs.
status	status	string	Der Status des Belegs. Verfügbare Werte sind: RECEIPTED, NEEDSRECEIPT und DONOTRECEIPT.

GiftApi.PaymentRead

Zahlung

Name	Pfad	Typ	Beschreibung
Kontotoken	account_token	string	Die tokenisierten Kontoinformationen (z. B. Kreditkarte) vom externen Zahlungsanbieter. Gilt nur für Zahlungsmethoden von "CreditCard" und "DirectDebit".
BBPS-Konfigurations-ID	bbps_configuration_id	string	Die BBPS-Konfigurations-ID. Gilt nur für Zahlungsmethoden von "CreditCard" und "DirectDebit".
BBPS-Transaktions-ID	bbps_transaction_id	string	Die BBPS-Transaktions-ID. Gilt nur für Zahlungsmethoden von "CreditCard" und "DirectDebit".
Tag	check_date.d	integer	Der Tag im Fuzzydatum.
Monat	check_date.m	integer	Der Monat im Fuzzydatum.
Jahr	check_date.y	integer	Das Jahr im Fuzzydatum.
Prüfnummer	check_number	string	Die Prüfnummer. Gilt nur für zahlungsmethoden von "PersonalCheck".
Transaktions-ID auschecken	checkout_transaction_id	string	Die Transaktions-ID des Auscheckens. Gilt nur für Zahlungsmethoden von "CreditCard" und "DirectDebit".
Zahlungsmethode	payment_method	string	Die Zahlungsmethode. Die verfügbaren Werte sind unten aufgeführt.
reference	reference	string	Der Verweis. Gilt nur für zahlungsmethoden von "Other".
Tag	reference_date.d	integer	Der Tag im Fuzzydatum.
Monat	reference_date.m	integer	Der Monat im Fuzzydatum.
Jahr	reference_date.y	integer	Das Jahr im Fuzzydatum.

GiftApi.SoftCreditRead

Soft credit

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des Soft credit.
value	amount.value	double	Der Geldwert.
Bestandteil-ID	constituent_id	string	Die Systemdatensatz-ID des Bestandteils, der dem Soft credit zugeordnet ist.
Geschenk-ID	gift_id	string	Die Systemdatensatz-ID des Geschenks, das dem Softguthaben zugeordnet ist.

GiftBatchApi.ApiCollectionOfGiftBatch

Geschenkbatches

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Gesamtzahl der Geschenkbatches in der Antwort.
value	value	array of GiftBatchApi.GiftBatch	Der Satz von Elementen, die in der Antwort enthalten sind.

GiftBatchApi.CreatedBatch

Erstellter Geschenkbatch

Name	Pfad	Typ	Beschreibung
ID	batch_id	string	Die Systemdatensatz-ID des neu erstellten Geschenkbatches.

GiftBatchApi.GiftBatch

Stellt das Geschenkbatchobjekt dar.

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des Batches.
Beschreibung	batch_description	string	Die Batchbeschreibung.
Batchnummer	batch_number	string	Die Batchnummer
Projizierte Zahl	projected_number_of_gifts	integer	Die projizierte Anzahl von Geschenken im Batch.
Ist-Zahl	number_of_gifts	integer	Die tatsächliche Anzahl der Geschenke in der Charge.
Projizierter Betrag	projected_amount	double	Der projizierte Wert von Geschenken im Batch.
Istbestand	actual_amount	double	Der tatsächliche Wert von Geschenken in der Charge.
hat Ausnahmen?	has_exceptions	boolean	Hat der Batch Ausnahmen?
gebilligt?	is_approved	boolean	Ist der Batch genehmigt?
Erstellt von	created_by	string	Der Name des Benutzers, der den Batch erstellt hat.
Erstellt am	created_on	date-time	Das Datum, an dem der Batch erstellt wurde.

ListApi.CreatedList

Liste erstellt

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Liste.

OpportunityApi.ApiCollectionOfOpportunityAttachmentRead

Attachments

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of OpportunityApi.OpportunityAttachmentRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead

Benutzerdefinierte Felder

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of OpportunityApi.OpportunityCustomFieldRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

OpportunityApi.ApiCollectionOfOpportunityRead

Gelegenheiten

Name	Pfad	Typ	Beschreibung
Anzahl	count	integer	Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.
value	value	array of OpportunityApi.OpportunityRead	Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

OpportunityApi.CreatedOpportunity

Erstellte Verkaufschance

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Verkaufschance.

OpportunityApi.CreatedOpportunityAttachment

Anlage zum Erstellen einer Verkaufschance

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Verkaufschancenanlage.

OpportunityApi.CreatedOpportunityCustomField

Anlage zum Erstellen einer Verkaufschance

Name	Pfad	Typ	Beschreibung
ID	id	string	Die ID der neu erstellten Verkaufschancenanlage.

OpportunityApi.Fundraiser

Fundraiser

Name	Pfad	Typ	Beschreibung
Bestandteil-ID	constituent_id	string	Die Systemdatensatz-ID des Bestandteils, der dem Fundraiser zugeordnet ist.
value	credit_amount.value	double	Der Geldwert.

OpportunityApi.OpportunityAttachmentRead

Attachment

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Anlage.
Verkaufschancen-ID	parent_id	string	Die Systemdatensatz-ID der Verkaufschance, die der Anlage zugeordnet ist.
Typ	type	string	Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet.
Name	name	string	Der Name der Anlage. Zeichenlimit: 150.
Datum	date	date-time	Das Datum der Anlage.
URL	url	string	Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.
Dateiname	file_name	string	Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Datei-ID	file_id	string	Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-ID	thumbnail_id	string	Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen.
Miniaturansichts-URL	thumbnail_url	string	Die URL für eine Miniaturansicht. Nur für physische Anlagen, die Bilder sind. Enthält eine zeitgebundene Signatur, die den Zugriff auf 60 Minuten beschränkt.
Inhaltstyp	content_type	string	Der Inhaltstyp. Nur für physische Anlagen.
Dateigröße	file_size	integer	Die Dateigröße in Byte. Nur für physische Anlagen.

OpportunityApi.OpportunityCustomFieldRead

Benutzerdefiniertes Feld

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID des benutzerdefinierten Felds.
Verkaufschancen-ID	parent_id	string	Die Systemdatensatz-ID der Verkaufschance, die dem benutzerdefinierten Feld zugeordnet ist.
Kategorie	category	string	Die Kategorie des benutzerdefinierten Felds.
Typ	type	string	Der Datentyp, den das benutzerdefinierte Feld darstellt.
Wert	value		Der Wert des benutzerdefinierten Felds.
Datum	date	date	Das Datum im benutzerdefinierten Feld.
Kommentar	comment	string	Der Kommentar für das benutzerdefinierte Feld. Zeichenlimit: 50.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem das benutzerdefinierte Feld erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem das benutzerdefinierte Feld zuletzt geändert wurde.

OpportunityApi.OpportunityRead

Gelegenheit

Name	Pfad	Typ	Beschreibung
ID	id	string	Die Systemdatensatz-ID der Verkaufschance.
Bestandteil-ID	constituent_id	string	Die Systemdatensatz-ID des Bestandteils, der der Verkaufschance zugeordnet ist.
Zweck	purpose	string	Die beabsichtigte Verwendung für jedes Geld, das infolge der Verkaufschance erhoben wurde.
Name	name	string	Der Name, der die Verkaufschance im gesamten Programm identifiziert, z. B. in Listen oder in Bestandteilen. Zeichenlimit: 255.
Der Status	status	string	Der Status, der angibt, wo sich die Verkaufschance im Solicitation-Prozess befindet.
Deadline	deadline	date-time	Das Zieldatum für die Gelegenheit, zu einem Geschenk zu führen.
Fragedatum	ask_date	date-time	Das Datum, an dem die Aufforderung gestellt wurde.
value	ask_amount.value	double	Der Geldwert.
Erwartetes Datum	expected_date	date-time	Das Datum, an dem die Aussicht als Reaktion auf die Verkaufschance erwartet wird.
value	expected_amount.value	double	Der Geldwert.
Finanzierter Termin	funded_date	date-time	Das Datum, an dem die Aussicht als Reaktion auf die Chance gegeben hat.
value	funded_amount.value	double	Der Geldwert.
Kampagnen-ID	campaign_id	string	Die Systemdatensatz-ID der Kampagne, die der Verkaufschance zugeordnet ist. Die Kampagne legt die Gesamtziele für die Geldbeschaffung fest.
Fund-ID	fund_id	string	Die Systemdatensatz-ID des Fonds, der der Verkaufschance zugeordnet ist. Der Fonds bestimmt den spezifischen finanziellen Zweck eines Geschenks und identifiziert das Finanzkonto für dieses Geschenk.
Fundraiser(en)	fundraisers	array of OpportunityApi.Fundraiser	Die Gruppe von Systemdatensatz-IDs für die Fundraiser, die der Verkaufschance zugewiesen wurden.
Inaktiv?	inactive	boolean	Ist die Chance inaktiv?
linked_gifts	linked_gifts	array of string	Die Systemdatensatz-IDs der Geschenke im Zusammenhang mit der Verkaufschance.
Datum hinzugefügt	date_added	date-time	Das Datum, an dem die Verkaufschance erstellt wurde.
Änderungsdatum	date_modified	date-time	Das Datum, an dem die Verkaufschance zuletzt geändert wurde.

Freigeben über

Blackbaud Raisers Edge NXT (Vorschau)

Voraussetzungen

Wie erhalten Sie Anmeldeinformationen?

Bekannte Probleme und Einschränkungen

Drosselungsgrenzwerte

Aktionen

Abrufen der Lebenszeit des Bestandteils

Parameter

Gibt zurück

Abrufen des Status des konstituierenden Aussichts

Parameter

Gibt zurück

Abrufen einer Kampagne

Parameter

Gibt zurück

Abrufen einer konstituierenden Aktion

Parameter

Gibt zurück

Abrufen eines Bestandteils

Parameter

Gibt zurück

Abrufen eines Ereignisses

Parameter

Gibt zurück

Abrufen eines Fonds

Parameter

Gibt zurück

Abrufen eines Konstituierenden Profilbilds

Parameter

Gibt zurück

Abrufen eines Pakets

Parameter

Gibt zurück

Abrufen eines Teilnehmers

Parameter

Gibt zurück

Aktualisieren der Details zur Geschenkbestätigung

Parameter

Aktualisieren einer Aktionsanlage

Parameter

Aktualisieren einer Beschwerdeanfügung

Parameter

Aktualisieren einer Bestandteil-Onlinepräsenz

Parameter

Aktualisieren einer Bestandteiladresse

Parameter

Aktualisieren einer Bestandteilanlage

Parameter

Aktualisieren einer bestandteilen E-Mail-Adresse

Parameter

Aktualisieren einer bestandteilen Notiz

Parameter

Aktualisieren einer Fondsanlage

Parameter

Aktualisieren einer Geschenkanlage

Parameter

Aktualisieren einer Kampagnenanlage

Parameter

Aktualisieren einer konstituierenden Aktion

Parameter

Aktualisieren einer Konstituierenden Beziehung

Parameter

Aktualisieren einer Teilerziehung

Parameter

Aktualisieren einer Teilnehmeroption

Parameter

Aktualisieren einer Verkaufschance

Parameter

Aktualisieren einer Verkaufschancenanlage

Parameter

Aktualisieren eines benutzerdefinierten Aktionsfelds

Parameter

Aktualisieren eines benutzerdefinierten Berufungsfelds

Parameter

Aktualisieren eines benutzerdefinierten Bestandteilfelds

Parameter

Aktualisieren eines benutzerdefinierten Fondsfelds

Parameter

Aktualisieren eines benutzerdefinierten Geschenkfelds