Freigeben über

Almabase (Vorschau)

Almabase ist die weltweit beliebtesten Alumni-Management-Software, um Alumni-zentrierte Programme zu erstellen, um die Teilnahme, das Engagement der Spender zu erhöhen und ansprechende Online-Communitys zu hosten.

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 Almabase-Unterstützung
URL https://docs.almabase.com
Email help@almabase.com
Connectormetadaten
Herausgeber Almabase, Inc.
Webseite https://almabase.com
Datenschutzrichtlinie https://www.almabase.com/ecloud-privacy-policy
Kategorien Vertrieb und CRM; Produktivität

Almabase bietet Softwaretools und Strategien für Bildungseinrichtungen, um Alumni-orientierte Programme zu erstellen, die ungegagierte Alumni zum Leben werden.

Dieser Connector basiert auf Almabase-APIs & Webhooks und stellt Vorgänge bereit, mit denen Entitäten in Almabase verwaltet werden können, darunter:

  • Datensatz (Bestandteile)
  • Geschenke
  • Ereignisse
  • Engagement Touchpoints
  • Formulare
  • Geldmittel
  • Geben von Seiten
  • Peer-to-Peer-Spendenkampagnen
  • und mehr…

Voraussetzungen

Um diesen Connector zu verwenden,

  • Sie müssen über ein aktives Almabase-Abonnement verfügen.
  • Sie müssen über die Rolle des Websiteadministrators verfügen.

So erhalten Sie Anmeldeinformationen

  • Melden Sie sich bei Ihrem Admin-Portal an, das von Almabase bereitgestellt wird.
  • Navigieren Sie zu API's & Tokens "Unter Settings".
  • Klicken Sie auf Add Auth Token, und füllen Sie das descriptionToken aus, und geben Sie es ein expiry date & time.
  • Notieren Sie sich den Workflow Access Token Wert (klicken Sie auf das Token, das in die Zwischenablage kopiert werden soll).
  • Verwenden Sie beim Workflow Access Token Erstellen der neuen Verbindung in Power Automate.

Erste Schritte mit Ihrem Connector

Häufige Anwendungsfälle

  • Wenn ein Geschenk erstellt wird, senden Sie eine personalisierte Nachricht und Geschenkbestätigung.
  • Wenn eine Engagement-Aktivität auf Slack, Gmail oder anderen sozialen Medien aufgezeichnet wird, fügen Sie die Engagement-Aktivität mithilfe einer Create Custom Touchpoint Aktion zu Engagement Studio auf Almabase hinzu.
  • Wenn eine neue E-Mail-Adresse (verlorene Alumni) in einem Geschenk oder einer Ereignisregistrierung oder einer Formularübermittlung gefunden wird, fügen Sie diese E-Mail-Adresse einem Datensatz auf Almabase oder einem Bestandteil von Raiser es Edge oder einem Kontakt in Salesforce hinzu.
  • Entwerfen Sie die bidirektionale Datensynchronisierung zwischen Almabase und Blackbaud Raiser es Edge.
  • Entwerfen Sie die bidirektionale Datensynchronisierung zwischen Almabase und Salesforce.

Bekannte Probleme und Einschränkungen

  • Geschenkauslöser funktionieren nur, wenn die Onlinezahlung auf Almabase erfolgt. Manuell hinzugefügte Geschenke würden die Flüsse nicht auslösen.

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:
Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

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

Name Typ Description Erforderlich
Domänen-URL Schnur Geben Sie Ihre Almabase-Domänen-URL an, z. B. https://your.domain.com Richtig
API-Schlüssel securestring Der API-Schlüssel des Benutzers Richtig

Drosselungsgrenzwerte

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

Aktionen

Abrufen einer E-Mail-Adresse eines Datensatzes

Gibt Informationen zu einer E-Mail-Adresse eines Datensatzes zurück.
Abrufen einer Geben-Seite

Gibt Informationen zu einer gegebenen Seite zurück.
Abrufen einer Übermittlung eines Formulars

Gibt Informationen zu einer Formularübermittlung zurück.
Abrufen eines Datensatzes

Gibt Informationen zu einem Datensatz zurück.
Abrufen eines Ereignisses

Gibt Informationen zu einem Ereignis zurück.
Abrufen eines Fonds

Gibt Informationen zu einem Fonds zurück.
Aktualisieren einer E-Mail-Adresse eines Datensatzes

Aktualisiert die Felder der E-Mail-Adresse eines Datensatzes.
Aktualisieren einer Kontaktperson

Aktualisiert eine Kontaktperson für ein Ereignis.
Aktualisieren eines Datensatzes

Aktualisiert einen Datensatz.
Aktualisieren eines Ereignisses

Aktualisiert ein Ereignis.
Aktualisieren eines Fonds

Aktualisiert einen Fonds.
Aktualisieren eines Geschenks

Aktualisiert ein Geschenk
Auflisten von E-Mail-Adressen eines Datensatzes

Gibt eine Liste der E-Mail-Adressen für einen Datensatz zurück.
Auflisten von Guthaben

Gibt eine Liste von Guthaben zurück.
Datensatz erstellen

Erstellt einen neuen Datensatz.
Datensätze auflisten

Gibt eine Liste von Datensätzen zurück.
Ereignis erstellen

Erstellt ein neues Ereignis.
Erstellen einer E-Mail-Adresse für einen Datensatz

Erstellt eine neue E-Mail-Adresse für einen Datensatz.
Erstellen eines Fonds

Erstellt einen neuen Fonds.
Erstellen eines Geschenks

Erstellt ein neues Geschenk.
Erstellen eines Touchpoints

Senden Sie einen neuen benutzerdefinierten Touchpoint an Almabase.
Geben von Seiten auflisten

Gibt eine Liste der Geben-Seiten zurück.
Geschenk erhalten

Gibt Informationen zu einem Geschenk zurück.
Geschenke auflisten

Gibt eine Liste von Geschenken zurück.
Hinzufügen einer Kontaktperson

Fügt einer Veranstaltung eine Kontaktperson hinzu.
Kontaktpersonen auflisten

Gibt eine Liste aller Kontaktpersonen für ein Ereignis zurück.
Listenformulare

Dient zum Abrufen einer Liste von Formularen.
Löschen einer E-Mail-Adresse eines Datensatzes

Löschen einer E-Mail-Adresse eines Datensatzes.
Senden eines Formulars

Erstellt eine neue Formularübermittlung für ein Formular
Veranstaltungen auflisten

Gibt eine Liste aller Ereignisse zurück.

Abrufen einer E-Mail-Adresse eines Datensatzes

Vorgangs-ID:
GetRecordEmailAddress

Gibt Informationen zu einer E-Mail-Adresse eines Datensatzes zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Datensatzkennung
 record_id True integer

Vom System generierte ID, um einen Datensatz eindeutig zu identifizieren.
ID
 email_id True integer

Vom System generierte ID, um eine E-Mail-Adresse eines Datensatzes eindeutig zu identifizieren.

Gibt zurück

E-Mail-Adresse

Body
v1.RecordApi.EmailAddressRead

Abrufen einer Geben-Seite

Vorgangs-ID:
GetGivingPage

Gibt Informationen zu einer gegebenen Seite zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Geben der Seiten-ID
 id True integer

Vom System generierte ID, um eine gebende Seite eindeutig zu identifizieren.
Felder
 fields array

Die durch Trennzeichen getrennte Liste der Felder in der Antwort.

Gibt zurück

Seite geben

Body
v1.GivingApi.GivingPageRead

Abrufen einer Übermittlung eines Formulars

Vorgangs-ID:
GetFormEntry

