Almabase (förhandsversion)

Almabase är världens mest älskade alumnhanteringsprogram för att bygga alumncentrerade program för att öka deltagandet, donatorengagemanget och vara värd för engagerande onlinegrupper.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Tjänster	Class	Regioner
Copilot Studio	Premie	Alla Power Automate-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)
Logiska appar	Norm	Alla Logic Apps-regioner utom följande:      – Azure Government-regioner      – Regioner i Azure Kina      - US Department of Defense (DoD)
Power Apps	Premie	Alla Power Apps-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)
Power Automate	Premie	Alla Power Automate-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)

Kontakt
Namn	Stöd för Almabase
URL	https://docs.almabase.com
E-postmeddelande	help@almabase.com

Metadata för anslutningsprogram
Utgivare	Almabase, Inc.
Webbplats	https://almabase.com
Sekretesspolicy	https://www.almabase.com/ecloud-privacy-policy
Kategorier	Försäljning och CRM; Produktivitet

Almabase tillhandahåller programvaruverktyg och strategier för utbildningsinstitutioner för att bygga alumnicentrerade program som förvandlar oengagerade alumner till supportrar för livet.

Den här anslutningsappen bygger på Almabase-API:er och webhooks och tillhandahåller åtgärder för att hantera entiteter som finns i Almabase, inklusive:

• Post (komponenter)
• Gåvor
• Evenemang
• Engagement Touchpoints
• Blanketter
• Fonder
• Ge sidor
• Peer-to-peer-insamlingskampanjer
• med flera...

Förutsättningar

Om du vill använda den här anslutningsappen

• Du måste ha en aktiv Almabase-prenumeration.
• Du måste ha rollen webbplatsadministratör.

Hämta autentiseringsuppgifter

• Logga in på administratörsportalen som tillhandahålls av Almabase.
• Navigera till API's & Tokens under Settings.
• Klicka på Add Auth Tokenoch fyll i descriptionoch ange token expiry date & time.
• Workflow Access Token Anteckna (klicka på token för att kopiera i Urklipp).
• Workflow Access Token Använd när du skapar den nya anslutningen i Power Automate.

Kom igång med anslutningsappen

Vanliga användningsfall

• När en gåva görs skickar du ett personligt meddelande och presentkort.
• När en engagemangsaktivitet registreras på Slack, Gmail eller andra sociala medier lägger du till engagemangsaktiviteten i Engagement Studio på Almabase med hjälp av Create Custom Touchpoint åtgärder.
• När en ny e-postadress hittas (förlorade alumner) i en gåva eller en händelseregistrering eller en formuläröverföring lägger du till den e-postadressen i en post på Almabase eller en väljare på Raiser's Edge eller en kontakt på Salesforce.
• Utforma dubbelriktad datasynkronisering mellan Almabase och Blackbaud Raiser's Edge.
• Utforma dubbelriktad datasynkronisering mellan Almabase och Salesforce.

Kända problem och begränsningar

• Presentutlösare fungerar bara när onlinebetalningen görs på Almabase. Manuellt tillagda gåvor utlöser inte flödena.

Skapa en anslutning

Anslutningsappen stöder följande autentiseringstyper:

Standardinställning	Parametrar för att skapa anslutning.	Alla regioner	Går inte att dela

Standard

Tillämpligt: Alla regioner

Parametrar för att skapa anslutning.

Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.

Namn	Typ	Description	Krävs
Domän-URL	snöre	Ange din Url för Almabase-domänen, t.ex. https://your.domain.com	Sann
API-nyckel	securestring	API-nyckeln för användaren	Sann

Begränsningsgränser

Name	Anrop	Förnyelseperiod
API-anrop per anslutning	100	60 sekunder

Åtgärder

Få ett formulär inskickat	Returnerar information om en formuläröverföring.
Hämta en e-postadress för en post	Returnerar information om en e-postadress för en post.
Hämta en givande sida	Returnerar information om en givande sida.
Hämta en gåva	Returnerar information om en gåva.
Hämta en händelse	Returnerar information om en händelse.
Hämta en post	Returnerar information om en post.
Lista e-postadresser för en post	Returnerar en lista med e-postadresser för en post.
Lista formulär	Hämta en lista över formulär.
Lista händelser	Returnerar en lista över alla händelser.
Lista kontaktpersoner	Returnerar en lista över alla kontaktpersoner för en händelse.
Lista med sidor	Returnerar en lista över givande sidor.
Lista medel	Returnerar en lista över medel
Lista poster	Returnerar en lista med poster.
Lägga till en kontaktperson	Lägger till en kontaktperson i en händelse.
Skaffa en fond	Returnerar information om en fond.
Skapa en e-postadress för en post	Skapar en ny e-postadress för en post.
Skapa en fond	Skapar en ny fond.
Skapa en gåva	Skapar en ny gåva.
Skapa en händelse	Skapar en ny händelse.
Skapa en pekpunkt	Skicka en ny anpassad touchpoint till Almabase.
Skapa en post	Skapar en ny post.
Skicka ett formulär	Skapar ett nytt formulär som skickas för ett formulär
Ta bort en e-postadress för en post	Ta bort en e-postadress för en post.
Uppdatera en e-postadress för en post	Uppdaterar fältens e-postadress för en post
Uppdatera en fond	Uppdaterar en fond.
Uppdatera en gåva	Uppdaterar en gåva
Uppdatera en händelse	Uppdaterar en händelse.
Uppdatera en kontaktperson	Uppdaterar en kontaktperson för en händelse.
Uppdatera en post	Uppdaterar en post.
Visa en lista över gåvor	Returnerar en lista med gåvor.

Få ett formulär inskickat

Åtgärds-ID:

GetFormEntry

Returnerar information om en formuläröverföring.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Formulär	form_id	True	integer	Systemgenererat ID för att unikt identifiera ett formulär.
Svars-ID	entry_id	True	string	Systemgenererat ID för att unikt identifiera ett formulär som skickas.

Returer

Utdata för den här åtgärden är dynamiska.

Hämta en e-postadress för en post

Åtgärds-ID:

GetRecordEmailAddress

Returnerar information om en e-postadress för en post.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Post-ID	record_id	True	integer	Systemgenererat ID för att unikt identifiera en post.
ID-nummer	email_id	True	integer	Systemgenererat ID för att unikt identifiera en e-postadress för en post.

Returer

E-postadress

Body

