Almabase (anteprima)
Almabase è il software di gestione degli ex studenti più amato al mondo per creare programmi incentrati sugli studenti per aumentare la partecipazione, il coinvolgimento dei donatori e ospitare comunità online coinvolgenti.
Questo connettore è disponibile nei prodotti e nelle aree seguenti:
| Servizio | Class | Regions |
|---|---|---|
| Copilot Studio | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| App per la logica | Normale | Tutte le aree di App per la logica , ad eccezione delle seguenti: - Aree di Azure per enti pubblici - Aree di Azure Cina - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Apps | Di alta qualità | Tutte le aree di Power Apps , ad eccezione dei seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Automate | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Contatto | |
|---|---|
| Nome | Supporto di Almabase |
| URL | https://docs.almabase.com |
| help@almabase.com |
| Metadati del connettore | |
|---|---|
| Editore | Almabase, Inc. |
| Sito web | https://almabase.com |
| Informativa sulla privacy | https://www.almabase.com/ecloud-privacy-policy |
| Categorie | Vendite e CRM; Produttività |
Almabase fornisce strumenti software e strategie per gli istituti di istruzione per creare programmi incentrati sugli studenti che trasformano gli ex ex-studenti in sostenitori per la vita.
Questo connettore si basa sulle API di Almabase e sui webhook e fornisce operazioni per gestire le entità presenti in Almabase, tra cui:
- Record (componenti)
- Regali
- Events
- Punti di tocco di Engagement
- Forme
- Fondi
- Assegnare pagine
- Campagne di raccolta fondi peer-to-peer
- E altro ancora...
Prerequisiti
Per usare questo connettore,
- È necessario disporre di una sottoscrizione di Almabase attiva.
- È necessario avere il ruolo di amministratore del sito.
Come ottenere le credenziali
- Accedere al portale di amministrazione fornito da Almabase.
- Passare a
API's & TokensinSettings. - Fare clic su
Add Auth Tokene compilaredescriptione impostare il tokenexpiry date & time. - Prendere nota di
Workflow Access Token(fare clic sul token per copiare negli Appunti). - Usare quando
Workflow Access Tokensi crea la nuova connessione in Power Automate.
Introduzione al connettore
Casi d'uso comuni
- Quando viene fatto un regalo, inviare un messaggio personalizzato e una ricevuta regalo.
- Quando un'attività di engagement viene registrata su Slack, Gmail o su qualsiasi altro social media, aggiungere l'attività di engagement a Engagement Studio su Almabase usando
Create Custom Touchpointl'azione. - Quando un nuovo indirizzo di posta elettronica viene trovato (ex-alunni persi) in un regalo o in un invio di un evento o un invio di modulo, aggiungere tale indirizzo di posta elettronica a un record su Almabase o un costituente su Raiser Edge o un contatto su Salesforce.
- Progettare la sincronizzazione dei dati bidirezionali tra Almabase e Blackbaud Raiser's Edge.
- Progettare la sincronizzazione dei dati bidirezionali tra Almabase e Salesforce.
Problemi noti e limitazioni
- I trigger regalo funzionano solo quando viene effettuato il pagamento online su Almabase. I regali aggiunti manualmente non attivano i flussi.
Creazione di una connessione
Il connettore supporta i tipi di autenticazione seguenti:
| Predefinita | Parametri per la creazione della connessione. | Tutte le aree geografiche | Non condivisibile |
Predefinito
Applicabile: tutte le aree
Parametri per la creazione della connessione.
Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.
| Nome | TIPO | Description | Obbligatorio |
|---|---|---|---|
| URL del dominio | corda | Specificare l'URL del dominio Almabase, ad esempio https://your.domain.com | Vero |
| Chiave API | securestring | Chiave API dell'utente | Vero |
Limiti per la limitazione delle richieste
| Nome | Chiamate | Periodo di rinnovo |
|---|---|---|
| Chiamate API per connessione | 100 | 60 secondi |
Azioni
| Aggiornare un evento |
Aggiorna un evento. |
| Aggiornare un fondo |
Aggiorna un fondo. |
| Aggiornare un indirizzo di posta elettronica di un record |
Aggiorna i campi l'indirizzo di posta elettronica di un record |
| Aggiornare un record |
Aggiorna un record. |
| Aggiornare un regalo |
Aggiorna un regalo |
| Aggiornare una persona di contatto |
Aggiorna una persona di contatto in un evento. |
| Aggiungere una persona di contatto |
Aggiunge una persona contatto a un evento. |
| Creare un evento |
Crea un nuovo evento. |
| Creare un fondo |
Crea un nuovo fondo. |
| Creare un indirizzo di posta elettronica per un record |
Crea un nuovo indirizzo di posta elettronica per un record. |
| Creare un punto di tocco |
Inviare un nuovo punto di tocco personalizzato a Almabase. |
| Creare un record |
Crea un nuovo record. |
| Creare un regalo |
Crea un nuovo regalo. |
| Elenca eventi |
Restituisce un elenco di tutti gli eventi. |
| Elencare gli indirizzi di posta elettronica di un record |
Restituisce un elenco di indirizzi di posta elettronica per un record. |
| Elencare i fondi |
Restituisce un elenco di fondi |
| Elencare i moduli |
Ottenere un elenco di moduli. |
| Elencare i record |
Restituisce un elenco di record. |
| Elencare i regali |
Restituisce un elenco di regali. |
| Elencare le pagine con le pagine |
Restituisce un elenco di pagine che assegnano. |
| Elencare le persone di contatto |
Restituisce un elenco di tutte le persone di contatto di un evento. |
| Eliminare un indirizzo di posta elettronica di un record |
Eliminare un indirizzo di posta elettronica di un record. |
| Inviare un modulo |
Crea un nuovo invio di modulo per un modulo |
| Ottenere un evento |
Restituisce informazioni su un evento. |
| Ottenere un fondo |
Restituisce informazioni su un fondo. |
| Ottenere un indirizzo di posta elettronica di un record |
Restituisce informazioni su un indirizzo di posta elettronica di un record. |
| Ottenere un invio di un modulo |
Restituisce informazioni su un invio di modulo. |
| Ottenere un record |
Restituisce informazioni su un record. |
| Ottenere una pagina di assegnare |
Restituisce informazioni su una pagina di assegnare. |
| Ottieni un regalo |
Restituisce informazioni su un regalo. |
Aggiornare un evento
Aggiorna un evento.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID evento
|
id | True | integer |
ID generato dal sistema per identificare in modo univoco un evento. |
|
Description
|
description | string |
Descrizione dell'evento |
|
|
Ora di fine
|
end_datetime | string |
Ora di fine dell'evento |
|
|
ID database esterno
|
external_database_id | string |
ID univoco assegnato dal sistema per il record dal database esterno. Ad esempio, ID record di sistema per Raiser Edge NXT, ID contatto per Salesforce |
|
|
URL registrazione esterna
|
external_registration_url | string |
URL di registrazione dell'evento in un sito Web esterno |
|
|
Nome
|
name | string |
Nome dell'evento |
|
|
Ora di avvio
|
start_datetime | string |
Ora di inizio dell'evento |
|
|
Timezone
|
timezone | string |
Fuso orario dell'evento |
|
|
Nome
|
display_name | string |
City,State,Country of the Venue |
Restituisce
Event
- Corpo
- v1.EventApi.EventRead
Aggiornare un fondo
Aggiorna un fondo.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID fondo
|
id | True | integer |
ID generato dal sistema per identificare in modo univoco un fondo. |
|
ID database esterno
|
external_database_id | string |
ID univoco assegnato dal sistema per il fondo dal database esterno. Ad esempio, ID record di sistema per Raiser Edge NXT, ID oggetto per Salesforce |
|
|
Il fondo predefinito è?
|
is_default | boolean |
Indica di associare tutte le divisioni a questo fondo se non sono definiti altri fondi in Pagina di donazioni. |
|
|
È un altro fondo?
|
is_other_fund | boolean |
Indica che i donatori del fondo hanno assegnato il nome del fondo personalizzato. |
|
|
Nome fondo
|
name | True | string |
Nome del fondo |
Restituisce
Il fondo associato alla divisione dei regali.
- Fondo
- v1.GivingApi.FundRead
Aggiornare un indirizzo di posta elettronica di un record
Aggiorna i campi l'indirizzo di posta elettronica di un record
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID record
|
record_id | True | integer |
ID generato dal sistema per identificare in modo univoco un record. |
|
ID indirizzo di posta elettronica
|
email_id | True | integer |
ID generato dal sistema per identificare in modo univoco un indirizzo di posta elettronica di un record. |
|
Usare per l'accesso?
|
is_login_email | boolean |
Indica se l'utente è autorizzato ad accedere alla piattaforma usando questo indirizzo di posta elettronica. |
|
|
È primario?
|
is_primary | boolean |
Un messaggio di posta elettronica primario viene usato per inviare i messaggi di posta elettronica automatizzati attivati dal sistema. Viene usato anche per inviare il messaggio di posta elettronica in blocco al profilo. È obbligatorio impostare un solo messaggio di posta elettronica come primario. |
|
|
stato
|
status | string |
Stato dell'indirizzo di posta elettronica |
|
|
TIPO
|
type | string |
Tipo di messaggio di posta elettronica |
Restituisce
Indirizzo di posta elettronica
Aggiornare un record
Aggiorna un record.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID record
|
id | True | integer |
ID generato dal sistema per identificare in modo univoco un record. |
|
ID database esterno
|
external_database_id | string |
ID univoco assegnato dal sistema per il record dal database esterno. Ad esempio, ID record di sistema per Raiser Edge NXT, ID contatto per Salesforce |
|
|
ID ricerca database esterno
|
external_database_lookup_id | string |
ID di ricerca personalizzato definito dall'utente per il record nel database esterno. Ad esempio, ID costituente |
|
|
Nome di battesimo
|
first_name | string |
Nome del record. |
|
|
Cognome
|
last_name | string |
Cognome del record. |
Restituisce
Registrazione
- Corpo
- v1.RecordApi.RecordRead
Aggiornare un regalo
Aggiorna un regalo
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID regalo
|
id | True | integer |
ID generato dal sistema per identificare in modo univoco un regalo. |
|
Numero batch
|
batch_number | string |
Numero batch del regalo. |
|
|
Indirizzo del donatore: riga 1
|
donor_address_line1 | string |
La riga di indirizzo 1 utilizzata dal donatore per il dono. |
|
|
Indirizzo del donatore: riga 2
|
donor_address_line2 | string |
La riga di indirizzo 2 utilizzata dal donatore per il dono. |
|
|
Nome: Città, Stato, Paese
|
name | string |
Città del donatore. Formato: Nome città, Nome stato breve, Nome paese breve |
|
|
Nome donatore
|
donor_name | string |
Nome completo del donatore. |
|
|
Numero di telefono del donatore
|
donor_phone_number | string |
Numero di telefono utilizzato dal donatore per il regalo. |
|
|
Indirizzo del donatore: Cap.
|
donor_zip_code | string |
Codice postale dell'indirizzo utilizzato dal donatore per il regalo. |
|
|
È nascosto dal tabellone punteggi?
|
exclude_from_leaderboard | boolean |
È nascosto dal tabellone punteggi? |
|
|
ID database esterno
|
external_database_id | string |
ID univoco assegnato dal sistema per il regalo dal database esterno. |
|
|
Messaggio omaggio
|
honor_message | string |
Un messaggio per un tributo regalo. |
|
|
Prefisso omaggio
|
honor_prefix | string |
Un prefisso per un tributo regalo. Le opzioni disponibili sono in_honor_of, in_memory_of, in_support_of |
|
|
È anonimo?
|
is_anonymous | boolean |
Indica che il desiderio del donatore sia anonimo ad altri donatori per questo dono. |
|
|
Annotazioni
|
note | string |
Testo della nota. |
|
|
Nome altro fondo
|
other_fund_name | string |
Quando il donatore seleziona un fondo contrassegnato come is_other_fund, aggiunge un nome di fondo personalizzato per attribuire il regalo. |
|
|
Pagina di assegnare
|
id | integer |
ID generato dal sistema per identificare in modo univoco una pagina di selezione. |
|
|
Documento d'identità
|
id | integer |
ID generato dal sistema per identificare in modo univoco un record. |
|
|
Importo
|
amount | True | string |
La quantità della divisione regalo. |
|
Fondo
|
id | True | integer |
ID generato dal sistema per identificare in modo univoco un fondo. |
Restituisce
Regalo
- Corpo
- v1.GivingApi.GiftRead
Aggiornare una persona di contatto
Aggiorna una persona di contatto in un evento.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID evento
|
id | True | integer |
ID generato dal sistema per identificare in modo univoco un evento. |
|
ID persona contatto evento
|
person_id | True | integer |
ID generato dal sistema per identificare in modo univoco una persona di contatto in un evento. |
|
Email
|
Indirizzo di posta elettronica della persona di contatto |
|||
|
Nome
|
name | string |
Nome della persona di contatto |
|
|
Numero di telefono
|
phone_number | string |
Numero di telefono della persona di contatto |
Restituisce
Persona di contatto di un evento
Aggiungere una persona di contatto
Aggiunge una persona contatto a un evento.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID evento
|
id | True | integer |
ID generato dal sistema per identificare in modo univoco un evento. |
|
Email
|
Indirizzo di posta elettronica della persona di contatto |
|||
|
Nome
|
name | string |
Nome della persona di contatto |
|
|
Numero di telefono
|
phone_number | string |
Numero di telefono della persona di contatto |
Restituisce
Persona di contatto di un evento
Creare un evento
Crea un nuovo evento.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Description
|
description | string |
Descrizione dell'evento |
|
|
Ora di fine
|
end_datetime | string |
Ora di fine dell'evento |
|
|
ID database esterno
|
external_database_id | string |
ID univoco assegnato dal sistema per il record dal database esterno. Ad esempio, ID record di sistema per Raiser Edge NXT, ID contatto per Salesforce |
|
|
URL registrazione esterna
|
external_registration_url | string |
URL di registrazione dell'evento in un sito Web esterno |
|
|
Nome
|
name | True | string |
Nome dell'evento |
|
Ora di avvio
|
start_datetime | string |
Ora di inizio dell'evento |
|
|
Timezone
|
timezone | string |
Fuso orario dell'evento |
|
|
Nome
|
display_name | string |
City,State,Country of the Venue |
Restituisce
Event
- Corpo
- v1.EventApi.EventRead
Creare un fondo
Crea un nuovo fondo.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID database esterno
|
external_database_id | string |
ID univoco assegnato dal sistema per il fondo dal database esterno. Ad esempio, ID record di sistema per Raiser Edge NXT, ID oggetto per Salesforce |
|
|
Il fondo predefinito è?
|
is_default | boolean |
Indica di associare tutte le divisioni a questo fondo se non sono definiti altri fondi in Pagina di donazioni. |
|
|
È un altro fondo?
|
is_other_fund | boolean |
Indica che i donatori del fondo hanno assegnato il nome del fondo personalizzato. |
|
|
Nome fondo
|
name | True | string |
Nome del fondo |
Restituisce
Il fondo associato alla divisione dei regali.
- Fondo
- v1.GivingApi.FundRead
Creare un indirizzo di posta elettronica per un record
Crea un nuovo indirizzo di posta elettronica per un record.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID record
|
record_id | True | integer |
ID generato dal sistema per identificare in modo univoco un record. |
|
Address
|
address |
Indirizzo di posta elettronica |
||
|
Usare per l'accesso?
|
is_login_email | boolean |
Indica se l'utente è autorizzato ad accedere alla piattaforma usando questo indirizzo di posta elettronica. |
|
|
È primario?
|
is_primary | boolean |
Un messaggio di posta elettronica primario viene usato per inviare i messaggi di posta elettronica automatizzati attivati dal sistema. Viene usato anche per inviare il messaggio di posta elettronica in blocco al profilo. È obbligatorio impostare un solo messaggio di posta elettronica come primario. |
|
|
Fonte
|
source | string |
L'origine indica come viene aggiunto il messaggio di posta elettronica al database. |
|
|
stato
|
status | string |
Stato dell'indirizzo di posta elettronica |
|
|
TIPO
|
type | string |
Tipo di messaggio di posta elettronica |
Restituisce
Indirizzo di posta elettronica
Creare un punto di tocco
Inviare un nuovo punto di tocco personalizzato a Almabase.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Programma
|
touchpoint_program | True | integer |
Filtra i tipi in base ai programmi touchpoint. |
|
Email
|
ID di posta elettronica usato per l'attività. |
|||
|
Documento d'identità
|
id | integer |
ID generato dal sistema per identificare in modo univoco un record. |
|
|
Registrato all'indirizzo
|
recorded_at | True | date-time |
Timestamp dell'attività. |
|
TIPO
|
id | True | integer |
Restituisce
Corpo del punto di tocco per creare un nuovo punto di tocco
Creare un record
Crea un nuovo record.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Riga 1
|
line1 | True | string |
Riga 1 dell'indirizzo |
|
Riga 2
|
line2 | string |
Riga 2 dell'indirizzo |
|
|
Nome
|
name | string |
Città, Stato, Paese della località |
|
|
Riservatezza
|
privacy | string |
privacy |
|
|
TIPO
|
type | True | string |
Tipo del numero |
|
Capcode
|
zip_code | string |
Capcode dell'indirizzo |
|
|
Data di nascita
|
date_of_birth | string |
Data di nascita. |
|
|
Defunto
|
deceased | boolean |
Defunto. |
|
|
Address
|
address |
Indirizzo di posta elettronica |
||
|
Usare per l'accesso?
|
is_login_email | boolean |
Indica se l'utente è autorizzato ad accedere alla piattaforma usando questo indirizzo di posta elettronica. |
|
|
È primario?
|
is_primary | boolean |
Un messaggio di posta elettronica primario viene usato per inviare i messaggi di posta elettronica automatizzati attivati dal sistema. Viene usato anche per inviare il messaggio di posta elettronica in blocco al profilo. È obbligatorio impostare un solo messaggio di posta elettronica come primario. |
|
|
Fonte
|
source | string |
L'origine indica come viene aggiunto il messaggio di posta elettronica al database. |
|
|
stato
|
status | string |
Stato dell'indirizzo di posta elettronica |
|
|
TIPO
|
type | string |
Tipo di messaggio di posta elettronica |
|
|
ID database esterno
|
external_database_id | string |
ID univoco assegnato dal sistema per il record dal database esterno. Ad esempio, ID record di sistema per Raiser Edge NXT, ID contatto per Salesforce |
|
|
ID ricerca database esterno
|
external_database_lookup_id | string |
ID di ricerca personalizzato definito dall'utente per il record nel database esterno. Ad esempio, ID costituente |
|
|
Nome di battesimo
|
first_name | True | string |
Nome del record. |
|
Cognome
|
last_name | True | string |
Cognome del record. |
|
Secondo nome
|
middle_name | string |
Secondo nome del record. |
|
|
Number
|
number | True | string |
Number |
|
Riservatezza
|
privacy | string |
privacy |
|
|
TIPO
|
type | True | string |
Tipo del numero |
Restituisce
Registrazione
- Corpo
- v1.RecordApi.RecordRead
Creare un regalo
Crea un nuovo regalo.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Importo regalo
|
amount | True | string |
Importo regalo con due decimali. |
|
Numero batch
|
batch_number | string |
Numero batch del regalo. |
|
|
Data regalo
|
completed_at | True | date-time |
Data in cui lo stato del regalo è contrassegnato come completato. |
|
Valuta
|
currency | True | integer |
Valuta utilizzata dal donatore per il dono. |
|
Indirizzo del donatore: riga 1
|
donor_address_line1 | string |
La riga di indirizzo 1 utilizzata dal donatore per il dono. |
|
|
Indirizzo del donatore: riga 2
|
donor_address_line2 | string |
La riga di indirizzo 2 utilizzata dal donatore per il dono. |
|
|
Nome: Città, Stato, Paese
|
name | string |
Città del donatore. Formato: Nome città, Nome stato breve, Nome paese breve |
|
|
Email del donatore
|
donor_email | True |
ID di posta elettronica utilizzato dal donatore per il regalo. |
|
|
Nome donatore
|
donor_name | True | string |
Nome completo del donatore. |
|
Numero di telefono del donatore
|
donor_phone_number | string |
Numero di telefono utilizzato dal donatore per il regalo. |
|
|
Indirizzo del donatore: Cap.
|
donor_zip_code | string |
Codice postale dell'indirizzo utilizzato dal donatore per il regalo. |
|
|
È nascosto dal tabellone punteggi?
|
exclude_from_leaderboard | boolean |
È nascosto dal tabellone punteggi? |
|
|
ID database esterno
|
external_database_id | string |
ID univoco assegnato dal sistema per il regalo dal database esterno. |
|
|
Messaggio omaggio
|
honor_message | string |
Un messaggio per un tributo regalo. |
|
|
Prefisso omaggio
|
honor_prefix | string |
Un prefisso per un tributo regalo. Le opzioni disponibili sono in_honor_of, in_memory_of, in_support_of |
|
|
È anonimo?
|
is_anonymous | boolean |
Indica che il desiderio del donatore sia anonimo ad altri donatori per questo dono. |
|
|
Modalità di pagamento
|
mode | True | string |
Modalità di pagamento, online o offline. |
|
Annotazioni
|
note | string |
Testo della nota. |
|
|
Nome altro fondo
|
other_fund_name | string |
Quando il donatore seleziona un fondo contrassegnato come is_other_fund, aggiunge un nome di fondo personalizzato per attribuire il regalo. |
|
|
Pagina di assegnare
|
id | integer |
ID generato dal sistema per identificare in modo univoco una pagina di selezione. |
|
|
Documento d'identità
|
id | integer |
ID generato dal sistema per identificare in modo univoco un record. |
|
|
Importo
|
amount | True | string |
La quantità della divisione regalo. |
|
Fondo
|
id | True | integer |
ID generato dal sistema per identificare in modo univoco un fondo. |
|
stato
|
status | True | string |
Stato del dono. |
Restituisce
Regalo
- Corpo
- v1.GivingApi.GiftRead
Elenca eventi
Restituisce un elenco di tutti gli eventi.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Ricerca per ID database esterno
|
external_database_id | string |
Cercare gli eventi in base all'ID del database esterno. |
|
|
Fields
|
fields | array |
Elenco delimitato da virgole di campi nella risposta. |
Restituisce
- response
- array of v1.EventApi.EventRead
Elencare gli indirizzi di posta elettronica di un record
Restituisce un elenco di indirizzi di posta elettronica per un record.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID record
|
record_id | True | integer |
ID generato dal sistema per identificare in modo univoco un record. |
|
È primario?
|
is_primary | boolean |
Cercare la posta elettronica primaria. |
|
|
Fields
|
fields | array |
Elenco delimitato da virgole di campi nella risposta. |
|
|
Dimensioni pagina
|
page_size | integer |
Rappresenta il numero di record da restituire. L'impostazione predefinita è 10. Il valore massimo è 50. |
|
|
Numero pagina
|
page | integer |
Rappresenta i numeri di pagina (offset). Per l'uso con la paginazione. |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
URL risultati successivi
|
nextlink | uri |
URL per il set di risultati della pagina successiva. Per l'uso con la paginazione. |
|
URL risultati precedenti
|
previouslink | uri |
URL per il set di risultati precedente. Per l'uso con la paginazione. |
|
Totale indirizzi di posta elettronica
|
total | integer |
Totale indirizzi di posta elettronica per i filtri specificati |
|
Indirizzo di posta elettronica
|
value | array of v1.RecordApi.EmailAddressRead |
Elenco dell'indirizzo di posta elettronica di un record restituito per i filtri specificati. I risultati vengono impaginati. |
Elencare i fondi
Restituisce un elenco di fondi
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Fields
|
fields | array |
Elenco delimitato da virgole di campi nella risposta. |
Restituisce
- response
- array of v1.GivingApi.FundRead
Elencare i moduli
Ottenere un elenco di moduli.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Fields
|
fields | array |
Elenco delimitato da virgole di campi nella risposta. |
Restituisce
- response
- array of v1.FormApi.FormRead
Elencare i record
Restituisce un elenco di record.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Cerca per nome
|
search | string |
Cercare i record in base al nome. |
|
|
Cerca per indirizzo di posta elettronica
|
email_addresses__address | string |
Cercare i record in base all'indirizzo di posta elettronica. |
|
|
Ricerca per ID database esterno
|
external_database_id | string |
Cercare i record in base all'ID del database esterno. |
|
|
Fields
|
fields | array |
Elenco delimitato da virgole di campi nella risposta. |
|
|
Aggiornato in o dopo
|
updated_at__gte | date-time |
Aggiornato in base o dopo una data. |
|
|
Creato in o dopo
|
created_at__gte | date-time |
Creato in base o dopo una data. |
|
|
Dimensioni pagina
|
page_size | integer |
Rappresenta il numero di record da restituire. L'impostazione predefinita è 10. Il valore massimo è 50. |
|
|
Numero pagina
|
page | integer |
Rappresenta i numeri di pagina (offset). Per l'uso con la paginazione. |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
URL risultati successivi
|
nextlink | uri |
URL per il set di risultati della pagina successiva. Per l'uso con la paginazione. |
|
URL risultati precedenti
|
previouslink | uri |
URL per il set di risultati precedente. Per l'uso con la paginazione. |
|
Totale record
|
total | integer |
Totale record per i filtri specificati |
|
Archivio
|
value | array of v1.RecordApi.RecordRead |
Elenco di record di un record restituito per i filtri specificati. |
Elencare i regali
Restituisce un elenco di regali.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
stato
|
status | True | string |
Filtra i regali in base allo stato. |
|
Pagina di assegnare
|
campaign | integer |
ID generato dal sistema per identificare in modo univoco una pagina di selezione. |
|
|
Filtra per ID gruppo di regali
|
group_id | uuid |
ID generato dal sistema per identificare in modo univoco un gruppo di regali o un elenco. |
|
|
Deve avere un numero di batch vuoto?
|
batch_number__isnull | boolean |
Filtra i regali in base al numero di batch o meno. |
|
|
Deve avere un ID di database esterno vuoto?
|
external_database_id__isnull | boolean |
Filtrare i regali in base a cui hanno già l'ID del database esterno o meno. NOTA: i regali con ID database esterno vengono già inseriti nel database esterno. |
|
|
Filtrare in base all'ID database esterno
|
external_database_id | string |
Filtrare i regali in base all'ID del database esterno. |
|
|
Filtra in base alla posta elettronica del donatore
|
donor_email | string |
Filtrare i regali in base all'indirizzo di posta elettronica del donatore |
|
|
Cerca per
|
search | string |
Cercare regali per nome o indirizzo di posta elettronica. |
|
|
Fields
|
fields | array |
Elenco delimitato da virgole di campi nella risposta. |
|
|
Dimensioni pagina
|
page_size | integer |
Rappresenta il numero di record da restituire. L'impostazione predefinita è 10. Il valore massimo è 50. |
|
|
Numero pagina
|
page | integer |
Rappresenta i numeri di pagina (offset). Per l'uso con la paginazione. |
|
|
Ordina per
|
ordering | string |
Definire l'ordine dei doni nella risposta. Un prefisso "-" rappresenta l'ordine decrescente e l'assenza del prefisso restituirà i risultati in ordine crescente. |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
URL risultati successivi
|
nextlink | uri |
URL per il set di risultati della pagina successiva. Per l'uso con la paginazione. |
|
URL risultati precedenti
|
previouslink | uri |
URL per il set di risultati precedente. Per l'uso con la paginazione. |
|
Totale regali
|
total | integer |
Totale regali per i filtri specificati |
|
Regali
|
value | array of v1.GivingApi.GiftRead |
Elenco di regali restituiti per i filtri specificati. I risultati vengono impaginati. |
Elencare le pagine con le pagine
Restituisce un elenco di pagine che assegnano.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Fields
|
fields | array |
Elenco delimitato da virgole di campi nella risposta. |
Restituisce
- response
- array of v1.GivingApi.GivingPageRead
Elencare le persone di contatto
Restituisce un elenco di tutte le persone di contatto di un evento.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID evento
|
id | True | integer |
ID generato dal sistema per identificare in modo univoco un evento. |
Restituisce
Eliminare un indirizzo di posta elettronica di un record
Eliminare un indirizzo di posta elettronica di un record.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID record
|
record_id | True | integer |
ID generato dal sistema per identificare in modo univoco un record. |
|
Documento d'identità
|
email_id | True | integer |
ID generato dal sistema per identificare in modo univoco un indirizzo di posta elettronica di un record. |
Inviare un modulo
Crea un nuovo invio di modulo per un modulo
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Formulario
|
form_id | True | integer |
ID generato dal sistema per identificare in modo univoco un modulo. |
|
body
|
body | dynamic |
Creare un nuovo invio di modulo |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID risposta
|
id | integer |
ID generato dal sistema per identificare in modo univoco un invio di modulo. |
Ottenere un evento
Restituisce informazioni su un evento.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID evento
|
id | True | integer |
ID generato dal sistema per identificare in modo univoco un evento. |
|
Fields
|
fields | array |
Elenco delimitato da virgole di campi nella risposta. |
Restituisce
Event
- Corpo
- v1.EventApi.EventRead
Ottenere un fondo
Restituisce informazioni su un fondo.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID fondo
|
id | True | integer |
ID generato dal sistema per identificare in modo univoco un fondo. |
|
Fields
|
fields | array |
Elenco delimitato da virgole di campi nella risposta. |
Restituisce
Il fondo associato alla divisione dei regali.
- Fondo
- v1.GivingApi.FundRead
Ottenere un indirizzo di posta elettronica di un record
Restituisce informazioni su un indirizzo di posta elettronica di un record.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID record
|
record_id | True | integer |
ID generato dal sistema per identificare in modo univoco un record. |
|
Documento d'identità
|
email_id | True | integer |
ID generato dal sistema per identificare in modo univoco un indirizzo di posta elettronica di un record. |
Restituisce
Indirizzo di posta elettronica
Ottenere un invio di un modulo
Restituisce informazioni su un invio di modulo.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Formulario
|
form_id | True | integer |
ID generato dal sistema per identificare in modo univoco un modulo. |
|
ID risposta
|
entry_id | True | string |
ID generato dal sistema per identificare in modo univoco un invio di modulo. |
Restituisce
Ottenere un record
Restituisce informazioni su un record.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID record
|
id | True | integer |
ID generato dal sistema per identificare in modo univoco un record. |
|
Fields
|
fields | array |
Elenco delimitato da virgole di campi nella risposta. |
Restituisce
Registrazione
- Corpo
- v1.RecordApi.RecordRead
Ottenere una pagina di assegnare
Restituisce informazioni su una pagina di assegnare.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID pagina di assegnare
|
id | True | integer |
ID generato dal sistema per identificare in modo univoco una pagina di selezione. |
|
Fields
|
fields | array |
Elenco delimitato da virgole di campi nella risposta. |
Restituisce
Pagina di assegnare
Ottieni un regalo
Restituisce informazioni su un regalo.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID regalo
|
id | True | integer |
ID generato dal sistema per identificare in modo univoco un regalo. |
|
Fields
|
fields | array |
Elenco delimitato da virgole di campi nella risposta. |
Restituisce
Regalo
- Corpo
- v1.GivingApi.GiftRead
Trigger
| Quando un messaggio di posta elettronica viene creato, aggiornato o eliminato in un record |
Attiva quando viene creato un nuovo messaggio di posta elettronica in un record o un messaggio di posta elettronica esistente viene aggiornato o eliminato da un record. |
| Quando un nuovo regalo ha esito positivo o un pagamento regalo online non è riuscito |
Si attiva quando un nuovo regalo viene registrato correttamente in una pagina di donazione da un donatore o il pagamento a un regalo non è riuscito. |
| Quando un record viene creato o aggiornato in Almabase |
Attiva quando viene creato un nuovo record in Almabase o viene aggiornato un record esistente. |
| Quando viene inviato un modulo o viene aggiornato un invio di modulo esistente |
Attiva quando viene inviato un modulo o viene aggiornato un invio di modulo esistente. |
Quando un messaggio di posta elettronica viene creato, aggiornato o eliminato in un record
Attiva quando viene creato un nuovo messaggio di posta elettronica in un record o un messaggio di posta elettronica esistente viene aggiornato o eliminato da un record.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
When
|
events | True | string |
Elenco di eventi per attivare il flusso. |
Restituisce
Quando un nuovo regalo ha esito positivo o un pagamento regalo online non è riuscito
Si attiva quando un nuovo regalo viene registrato correttamente in una pagina di donazione da un donatore o il pagamento a un regalo non è riuscito.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
When
|
events | True | string |
Elenco di eventi per attivare il flusso. |
|
Pagina di assegnare
|
object_id | integer |
ID generato dal sistema per identificare in modo univoco una pagina di selezione. |
Restituisce
Quando un record viene creato o aggiornato in Almabase
Attiva quando viene creato un nuovo record in Almabase o viene aggiornato un record esistente.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
When
|
events | True | string |
Elenco di eventi per attivare il flusso. |
Restituisce
Quando viene inviato un modulo o viene aggiornato un invio di modulo esistente
Attiva quando viene inviato un modulo o viene aggiornato un invio di modulo esistente.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
When
|
events | True | string |
Elenco di eventi per attivare il flusso. |
|
Formulario
|
object_id | True | integer |
ID generato dal sistema per identificare in modo univoco un modulo. |
Restituisce
Definizioni
v1. FormApi.FormRead
Formulario
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documento d'identità
|
id | integer |
ID generato dal sistema per identificare in modo univoco un modulo. |
|
Nome modulo
|
title | string |
Nome del modulo |
v1. GivingApi.GiftWebhookRecordRead
Record
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID database esterno
|
external_database_id | string |
ID univoco assegnato dal sistema per il record dal database esterno. Ad esempio, ID record di sistema per Raiser Edge NXT, ID contatto per Salesforce |
|
Nome di battesimo
|
first_name | string |
Nome del record mappato |
|
Documento d'identità
|
id | integer |
ID generato dal sistema per identificare in modo univoco un record. |
|
Il donatore è registrato su Almabase?
|
is_registered | boolean |
Indicare se il record mappato o il donatore registrato su Almabase |
|
Cognome
|
last_name | string |
Cognome del record mappato |
v1. GivingApi.GiftWebhookResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Importo
|
data.amount | string |
Importo regalo con due decimali. |
|
Date
|
data.completed_at | date-time |
Data in cui lo stato del regalo è contrassegnato come completato. |
|
Email del donatore
|
data.email |
ID di posta elettronica utilizzato dal donatore per il regalo. |
|
|
ID database esterno
|
data.external_database_id | string |
ID univoco assegnato dal sistema per il regalo dal database esterno. |
|
Documento d'identità
|
data.id | integer |
ID generato dal sistema per identificare in modo univoco un regalo. |
|
È un nuovo messaggio di posta elettronica?
|
data.is_email_new | boolean |
Indica se il messaggio di posta elettronica fornito dal donatore esiste già nei record di Almabase. |
|
schema
|
data.mapped_profile.schema | v1.GivingApi.GiftWebhookRecordRead |
Record |
|
Mode
|
data.mode | string |
Modalità del dono. |
|
Nome donatore
|
data.name | string |
Nome completo del donatore. |
|
Documento d'identità
|
data.page.id | integer |
ID generato dal sistema per identificare in modo univoco una pagina di selezione. |
|
Nome pagina
|
data.page.name | string |
Nome della pagina di assegnare associata |
|
stato
|
data.status | string |
Stato del dono. |
|
Evento attivato all'indirizzo
|
time | string |
Ora dell'evento. |
|
Tipo di evento
|
type | string |
Tipo di evento. |
v1. GivingApi.LocationRead
La città utilizzata dal donatore per il dono.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Città
|
city | string |
La città del donatore |
|
Nome breve città
|
city_short_name | string |
Breve rappresentazione della città, ad esempio SF |
|
Latitudine
|
coordinates.latitude | string |
Latitudine della posizione |
|
Longitudine
|
coordinates.longitude | string |
Longitudine della posizione |
|
Paese
|
country | string |
Paese del donatore |
|
Nome breve paese
|
country_short_name | string |
Breve rappresentazione del paese, ad esempio Stati Uniti |
|
Google Place Id
|
gpid | string |
ID luogo ottenuto da Google |
|
Città, Stato, Paese
|
name | string |
Città del donatore. Formato: Nome città, Nome stato breve, Nome paese breve |
|
stato
|
state | string |
Stato del donatore |
|
Nome breve stato
|
state_short_name | string |
Rappresentazione breve dello stato, ad esempio CA |
v1. GivingApi.FormFieldRead
Campo modulo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Value
|
display_value | string |
Valore formattato immesso dai risponditori. Ad esempio, nome del caricamento del file. |
|
Nome campo domanda/modulo
|
label | string |
Nome del campo della domanda/modulo nel modulo |
v1. GivingApi.FundRead
Il fondo associato alla divisione dei regali.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID database esterno
|
external_database_id | string |
ID univoco assegnato dal sistema per il fondo dal database esterno. Ad esempio, ID record di sistema per Raiser Edge NXT, ID oggetto per Salesforce |
|
Documento d'identità
|
id | integer |
ID generato dal sistema per identificare in modo univoco un fondo. |
|
Il fondo predefinito è?
|
is_default | boolean |
Indica di associare tutte le divisioni a questo fondo se non sono definiti altri fondi in Pagina di donazioni. |
|
È un altro fondo?
|
is_other_fund | boolean |
Indica che i donatori del fondo hanno assegnato il nome del fondo personalizzato. |
|
Nome
|
name | string |
Nome del fondo |
v1. GivingApi.GiftRead
Regalo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Importo regalo
|
amount | string |
Importo regalo con due decimali. |
|
Numero batch
|
batch_number | string |
Numero batch del regalo. |
|
Data regalo
|
completed_at | date-time |
Data in cui lo stato del regalo è contrassegnato come completato. |
|
Valuta
|
currency | integer |
Valuta utilizzata dal donatore per il dono. |
|
Device
|
device | string |
Identificare il dispositivo usato per fare il regalo, ad esempio pc, cellulare o tablet. |
|
Indirizzo del donatore: riga 1
|
donor_address_line1 | string |
La riga di indirizzo 1 utilizzata dal donatore per il dono. |
|
Indirizzo del donatore: riga 2
|
donor_address_line2 | string |
La riga di indirizzo 2 utilizzata dal donatore per il dono. |
|
Indirizzo del donatore: Località
|
donor_city_place | v1.GivingApi.LocationRead |
La città utilizzata dal donatore per il dono. |
|
Email del donatore
|
donor_email |
ID di posta elettronica utilizzato dal donatore per il regalo. |
|
|
Nome donatore
|
donor_name | string |
Nome completo del donatore. |
|
Numero di telefono del donatore
|
donor_phone_number | string |
Numero di telefono utilizzato dal donatore per il regalo. |
|
Indirizzo del donatore: Cap.
|
donor_zip_code | string |
Codice postale dell'indirizzo utilizzato dal donatore per il regalo. |
|
È nascosto dal tabellone punteggi?
|
exclude_from_leaderboard | boolean |
È nascosto dal tabellone punteggi? |
|
ID database esterno
|
external_database_id | string |
ID univoco assegnato dal sistema per il regalo dal database esterno. |
|
Messaggio omaggio
|
honor_message | string |
Un messaggio per un tributo regalo. |
|
Prefisso omaggio
|
honor_prefix | string |
Un prefisso per un tributo regalo. Le opzioni disponibili sono in_honor_of, in_memory_of, in_support_of |
|
Documento d'identità
|
id | integer |
ID generato dal sistema per identificare in modo univoco un regalo. |
|
Influencer
|
influencer | v1.GivingApi.InfluencerRead |
Collegamento alla condivisione pubblica e collegamento al dashboard privato |
|
È anonimo?
|
is_anonymous | boolean |
Indica che il desiderio del donatore sia anonimo ad altri donatori per questo dono. |
|
Il donatore ha coperto gli addebiti per il gateway di pagamento?
|
is_donor_covered_charges | boolean |
Indica se il donatore ha scelto di coprire gli addebiti per il gateway di pagamento quando si effettua il regalo? |
|
Il messaggio di posta elettronica viene aggiunto a un record su Almabase?
|
is_email_added_to_profile | boolean |
Indica se il messaggio di posta elettronica fornito dal donatore viene aggiunto nel record almabase (indipendentemente dallo stato di is_email_new) |
|
È un nuovo messaggio di posta elettronica?
|
is_email_new | boolean |
Indica se il messaggio di posta elettronica fornito dal donatore esiste già nei record di Almabase. |
|
Il mapping a un record in Almabase viene ignorato?
|
is_profile_mapping_ignored | boolean |
Indica se il mapping dei record deve essere ignorato. |
|
Modalità di pagamento
|
mode | string |
Modalità di pagamento, online o offline. |
|
Annotazioni
|
note | string |
Testo della nota. |
|
Nome altro fondo
|
other_fund_name | string |
Quando il donatore seleziona un fondo contrassegnato come is_other_fund, aggiunge un nome di fondo personalizzato per attribuire il regalo. |
|
Pagina di assegnare
|
page | v1.GivingApi.GivingPageAssociatedWithGift |
Pagina di donazione associata al regalo. |
|
Fields
|
post_payment_form_entry.fields | array of v1.GivingApi.FormFieldRead | |
|
ID risposta
|
post_payment_form_entry.id | integer |
ID generato dal sistema per identificare in modo univoco un invio di modulo. |
|
Fields
|
pre_payment_form_entry.fields | array of v1.GivingApi.FormFieldRead | |
|
ID risposta
|
pre_payment_form_entry.id | integer |
ID generato dal sistema per identificare in modo univoco un invio di modulo. |
|
Record mappato
|
profile | v1.GivingApi.RecordRead |
Record mappato su Almabase |
|
Collegamento referrer
|
referrer_link | string |
Collegamento al sito web per identificare la fonte di come il donatore visita. ad esempio, il donatore ha visitato la campagna di donazione da Facebook, Google, ecc. |
|
Importo rimborso
|
refund_amount | string |
Importo rimborsato al donatore. Se l'intero importo viene rimborsato, lo stato del regalo verrà rimborsato anziché completato. |
|
Divide
|
splits | array of v1.GivingApi.GiftSplitRead |
Le divisioni associate al dono. |
|
stato
|
status | string |
Stato del dono. |
|
Transazione online
|
transaction | v1.GivingApi.TransactionRead |
Transazione di pagamento online associata al regalo. |
|
Campagna UTM
|
utm_campaign | string |
Usato per l'analisi delle parole chiave. utm_campaign identificare una campagna strategica o una promozione di prodotto specifica. ad esempio annual_fund_2020 |
|
UTM Medium
|
utm_medium | string |
utm_medium identificare un supporto, ad esempio la posta elettronica o il costo per clic. ad esempio cpc |
|
Origine UTM
|
utm_source | string |
utm_source identificare un motore di ricerca, un nome di newsletter o un'altra origine. ad esempio Google |
v1. GivingApi.GiftSplitRead
Divisione regalo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Importo
|
amount | string |
La quantità della divisione regalo. |
|
Fondo
|
fund | v1.GivingApi.FundRead |
Il fondo associato alla divisione dei regali. |
|
Documento d'identità
|
id | integer |
ID generato dal sistema per identificare in modo univoco una divisione regalo. |
v1. GivingApi.GivingPageAssociatedWithGift
Pagina di donazione associata al regalo.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documento d'identità
|
id | integer |
ID generato dal sistema per identificare in modo univoco una pagina di selezione. |
|
Nome
|
name | string |
Nome della pagina di doni associata. |
v1. GivingApi.GivingPageRead
Pagina di assegnare
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documento d'identità
|
id | integer |
ID generato dal sistema per identificare in modo univoco una pagina di selezione. |
|
Nome
|
name | string |
Nome della pagina di assegnare |
v1. GivingApi.InfluencerRead
Collegamento alla condivisione pubblica e collegamento al dashboard privato
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Collegamento al dashboard di influenza privata
|
dashboard_url | uri |
Il dashboard privato del donatore per monitorare il numero di visite di pagina e regali influenzati da loro |
|
Collegamento di condivisione pubblica
|
page_share_url | uri |
Il collegamento pubblico di dare pagina/campagna di donatore per tenere traccia dell'influenza sulle visite alla pagina di donazione e ai doni. |
v1. GivingApi.PaymentAccountRead
Conto di pagamento associato alla transazione, ad esempio BBMS, Stripe, PayPal e così via.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documento d'identità
|
id | integer |
ID generato dal sistema per identificare in modo univoco un account di pagamento. |
|
Nome
|
name | string |
Nome dell'account di pagamento. |
|
Gateway
|
type | string |
Nome del gateway di pagamento. |
v1. GivingApi.RecordRead
Record mappato su Almabase
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID database esterno
|
external_database_id | string |
ID univoco assegnato dal sistema per il record dal database esterno. Ad esempio, ID record di sistema per Raiser Edge NXT, ID contatto per Salesforce |
|
Nome di battesimo
|
first_name | string |
Nome del record mappato |
|
Nome completo
|
formatted_name | string |
Nome completo del record mappato |
|
Documento d'identità
|
id | integer |
ID generato dal sistema per identificare in modo univoco un record. |
|
Il donatore è registrato su Almabase?
|
is_registered | boolean |
Indicare se il record mappato o il donatore registrato su Almabase |
|
Cognome
|
last_name | string |
Cognome del record mappato |
|
URL immagine
|
present_picture | uri |
URL dell'immagine del record |
|
Link
|
profile_url | uri |
Collegamento al record in Almabase |
v1. GivingApi.TransactionRead
Transazione di pagamento online associata al regalo.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Account di pagamento
|
account | v1.GivingApi.PaymentAccountRead |
Conto di pagamento associato alla transazione, ad esempio BBMS, Stripe, PayPal e così via. |
|
Ora di creazione
|
created_at | date-time |
Ora di creazione della transazione. |
|
Motivo errore
|
failure_reason | string |
Motivo dell'errore di transazione restituito dal gateway di pagamento. |
|
Documento d'identità
|
id | uuid |
ID generato dal sistema per identificare in modo univoco una transazione. |
|
stato
|
status | integer |
Stato della transazione. - 1 (Non elaborato) - 2 (Operazione riuscita) - 3 (Non riuscito) - 4 (In sospeso) - 5 (Errore): questi stati sono associati allo stato della transazione dal gateway di pagamento |
|
ID di riferimento del gateway di pagamento
|
transaction_id | string |
ID univoco generato dal gateway di pagamento per identificare la transazione. Ad esempio, ID transazione Blackbaud Merchant Services (BBMS) o ID addebito stripe, PayPal ID transazione |
v1. AlmasightsApi.RecordAddOrEdit
Record su Almabase.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documento d'identità
|
id | integer |
ID generato dal sistema per identificare in modo univoco un record. |
v1. AlmasightsApi.TouchpointCustomObjectAdd
Corpo del punto di tocco per creare un nuovo punto di tocco
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Email
|
ID di posta elettronica usato per l'attività. |
||
|
Record
|
mapped_profile | v1.AlmasightsApi.RecordAddOrEdit |
Record su Almabase. |
|
Registrato all'indirizzo
|
recorded_at | date-time |
Timestamp dell'attività. |
|
TIPO
|
touchpoint_type.id | integer |
v1. RecordApi.LocationRead
Posizione dell'indirizzo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Città
|
city | string |
Nome città della località |
|
Paese
|
country | string |
Nome paese della località |
|
Latitudine
|
latitude | double |
Latitudine della posizione |
|
Longitudine
|
longitude | double |
Longitudine della posizione |
|
stato
|
state | string |
Nome dello stato della posizione |
v1. RecordApi.AddressRead
Address
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Riga 1
|
line1 | string |
Riga 1 dell'indirizzo |
|
Riga 2
|
line2 | string |
Riga 2 dell'indirizzo |
|
schema
|
location.schema | v1.RecordApi.LocationRead |
Posizione dell'indirizzo |
|
Capcode
|
zipcode | string |
Capcode dell'indirizzo |
v1. RecordApi.EmailWebhookRecordRead
Record
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID database esterno
|
external_database_id | string |
ID univoco assegnato dal sistema per il record dal database esterno. Ad esempio, ID record di sistema per Raiser Edge NXT, ID contatto per Salesforce |
|
Nome di battesimo
|
first_name | string |
Nome del record mappato |
|
Documento d'identità
|
id | integer |
ID generato dal sistema per identificare in modo univoco un record. |
|
Il record è registrato su Almabase?
|
is_registered | boolean |
Indicare se il record mappato registrato in Almabase |
|
Cognome
|
last_name | string |
Cognome del record mappato |
v1. RecordApi.EmailWebhookResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Indirizzo di posta elettronica
|
data.address |
Indirizzo di posta elettronica. |
|
|
Documento d'identità
|
data.id | integer |
ID generato dal sistema per identificare in modo univoco un messaggio di posta elettronica. |
|
È primario
|
data.is_primary | boolean |
Indica se il messaggio di posta elettronica è primario o meno. |
|
schema
|
data.profile.schema | v1.RecordApi.EmailWebhookRecordRead |
Record |
|
Tipo di messaggio di posta elettronica
|
data.type | string |
Tipo di indirizzo di posta elettronica (primario, personale, aziendale e così via). |
|
Evento attivato all'indirizzo
|
time | string |
Ora dell'evento. |
|
Tipo di evento
|
type | string |
Tipo di evento. |
v1. RecordApi.RecordWebhookResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Affiliations
|
data.affiliations | array of string | |
|
Anno classe
|
data.class_year | string |
Anno di classe del record |
|
Indirizzo di posta elettronica
|
data.email |
Indirizzo di posta elettronica. |
|
|
ID database esterno
|
data.external_database_id | string |
ID univoco assegnato dal sistema per il record dal database esterno. Ad esempio, ID record di sistema per Raiser Edge NXT, ID contatto per Salesforce |
|
Nome di battesimo
|
data.first_name | string |
Nome del record mappato |
|
schema
|
data.home_address.schema | v1.RecordApi.AddressRead |
Address |
|
Documento d'identità
|
data.id | integer |
ID generato dal sistema per identificare in modo univoco un record. |
|
Cognome
|
data.last_name | string |
Cognome del record mappato |
|
Data di scadenza dell'appartenenza
|
data.membership_expiry_date | date-time |
Data di scadenza dell'appartenenza del record |
|
Nome tipo di appartenenza
|
data.membership_type_name | string |
Nome del tipo di appartenenza del record |
|
Numero di cellulare
|
data.mobile_number | string |
Numero di cellulare del record |
|
schema
|
data.office_address.schema | v1.RecordApi.AddressRead |
Address |
|
Numero di telefono ufficio
|
data.office_phone_number | string |
Numero di telefono dell'ufficio del record |
|
Numero di telefono di residenza
|
data.residence_phone_number | string |
Numero di telefono di residenza del record |
|
Evento attivato all'indirizzo
|
time | string |
Ora dell'evento. |
|
Tipo di evento
|
type | string |
Tipo di evento. |
v1. RecordApi.EmailAddressRead
Indirizzo di posta elettronica
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Address
|
address |
Indirizzo di posta elettronica |
|
|
Documento d'identità
|
id | integer |
ID generato dal sistema per identificare in modo univoco un indirizzo di posta elettronica di un record. |
|
È impegnato?
|
is_engaged | boolean |
Indica se si fa clic o si apre un messaggio di posta elettronica in blocco oppure l'utente risponde a un messaggio di posta elettronica |
|
Usare per l'accesso?
|
is_login_email | boolean |
Indica se l'utente è autorizzato ad accedere alla piattaforma usando questo indirizzo di posta elettronica. |
|
È primario?
|
is_primary | boolean |
Un messaggio di posta elettronica primario viene usato per inviare i messaggi di posta elettronica automatizzati attivati dal sistema. Viene usato anche per inviare il messaggio di posta elettronica in blocco al record. È obbligatorio impostare un solo messaggio di posta elettronica come primario. |
|
È verificato dall'utente?
|
is_verified | boolean |
Indicare se l'utente ha verificato di essere proprietari del messaggio di posta elettronica. |
|
source
|
source | string |
L'origine indica come viene aggiunto il messaggio di posta elettronica al database. |
|
status
|
status | string | |
|
TIPO
|
type | string |
Tipo di messaggio di posta elettronica |
v1. RecordApi.RecordRead
Registrazione
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Indirizzi di posta elettronica
|
email_addresses | array of v1.RecordApi.EmailAddressRead |
Elenco di indirizzi di posta elettronica di un profilo |
|
ID database esterno
|
external_database_id | string |
ID univoco assegnato dal sistema per il record dal database esterno. Ad esempio, ID record di sistema per Raiser Edge NXT, ID contatto per Salesforce |
|
Nome di battesimo
|
first_name | string |
Nome del record. |
|
Nome completo
|
formatted_name | string |
Nome completo del record. |
|
Documento d'identità
|
id | integer |
ID generato dal sistema per identificare in modo univoco un record. |
|
Registrato su Almabase?
|
is_registered | boolean |
Indicare se il record o il donatore registrato su Almabase |
|
Cognome
|
last_name | string |
Cognome del record. |
|
URL immagine
|
present_picture | uri |
URL dell'immagine del record |
|
Link
|
record_url | uri |
Collegamento al record in Almabase |
v1. EventApi.ContactPersonRead
Persona di contatto di un evento
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Email
|
Indirizzo di posta elettronica della persona di contatto |
||
|
Documento d'identità
|
id | integer |
ID generato dal sistema per identificare in modo univoco una persona di contatto. |
|
Nome
|
name | string |
Nome della persona di contatto |
|
Numero di telefono
|
phone_number | string |
Numero di telefono della persona di contatto |
v1. EventApi.EventRead
Event
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Description
|
description | string |
Descrizione dell'evento |
|
Ora di fine
|
end_datetime | string |
Ora di fine dell'evento |
|
ID database esterno
|
external_database_id | string |
ID univoco assegnato dal sistema per il record dal database esterno. Ad esempio, ID record di sistema per Raiser Edge NXT, ID contatto per Salesforce |
|
URL registrazione esterna
|
external_registration_url | string |
URL di registrazione dell'evento in un sito Web esterno |
|
Documento d'identità
|
id | integer |
ID generato dal sistema per identificare in modo univoco un evento. |
|
Nome
|
name | string |
Nome dell'evento |
|
Ora di avvio
|
start_datetime | string |
Ora di inizio dell'evento |
|
Timezone
|
timezone | string |
Fuso orario dell'evento |