Gibt Informationen zu einer Formularübermittlung zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Formular
 form_id True integer

Vom System generierte ID, um ein Formular eindeutig zu identifizieren.
Antwort-ID
 entry_id True string

Vom System generierte ID, um eine Formularübermittlung eindeutig zu identifizieren.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Abrufen eines Datensatzes

Vorgangs-ID:
GetRecord

Gibt Informationen zu einem Datensatz zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Datensatzkennung
 id True integer

Vom System generierte ID, um einen Datensatz eindeutig zu identifizieren.
Felder
 fields array

Die durch Trennzeichen getrennte Liste der Felder in der Antwort.

Gibt zurück

Datensatz (record)

Body
v1.RecordApi.RecordRead

Abrufen eines Ereignisses

Vorgangs-ID:
GetEvent

Gibt Informationen zu einem Ereignis zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Ereignis-ID
 id True integer

Vom System generierte ID, um ein Ereignis eindeutig zu identifizieren.
Felder
 fields array

Die durch Trennzeichen getrennte Liste der Felder in der Antwort.

Gibt zurück

Event

Body
v1.EventApi.EventRead

Abrufen eines Fonds

Vorgangs-ID:
GetFund

Gibt Informationen zu einem Fonds zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Fund-ID
 id True integer

Vom System generierte ID, um einen Fonds eindeutig zu identifizieren.
Felder
 fields array

Die durch Trennzeichen getrennte Liste der Felder in der Antwort.

Gibt zurück

Der Fonds, der mit dem Geschenk split verbunden ist.

Fonds
v1.GivingApi.FundRead

Aktualisieren einer E-Mail-Adresse eines Datensatzes

Vorgangs-ID:
UpdateRecordEmailAddress

Aktualisiert die Felder der E-Mail-Adresse eines Datensatzes.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Datensatzkennung
 record_id True integer

Vom System generierte ID, um einen Datensatz eindeutig zu identifizieren.
E-Mail-Adress-ID
 email_id True integer

Vom System generierte ID, um eine E-Mail-Adresse eines Datensatzes eindeutig zu identifizieren.
Wird für die Anmeldung verwendet?
 is_login_email boolean

Gibt an, ob der Benutzer sich mit dieser E-Mail-Adresse bei der Plattform anmelden darf.
Ist primär?
 is_primary boolean

Eine primäre E-Mail wird verwendet, um die vom System ausgelösten automatisierten E-Mails zu senden. Es wird auch verwendet, um die Massen-E-Mail an das Profil zu senden. Es ist obligatorisch, dass nur eine E-Mail als primär festgelegt ist.
Der Status
 status string

Status der E-Mail-Adresse
Typ
 type string

Der Typ der E-Mail

Gibt zurück

E-Mail-Adresse

Body
v1.RecordApi.EmailAddressRead

Aktualisieren einer Kontaktperson

Vorgangs-ID:
UpdateEventContactPerson

Aktualisiert eine Kontaktperson für ein Ereignis.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Ereignis-ID
 id True integer

Vom System generierte ID, um ein Ereignis eindeutig zu identifizieren.
Ereigniskontaktperson-ID
 person_id True integer

Vom System generierte ID, um eine Kontaktperson für ein Ereignis eindeutig zu identifizieren.
Email
 email email

E-Mail der Kontaktperson
Name
 name string

Name der Kontaktperson
Rufnummer
 phone_number string

Telefonnummer der Kontaktperson

Gibt zurück

Ansprechpartner eines Ereignisses

Body
v1.EventApi.ContactPersonRead

Aktualisieren eines Datensatzes

Vorgangs-ID:
UpdateRecord

Aktualisiert einen Datensatz.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Datensatzkennung
 id True integer

Vom System generierte ID, um einen Datensatz eindeutig zu identifizieren.
Id der externen Datenbank
 external_database_id string

Ein System, dem die eindeutige ID für den Datensatz durch die externe Datenbank zugewiesen wurde. z. B. System Record ID für Raiser Edge NXT, Kontakt-ID für Salesforce
Nachschlage-ID für externe Datenbank
 external_database_lookup_id string

Eine benutzerdefinierte benutzerdefinierte Nachschlage-ID für den Datensatz in der externen Datenbank. z. B. Bestandteil-ID
Vorname
 first_name string

Vorname des Datensatzes.
Nachname
 last_name string

Nachname des Datensatzes.

Gibt zurück

Datensatz (record)

Body
v1.RecordApi.RecordRead

Aktualisieren eines Ereignisses

Vorgangs-ID:
UpdateEvent

Aktualisiert ein Ereignis.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Ereignis-ID
 id True integer

Vom System generierte ID, um ein Ereignis eindeutig zu identifizieren.
Description
 description string

Beschreibung des Ereignisses.
Endzeit
 end_datetime string

Endzeit des Ereignisses
Id der externen Datenbank
 external_database_id string

Ein System, dem die eindeutige ID für den Datensatz durch die externe Datenbank zugewiesen wurde. z. B. System Record ID für Raiser Edge NXT, Kontakt-ID für Salesforce
Url der externen Registrierung
 external_registration_url string

Die Registrierungs-URL des Ereignisses auf einer externen Website
Name
 name string

Name des Ereignisses
Startzeit
 start_datetime string

Startzeit des Ereignisses
Timezone
 timezone string

Zeitzone des Ereignisses
Name
 display_name string

Stadt,Bundesland,Land des Veranstaltungsorts

Gibt zurück

Event

Body
v1.EventApi.EventRead

Aktualisieren eines Fonds

Vorgangs-ID:
UpdateFund

Aktualisiert einen Fonds.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Fund-ID
 id True integer

Vom System generierte ID, um einen Fonds eindeutig zu identifizieren.
Id der externen Datenbank
 external_database_id string

Ein System, dem eine eindeutige ID für den Fonds durch die externe Datenbank zugewiesen wurde. z. B. System Record ID für Raiser Edge NXT, Objekt-ID für Salesforce
Ist der Standardfonds?
 is_default boolean

Gibt an, dass alle Splits diesem Fonds zugeordnet werden, wenn auf der Spendenseite keine anderen Mittel definiert sind.
Ist anderer Fonds?
 is_other_fund boolean

Gibt an, dass die Geber dieses Fonds einen benutzerdefinierten Fondsnamen gegeben haben.
Name des Fonds
 name True string

Name des Fonds

Gibt zurück

Der Fonds, der mit dem Geschenk split verbunden ist.

Fonds
v1.GivingApi.FundRead

Aktualisieren eines Geschenks

Vorgangs-ID:
UpdateGift

Aktualisiert ein Geschenk

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Geschenk-ID
 id True integer

Vom System generierte ID, um ein Geschenk eindeutig zu identifizieren.
Batchnummer
 batch_number string

Die Batchnummer des Geschenks.
Spenderadresse: Zeile 1
 donor_address_line1 string

Die Adresse Zeile 1, die vom Spender für das Geschenk verwendet wird.
Spenderadresse: Zeile 2
 donor_address_line2 string

Die Adresse Zeile 2, die vom Spender für das Geschenk verwendet wird.
Name: Stadt, Bundesland, Land
 name string

Die Stadt des Spenders. Format: Ortsname, Kurzstaatsname, Kurzlandname
Spendername
 donor_name string

Vollständiger Name des Spenders.
Spendertelefonnummer
 donor_phone_number string

Telefonnummer, die vom Spender für das Geschenk verwendet wird.
Spenderadresse: Postleitzahl
 donor_zip_code string

Die Postleitzahl der Adresse, die vom Spender für das Geschenk verwendet wird.
Ist von Leaderboard ausgeblendet?
 exclude_from_leaderboard boolean