v1.RecordApi.EmailAddressRead

Hämta en givande sida

Åtgärds-ID:

GetGivingPage

Returnerar information om en givande sida.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Ge sid-ID	id	True	integer	Systemgenererat ID för att unikt identifiera en givande sida.
Fields	fields		array	Kommaavgränsad lista över fält i svaret.

Returer

Givande sida

Body

v1.GivingApi.GivingPageRead

Hämta en gåva

Åtgärds-ID:

GetGift

Returnerar information om en gåva.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Present-ID	id	True	integer	Systemgenererat ID för att unikt identifiera en gåva.
Fields	fields		array	Kommaavgränsad lista över fält i svaret.

Returer

Gåva

Body

v1.GivingApi.GiftRead

Hämta en händelse

Åtgärds-ID:

GetEvent

Returnerar information om en händelse.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Händelse-ID	id	True	integer	Systemgenererat ID för att unikt identifiera en händelse.
Fields	fields		array	Kommaavgränsad lista över fält i svaret.

Returer

Event

Body

v1.EventApi.EventRead

Hämta en post

Åtgärds-ID:

GetRecord

Returnerar information om en post.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Post-ID	id	True	integer	Systemgenererat ID för att unikt identifiera en post.
Fields	fields		array	Kommaavgränsad lista över fält i svaret.

Returer

rekord

Body

v1.RecordApi.RecordRead

Lista e-postadresser för en post

Åtgärds-ID:

ListRecordEmailAddresses

Returnerar en lista med e-postadresser för en post.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Post-ID	record_id	True	integer	Systemgenererat ID för att unikt identifiera en post.
Är primär?	is_primary		boolean	Sök efter primär e-post.
Fields	fields		array	Kommaavgränsad lista över fält i svaret.
Sidstorlek	page_size		integer	Representerar antalet poster som ska returneras. Standardvärdet är 10. Maxvärdet är 50.
Sidnummer	page		integer	Representera sidnumren (förskjutning). För användning med sidnumrering.

Returer

Name	Sökväg	Typ	Description
Url för nästa resultat	nextlink	uri	URL för nästa siduppsättning med resultat. För användning med sidnumrering.
URL för tidigare resultat	previouslink	uri	URL för den tidigare uppsättningen resultat. För användning med sidnumrering.
Totalt antal e-postadresser	total	integer	Totalt antal e-postadresser för de angivna filtren
E-postadress	value	array of v1.RecordApi.EmailAddressRead	Lista över e-postadresser för en post som returneras för de angivna filtren. Resultaten är sidnumrerade.

Lista formulär

Åtgärds-ID:

ListForms

Hämta en lista över formulär.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Fields	fields		array	Kommaavgränsad lista över fält i svaret.

Returer

response

array of v1.FormApi.FormRead

Lista händelser

Åtgärds-ID:

ListEvents

Returnerar en lista över alla händelser.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Sök efter externt databas-ID	external_database_id		string	Sök efter händelser efter externt databas-ID.
Fields	fields		array	Kommaavgränsad lista över fält i svaret.

Returer

response

array of v1.EventApi.EventRead

Lista kontaktpersoner

Åtgärds-ID:

ListEventContactPersons

Returnerar en lista över alla kontaktpersoner för en händelse.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Händelse-ID	id	True	integer	Systemgenererat ID för att unikt identifiera en händelse.

Returer

response

array of v1.EventApi.ContactPersonRead

Lista med sidor

Åtgärds-ID:

ListGivingPages

Returnerar en lista över givande sidor.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Fields	fields		array	Kommaavgränsad lista över fält i svaret.

Returer

response

array of v1.GivingApi.GivingPageRead

Lista medel

Åtgärds-ID:

ListFunds

Returnerar en lista över medel

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Fields	fields		array	Kommaavgränsad lista över fält i svaret.

Returer

response

array of v1.GivingApi.FundRead

Lista poster

Åtgärds-ID:

ListRecords

Returnerar en lista med poster.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Sök efter namn	search		string	Sök efter poster efter namn.
Sök efter e-postadress	email_addresses__address		string	Sök efter poster efter e-postadress.
Sök efter externt databas-ID	external_database_id		string	Sök efter poster efter externt databas-ID.
Fields	fields		array	Kommaavgränsad lista över fält i svaret.
Uppdaterad på eller efter	updated_at__gte		date-time	Uppdaterad på eller efter ett datum.
Skapad på eller efter	created_at__gte		date-time	Skapades på eller efter ett datum.
Sidstorlek	page_size		integer	Representerar antalet poster som ska returneras. Standardvärdet är 10. Maxvärdet är 50.
Sidnummer	page		integer	Representera sidnumren (förskjutning). För användning med sidnumrering.

Returer

Name	Sökväg	Typ	Description
Url för nästa resultat	nextlink	uri	URL för nästa siduppsättning med resultat. För användning med sidnumrering.
URL för tidigare resultat	previouslink	uri	URL för den tidigare uppsättningen resultat. För användning med sidnumrering.
Totalt antal poster	total	integer	Totalt antal poster för de angivna filtren
Register	value	array of v1.RecordApi.RecordRead	Lista över poster för en post som returneras för de angivna filtren.

Lägga till en kontaktperson

Åtgärds-ID:

AddEventContactPerson

Lägger till en kontaktperson i en händelse.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Händelse-ID	id	True	integer	Systemgenererat ID för att unikt identifiera en händelse.
E-postmeddelande	email		email	E-post till kontaktpersonen
Namn	name		string	Kontaktpersonens namn
Telefonnummer	phone_number		string	Kontaktpersonens telefonnummer

Returer

Kontaktperson för en händelse

Body

v1.EventApi.ContactPersonRead

Skaffa en fond

Åtgärds-ID:

GetFund

Returnerar information om en fond.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Fond-ID	id	True	integer	Systemgenererat ID för att unikt identifiera en fond.
Fields	fields		array	Kommaavgränsad lista över fält i svaret.

Returer

Fonden som är associerad med gåvodelningen.

Fond

v1.GivingApi.FundRead

Skapa en e-postadress för en post

Åtgärds-ID:

CreateRecordEmailAddress