Ist von Leaderboard ausgeblendet?
Id der externen Datenbank
 external_database_id string

Ein System, dem eine eindeutige ID für das Geschenk durch die externe Datenbank zugewiesen wurde.
Ehrungsnachricht
 honor_message string

Eine Botschaft für eine Geschenkwürdigung.
Ehrenpräfix
 honor_prefix string

Ein Präfix für eine Geschenkwürdigung. Verfügbare Optionen sind in_honor_of, in_memory_of, in_support_of
Ist anonym?
 is_anonymous boolean

Gibt an, dass der Wunsch des Spenders anonym für andere Spender für dieses Geschenk sein soll.
Hinweis
 note string

Der Notiztext.
Sonstiger Fondsname
 other_fund_name string

Wenn der Spender einen Fonds auswählt, der als is_other_fund gekennzeichnet ist, fügen sie einen benutzerdefinierten Fondsnamen hinzu, um das Geschenk zuzuordnen.
Seite geben
 id integer

Vom System generierte ID, um eine gebende Seite eindeutig zu identifizieren.
ID
 id integer

Vom System generierte ID, um einen Datensatz eindeutig zu identifizieren.
Betrag
 amount True string

Der Betrag des Geschenks, der geteilt wird.
Fonds
 id True integer

Vom System generierte ID, um einen Fonds eindeutig zu identifizieren.

Gibt zurück

Geschenk

Body
v1.GivingApi.GiftRead

Auflisten von E-Mail-Adressen eines Datensatzes

Vorgangs-ID:
ListRecordEmailAddresses

Gibt eine Liste der E-Mail-Adressen für einen Datensatz zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Datensatzkennung
 record_id True integer

Vom System generierte ID, um einen Datensatz eindeutig zu identifizieren.
Ist primär?
 is_primary boolean

Suchen Sie nach primärer E-Mail.
Felder
 fields array

Die durch Trennzeichen getrennte Liste der Felder in der Antwort.
Seitenformat
 page_size integer

Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 10. Das Maximum beträgt 50.
Seitennummer
 page integer

Stellt die Seitenzahlen (Offset) dar. Zur Verwendung mit Paginierung.

Gibt zurück

Name Pfad Typ Beschreibung
URL der nächsten Ergebnisse
 nextlink uri

URL für den nächsten Seitensatz von Ergebnissen. Zur Verwendung mit Paginierung.
URL der vorherigen Ergebnisse
 previouslink uri

URL für den vorherigen Ergebnissatz. Zur Verwendung mit Paginierung.
E-Mail-Adressen insgesamt
 total integer

Gesamtzahl der E-Mail-Adressen für die angegebenen Filter
E-Mail-Adresse
 value array of v1.RecordApi.EmailAddressRead

Liste der E-Mail-Adresse eines Datensatzes, der für die angegebenen Filter zurückgegeben wird. Die Ergebnisse werden paginiert.

Auflisten von Guthaben

Vorgangs-ID:
ListFunds

Gibt eine Liste von Guthaben zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Felder
 fields array

Die durch Trennzeichen getrennte Liste der Felder in der Antwort.

Gibt zurück

response
array of v1.GivingApi.FundRead

Datensatz erstellen

Vorgangs-ID:
CreateRecord

Erstellt einen neuen Datensatz.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Zeile 1
 line1 True string

Zeile 1 der Adresse
Zeile 2
 line2 string

Zeile 2 der Adresse
Name
 name string

Stadt,Bundesland,Land des Standorts
Datenschutz
 privacy string

Privatsphäre
Typ
 type True string

Typ der Zahl
Postleitzahl
 zip_code string

Postleitzahl der Adresse
Geburtsdatum
 date_of_birth string

Geburtsdatum.
Verstorben
 deceased boolean

Verstorben.
Adresse
 address email

Die E-Mail-Adresse
Wird für die Anmeldung verwendet?
 is_login_email boolean

Gibt an, ob der Benutzer sich mit dieser E-Mail-Adresse bei der Plattform anmelden darf.
Ist primär?
 is_primary boolean

Eine primäre E-Mail wird verwendet, um die vom System ausgelösten automatisierten E-Mails zu senden. Es wird auch verwendet, um die Massen-E-Mail an das Profil zu senden. Es ist obligatorisch, dass nur eine E-Mail als primär festgelegt ist.
Quelle
 source string

Die Quelle gibt an, wie die E-Mail der Datenbank hinzugefügt wird.
Der Status
 status string

Status der E-Mail-Adresse
Typ
 type string

Der Typ der E-Mail
Id der externen Datenbank
 external_database_id string

Ein System, dem die eindeutige ID für den Datensatz durch die externe Datenbank zugewiesen wurde. z. B. System Record ID für Raiser Edge NXT, Kontakt-ID für Salesforce
Nachschlage-ID für externe Datenbank
 external_database_lookup_id string

Eine benutzerdefinierte benutzerdefinierte Nachschlage-ID für den Datensatz in der externen Datenbank. z. B. Bestandteil-ID
Vorname
 first_name True string

Vorname des Datensatzes.
Nachname
 last_name True string

Nachname des Datensatzes.
Zweitname
 middle_name string

Zweiter Name des Datensatzes.
Number
 number True string

Number
Datenschutz
 privacy string

Privatsphäre
Typ
 type True string

Typ der Zahl

Gibt zurück

Datensatz (record)

Body
v1.RecordApi.RecordRead

Datensätze auflisten

Vorgangs-ID:
ListRecords

Gibt eine Liste von Datensätzen zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach Name suchen
 search string

Suchen Sie nach Datensätzen nach Namen.
Nach E-Mail-Adresse suchen
 email_addresses__address string

Suchen Sie nach Datensätzen nach E-Mail-Adresse.
Nach externer Datenbank-ID suchen
 external_database_id string

Suchen Sie nach Datensätzen nach externer Datenbank-ID.
Felder
 fields array

Die durch Trennzeichen getrennte Liste der Felder in der Antwort.
Aktualisiert am oder nach
 updated_at__gte date-time

Aktualisiert am oder nach einem Datum.
Erstellt am oder nach
 created_at__gte date-time

Erstellt am oder nach einem Datum.
Seitenformat
 page_size integer

Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 10. Das Maximum beträgt 50.
Seitennummer
 page integer

Stellt die Seitenzahlen (Offset) dar. Zur Verwendung mit Paginierung.

Gibt zurück

Name Pfad Typ Beschreibung
URL der nächsten Ergebnisse
 nextlink uri

URL für den nächsten Seitensatz von Ergebnissen. Zur Verwendung mit Paginierung.
URL der vorherigen Ergebnisse
 previouslink uri

URL für den vorherigen Ergebnissatz. Zur Verwendung mit Paginierung.
Datensätze insgesamt
 total integer

Gesamtdatensätze für die angegebenen Filter
Datensätze
 value array of v1.RecordApi.RecordRead

Liste der Datensätze eines Datensatzes, der für die angegebenen Filter zurückgegeben wird.

Ereignis erstellen

Vorgangs-ID:
CreateEvent

Erstellt ein neues Ereignis.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Description
 description string

Beschreibung des Ereignisses.
Endzeit
 end_datetime string

Endzeit des Ereignisses
Id der externen Datenbank
 external_database_id string

Ein System, dem die eindeutige ID für den Datensatz durch die externe Datenbank zugewiesen wurde. z. B. System Record ID für Raiser Edge NXT, Kontakt-ID für Salesforce
Url der externen Registrierung
 external_registration_url string

Die Registrierungs-URL des Ereignisses auf einer externen Website
Name
 name True string

Name des Ereignisses
Startzeit
 start_datetime string

Startzeit des Ereignisses
Timezone
 timezone string

Zeitzone des Ereignisses
Name
 display_name string

Stadt,Bundesland,Land des Veranstaltungsorts

Gibt zurück

Event

Body
v1.EventApi.EventRead

Erstellen einer E-Mail-Adresse für einen Datensatz

Vorgangs-ID:
CreateRecordEmailAddress

Erstellt eine neue E-Mail-Adresse für einen Datensatz.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Datensatzkennung
 record_id True integer

Vom System generierte ID, um einen Datensatz eindeutig zu identifizieren.
Adresse
 address email

Die E-Mail-Adresse
Wird für die Anmeldung verwendet?
 is_login_email boolean

Gibt an, ob der Benutzer sich mit dieser E-Mail-Adresse bei der Plattform anmelden darf.
Ist primär?
 is_primary boolean

Eine primäre E-Mail wird verwendet, um die vom System ausgelösten automatisierten E-Mails zu senden. Es wird auch verwendet, um die Massen-E-Mail an das Profil zu senden. Es ist obligatorisch, dass nur eine E-Mail als primär festgelegt ist.
Quelle
 source string

Die Quelle gibt an, wie die E-Mail der Datenbank hinzugefügt wird.
Der Status
 status string

Status der E-Mail-Adresse
Typ
 type string

Der Typ der E-Mail

Gibt zurück

E-Mail-Adresse

Body
v1.RecordApi.EmailAddressRead

Erstellen eines Fonds

Vorgangs-ID:
CreateFund

Erstellt einen neuen Fonds.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id der externen Datenbank
 external_database_id string

Ein System, dem eine eindeutige ID für den Fonds durch die externe Datenbank zugewiesen wurde. z. B. System Record ID für Raiser Edge NXT, Objekt-ID für Salesforce
Ist der Standardfonds?
 is_default boolean

Gibt an, dass alle Splits diesem Fonds zugeordnet werden, wenn auf der Spendenseite keine anderen Mittel definiert sind.
Ist anderer Fonds?
 is_other_fund boolean

Gibt an, dass die Geber dieses Fonds einen benutzerdefinierten Fondsnamen gegeben haben.
Name des Fonds
 name True string

Name des Fonds

Gibt zurück

Der Fonds, der mit dem Geschenk split verbunden ist.

Fonds
v1.GivingApi.FundRead

Erstellen eines Geschenks

Vorgangs-ID:
CreateGift

Erstellt ein neues Geschenk.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Geschenkbetrag
 amount True string

Der Geschenkbetrag mit zwei Dezimalstellen.
Batchnummer
 batch_number string

Die Batchnummer des Geschenks.
Geschenkdatum
 completed_at True date-time

Das Datum, an dem der Status des Geschenks als abgeschlossen gekennzeichnet ist.
Währung
 currency True integer

Währung, die vom Spender für das Geschenk verwendet wird.
Spenderadresse: Zeile 1
 donor_address_line1 string

Die Adresse Zeile 1, die vom Spender für das Geschenk verwendet wird.
Spenderadresse: Zeile 2
 donor_address_line2 string

Die Adresse Zeile 2, die vom Spender für das Geschenk verwendet wird.
Name: Stadt, Bundesland, Land
 name string

Die Stadt des Spenders. Format: Ortsname, Kurzstaatsname, Kurzlandname
Spender-E-Mail
 donor_email True email

E-Mail-ID, die vom Spender für das Geschenk verwendet wird.
Spendername
 donor_name True string

Vollständiger Name des Spenders.
Spendertelefonnummer
 donor_phone_number string

Telefonnummer, die vom Spender für das Geschenk verwendet wird.
Spenderadresse: Postleitzahl
 donor_zip_code string

Die Postleitzahl der Adresse, die vom Spender für das Geschenk verwendet wird.
Ist von Leaderboard ausgeblendet?
 exclude_from_leaderboard boolean

Ist von Leaderboard ausgeblendet?
Id der externen Datenbank
 external_database_id string

Ein System, dem eine eindeutige ID für das Geschenk durch die externe Datenbank zugewiesen wurde.
Ehrungsnachricht
 honor_message string

Eine Botschaft für eine Geschenkwürdigung.
Ehrenpräfix
 honor_prefix string

Ein Präfix für eine Geschenkwürdigung. Verfügbare Optionen sind in_honor_of, in_memory_of, in_support_of
Ist anonym?
 is_anonymous boolean

Gibt an, dass der Wunsch des Spenders anonym für andere Spender für dieses Geschenk sein soll.
Zahlungsmodus
 mode True string

Zahlungsmodus, entweder online oder offline.
Hinweis
 note string

Der Notiztext.
Sonstiger Fondsname
 other_fund_name string

Wenn der Spender einen Fonds auswählt, der als is_other_fund gekennzeichnet ist, fügen sie einen benutzerdefinierten Fondsnamen hinzu, um das Geschenk zuzuordnen.
Seite geben
 id integer

Vom System generierte ID, um eine gebende Seite eindeutig zu identifizieren.
ID
 id integer

Vom System generierte ID, um einen Datensatz eindeutig zu identifizieren.
Betrag
 amount True string

Der Betrag des Geschenks, der geteilt wird.
Fonds
 id True integer

Vom System generierte ID, um einen Fonds eindeutig zu identifizieren.
Der Status
 status True string

Status des Geschenks.

Gibt zurück

Geschenk

Body
v1.GivingApi.GiftRead

Erstellen eines Touchpoints

Vorgangs-ID:
createTouchpointCustomObject

Senden Sie einen neuen benutzerdefinierten Touchpoint an Almabase.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Programm
 touchpoint_program True integer

Filtert die Typen nach Touchpoint-Programmen.
Email
 email email

E-Mail-ID, die für die Aktivität verwendet wird.
ID
 id integer

Vom System generierte ID, um einen Datensatz eindeutig zu identifizieren.
Aufgezeichnet bei
 recorded_at True date-time

Der Zeitstempel der Aktivität.
Typ
 id True integer

Gibt zurück

Touchpoint-Textkörper zum Erstellen eines neuen Touchpoints

Body
v1.AlmasightsApi.TouchpointCustomObjectAdd

Geben von Seiten auflisten

Vorgangs-ID:
ListGivingPages

Gibt eine Liste der Geben-Seiten zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Felder
 fields array

Die durch Trennzeichen getrennte Liste der Felder in der Antwort.

Gibt zurück

response
array of v1.GivingApi.GivingPageRead

Geschenk erhalten

Vorgangs-ID:
GetGift

Gibt Informationen zu einem Geschenk zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Geschenk-ID
 id True integer

Vom System generierte ID, um ein Geschenk eindeutig zu identifizieren.
Felder
 fields array

Die durch Trennzeichen getrennte Liste der Felder in der Antwort.

Gibt zurück

Geschenk

Body
v1.GivingApi.GiftRead

Geschenke auflisten

Vorgangs-ID:
ListGifts

Gibt eine Liste von Geschenken zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Der Status
 status True string

Filtern Sie Geschenke basierend auf dem Status.
Seite geben
 campaign integer

Vom System generierte ID, um eine gebende Seite eindeutig zu identifizieren.
Nach Geschenkgruppen-ID filtern
 group_id uuid

Vom System generierte ID, um eine Geschenkgruppe oder eine Liste eindeutig zu identifizieren.
Soll eine leere Batchnummer vorliegen?
 batch_number__isnull boolean

Filtern Sie Geschenke auf der Grundlage einer Batchnummer oder nicht.
Sollte die id der externen Datenbank leer sein?
 external_database_id__isnull boolean