Skapar en ny e-postadress för en post.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Post-ID	record_id	True	integer	Systemgenererat ID för att unikt identifiera en post.
Address	address		email	E-postadressen
Används för inloggning?	is_login_email		boolean	Anger om användaren får logga in på plattformen med den här e-postadressen.
Är primär?	is_primary		boolean	Ett primärt e-postmeddelande används för att skicka automatiserade e-postmeddelanden som utlöses av systemet. Det används också för att skicka massmeddelandet till profilen. Det är obligatoriskt att endast ett e-postmeddelande anges som primärt.
Källa	source		string	Källan anger hur e-postmeddelandet läggs till i databasen.
Läge	status		string	Status för e-postadressen
Typ	type		string	Typ av e-post

Returer

E-postadress

Body

v1.RecordApi.EmailAddressRead

Skapa en fond

Åtgärds-ID:

CreateFund

Skapar en ny fond.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Externt databas-ID	external_database_id		string	Ett system som tilldelats unikt ID för fonden av den externa databasen. t.ex. systempost-ID för Raiser Edge NXT, objekt-ID för Salesforce
Är standardfond?	is_default		boolean	Anger för att associera alla delningar till den här fonden om inga andra medel har definierats på Giving Page.
Är andra fonden?	is_other_fund		boolean	Anger att givarna av denna fond har gett anpassade fondnamn.
Fondnamn	name	True	string	Fondens namn

Returer

Fonden som är associerad med gåvodelningen.

Fond

v1.GivingApi.FundRead

Skapa en gåva

Åtgärds-ID:

CreateGift

Skapar en ny gåva.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Presentbelopp	amount	True	string	Presentbeloppet med två decimaler.
Batchnummer	batch_number		string	Batchnumret för gåvan.
Presentdatum	completed_at	True	date-time	Det datum då status för gåvan har markerats som slutförd.
Valuta	currency	True	integer	Valuta som används av givaren för gåvan.
Donatoradress: Rad 1	donor_address_line1		string	Adressrad 1 som används av donatorn för gåvan.
Donatoradress: Rad 2	donor_address_line2		string	Adressrad 2 som används av donatorn för gåvan.
Namn: Stad, Delstat, Land	name		string	Donatorns stad. Format: Ortnamn, kort delstatsnamn, kort landsnamn
E-post för donator	donor_email	True	email	E-post-ID som används av donatorn för gåvan.
Namn på donator	donor_name	True	string	Fullständigt namn på donatorn.
Telefonnummer för donator	donor_phone_number		string	Telefonnummer som används av donatorn för gåvan.
Donatoradress: Postnummer	donor_zip_code		string	Postnumret för den adress som donatorn använder för gåvan.
Är dold från rankningslistan?	exclude_from_leaderboard		boolean	Är dold från rankningslistan?
Externt databas-ID	external_database_id		string	Ett system som tilldelats unikt ID för gåvan av den externa databasen.
Hyllningsmeddelande	honor_message		string	Ett meddelande till en gåva hyllning.
Hyllningsprefix	honor_prefix		string	Ett prefix för en presenthyllning. Tillgängliga alternativ är in_honor_of, in_memory_of, in_support_of
Är anonym?	is_anonymous		boolean	Anger givarens önskan att vara anonym för andra donatorer för denna gåva.
Betalningssätt	mode	True	string	Betalningssätt, antingen online eller offline.
Anmärkning	note		string	Anteckningstexten.
Annat fondnamn	other_fund_name		string	När givaren väljer en fond som är markerad som is_other_fund lägger de till ett anpassat fondnamn för att tillskriva gåvan.
Givande sida	id		integer	Systemgenererat ID för att unikt identifiera en givande sida.
ID-nummer	id		integer	Systemgenererat ID för att unikt identifiera en post.
Mängd	amount	True	string	Mängden gåva delas.
Fond	id	True	integer	Systemgenererat ID för att unikt identifiera en fond.
Läge	status	True	string	Status för gåvan.

Returer

Gåva

Body

v1.GivingApi.GiftRead

Skapa en händelse

Åtgärds-ID:

CreateEvent

Skapar en ny händelse.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Description	description		string	Beskrivning av händelsen
Avslutningstid	end_datetime		string	Sluttid för händelsen
Externt databas-ID	external_database_id		string	Ett system som tilldelats unikt ID för posten av den externa databasen. t.ex. systempost-ID för Raiser Edge NXT, kontakt-ID för Salesforce
Url för extern registrering	external_registration_url		string	Registrerings-URL:en för händelsen på en extern webbplats
Namn	name	True	string	Namn på evenemanget
Starttid	start_datetime		string	Starttid för händelsen
Timezone	timezone		string	Tidszon för händelsen
Namn	display_name		string	Ort, delstat, platsland

Returer

Event

Body

v1.EventApi.EventRead

Skapa en pekpunkt

Åtgärds-ID:

createTouchpointCustomObject

Skicka en ny anpassad touchpoint till Almabase.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Program	touchpoint_program	True	integer	Filtrerar typerna efter touchpoint-program.
E-postmeddelande	email		email	E-post-ID som används för aktiviteten.
ID-nummer	id		integer	Systemgenererat ID för att unikt identifiera en post.
Inspelad vid	recorded_at	True	date-time	Tidsstämpeln för aktiviteten.
Typ	id	True	integer

Returer

Touchpoint-brödtext för att skapa en ny touchpoint

Body

v1.AlmasightsApi.TouchpointCustomObjectAdd

Skapa en post

Åtgärds-ID:

CreateRecord

Skapar en ny post.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Rad 1	line1	True	string	Rad 1 i adressen
Rad 2	line2		string	Rad 2 i adressen
Namn	name		string	Ort, delstat, platsland
Privatliv	privacy		string	privatliv
Typ	type	True	string	Typ av tal
Postnummer	zip_code		string	Postnummer för adressen
Födelsedatum	date_of_birth		string	Födelsedatum.
Avliden	deceased		boolean	Avliden.
Address	address		email	E-postadressen
Används för inloggning?	is_login_email		boolean	Anger om användaren får logga in på plattformen med den här e-postadressen.
Är primär?	is_primary		boolean	Ett primärt e-postmeddelande används för att skicka automatiserade e-postmeddelanden som utlöses av systemet. Det används också för att skicka massmeddelandet till profilen. Det är obligatoriskt att endast ett e-postmeddelande anges som primärt.
Källa	source		string	Källan anger hur e-postmeddelandet läggs till i databasen.
Läge	status		string	Status för e-postadressen
Typ	type		string	Typ av e-post
Externt databas-ID	external_database_id		string	Ett system som tilldelats unikt ID för posten av den externa databasen. t.ex. systempost-ID för Raiser Edge NXT, kontakt-ID för Salesforce
Uppslags-ID för extern databas	external_database_lookup_id		string	Ett anpassat användardefinierat uppslags-ID för posten i den externa databasen. t.ex. konstituerande ID
Förnamn	first_name	True	string	Postens förnamn.
Efternamn	last_name	True	string	Postens efternamn.
Mellannamn	middle_name		string	Postens mellannamn.
Nummer	number	True	string	Nummer
Privatliv	privacy		string	privatliv
Typ	type	True	string	Typ av tal