Filtern Sie Geschenke basierend darauf, dass sie bereits über eine externe Datenbank-ID verfügen oder nicht. HINWEIS: Die Geschenke, die über eine externe Datenbank-ID verfügen, werden bereits an die externe Datenbank übertragen.
Filtern nach externer Datenbank-ID
 external_database_id string

Filtern Sie Geschenke basierend auf der externen Datenbank-ID.
Nach Spender-E-Mail filtern
 donor_email string

Filtern von Geschenken basierend auf der E-Mail-Adresse des Spenders
Suchen nach
 search string

Suchen Sie nach Geschenken nach Name oder E-Mail-Adresse.
Felder
 fields array

Die durch Trennzeichen getrennte Liste der Felder in der Antwort.
Seitenformat
 page_size integer

Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 10. Das Maximum beträgt 50.
Seitennummer
 page integer

Stellt die Seitenzahlen (Offset) dar. Zur Verwendung mit Paginierung.
Bestellung nach
 ordering string

Definieren Sie die Reihenfolge der Geschenke in der Antwort. Ein Präfix "-" stellt absteigende Reihenfolge dar, und das Fehlen des Präfixes würde die Ergebnisse in aufsteigender Reihenfolge zurückgeben.

Gibt zurück

Name Pfad Typ Beschreibung
URL der nächsten Ergebnisse
 nextlink uri

URL für den nächsten Seitensatz von Ergebnissen. Zur Verwendung mit Paginierung.
URL der vorherigen Ergebnisse
 previouslink uri

URL für den vorherigen Ergebnissatz. Zur Verwendung mit Paginierung.
Geschenke insgesamt
 total integer

Gesamtgeschenke für die angegebenen Filter
Geschenke
 value array of v1.GivingApi.GiftRead

Liste der Geschenke, die für die angegebenen Filter zurückgegeben werden. Die Ergebnisse werden paginiert.

Hinzufügen einer Kontaktperson

Vorgangs-ID:
AddEventContactPerson

Fügt einer Veranstaltung eine Kontaktperson hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Ereignis-ID
 id True integer

Vom System generierte ID, um ein Ereignis eindeutig zu identifizieren.
Email
 email email

E-Mail der Kontaktperson
Name
 name string

Name der Kontaktperson
Rufnummer
 phone_number string

Telefonnummer der Kontaktperson

Gibt zurück

Ansprechpartner eines Ereignisses

Body
v1.EventApi.ContactPersonRead

Kontaktpersonen auflisten

Vorgangs-ID:
ListEventContactPersons

Gibt eine Liste aller Kontaktpersonen für ein Ereignis zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Ereignis-ID
 id True integer

Vom System generierte ID, um ein Ereignis eindeutig zu identifizieren.

Gibt zurück

response
array of v1.EventApi.ContactPersonRead

Listenformulare

Vorgangs-ID:
ListForms

Dient zum Abrufen einer Liste von Formularen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Felder
 fields array

Die durch Trennzeichen getrennte Liste der Felder in der Antwort.

Gibt zurück

response
array of v1.FormApi.FormRead

Löschen einer E-Mail-Adresse eines Datensatzes

Vorgangs-ID:
DeleteRecordEmailAddress

Löschen einer E-Mail-Adresse eines Datensatzes.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Datensatzkennung
 record_id True integer

Vom System generierte ID, um einen Datensatz eindeutig zu identifizieren.
ID
 email_id True integer

Vom System generierte ID, um eine E-Mail-Adresse eines Datensatzes eindeutig zu identifizieren.

Senden eines Formulars

Vorgangs-ID:
CreateFormEntry

Erstellt eine neue Formularübermittlung für ein Formular

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Formular
 form_id True integer

Vom System generierte ID, um ein Formular eindeutig zu identifizieren.
body
 body dynamic

Erstellen einer neuen Formularübermittlung

Gibt zurück

Name Pfad Typ Beschreibung
Antwort-ID
 id integer

Vom System generierte ID, um eine Formularübermittlung eindeutig zu identifizieren.

Veranstaltungen auflisten

Vorgangs-ID:
ListEvents

Gibt eine Liste aller Ereignisse zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach externer Datenbank-ID suchen
 external_database_id string

Suchen Sie nach Ereignissen nach externer Datenbank-ID.
Felder
 fields array

Die durch Trennzeichen getrennte Liste der Felder in der Antwort.

Gibt zurück

response
array of v1.EventApi.EventRead

Auslöser

Beim Erstellen, Aktualisieren oder Löschen einer E-Mail auf einem Datensatz

Triggers when a new email is created on a record or an existing email is updated or deleted from a record.
Wenn ein Datensatz auf Almabase erstellt oder aktualisiert wird

Wird ausgelöst, wenn ein neuer Datensatz auf Almabase erstellt wird oder ein vorhandener Datensatz aktualisiert wird.
Wenn ein Formular übermittelt oder eine vorhandene Formularübermittlung aktualisiert wird

Wird ausgelöst, wenn ein Formular gesendet oder eine vorhandene Formularübermittlung aktualisiert wird.
Wenn ein neues Geschenk erfolgreich ist oder eine Online-Geschenkzahlung fehlgeschlagen ist

Wird ausgelöst, wenn ein neues Geschenk erfolgreich auf einer Spendenseite von einem Spender aufgezeichnet wird oder die Zahlung an ein Geschenk fehlgeschlagen ist.

Beim Erstellen, Aktualisieren oder Löschen einer E-Mail auf einem Datensatz

Vorgangs-ID:
EmailChangedWebhook

Triggers when a new email is created on a record or an existing email is updated or deleted from a record.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Wann
 events True string

Die Liste der Ereignisse, die den Fluss auslösen sollen.

Gibt zurück

Body
v1.RecordApi.EmailWebhookResponse

Wenn ein Datensatz auf Almabase erstellt oder aktualisiert wird

Vorgangs-ID:
RecordChangedWebhook

Wird ausgelöst, wenn ein neuer Datensatz auf Almabase erstellt wird oder ein vorhandener Datensatz aktualisiert wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Wann
 events True string

Die Liste der Ereignisse, die den Fluss auslösen sollen.

Gibt zurück

Body
v1.RecordApi.RecordWebhookResponse

Wenn ein Formular übermittelt oder eine vorhandene Formularübermittlung aktualisiert wird

Vorgangs-ID:
FormEntryCreateOrUpdateWebhook

Wird ausgelöst, wenn ein Formular gesendet oder eine vorhandene Formularübermittlung aktualisiert wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Wann
 events True string

Die Liste der Ereignisse, die den Fluss auslösen sollen.
Formular
 object_id True integer

Vom System generierte ID, um ein Formular eindeutig zu identifizieren.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Wenn ein neues Geschenk erfolgreich ist oder eine Online-Geschenkzahlung fehlgeschlagen ist

Vorgangs-ID:
GiftSucceededOrFailedWebhook

Wird ausgelöst, wenn ein neues Geschenk erfolgreich auf einer Spendenseite von einem Spender aufgezeichnet wird oder die Zahlung an ein Geschenk fehlgeschlagen ist.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Wann
 events True string

Die Liste der Ereignisse, die den Fluss auslösen sollen.
Seite geben
 object_id integer

Vom System generierte ID, um eine gebende Seite eindeutig zu identifizieren.

Gibt zurück

Body
v1.GivingApi.GiftWebhookResponse

Definitionen

v1. FormApi.FormRead

Formular

Name Pfad Typ Beschreibung
ID
 id integer

Vom System generierte ID, um ein Formular eindeutig zu identifizieren.
Formularname
 title string

Der Name des Formulars

v1. GivingApi.GiftWebhookRecordRead

Datensatz

Name Pfad Typ Beschreibung
Id der externen Datenbank
 external_database_id string

Ein System, dem die eindeutige ID für den Datensatz durch die externe Datenbank zugewiesen wurde. z. B. System Record ID für Raiser Edge NXT, Kontakt-ID für Salesforce
Vorname
 first_name string

Vorname des zugeordneten Datensatzes
ID
 id integer

Vom System generierte ID, um einen Datensatz eindeutig zu identifizieren.
Ist der Spender auf Almabase registriert?
 is_registered boolean

Geben Sie an, ob der zugeordnete Datensatz oder spender auf Almabase registriert ist.
Nachname
 last_name string

Nachname des zugeordneten Datensatzes

v1. GivingApi.GiftWebhookResponse

Name Pfad Typ Beschreibung
Betrag
 data.amount string

Der Geschenkbetrag mit zwei Dezimalstellen.
Datum
 data.completed_at date-time

Das Datum, an dem der Status des Geschenks als abgeschlossen gekennzeichnet ist.
Spender-E-Mail
 data.email email

E-Mail-ID, die vom Spender für das Geschenk verwendet wird.
Id der externen Datenbank
 data.external_database_id string

Ein System, dem eine eindeutige ID für das Geschenk durch die externe Datenbank zugewiesen wurde.
ID
 data.id integer

Vom System generierte ID, um ein Geschenk eindeutig zu identifizieren.
Ist neue E-Mail?
 data.is_email_new boolean

Gibt an, ob die von spender bereitgestellte E-Mail bereits auf Almabase-Datensätzen vorhanden ist.
schema
 data.mapped_profile.schema v1.GivingApi.GiftWebhookRecordRead

Datensatz
Modus
 data.mode string

Modus des Geschenks.
Spendername
 data.name string

Vollständiger Name des Spenders.
ID
 data.page.id integer

Vom System generierte ID, um eine gebende Seite eindeutig zu identifizieren.
Geben des Seitennamens
 data.page.name string

Name der zugeordneten Seite
Der Status
 data.status string

Status des Geschenks.
Ereignis ausgelöst bei
 time string

Die Ereigniszeit.
Ereignistyp
 type string

Der Ereignistyp.

v1. GivingApi.LocationRead

Die Stadt, die vom Spender für das Geschenk verwendet wird.

Name Pfad Typ Beschreibung
Stadt
 city string

Die Stadt des Spenders
Kurzname der Stadt
 city_short_name string

Die kurze Darstellung der Stadt, z.B. SF
Breitengrad
 coordinates.latitude string

Der Breitengrad des Standorts
Längengrad
 coordinates.longitude string

Der Längengrad des Standorts
Country
 country string

Das Land des Gebers
Kurzname des Landes
 country_short_name string

Die kurze Vertretung des Landes, z.B. USA
Google Place Id
 gpid string

Die von Google abgerufene Orts-ID
Stadt, Bundesland, Land
 name string

Die Stadt des Spenders. Format: Ortsname, Kurzstaatsname, Kurzlandname
Staat
 state string

Der Zustand des Spenders
Kurzname des Status
 state_short_name string

Die kurze Darstellung des Zustands, z. B. CA

v1. GivingApi.FormFieldRead

Formularfeld

Name Pfad Typ Beschreibung
Wert
 display_value string

Der formatierte Wert, der von Antwortenden eingegeben wurde. z. B. Name des Dateiuploads.
Name des Frage-/Formularfelds
 label string

Der Name des Frage-/Formularfelds im Formular

v1. GivingApi.FundRead

Der Fonds, der mit dem Geschenk split verbunden ist.

Name Pfad Typ Beschreibung
Id der externen Datenbank
 external_database_id string

Ein System, dem eine eindeutige ID für den Fonds durch die externe Datenbank zugewiesen wurde. z. B. System Record ID für Raiser Edge NXT, Objekt-ID für Salesforce
ID
 id integer

Vom System generierte ID, um einen Fonds eindeutig zu identifizieren.
Ist der Standardfonds?
 is_default boolean

Gibt an, dass alle Splits diesem Fonds zugeordnet werden, wenn auf der Spendenseite keine anderen Mittel definiert sind.
Ist anderer Fonds?
 is_other_fund boolean

Gibt an, dass die Geber dieses Fonds einen benutzerdefinierten Fondsnamen gegeben haben.
Name
 name string

Name des Fonds

v1. GivingApi.GiftRead

Geschenk

Name Pfad Typ Beschreibung
Geschenkbetrag
 amount string

Der Geschenkbetrag mit zwei Dezimalstellen.
Batchnummer
 batch_number string

Die Batchnummer des Geschenks.
Geschenkdatum
 completed_at date-time

Das Datum, an dem der Status des Geschenks als abgeschlossen gekennzeichnet ist.
Währung
 currency integer

Währung, die vom Spender für das Geschenk verwendet wird.
Device
 device string

Identifizieren Sie das Gerät, das zum Erstellen des Geschenks verwendet wird, z. B. PC, Mobil oder Tablet.
Spenderadresse: Zeile 1
 donor_address_line1 string

Die Adresse Zeile 1, die vom Spender für das Geschenk verwendet wird.
Spenderadresse: Zeile 2
 donor_address_line2 string

Die Adresse Zeile 2, die vom Spender für das Geschenk verwendet wird.
Spenderadresse: Ort
 donor_city_place v1.GivingApi.LocationRead

Die Stadt, die vom Spender für das Geschenk verwendet wird.
Spender-E-Mail
 donor_email email

E-Mail-ID, die vom Spender für das Geschenk verwendet wird.
Spendername
 donor_name string

Vollständiger Name des Spenders.
Spendertelefonnummer
 donor_phone_number string

Telefonnummer, die vom Spender für das Geschenk verwendet wird.
Spenderadresse: Postleitzahl
 donor_zip_code string

Die Postleitzahl der Adresse, die vom Spender für das Geschenk verwendet wird.
Ist von Leaderboard ausgeblendet?
 exclude_from_leaderboard boolean

Ist von Leaderboard ausgeblendet?
Id der externen Datenbank
 external_database_id string

Ein System, dem eine eindeutige ID für das Geschenk durch die externe Datenbank zugewiesen wurde.
Ehrungsnachricht
 honor_message string

Eine Botschaft für eine Geschenkwürdigung.
Ehrenpräfix
 honor_prefix string

Ein Präfix für eine Geschenkwürdigung. Verfügbare Optionen sind in_honor_of, in_memory_of, in_support_of
ID
 id integer

Vom System generierte ID, um ein Geschenk eindeutig zu identifizieren.
Influencer
 influencer v1.GivingApi.InfluencerRead

Der Link "Öffentliche Freigabe" und der Link "Privates Dashboard"
Ist anonym?
 is_anonymous boolean

Gibt an, dass der Wunsch des Spenders anonym für andere Spender für dieses Geschenk sein soll.
Hat der Geber die Gebühren für das Zahlungsgateway abgedeckt?
 is_donor_covered_charges boolean

Gibt an, ob sich der Spender für die Deckung der Gebühren für das Zahlungsgateway entschieden hat, wenn er das Geschenk macht?
Wird E-Mail zu einem Datensatz auf Almabase hinzugefügt?
 is_email_added_to_profile boolean

Gibt an, ob die vom Spender bereitgestellte E-Mail auf dem Almabase-Datensatz hinzugefügt wird (unabhängig von is_email_new Status)
Ist neue E-Mail?
 is_email_new boolean