Returer

rekord

Body

v1.RecordApi.RecordRead

Skicka ett formulär

Åtgärds-ID:

CreateFormEntry

Skapar ett nytt formulär som skickas för ett formulär

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Formulär	form_id	True	integer	Systemgenererat ID för att unikt identifiera ett formulär.
body	body		dynamic	Skapa ett nytt formulär som skickas

Returer

Name	Sökväg	Typ	Description
Svars-ID	id	integer	Systemgenererat ID för att unikt identifiera ett formulär som skickas.

Ta bort en e-postadress för en post

Åtgärds-ID:

DeleteRecordEmailAddress

Ta bort en e-postadress för en post.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Post-ID	record_id	True	integer	Systemgenererat ID för att unikt identifiera en post.
ID-nummer	email_id	True	integer	Systemgenererat ID för att unikt identifiera en e-postadress för en post.

Uppdatera en e-postadress för en post

Åtgärds-ID:

UpdateRecordEmailAddress

Uppdaterar fältens e-postadress för en post

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Post-ID	record_id	True	integer	Systemgenererat ID för att unikt identifiera en post.
E-postadress-ID	email_id	True	integer	Systemgenererat ID för att unikt identifiera en e-postadress för en post.
Används för inloggning?	is_login_email		boolean	Anger om användaren får logga in på plattformen med den här e-postadressen.
Är primär?	is_primary		boolean	Ett primärt e-postmeddelande används för att skicka automatiserade e-postmeddelanden som utlöses av systemet. Det används också för att skicka massmeddelandet till profilen. Det är obligatoriskt att endast ett e-postmeddelande anges som primärt.
Läge	status		string	Status för e-postadressen
Typ	type		string	Typ av e-post

Returer

E-postadress

Body

v1.RecordApi.EmailAddressRead

Uppdatera en fond

Åtgärds-ID:

UpdateFund

Uppdaterar en fond.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Fond-ID	id	True	integer	Systemgenererat ID för att unikt identifiera en fond.
Externt databas-ID	external_database_id		string	Ett system som tilldelats unikt ID för fonden av den externa databasen. t.ex. systempost-ID för Raiser Edge NXT, objekt-ID för Salesforce
Är standardfond?	is_default		boolean	Anger för att associera alla delningar till den här fonden om inga andra medel har definierats på Giving Page.
Är andra fonden?	is_other_fund		boolean	Anger att givarna av denna fond har gett anpassade fondnamn.
Fondnamn	name	True	string	Fondens namn

Returer

Fonden som är associerad med gåvodelningen.

Fond

v1.GivingApi.FundRead

Uppdatera en gåva

Åtgärds-ID:

UpdateGift

Uppdaterar en gåva

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Present-ID	id	True	integer	Systemgenererat ID för att unikt identifiera en gåva.
Batchnummer	batch_number		string	Batchnumret för gåvan.
Donatoradress: Rad 1	donor_address_line1		string	Adressrad 1 som används av donatorn för gåvan.
Donatoradress: Rad 2	donor_address_line2		string	Adressrad 2 som används av donatorn för gåvan.
Namn: Stad, Delstat, Land	name		string	Donatorns stad. Format: Ortnamn, kort delstatsnamn, kort landsnamn
Namn på donator	donor_name		string	Fullständigt namn på donatorn.
Telefonnummer för donator	donor_phone_number		string	Telefonnummer som används av donatorn för gåvan.
Donatoradress: Postnummer	donor_zip_code		string	Postnumret för den adress som donatorn använder för gåvan.
Är dold från rankningslistan?	exclude_from_leaderboard		boolean	Är dold från rankningslistan?
Externt databas-ID	external_database_id		string	Ett system som tilldelats unikt ID för gåvan av den externa databasen.
Hyllningsmeddelande	honor_message		string	Ett meddelande till en gåva hyllning.
Hyllningsprefix	honor_prefix		string	Ett prefix för en presenthyllning. Tillgängliga alternativ är in_honor_of, in_memory_of, in_support_of
Är anonym?	is_anonymous		boolean	Anger givarens önskan att vara anonym för andra donatorer för denna gåva.
Anmärkning	note		string	Anteckningstexten.
Annat fondnamn	other_fund_name		string	När givaren väljer en fond som är markerad som is_other_fund lägger de till ett anpassat fondnamn för att tillskriva gåvan.
Givande sida	id		integer	Systemgenererat ID för att unikt identifiera en givande sida.
ID-nummer	id		integer	Systemgenererat ID för att unikt identifiera en post.
Mängd	amount	True	string	Mängden gåva delas.
Fond	id	True	integer	Systemgenererat ID för att unikt identifiera en fond.

Returer

Gåva

Body

v1.GivingApi.GiftRead

Uppdatera en händelse

Åtgärds-ID:

UpdateEvent

Uppdaterar en händelse.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Händelse-ID	id	True	integer	Systemgenererat ID för att unikt identifiera en händelse.
Description	description		string	Beskrivning av händelsen
Avslutningstid	end_datetime		string	Sluttid för händelsen
Externt databas-ID	external_database_id		string	Ett system som tilldelats unikt ID för posten av den externa databasen. t.ex. systempost-ID för Raiser Edge NXT, kontakt-ID för Salesforce
Url för extern registrering	external_registration_url		string	Registrerings-URL:en för händelsen på en extern webbplats
Namn	name		string	Namn på evenemanget
Starttid	start_datetime		string	Starttid för händelsen
Timezone	timezone		string	Tidszon för händelsen
Namn	display_name		string	Ort, delstat, platsland

Returer

Event

Body

v1.EventApi.EventRead

Uppdatera en kontaktperson

Åtgärds-ID:

UpdateEventContactPerson