Gibt an, ob die von spender bereitgestellte E-Mail bereits auf Almabase-Datensätzen vorhanden ist.
Wird die Zuordnung zu einem Datensatz auf Almabase ignoriert?
 is_profile_mapping_ignored boolean

Gibt an, ob die Datensatzzuordnung ignoriert werden soll.
Zahlungsmodus
 mode string

Zahlungsmodus, entweder online oder offline.
Hinweis
 note string

Der Notiztext.
Sonstiger Fondsname
 other_fund_name string

Wenn der Spender einen Fonds auswählt, der als is_other_fund gekennzeichnet ist, fügen sie einen benutzerdefinierten Fondsnamen hinzu, um das Geschenk zuzuordnen.
Seite geben
 page v1.GivingApi.GivingPageAssociatedWithGift

Die dem Geschenk zugeordnete Spendenseite.
Felder
 post_payment_form_entry.fields array of v1.GivingApi.FormFieldRead
Antwort-ID
 post_payment_form_entry.id integer

Vom System generierte ID, um eine Formularübermittlung eindeutig zu identifizieren.
Felder
 pre_payment_form_entry.fields array of v1.GivingApi.FormFieldRead
Antwort-ID
 pre_payment_form_entry.id integer

Vom System generierte ID, um eine Formularübermittlung eindeutig zu identifizieren.
Zugeordneter Datensatz
 profile v1.GivingApi.RecordRead

Zugeordneter Datensatz auf Almabase
Verweiserlink
 referrer_link string

Die Website-Link, um die Quelle zu identifizieren, wie der Spender besuch. z.B. Spender besuchte die Spendenkampagne von Facebook, Google usw.
Erstattungsbetrag
 refund_amount string

Der Betrag, der dem Spender erstattet wurde. Wenn der gesamte Betrag erstattet wird, wird der Status des Geschenks statt abgeschlossen erstattet.
Spagat
 splits array of v1.GivingApi.GiftSplitRead

Die Splits, die dem Geschenk zugeordnet sind.
Der Status
 status string

Status des Geschenks.
Onlinetransaktion
 transaction v1.GivingApi.TransactionRead

Die Online-Zahlungstransaktion, die dem Geschenk zugeordnet ist.
UTM-Kampagne
 utm_campaign string

Wird für die Schlüsselwortanalyse verwendet. utm_campaign eine bestimmte Produktförderung oder strategische Kampagne identifizieren. z. B. annual_fund_2020
UTM Medium
 utm_medium string

utm_medium ein Medium wie E-Mail oder Kosten pro Klick identifizieren. z.B. cpc
UTM-Quelle
 utm_source string

utm_source eine Suchmaschine, einen Newsletternamen oder eine andere Quelle identifizieren. z.B. Google

v1. GivingApi.GiftSplitRead

Geschenk split

Name Pfad Typ Beschreibung
Betrag
 amount string

Der Betrag des Geschenks, der geteilt wird.
Fonds
 fund v1.GivingApi.FundRead

Der Fonds, der mit dem Geschenk split verbunden ist.
ID
 id integer

Vom System generierte ID, um einen Geschenkteil eindeutig zu identifizieren.

v1. GivingApi.GivingPageAssociatedWithGift

Die dem Geschenk zugeordnete Spendenseite.

Name Pfad Typ Beschreibung
ID
 id integer

Vom System generierte ID, um eine gebende Seite eindeutig zu identifizieren.
Name
 name string

Name der zugeordneten Spendenseite.

v1. GivingApi.GivingPageRead

Seite geben

Name Pfad Typ Beschreibung
ID
 id integer

Vom System generierte ID, um eine gebende Seite eindeutig zu identifizieren.
Name
 name string

Name der Geben-Seite

v1. GivingApi.InfluencerRead

Der Link "Öffentliche Freigabe" und der Link "Privates Dashboard"

Name Pfad Typ Beschreibung
Link zum Privaten Influencer-Dashboard
 dashboard_url uri

Das private Dashboard des Spenders, um die Anzahl der Seitenbesuche und Geschenke zu überwachen, die von ihnen beeinflusst werden
Link "Öffentliche Freigabe"
 page_share_url uri

Der öffentliche Link der Spendenseite/Kampagne des Spenders, um den Einfluss auf Besuche auf Giving Page und die Geschenke nachzuverfolgen.

v1. GivingApi.PaymentAccountRead

Das mit der Transaktion verbundene Zahlungskonto, z. B. BBMS, Stripe, PayPal usw.

Name Pfad Typ Beschreibung
ID
 id integer

Vom System generierte ID, um ein Zahlungskonto eindeutig zu identifizieren.
Name
 name string

Der Name des Zahlungskontos.
Gateway
 type string

Der Name des Zahlungsgateways.

v1. GivingApi.RecordRead

Zugeordneter Datensatz auf Almabase

Name Pfad Typ Beschreibung
Id der externen Datenbank
 external_database_id string

Ein System, dem die eindeutige ID für den Datensatz durch die externe Datenbank zugewiesen wurde. z. B. System Record ID für Raiser Edge NXT, Kontakt-ID für Salesforce
Vorname
 first_name string

Vorname des zugeordneten Datensatzes
Vollständiger Name
 formatted_name string

Vollständiger Name des zugeordneten Datensatzes
ID
 id integer

Vom System generierte ID, um einen Datensatz eindeutig zu identifizieren.
Ist der Spender auf Almabase registriert?
 is_registered boolean

Geben Sie an, ob der zugeordnete Datensatz oder spender auf Almabase registriert ist.
Nachname
 last_name string

Nachname des zugeordneten Datensatzes
Bild-URL
 present_picture uri

Die URL des Datensatzbilds
Link
 profile_url uri

Der Datensatzlink auf Almabase

v1. GivingApi.TransactionRead

Die Online-Zahlungstransaktion, die dem Geschenk zugeordnet ist.

Name Pfad Typ Beschreibung
Zahlungskonto
 account v1.GivingApi.PaymentAccountRead

Das mit der Transaktion verbundene Zahlungskonto, z. B. BBMS, Stripe, PayPal usw.
Erstellt am
 created_at date-time

Der Zeitpunkt der Erstellung dieser Transaktion.
Fehlergrund
 failure_reason string

Der vom Zahlungsgateway zurückgegebene Transaktionsfehlergrund.
ID
 id uuid

Vom System generierte ID, um eine Transaktion eindeutig zu identifizieren.
Der Status
 status integer

Status der Transaktion. - 1 (nicht verarbeitet) - 2 (erfolgreich) - 3 (fehlgeschlagen) - 4 (Ausstehend) - 5 (Fehler) HINWEIS: Dieser Status ist dem Status der Transaktion durch das Zahlungsgateway zugeordnet.
Referenz-ID des Zahlungsgateways
 transaction_id string

Die eindeutige ID, die vom Zahlungsgateway generiert wurde, um die Transaktion zu identifizieren. z. B. BbMS-Transaktions-ID (Blackbaud Merchant Services) oder Stripe Charge ID, PayPal Transaktions-ID

v1. AlmasightsApi.RecordAddOrEdit

Datensatz auf Almabase.

Name Pfad Typ Beschreibung
ID
 id integer

Vom System generierte ID, um einen Datensatz eindeutig zu identifizieren.

v1. AlmasightsApi.TouchpointCustomObjectAdd

Touchpoint-Textkörper zum Erstellen eines neuen Touchpoints

Name Pfad Typ Beschreibung
Email
 email email

E-Mail-ID, die für die Aktivität verwendet wird.
Datensatz
 mapped_profile v1.AlmasightsApi.RecordAddOrEdit

Datensatz auf Almabase.
Aufgezeichnet bei
 recorded_at date-time