Uppdaterar en kontaktperson för en händelse.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Händelse-ID	id	True	integer	Systemgenererat ID för att unikt identifiera en händelse.
Händelsekontaktens person-ID	person_id	True	integer	Systemgenererat ID för att unikt identifiera en kontaktperson för en händelse.
E-postmeddelande	email		email	E-post till kontaktpersonen
Namn	name		string	Kontaktpersonens namn
Telefonnummer	phone_number		string	Kontaktpersonens telefonnummer

Returer

Kontaktperson för en händelse

Body

v1.EventApi.ContactPersonRead

Uppdatera en post

Åtgärds-ID:

UpdateRecord

Uppdaterar en post.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Post-ID	id	True	integer	Systemgenererat ID för att unikt identifiera en post.
Externt databas-ID	external_database_id		string	Ett system som tilldelats unikt ID för posten av den externa databasen. t.ex. systempost-ID för Raiser Edge NXT, kontakt-ID för Salesforce
Uppslags-ID för extern databas	external_database_lookup_id		string	Ett anpassat användardefinierat uppslags-ID för posten i den externa databasen. t.ex. konstituerande ID
Förnamn	first_name		string	Postens förnamn.
Efternamn	last_name		string	Postens efternamn.

Returer

rekord

Body

v1.RecordApi.RecordRead

Visa en lista över gåvor

Åtgärds-ID:

ListGifts

Returnerar en lista med gåvor.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Läge	status	True	string	Filtrera gåvor baserat på statusen.
Givande sida	campaign		integer	Systemgenererat ID för att unikt identifiera en givande sida.
Filtrera efter presentgrupps-ID	group_id		uuid	Systemgenererat ID för att unikt identifiera en presentgrupp eller en lista.
Ska ha ett tomt batchnummer?	batch_number__isnull		boolean	Filtrera gåvor baserat på att de har ett batchnummer eller inte.
Ska det finnas ett tomt externt databas-ID?	external_database_id__isnull		boolean	Filtrera gåvor baserat på att de redan har ett externt databas-ID eller inte. Obs! Gåvorna som har ett externt databas-ID skickas redan till en extern databas.
Filtrera efter externt databas-ID	external_database_id		string	Filtrera gåvor baserat på externt databas-ID.
Filtrera efter e-post för donator	donor_email		string	Filtrera gåvor baserat på donator-e-postadress
Sök efter	search		string	Sök efter gåvor efter namn eller e-postadress.
Fields	fields		array	Kommaavgränsad lista över fält i svaret.
Sidstorlek	page_size		integer	Representerar antalet poster som ska returneras. Standardvärdet är 10. Maxvärdet är 50.
Sidnummer	page		integer	Representera sidnumren (förskjutning). För användning med sidnumrering.
Sortera efter	ordering		string	Definiera ordningen på gåvorna i svaret. Ett "-" prefix representerar fallande ordning, och om prefixet saknas returneras resultatet i stigande ordning.

Returer

Name	Sökväg	Typ	Description
Url för nästa resultat	nextlink	uri	URL för nästa siduppsättning med resultat. För användning med sidnumrering.
URL för tidigare resultat	previouslink	uri	URL för den tidigare uppsättningen resultat. För användning med sidnumrering.
Totalt antal gåvor	total	integer	Totalt antal gåvor för de angivna filtren
Gåvor	value	array of v1.GivingApi.GiftRead	Lista över gåvor som returneras för de angivna filtren. Resultaten är sidnumrerade.

Utlösare

När en ny gåva lyckas eller en onlinegåvabetalning misslyckas	Utlöses när en ny gåva har registrerats på en givande sida av en donator eller betalningen till en gåva misslyckas.
När en post skapas eller uppdateras på Almabase	Utlöses när en ny post skapas på Almabase eller om en befintlig post uppdateras.
När ett e-postmeddelande skapas, uppdateras eller tas bort på en post	Utlöses när ett nytt e-postmeddelande skapas på en post eller ett befintligt e-postmeddelande uppdateras eller tas bort från en post.
När ett formulär skickas eller ett befintligt formulär skickas uppdateras	Utlöses när ett formulär skickas eller en befintlig formuläröverföring uppdateras.

När en ny gåva lyckas eller en onlinegåvabetalning misslyckas

Åtgärds-ID:

GiftSucceededOrFailedWebhook

Utlöses när en ny gåva har registrerats på en givande sida av en donator eller betalningen till en gåva misslyckas.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
When	events	True	string	Listan över händelser som utlöser flödet.
Givande sida	object_id		integer	Systemgenererat ID för att unikt identifiera en givande sida.

Returer

Body

v1.GivingApi.GiftWebhookResponse

När en post skapas eller uppdateras på Almabase

Åtgärds-ID:

RecordChangedWebhook

Utlöses när en ny post skapas på Almabase eller om en befintlig post uppdateras.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
When	events	True	string	Listan över händelser som utlöser flödet.

Returer

Body

v1.RecordApi.RecordWebhookResponse

När ett e-postmeddelande skapas, uppdateras eller tas bort på en post

Åtgärds-ID:

EmailChangedWebhook

Utlöses när ett nytt e-postmeddelande skapas på en post eller ett befintligt e-postmeddelande uppdateras eller tas bort från en post.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
When	events	True	string	Listan över händelser som utlöser flödet.

Returer

Body

v1.RecordApi.EmailWebhookResponse

När ett formulär skickas eller ett befintligt formulär skickas uppdateras

Åtgärds-ID:

FormEntryCreateOrUpdateWebhook

Utlöses när ett formulär skickas eller en befintlig formuläröverföring uppdateras.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
When	events	True	string	Listan över händelser som utlöser flödet.
Formulär	object_id	True	integer	Systemgenererat ID för att unikt identifiera ett formulär.

Returer

Utdata för den här åtgärden är dynamiska.

Definitioner

v1. FormApi.FormRead

Formulär

Name	Sökväg	Typ	Description
ID-nummer	id	integer	Systemgenererat ID för att unikt identifiera ett formulär.
Formulärnamn	title	string	Formulärets namn

v1. GivingApi.GiftWebhookRecordRead

Rekord

Name	Sökväg	Typ	Description
Externt databas-ID	external_database_id	string	Ett system som tilldelats unikt ID för posten av den externa databasen. t.ex. systempost-ID för Raiser Edge NXT, kontakt-ID för Salesforce
Förnamn	first_name	string	Förnamn för den mappade posten
ID-nummer	id	integer	Systemgenererat ID för att unikt identifiera en post.
Är donator registrerad på Almabase?	is_registered	boolean	Ange om den mappade posten eller donatorn som är registrerad på Almabase
Efternamn	last_name	string	Efternamn på den mappade posten

v1. GivingApi.GiftWebhookResponse

Name	Sökväg	Typ	Description
Mängd	data.amount	string	Presentbeloppet med två decimaler.
Date	data.completed_at	date-time	Det datum då status för gåvan har markerats som slutförd.
E-post för donator	data.email	email	E-post-ID som används av donatorn för gåvan.
Externt databas-ID	data.external_database_id	string	Ett system som tilldelats unikt ID för gåvan av den externa databasen.
ID-nummer	data.id	integer	Systemgenererat ID för att unikt identifiera en gåva.
Är ny e-post?	data.is_email_new	boolean	Anger om e-postmeddelandet som tillhandahålls av givaren redan finns i Almabase-poster.
schema	data.mapped_profile.schema	v1.GivingApi.GiftWebhookRecordRead	Rekord
Mode	data.mode	string	Läge för gåvan.
Namn på donator	data.name	string	Fullständigt namn på donatorn.
ID-nummer	data.page.id	integer	Systemgenererat ID för att unikt identifiera en givande sida.
Ge sidnamn	data.page.name	string	Namnet på den associerade givande sidan
Läge	data.status	string	Status för gåvan.
Händelse som utlöses vid	time	string	Händelsetiden.
Händelsetyp	type	string	Händelsetyp

v1. GivingApi.LocationRead

Staden som donatorn använde för gåvan.

Name	Sökväg	Typ	Description
City	city	string	Staden av givaren
Ortens korta namn	city_short_name	string	Den korta representationen av staden, t.ex.
Latitud	coordinates.latitude	string	Platsens latitud
Longitud	coordinates.longitude	string	Platsens longitud
Country	country	string	Givarens land
Kort namn på land	country_short_name	string	Den korta representationen av landet, t.ex.
Google Place-ID	gpid	string	Plats-ID:t som hämtats från Google
Stad, Delstat, Land	name	string	Donatorns stad. Format: Ortnamn, kort delstatsnamn, kort landsnamn
Stat/län	state	string	Givarens tillstånd
Kort namn för tillstånd	state_short_name	string	Den korta representationen av tillståndet, t.ex. CA

v1. GivingApi.FormFieldRead

Formulärfält

Name	Sökväg	Typ	Description
Värde	display_value	string	Det formaterade värdet som angetts av svararna. t.ex. Namnet på filuppladdningen.
Namn på fråge-/formulärfält	label	string	Namn på fråge-/formulärfält i formuläret

v1. GivingApi.FundRead

Fonden som är associerad med gåvodelningen.

Name	Sökväg	Typ	Description
Externt databas-ID	external_database_id	string	Ett system som tilldelats unikt ID för fonden av den externa databasen. t.ex. systempost-ID för Raiser Edge NXT, objekt-ID för Salesforce
ID-nummer	id	integer	Systemgenererat ID för att unikt identifiera en fond.
Är standardfond?	is_default	boolean	Anger för att associera alla delningar till den här fonden om inga andra medel har definierats på Giving Page.
Är andra fonden?	is_other_fund	boolean	Anger att givarna av denna fond har gett anpassade fondnamn.
Namn	name	string	Fondens namn

v1. GivingApi.GiftRead

Gåva

Name	Sökväg	Typ	Description
Presentbelopp	amount	string	Presentbeloppet med två decimaler.
Batchnummer	batch_number	string	Batchnumret för gåvan.
Presentdatum	completed_at	date-time	Det datum då status för gåvan har markerats som slutförd.
Valuta	currency	integer	Valuta som används av givaren för gåvan.
Device	device	string	Identifiera den enhet som används för att göra gåvan, t.ex. pc, mobil eller surfplatta.
Donatoradress: Rad 1	donor_address_line1	string	Adressrad 1 som används av donatorn för gåvan.
Donatoradress: Rad 2	donor_address_line2	string	Adressrad 2 som används av donatorn för gåvan.
Donatoradress: Plats	donor_city_place	v1.GivingApi.LocationRead	Staden som donatorn använde för gåvan.
E-post för donator	donor_email	email	E-post-ID som används av donatorn för gåvan.
Namn på donator	donor_name	string	Fullständigt namn på donatorn.
Telefonnummer för donator	donor_phone_number	string	Telefonnummer som används av donatorn för gåvan.
Donatoradress: Postnummer	donor_zip_code	string	Postnumret för den adress som donatorn använder för gåvan.
Är dold från rankningslistan?	exclude_from_leaderboard	boolean	Är dold från rankningslistan?
Externt databas-ID	external_database_id	string	Ett system som tilldelats unikt ID för gåvan av den externa databasen.
Hyllningsmeddelande	honor_message	string	Ett meddelande till en gåva hyllning.
Hyllningsprefix	honor_prefix	string	Ett prefix för en presenthyllning. Tillgängliga alternativ är in_honor_of, in_memory_of, in_support_of
ID-nummer	id	integer	Systemgenererat ID för att unikt identifiera en gåva.
Påverkare	influencer	v1.GivingApi.InfluencerRead	Länken till den offentliga resursen och den privata instrumentpanelen
Är anonym?	is_anonymous	boolean	Anger givarens önskan att vara anonym för andra donatorer för denna gåva.
Har givaren täckt avgifterna för betalningsgatewayen?	is_donor_covered_charges	boolean	Anger om givaren har valt att täcka avgifterna för betalningsgatewayen när han eller hon gör den här gåvan?
Har e-post lagts till i en post på Almabase?	is_email_added_to_profile	boolean	Anger om e-postmeddelandet som tillhandahålls av donatorn läggs till i Almabase-posten (oavsett is_email_new status)
Är ny e-post?	is_email_new	boolean	Anger om e-postmeddelandet som tillhandahålls av givaren redan finns i Almabase-poster.
Ignoreras mappning till en post på Almabase?	is_profile_mapping_ignored	boolean	Anger om postmappningen ska ignoreras.
Betalningssätt	mode	string	Betalningssätt, antingen online eller offline.
Anmärkning	note	string	Anteckningstexten.
Annat fondnamn	other_fund_name	string	När givaren väljer en fond som är markerad som is_other_fund lägger de till ett anpassat fondnamn för att tillskriva gåvan.
Givande sida	page	v1.GivingApi.GivingPageAssociatedWithGift	Den givande sidan som är associerad med gåvan.
Fields	post_payment_form_entry.fields	array of v1.GivingApi.FormFieldRead
Svars-ID	post_payment_form_entry.id	integer	Systemgenererat ID för att unikt identifiera ett formulär som skickas.
Fields	pre_payment_form_entry.fields	array of v1.GivingApi.FormFieldRead
Svars-ID	pre_payment_form_entry.id	integer	Systemgenererat ID för att unikt identifiera ett formulär som skickas.
Mappad post	profile	v1.GivingApi.RecordRead	Mappad post på Almabase
Referenslänk	referrer_link	string	Länken till webbplatsen för att identifiera källan till hur givaren besöker. t.ex. Givaren besökte kampanjen Giving från Facebook, Google osv.
Återbetalningsbelopp	refund_amount	string	Det belopp som återbetalas till givaren. Om hela beloppet återbetalas återbetalas statusen för gåvan i stället för att slutföras.
Spagat	splits	array of v1.GivingApi.GiftSplitRead	Delningarna som är associerade med gåvan.
Läge	status	string	Status för gåvan.
Onlinetransaktion	transaction	v1.GivingApi.TransactionRead	Den onlinebetalningstransaktion som är associerad med gåvan.
UTM-kampanj	utm_campaign	string	Används för nyckelordsanalys. utm_campaign identifiera en specifik produktkampanj eller strategisk kampanj. t.ex. annual_fund_2020
UTM Medium	utm_medium	string	utm_medium identifiera ett medium, till exempel e-post eller kostnad per klick. t.ex. cpc
UTM-källa	utm_source	string	utm_source identifiera en sökmotor, ett nyhetsbrevsnamn eller en annan källa. t.ex. Google