Der Zeitstempel der Aktivität.
Typ
 touchpoint_type.id integer

v1. RecordApi.LocationRead

Speicherort der Adresse

Name Pfad Typ Beschreibung
Stadt
 city string

Ortsname des Standorts
Country
 country string

Name des Landes des Standorts
Breitengrad
 latitude double

Der Breitengrad des Standorts
Längengrad
 longitude double

Der Längengrad des Standorts
Staat
 state string

Statusname des Speicherorts

v1. RecordApi.AddressRead

Adresse

Name Pfad Typ Beschreibung
Line1
 line1 string

Zeile 1 der Adresse
Line2
 line2 string

Zeile 2 der Adresse
schema
 location.schema v1.RecordApi.LocationRead

Speicherort der Adresse
Postleitzahl
 zipcode string

Postleitzahl der Adresse

v1. RecordApi.EmailWebhookRecordRead

Datensatz

Name Pfad Typ Beschreibung
Id der externen Datenbank
 external_database_id string

Ein System, dem die eindeutige ID für den Datensatz durch die externe Datenbank zugewiesen wurde. z. B. System Record ID für Raiser Edge NXT, Kontakt-ID für Salesforce
Vorname
 first_name string

Vorname des zugeordneten Datensatzes
ID
 id integer

Vom System generierte ID, um einen Datensatz eindeutig zu identifizieren.
Ist der Datensatz auf Almabase registriert?
 is_registered boolean

Geben Sie an, ob der zugeordnete Datensatz, der auf Almabase registriert ist
Nachname
 last_name string

Nachname des zugeordneten Datensatzes

v1. RecordApi.EmailWebhookResponse

Name Pfad Typ Beschreibung
E-Mail-Adresse
 data.address email

E-Mail-Adresse.
ID
 data.id integer

Vom System generierte ID, um eine E-Mail eindeutig zu identifizieren.
Ist primär
 data.is_primary boolean

Gibt an, ob die E-Mail primär ist oder nicht.
schema
 data.profile.schema v1.RecordApi.EmailWebhookRecordRead

Datensatz
E-Mail-Typ
 data.type string

Typ der E-Mail-Adresse (primär, persönlich, geschäftlich usw.).
Ereignis ausgelöst bei
 time string

Die Ereigniszeit.
Ereignistyp
 type string

Der Ereignistyp.

v1. RecordApi.RecordWebhookResponse

Name Pfad Typ Beschreibung
Zugehörigkeiten
 data.affiliations array of string
Klassenjahr
 data.class_year string

Klassenjahr des Datensatzes
E-Mail-Adresse
 data.email email

E-Mail-Adresse.
Id der externen Datenbank
 data.external_database_id string

Ein System, dem die eindeutige ID für den Datensatz durch die externe Datenbank zugewiesen wurde. z. B. System Record ID für Raiser Edge NXT, Kontakt-ID für Salesforce
Vorname
 data.first_name string

Vorname des zugeordneten Datensatzes
schema
 data.home_address.schema v1.RecordApi.AddressRead

Adresse
ID
 data.id integer

Vom System generierte ID, um einen Datensatz eindeutig zu identifizieren.
Nachname
 data.last_name string

Nachname des zugeordneten Datensatzes
Ablaufdatum der Mitgliedschaft
 data.membership_expiry_date date-time

Ablaufdatum der Mitgliedschaft des Datensatzes
Name des Mitgliedschaftstyps
 data.membership_type_name string

Name des Mitgliedschaftstyps des Datensatzes
Handynummer
 data.mobile_number string

Mobiltelefonnummer des Datensatzes
schema
 data.office_address.schema v1.RecordApi.AddressRead

Adresse
Office-Telefonnummer
 data.office_phone_number string

Office-Telefonnummer des Datensatzes
Wohnsitztelefonnummer
 data.residence_phone_number string

Telefonnummer des Wohnsitzes des Datensatzes
Ereignis ausgelöst bei
 time string

Die Ereigniszeit.
Ereignistyp
 type string

Der Ereignistyp.

v1. RecordApi.EmailAddressRead

E-Mail-Adresse

Name Pfad Typ Beschreibung
Adresse
 address email

Die E-Mail-Adresse
ID
 id integer

Vom System generierte ID, um eine E-Mail-Adresse eines Datensatzes eindeutig zu identifizieren.
Ist engagiert?
 is_engaged boolean

Gibt an, ob auf eine Massen-E-Mail geklickt oder geöffnet wird oder der Benutzer auf eine E-Mail antwortet.
Wird für die Anmeldung verwendet?
 is_login_email boolean

Gibt an, ob der Benutzer sich mit dieser E-Mail-Adresse bei der Plattform anmelden darf.
Ist primär?
 is_primary boolean

Eine primäre E-Mail wird verwendet, um die vom System ausgelösten automatisierten E-Mails zu senden. Es wird auch verwendet, um die Massen-E-Mails an den Datensatz zu senden. Es ist obligatorisch, dass nur eine E-Mail als primär festgelegt ist.
Wird vom Benutzer überprüft?
 is_verified boolean

Geben Sie an, ob der Benutzer überprüft hat, ob er besitzer der E-Mail ist.
source
 source string

Die Quelle gibt an, wie die E-Mail der Datenbank hinzugefügt wird.
status
 status string
Typ
 type string

Der Typ der E-Mail

v1. RecordApi.RecordRead

Datensatz (record)

Name Pfad Typ Beschreibung
E-Mail-Adressen
 email_addresses array of v1.RecordApi.EmailAddressRead

Liste der E-Mail-Adressen eines Profils
Id der externen Datenbank
 external_database_id string

Ein System, dem die eindeutige ID für den Datensatz durch die externe Datenbank zugewiesen wurde. z. B. System Record ID für Raiser Edge NXT, Kontakt-ID für Salesforce
Vorname
 first_name string

Vorname des Datensatzes.
Vollständiger Name
 formatted_name string

Vollständiger Name des Datensatzes.
ID
 id integer

Vom System generierte ID, um einen Datensatz eindeutig zu identifizieren.
Ist auf Almabase registriert?
 is_registered boolean

Geben Sie an, ob der Datensatz oder der Spender auf Almabase registriert ist
Nachname
 last_name string

Nachname des Datensatzes.
Bild-URL
 present_picture uri

Die URL des Datensatzbilds
Link
 record_url uri

Der Datensatzlink auf Almabase

v1. EventApi.ContactPersonRead

Ansprechpartner eines Ereignisses

Name Pfad Typ Beschreibung
Email
 email email

E-Mail der Kontaktperson
ID
 id integer

Vom System generierte ID, um eine Kontaktperson eindeutig zu identifizieren.
Name
 name string

Name der Kontaktperson
Rufnummer
 phone_number string

Telefonnummer der Kontaktperson

v1. EventApi.EventRead

Event

Name Pfad Typ Beschreibung
Description
 description string

Beschreibung des Ereignisses.
Endzeit
 end_datetime string

Endzeit des Ereignisses
Id der externen Datenbank
 external_database_id string

Ein System, dem die eindeutige ID für den Datensatz durch die externe Datenbank zugewiesen wurde. z. B. System Record ID für Raiser Edge NXT, Kontakt-ID für Salesforce
Url der externen Registrierung
 external_registration_url string

Die Registrierungs-URL des Ereignisses auf einer externen Website
ID
 id integer

Vom System generierte ID, um ein Ereignis eindeutig zu identifizieren.
Name
 name string

Name des Ereignisses
Startzeit
 start_datetime string

Startzeit des Ereignisses
Timezone
 timezone string

Zeitzone des Ereignisses