v1. GivingApi.GiftSplitRead

Gåvodelning

Name	Sökväg	Typ	Description
Mängd	amount	string	Mängden gåva delas.
Fond	fund	v1.GivingApi.FundRead	Fonden som är associerad med gåvodelningen.
ID-nummer	id	integer	Systemgenererat ID för att unikt identifiera en presentdelning.

v1. GivingApi.GivingPageAssociatedWithGift

Den givande sidan som är associerad med gåvan.

Name	Sökväg	Typ	Description
ID-nummer	id	integer	Systemgenererat ID för att unikt identifiera en givande sida.
Namn	name	string	Namnet på den associerade givande sidan.

v1. GivingApi.GivingPageRead

Givande sida

Name	Sökväg	Typ	Description
ID-nummer	id	integer	Systemgenererat ID för att unikt identifiera en givande sida.
Namn	name	string	Namn på givande sida

v1. GivingApi.InfluencerRead

Länken till den offentliga resursen och den privata instrumentpanelen

Name	Sökväg	Typ	Description
Länk till instrumentpanelen för privat influerare	dashboard_url	uri	Den privata instrumentpanelen för givaren för att övervaka antalet sidbesök och gåvor som påverkas av dem
Länk till offentlig resurs	page_share_url	uri	Den offentliga länken till att ge sida / kampanj av donator för att spåra inflytandet på besök på Giving Page och gåvorna.

v1. GivingApi.PaymentAccountRead

Det betalningskonto som är kopplat till transaktionen, t.ex. BBMS, Stripe, PayPal osv.

Name	Sökväg	Typ	Description
ID-nummer	id	integer	Systemgenererat ID för att unikt identifiera ett betalningskonto.
Namn	name	string	Namnet på betalningskontot.
Gateway	type	string	Namnet på betalningsgatewayen.

v1. GivingApi.RecordRead

Mappad post på Almabase

Name	Sökväg	Typ	Description
Externt databas-ID	external_database_id	string	Ett system som tilldelats unikt ID för posten av den externa databasen. t.ex. systempost-ID för Raiser Edge NXT, kontakt-ID för Salesforce
Förnamn	first_name	string	Förnamn för den mappade posten
Fullständigt namn	formatted_name	string	Fullständigt namn på den mappade posten
ID-nummer	id	integer	Systemgenererat ID för att unikt identifiera en post.
Är donator registrerad på Almabase?	is_registered	boolean	Ange om den mappade posten eller donatorn som är registrerad på Almabase
Efternamn	last_name	string	Efternamn på den mappade posten
Bild-URL	present_picture	uri	Url:en för arkivhandlingsbilden
Länk	profile_url	uri	Postlänken på Almabase

v1. GivingApi.TransactionRead

Den onlinebetalningstransaktion som är associerad med gåvan.

Name	Sökväg	Typ	Description
Betalningskonto	account	v1.GivingApi.PaymentAccountRead	Det betalningskonto som är kopplat till transaktionen, t.ex. BBMS, Stripe, PayPal osv.
Skapat vid	created_at	date-time	Tidpunkten för att skapa den här transaktionen.
Felorsak	failure_reason	string	Orsaken till transaktionsfelet som returnerades av betalningsgatewayen.
ID-nummer	id	uuid	Systemgenererat ID för att unikt identifiera en transaktion.
Läge	status	integer	Status för transaktionen. - 1 (obearbetad) - 2 (lyckades) - 3 (misslyckades) - 4 (väntar) - 5 (fel) OBS: Dessa status är associerade med statusen för transaktionen av Payment Gateway
Referens-ID för Payment Gateway	transaction_id	string	Det unika ID som genereras av betalningsgatewayen för att identifiera transaktionen. t.ex. Transaktions-ID för Blackbaud Merchant Services (BBMS) eller Stripe Charge ID PayPal transaktions-ID

v1. AlmasightsApi.RecordAddOrEdit

Spela in på Almabase.

Name	Sökväg	Typ	Description
ID-nummer	id	integer	Systemgenererat ID för att unikt identifiera en post.

v1. AlmasightsApi.TouchpointCustomObjectAdd

Touchpoint-brödtext för att skapa en ny touchpoint

Name	Sökväg	Typ	Description
E-postmeddelande	email	email	E-post-ID som används för aktiviteten.
Rekord	mapped_profile	v1.AlmasightsApi.RecordAddOrEdit	Spela in på Almabase.
Inspelad vid	recorded_at	date-time	Tidsstämpeln för aktiviteten.
Typ	touchpoint_type.id	integer

v1. RecordApi.LocationRead

Adressplats

Name	Sökväg	Typ	Description
City	city	string	Ortens namn på platsen
Country	country	string	Namnet på platsen
Latitud	latitude	double	Platsens latitud
Longitud	longitude	double	Platsens longitud
Stat/län	state	string	Platsens tillståndsnamn

v1. RecordApi.AddressRead

Address

Name	Sökväg	Typ	Description
Rad 1	line1	string	Rad 1 i adressen
Rad 2	line2	string	Rad 2 i adressen
schema	location.schema	v1.RecordApi.LocationRead	Adressplats
Postnummer	zipcode	string	Postnummer för adressen

v1. RecordApi.EmailWebhookRecordRead

Rekord

Name	Sökväg	Typ	Description
Externt databas-ID	external_database_id	string	Ett system som tilldelats unikt ID för posten av den externa databasen. t.ex. systempost-ID för Raiser Edge NXT, kontakt-ID för Salesforce
Förnamn	first_name	string	Förnamn för den mappade posten
ID-nummer	id	integer	Systemgenererat ID för att unikt identifiera en post.
Är posten registrerad på Almabase?	is_registered	boolean	Ange om den mappade posten som registrerats på Almabase
Efternamn	last_name	string	Efternamn på den mappade posten

v1. RecordApi.EmailWebhookResponse

Name	Sökväg	Typ	Description
E-postadress	data.address	email	E-postadress.
ID-nummer	data.id	integer	Systemgenererat ID för att unikt identifiera ett e-postmeddelande.
Är primärt	data.is_primary	boolean	Anger om e-postmeddelandet är primärt eller inte.
schema	data.profile.schema	v1.RecordApi.EmailWebhookRecordRead	Rekord
E-posttyp	data.type	string	Typ av e-postadress (primär, personlig, arbete osv.).
Händelse som utlöses vid	time	string	Händelsetiden.
Händelsetyp	type	string	Händelsetyp

v1. RecordApi.RecordWebhookResponse

Name	Sökväg	Typ	Description
Anknytningar	data.affiliations	array of string
Klassår	data.class_year	string	Postens klassår
E-postadress	data.email	email	E-postadress.
Externt databas-ID	data.external_database_id	string	Ett system som tilldelats unikt ID för posten av den externa databasen. t.ex. systempost-ID för Raiser Edge NXT, kontakt-ID för Salesforce
Förnamn	data.first_name	string	Förnamn för den mappade posten
schema	data.home_address.schema	v1.RecordApi.AddressRead	Address
ID-nummer	data.id	integer	Systemgenererat ID för att unikt identifiera en post.
Efternamn	data.last_name	string	Efternamn på den mappade posten
Förfallodatum för medlemskap	data.membership_expiry_date	date-time	Förfallodatum för postens medlemskap
Namn på medlemskapstyp	data.membership_type_name	string	Namnet på postens medlemskapstyp
Mobilnummer	data.mobile_number	string	Mobilnummer för posten
schema	data.office_address.schema	v1.RecordApi.AddressRead	Address
Office-telefonnummer	data.office_phone_number	string	Postens Office-telefonnummer
Telefonnummer för bostad	data.residence_phone_number	string	Postens uppehållstillståndsnummer
Händelse som utlöses vid	time	string	Händelsetiden.
Händelsetyp	type	string	Händelsetyp

v1. RecordApi.EmailAddressRead

E-postadress

Name	Sökväg	Typ	Description
Address	address	email	E-postadressen
ID-nummer	id	integer	Systemgenererat ID för att unikt identifiera en e-postadress för en post.
Är förlovad?	is_engaged	boolean	Anger om ett massmeddelande har klickats eller öppnats, eller om användaren svarar på ett e-postmeddelande
Används för inloggning?	is_login_email	boolean	Anger om användaren får logga in på plattformen med den här e-postadressen.
Är primär?	is_primary	boolean	Ett primärt e-postmeddelande används för att skicka automatiserade e-postmeddelanden som utlöses av systemet. Det används också för att skicka massmeddelandet till posten. Det är obligatoriskt att endast ett e-postmeddelande anges som primärt.
Verifieras av användaren?	is_verified	boolean	Ange om användaren har verifierat att de äger e-postmeddelandet.
källa	source	string	Källan anger hur e-postmeddelandet läggs till i databasen.
status	status	string
Typ	type	string	Typ av e-post

v1. RecordApi.RecordRead

rekord

Name	Sökväg	Typ	Description
E-postadresser	email_addresses	array of v1.RecordApi.EmailAddressRead	Lista över e-postadresser för en profil
Externt databas-ID	external_database_id	string	Ett system som tilldelats unikt ID för posten av den externa databasen. t.ex. systempost-ID för Raiser Edge NXT, kontakt-ID för Salesforce
Förnamn	first_name	string	Postens förnamn.
Fullständigt namn	formatted_name	string	Fullständigt namn på posten.
ID-nummer	id	integer	Systemgenererat ID för att unikt identifiera en post.
Är registrerad på Almabase?	is_registered	boolean	Ange om posten eller donatorn som är registrerad på Almabase
Efternamn	last_name	string	Postens efternamn.
Bild-URL	present_picture	uri	Url:en för arkivhandlingsbilden
Länk	record_url	uri	Postlänken på Almabase

v1. EventApi.ContactPersonRead

Kontaktperson för en händelse

Name	Sökväg	Typ	Description
E-postmeddelande	email	email	E-post till kontaktpersonen
ID-nummer	id	integer	Systemgenererat ID för att unikt identifiera en kontaktperson.
Namn	name	string	Kontaktpersonens namn
Telefonnummer	phone_number	string	Kontaktpersonens telefonnummer

v1. EventApi.EventRead

Event

Name	Sökväg	Typ	Description
Description	description	string	Beskrivning av händelsen
Avslutningstid	end_datetime	string	Sluttid för händelsen
Externt databas-ID	external_database_id	string	Ett system som tilldelats unikt ID för posten av den externa databasen. t.ex. systempost-ID för Raiser Edge NXT, kontakt-ID för Salesforce
Url för extern registrering	external_registration_url	string	Registrerings-URL:en för händelsen på en extern webbplats
ID-nummer	id	integer	Systemgenererat ID för att unikt identifiera en händelse.
Namn	name	string	Namn på evenemanget
Starttid	start_datetime	string	Starttid för händelsen
Timezone	timezone	string	Tidszon för händelsen