Partager via

Almabase (préversion)

Almabase est le logiciel de gestion des anciens les plus aimés du monde pour créer des programmes centrés sur les anciens afin d’accroître la participation, l’engagement des donateurs et d’héberger des communautés en ligne attrayantes.

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Régions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom Prise en charge d’Almabase
URL https://docs.almabase.com
Messagerie électronique help@almabase.com
Métadonnées du connecteur
Éditeur Almabase, Inc.
Site internet https://almabase.com
Politique de confidentialité https://www.almabase.com/ecloud-privacy-policy
Catégories Ventes et CRM ; Productivité

Almabase fournit des outils logiciels et des stratégies pour les établissements d’enseignement afin de créer des programmes centrés sur les anciens qui transforment les anciens non managés en partisans de la vie.

Ce connecteur est basé sur les API Et webhooks Almabase et fournit des opérations pour aider à gérer les entités trouvées dans Almabase, notamment :

  • Enregistrement (constituants)
  • Cadeaux
  • Événements
  • Points de contact d’engagement
  • Formulaires
  • Fonds
  • Donner des pages
  • Campagnes de collecte de fonds d’égal à égal
  • et bien plus encore...

Prerequisites

Pour utiliser ce connecteur,

  • Vous devez disposer d’un abonnement Almabase actif.
  • Vous devez disposer du rôle d’administrateur de site.

Comment obtenir des informations d’identification

  • Connectez-vous à votre portail d’administration fourni par Almabase.
  • Accédez à API's & Tokens sous Settings.
  • Cliquez sur Add Auth Token, puis renseignez le descriptionjeton et définissez le jeton expiry date & time.
  • Notez la Workflow Access Token valeur (cliquez sur le jeton pour copier dans le Presse-papiers).
  • Utilisez le Workflow Access Token paramètre lors de la création de la connexion sur Power Automate.

Bien démarrer avec votre connecteur

Cas d’usage courants

  • Lorsqu’un cadeau est effectué, envoyez un message personnalisé et un reçu cadeau.
  • Lorsqu’une activité d’engagement est enregistrée sur Slack, Gmail ou tout autre média social, ajoutez l’activité d’engagement à Engagement Studio sur Almabase à l’aide Create Custom Touchpoint d’une action.
  • Lorsqu’une nouvelle adresse e-mail est trouvée (anciennes perdues) dans un cadeau ou une inscription d’événement ou une soumission de formulaire, ajoutez cette adresse e-mail à un enregistrement sur Almabase ou un constituant sur Edge de Raiser ou un contact sur Salesforce.
  • Concevez la synchronisation bidirectionnelle des données entre Almabase et Blackbaud Raiser’s Edge.
  • Concevoir la synchronisation des données bidirectionnelles entre Almabase et Salesforce.

Problèmes connus et limitations

  • Les déclencheurs de cadeaux fonctionnent uniquement lorsque le paiement en ligne est effectué sur Almabase. Les dons ajoutés manuellement ne déclenchent pas les flux.

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :
Par défaut Paramètres de création de connexion. Toutes les régions Non partageable

Faire défaut

Applicable : Toutes les régions

Paramètres de création de connexion.

Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.

Nom Type Descriptif Obligatoire
URL du domaine ficelle Spécifiez votre URL de domaine Almabase, par exemple https://your.domain.com Vrai
Clé d’API securestring Clé API de l’utilisateur Vrai

Limitations

Nom Appels Période de renouvellement
Appels d’API par connexion 100 60 secondes

Actions

Ajouter une personne de contact

Ajoute une personne de contact à un événement.
Créer un cadeau

Crée un cadeau.
Créer un enregistrement

Crée un enregistrement.
Créer un fonds

Crée un fonds.
Créer un point tactile

Envoyez un nouveau point de contact personnalisé à Almabase.
Créer un événement

Crée un événement.
Créer une adresse e-mail pour un enregistrement

Crée une adresse e-mail pour un enregistrement.
Envoyer un formulaire

Crée une soumission de formulaire pour un formulaire
Liste des événements

Retourne une liste de tous les événements.
Lister les pages donnant des pages

Retourne une liste de pages donnant.
Mettre à jour un cadeau

Met à jour un cadeau
Mettre à jour un enregistrement

Met à jour un enregistrement.
Mettre à jour un fonds

Met à jour un fonds.
Mettre à jour un événement

Met à jour un événement.
Mettre à jour une adresse e-mail d’un enregistrement

Met à jour les champs de l’adresse e-mail d’un enregistrement
Mettre à jour une personne de contact

Met à jour une personne de contact sur un événement.
Obtenir un cadeau

Retourne des informations sur un cadeau.
Obtenir un enregistrement

Retourne des informations sur un enregistrement.
Obtenir un fonds

Retourne des informations sur un fonds.
Obtenir un événement

Retourne des informations sur un événement.
Obtenir une adresse e-mail d’un enregistrement

Retourne des informations sur une adresse e-mail d’un enregistrement.
Obtenir une page d’octroi

Retourne des informations sur une page d’octroi.
Obtenir une soumission d’un formulaire

Retourne des informations sur une soumission de formulaire.
Répertorier les adresses e-mail d’un enregistrement

Retourne une liste d’adresses e-mail pour un enregistrement.
Répertorier les cadeaux

Retourne une liste de cadeaux.
Répertorier les enregistrements

Retourne une liste d’enregistrements.
Répertorier les fonds

Retourne une liste de fonds
Répertorier les formulaires

Obtenez une liste de formulaires.
Répertorier les personnes de contact

Retourne une liste de toutes les personnes de contact sur un événement.
Supprimer une adresse e-mail d’un enregistrement

Supprimez une adresse e-mail d’un enregistrement.

Ajouter une personne de contact

ID d’opération :
AddEventContactPerson

Ajoute une personne de contact à un événement.

Paramètres

Nom Clé Obligatoire Type Description
ID de l’événement
 id True integer

ID généré par le système pour identifier un événement de manière unique.
Messagerie électronique
 email email

E-mail de la personne de contact
Nom
 name string

Nom de la personne de contact
Numéro de téléphone
 phone_number string

Numéro de téléphone de la personne de contact

Retours

Personne de contact d’un événement

Corps
v1.EventApi.ContactPersonRead

Créer un cadeau

ID d’opération :
CreateGift

Crée un cadeau.

Paramètres

Nom Clé Obligatoire Type Description
Montant du cadeau
 amount True string

Montant du cadeau avec deux décimales.
Numéro de lot
 batch_number string

Numéro de lot du cadeau.
Date de cadeau
 completed_at True date-time

Date à laquelle l’état du cadeau est marqué comme terminé.
Monnaie
 currency True integer

Devise utilisée par le donneur pour le cadeau.
Adresse du donneur : ligne 1
 donor_address_line1 string

Ligne d’adresse 1 utilisée par le donneur pour le cadeau.
Adresse du donneur : ligne 2
 donor_address_line2 string

Ligne d’adresse 2 utilisée par le donneur pour le cadeau.
Nom : Ville, État, Pays
 name string

La ville du donneur. Format : Nom de la ville, Nom de l’état court, Nom du pays court
E-mail du donneur
 donor_email True email

ID d’e-mail utilisé par le donneur pour le cadeau.
Nom du donneur
 donor_name True string

Nom complet du donneur.
Numéro de téléphone du donneur
 donor_phone_number string

Numéro de téléphone utilisé par le donneur pour le cadeau.
Adresse du donneur : code postal
 donor_zip_code string

Code postal de l’adresse utilisée par le donneur pour le cadeau.
Est-il masqué dans le classement ?
 exclude_from_leaderboard boolean

Est-il masqué dans le classement ?
ID de base de données externe
 external_database_id string

ID unique attribué par le système pour le cadeau par la base de données externe.
Message d’hommage
 honor_message string

Un message pour un hommage cadeau.
Préfixe d’hommage
 honor_prefix string

Préfixe d’un hommage cadeau. Les options disponibles sont in_honor_of, in_memory_of, in_support_of
Anonyme ?
 is_anonymous boolean

Indique que le souhait de donneur soit anonyme auprès d’autres donateurs pour ce cadeau.
Mode de paiement
 mode True string

Mode de paiement, en ligne ou hors connexion.
Note
 note string

Texte de la note.
Autre nom du fonds
 other_fund_name string

Lorsque le donneur sélectionne un fonds marqué comme is_other_fund, il ajoute un nom de fonds personnalisé pour attribuer le cadeau.
Page d’attribution
 id integer

ID généré par le système pour identifier de manière unique une page d’attribution.
ID
 id integer

ID généré par le système pour identifier un enregistrement de manière unique.
Montant
 amount True string

Le montant du cadeau fractionné.
Fonds
 id True integer

ID généré par le système pour identifier de manière unique un fonds.
Statut
 status True string

État du cadeau.

Retours

Cadeau

Corps
v1.GivingApi.GiftRead

Créer un enregistrement

ID d’opération :
CreateRecord

Crée un enregistrement.

Paramètres

Nom Clé Obligatoire Type Description
Ligne 1
 line1 True string

Ligne 1 de l’adresse
Ligne 2
 line2 string

Ligne 2 de l’adresse
Nom
 name string

Ville,État,Pays de l’emplacement
Confidentialité
 privacy string

La confidentialité
Type
 type True string

Type du nombre
Code postal
 zip_code string

Code postal de l’adresse
Date de naissance
 date_of_birth string

Date de naissance.
Décédé
 deceased boolean

Décédé.
Adresse
 address email

Adresse e-mail
Utiliser pour la connexion ?
 is_login_email boolean

Indique si l’utilisateur est autorisé à se connecter à la plateforme à l’aide de cette adresse e-mail.
Est-ce que primaire ?
 is_primary boolean

Un e-mail principal est utilisé pour envoyer les e-mails automatisés déclenchés par le système. Il est également utilisé pour envoyer l’e-mail en bloc au profil. Il est obligatoire qu’un seul e-mail soit défini comme principal.
Origine
 source string

La source indique comment l’e-mail est ajouté à la base de données.
Statut
 status string

État de l’adresse e-mail
Type
 type string

Type de l’e-mail
ID de base de données externe
 external_database_id string

ID unique attribué par le système pour l’enregistrement par la base de données externe. Par exemple, ID d’enregistrement système pour Raiser Edge NXT, ID de contact pour Salesforce
ID de recherche de base de données externe
 external_database_lookup_id string

ID de recherche personnalisé défini par l’utilisateur pour l’enregistrement dans la base de données externe. par exemple, ID de la constituante
Prénom
 first_name True string

Prénom de l’enregistrement.
Nom de famille
 last_name True string

Nom de l’enregistrement.
Deuxième prénom
 middle_name string

Prénom de l’enregistrement.
Number
 number True string

Number
Confidentialité
 privacy string

La confidentialité
Type
 type True string

Type du nombre

Retours

enregistrement

Corps
v1.RecordApi.RecordRead

Créer un fonds

ID d’opération :
CreateFund

Crée un fonds.

Paramètres

Nom Clé Obligatoire Type Description
ID de base de données externe
 external_database_id string

ID unique attribué par le fonds par la base de données externe. Par exemple, ID d’enregistrement système pour Raiser Edge NXT, ID d’objet pour Salesforce
Le fonds par défaut est-il ?
 is_default boolean

Indique à tous les fractionnements associés à ce fonds si aucun autre fonds n’est défini sur La page Donner.
Est-ce que d’autres fonds ?
 is_other_fund boolean

Indique que les donateurs de ce fonds ont donné un nom de fonds personnalisé.
Nom du fonds
 name True string

Nom du fonds

Retours

Le fonds associé au fractionnement du cadeau.

Fonds
v1.GivingApi.FundRead

Créer un point tactile

ID d’opération :
createTouchpointCustomObject

Envoyez un nouveau point de contact personnalisé à Almabase.

Paramètres

Nom Clé Obligatoire Type Description
Programme
 touchpoint_program True integer

Filtre les types par les programmes tactiles.
Messagerie électronique
 email email

ID d’e-mail utilisé pour l’activité.
ID
 id integer

ID généré par le système pour identifier un enregistrement de manière unique.
Enregistré à
 recorded_at True date-time

Horodatage de l’activité.
Type
 id True integer

Retours

Corps du point de contact pour créer un point tactile

Corps
v1.AlmasightsApi.TouchpointCustomObjectAdd

Créer un événement

ID d’opération :
CreateEvent

Crée un événement.

Paramètres

Nom Clé Obligatoire Type Description
Descriptif
 description string

Description de l’événement
Heure de fin
 end_datetime string

Heure de fin de l’événement
ID de base de données externe
 external_database_id string

ID unique attribué par le système pour l’enregistrement par la base de données externe. Par exemple, ID d’enregistrement système pour Raiser Edge NXT, ID de contact pour Salesforce
URL d’inscription externe
 external_registration_url string

URL d’inscription de l’événement sur un site web externe
Nom
 name True string

Le nom de l’événement
Heure de début
 start_datetime string

Heure de début de l’événement
Timezone
 timezone string

Fuseau horaire de l’événement
Nom
 display_name string

Ville, État, Pays du Lieu

Retours

Événement

Corps
v1.EventApi.EventRead

Créer une adresse e-mail pour un enregistrement

ID d’opération :
CreateRecordEmailAddress

Crée une adresse e-mail pour un enregistrement.

Paramètres

Nom Clé Obligatoire Type Description
ID enregistrement
 record_id True integer

ID généré par le système pour identifier un enregistrement de manière unique.
Adresse
 address email

Adresse e-mail
Utiliser pour la connexion ?
 is_login_email boolean

Indique si l’utilisateur est autorisé à se connecter à la plateforme à l’aide de cette adresse e-mail.
Est-ce que primaire ?
 is_primary boolean

Un e-mail principal est utilisé pour envoyer les e-mails automatisés déclenchés par le système. Il est également utilisé pour envoyer l’e-mail en bloc au profil. Il est obligatoire qu’un seul e-mail soit défini comme principal.
Origine
 source string

La source indique comment l’e-mail est ajouté à la base de données.
Statut
 status string

État de l’adresse e-mail
Type
 type string

Type de l’e-mail

Retours

Adresse électronique

Corps
v1.RecordApi.EmailAddressRead

Envoyer un formulaire

ID d’opération :
CreateFormEntry

Crée une soumission de formulaire pour un formulaire

Paramètres

Nom Clé Obligatoire Type Description
Formulaire
 form_id True integer

ID généré par le système pour identifier de manière unique un formulaire.
body
 body dynamic

Créer une soumission de formulaire

Retours

Nom Chemin d’accès Type Description
ID de réponse
 id integer

ID généré par le système pour identifier de manière unique une soumission de formulaire.

Liste des événements

ID d’opération :
ListEvents

Retourne une liste de tous les événements.

Paramètres

Nom Clé Obligatoire Type Description
Rechercher par ID de base de données externe
 external_database_id string

Recherchez des événements par ID de base de données externe.
Fields
 fields array

Liste de champs séparés par des virgules dans la réponse.

Retours

response
array of v1.EventApi.EventRead

Lister les pages donnant des pages

ID d’opération :
ListGivingPages

Retourne une liste de pages donnant.

Paramètres

Nom Clé Obligatoire Type Description
Fields
 fields array

Liste de champs séparés par des virgules dans la réponse.

Retours

response
array of v1.GivingApi.GivingPageRead

Mettre à jour un cadeau

ID d’opération :
UpdateGift

Met à jour un cadeau

Paramètres

Nom Clé Obligatoire Type Description
ID cadeau
 id True integer

ID généré par le système pour identifier de façon unique un cadeau.
Numéro de lot
 batch_number string

Numéro de lot du cadeau.
Adresse du donneur : ligne 1
 donor_address_line1 string

Ligne d’adresse 1 utilisée par le donneur pour le cadeau.
Adresse du donneur : ligne 2
 donor_address_line2 string

Ligne d’adresse 2 utilisée par le donneur pour le cadeau.
Nom : Ville, État, Pays
 name string

La ville du donneur. Format : Nom de la ville, Nom de l’état court, Nom du pays court
Nom du donneur
 donor_name string

Nom complet du donneur.
Numéro de téléphone du donneur
 donor_phone_number string

Numéro de téléphone utilisé par le donneur pour le cadeau.
Adresse du donneur : code postal
 donor_zip_code string

Code postal de l’adresse utilisée par le donneur pour le cadeau.
Est-il masqué dans le classement ?
 exclude_from_leaderboard boolean

Est-il masqué dans le classement ?
ID de base de données externe
 external_database_id string

ID unique attribué par le système pour le cadeau par la base de données externe.
Message d’hommage
 honor_message string

Un message pour un hommage cadeau.
Préfixe d’hommage
 honor_prefix string

Préfixe d’un hommage cadeau. Les options disponibles sont in_honor_of, in_memory_of, in_support_of
Anonyme ?
 is_anonymous boolean

Indique que le souhait de donneur soit anonyme auprès d’autres donateurs pour ce cadeau.
Note
 note string

Texte de la note.
Autre nom du fonds
 other_fund_name string

Lorsque le donneur sélectionne un fonds marqué comme is_other_fund, il ajoute un nom de fonds personnalisé pour attribuer le cadeau.
Page d’attribution
 id integer

ID généré par le système pour identifier de manière unique une page d’attribution.
ID
 id integer

ID généré par le système pour identifier un enregistrement de manière unique.
Montant
 amount True string

Le montant du cadeau fractionné.
Fonds
 id True integer

ID généré par le système pour identifier de manière unique un fonds.

Retours

Cadeau

Corps
v1.GivingApi.GiftRead

Mettre à jour un enregistrement

ID d’opération :
UpdateRecord

Met à jour un enregistrement.

Paramètres

Nom Clé Obligatoire Type Description
ID enregistrement
 id True integer

ID généré par le système pour identifier un enregistrement de manière unique.
ID de base de données externe
 external_database_id string

ID unique attribué par le système pour l’enregistrement par la base de données externe. Par exemple, ID d’enregistrement système pour Raiser Edge NXT, ID de contact pour Salesforce
ID de recherche de base de données externe
 external_database_lookup_id string

ID de recherche personnalisé défini par l’utilisateur pour l’enregistrement dans la base de données externe. par exemple, ID de la constituante
Prénom
 first_name string

Prénom de l’enregistrement.
Nom de famille
 last_name string

Nom de l’enregistrement.

Retours

enregistrement

Corps
v1.RecordApi.RecordRead

Mettre à jour un fonds

ID d’opération :
UpdateFund

Met à jour un fonds.

Paramètres

Nom Clé Obligatoire Type Description
ID du fonds
 id True integer

ID généré par le système pour identifier de manière unique un fonds.
ID de base de données externe
 external_database_id string

ID unique attribué par le fonds par la base de données externe. Par exemple, ID d’enregistrement système pour Raiser Edge NXT, ID d’objet pour Salesforce
Le fonds par défaut est-il ?
 is_default boolean

Indique à tous les fractionnements associés à ce fonds si aucun autre fonds n’est défini sur La page Donner.
Est-ce que d’autres fonds ?
 is_other_fund boolean

Indique que les donateurs de ce fonds ont donné un nom de fonds personnalisé.
Nom du fonds
 name True string

Nom du fonds

Retours

Le fonds associé au fractionnement du cadeau.

Fonds
v1.GivingApi.FundRead

Mettre à jour un événement

ID d’opération :
UpdateEvent

Met à jour un événement.

Paramètres

Nom Clé Obligatoire Type Description
ID de l’événement
 id True integer

ID généré par le système pour identifier un événement de manière unique.
Descriptif
 description string

Description de l’événement
Heure de fin
 end_datetime string

Heure de fin de l’événement
ID de base de données externe
 external_database_id string

ID unique attribué par le système pour l’enregistrement par la base de données externe. Par exemple, ID d’enregistrement système pour Raiser Edge NXT, ID de contact pour Salesforce
URL d’inscription externe
 external_registration_url string

URL d’inscription de l’événement sur un site web externe
Nom
 name string

Le nom de l’événement
Heure de début
 start_datetime string

Heure de début de l’événement
Timezone
 timezone string

Fuseau horaire de l’événement
Nom
 display_name string

Ville, État, Pays du Lieu

Retours

Événement

Corps
v1.EventApi.EventRead

Mettre à jour une adresse e-mail d’un enregistrement

ID d’opération :
UpdateRecordEmailAddress

Met à jour les champs de l’adresse e-mail d’un enregistrement

Paramètres

Nom Clé Obligatoire Type Description
ID enregistrement
 record_id True integer

ID généré par le système pour identifier un enregistrement de manière unique.
ID d’adresse e-mail
 email_id True integer

ID généré par le système pour identifier de manière unique une adresse e-mail d’un enregistrement.
Utiliser pour la connexion ?
 is_login_email boolean

Indique si l’utilisateur est autorisé à se connecter à la plateforme à l’aide de cette adresse e-mail.
Est-ce que primaire ?
 is_primary boolean

Un e-mail principal est utilisé pour envoyer les e-mails automatisés déclenchés par le système. Il est également utilisé pour envoyer l’e-mail en bloc au profil. Il est obligatoire qu’un seul e-mail soit défini comme principal.
Statut
 status string

État de l’adresse e-mail
Type
 type string

Type de l’e-mail

Retours

Adresse électronique

Corps
v1.RecordApi.EmailAddressRead

Mettre à jour une personne de contact

ID d’opération :
UpdateEventContactPerson

Met à jour une personne de contact sur un événement.

Paramètres

Nom Clé Obligatoire Type Description
ID de l’événement
 id True integer

ID généré par le système pour identifier un événement de manière unique.
ID de personne de contact d’événement
 person_id True integer

ID généré par le système pour identifier de manière unique une personne de contact sur un événement.
Messagerie électronique
 email email

E-mail de la personne de contact
Nom
 name string

Nom de la personne de contact
Numéro de téléphone
 phone_number string

Numéro de téléphone de la personne de contact

Retours

Personne de contact d’un événement

Corps
v1.EventApi.ContactPersonRead

Obtenir un cadeau

ID d’opération :
GetGift

Retourne des informations sur un cadeau.

Paramètres

Nom Clé Obligatoire Type Description
ID cadeau
 id True integer

ID généré par le système pour identifier de façon unique un cadeau.
Fields
 fields array

Liste de champs séparés par des virgules dans la réponse.

Retours

Cadeau

Corps
v1.GivingApi.GiftRead

Obtenir un enregistrement

ID d’opération :
GetRecord

Retourne des informations sur un enregistrement.

Paramètres

Nom Clé Obligatoire Type Description
ID enregistrement
 id True integer

ID généré par le système pour identifier un enregistrement de manière unique.
Fields
 fields array

Liste de champs séparés par des virgules dans la réponse.

Retours

enregistrement

Corps
v1.RecordApi.RecordRead

Obtenir un fonds

ID d’opération :
GetFund

Retourne des informations sur un fonds.

Paramètres

Nom Clé Obligatoire Type Description
ID du fonds
 id True integer

ID généré par le système pour identifier de manière unique un fonds.
Fields
 fields array

Liste de champs séparés par des virgules dans la réponse.

Retours

Le fonds associé au fractionnement du cadeau.

Fonds
v1.GivingApi.FundRead

Obtenir un événement

ID d’opération :
GetEvent

Retourne des informations sur un événement.

Paramètres

Nom Clé Obligatoire Type Description
ID de l’événement
 id True integer

ID généré par le système pour identifier un événement de manière unique.
Fields
 fields array

Liste de champs séparés par des virgules dans la réponse.

Retours

Événement

Corps
v1.EventApi.EventRead

Obtenir une adresse e-mail d’un enregistrement

ID d’opération :
GetRecordEmailAddress

Retourne des informations sur une adresse e-mail d’un enregistrement.

Paramètres

Nom Clé Obligatoire Type Description
ID enregistrement
 record_id True integer

ID généré par le système pour identifier un enregistrement de manière unique.
ID
 email_id True integer

ID généré par le système pour identifier de manière unique une adresse e-mail d’un enregistrement.

Retours

Adresse électronique

Corps
v1.RecordApi.EmailAddressRead

Obtenir une page d’octroi

ID d’opération :
GetGivingPage

Retourne des informations sur une page d’octroi.

Paramètres

Nom Clé Obligatoire Type Description
Attribution de l’ID de page
 id True integer

ID généré par le système pour identifier de manière unique une page d’attribution.
Fields
 fields array

Liste de champs séparés par des virgules dans la réponse.

Retours

Page d’attribution

Corps
v1.GivingApi.GivingPageRead

Obtenir une soumission d’un formulaire

ID d’opération :
GetFormEntry

Retourne des informations sur une soumission de formulaire.

Paramètres

Nom Clé Obligatoire Type Description
Formulaire
 form_id True integer

ID généré par le système pour identifier de manière unique un formulaire.
ID de réponse
 entry_id True string

ID généré par le système pour identifier de manière unique une soumission de formulaire.

Retours

Les sorties de cette opération sont dynamiques.

Répertorier les adresses e-mail d’un enregistrement

ID d’opération :
ListRecordEmailAddresses

Retourne une liste d’adresses e-mail pour un enregistrement.

Paramètres

Nom Clé Obligatoire Type Description
ID enregistrement
 record_id True integer

ID généré par le système pour identifier un enregistrement de manière unique.
Est-ce que primaire ?
 is_primary boolean

Recherchez l’e-mail principal.
Fields
 fields array

Liste de champs séparés par des virgules dans la réponse.
Taille de page
 page_size integer

Représente le nombre d’enregistrements à retourner. La valeur par défaut est 10. Le maximum est de 50.
Numéro de page
 page integer

Représente les numéros de page (décalage). Pour une utilisation avec la pagination.

Retours

Nom Chemin d’accès Type Description
URL des résultats suivants
 nextlink uri

URL du jeu de résultats de la page suivante. Pour une utilisation avec la pagination.
URL des résultats précédents
 previouslink uri

URL de l’ensemble de résultats précédent. Pour une utilisation avec la pagination.
Nombre total d’adresses e-mail
 total integer

Nombre total d’adresses e-mail pour les filtres donnés
Adresse électronique
 value array of v1.RecordApi.EmailAddressRead

Liste de l’adresse e-mail d’un enregistrement retourné pour les filtres donnés. Les résultats sont paginés.

Répertorier les cadeaux

ID d’opération :
ListGifts

Retourne une liste de cadeaux.

Paramètres

Nom Clé Obligatoire Type Description
Statut
 status True string

Filtrez les cadeaux en fonction de l’état.
Page d’attribution
 campaign integer

ID généré par le système pour identifier de manière unique une page d’attribution.
Filtrer par ID de groupe cadeau
 group_id uuid

ID généré par le système pour identifier de manière unique un groupe de cadeaux ou une liste.
Doit-il avoir un numéro de lot vide ?
 batch_number__isnull boolean

Filtrez les cadeaux en fonction d’un numéro de lot ou non.
Doit-il avoir un ID de base de données externe vide ?
 external_database_id__isnull boolean

Filtrez les cadeaux en fonction de leur ID de base de données externe ou non. REMARQUE : Les cadeaux qui ont l’ID de base de données externe sont déjà envoyés vers une base de données externe.
Filtrer par ID de base de données externe
 external_database_id string

Filtrez les cadeaux en fonction de l’ID de base de données externe.
Filtrer par e-mail de donneur
 donor_email string

Filtrer les cadeaux en fonction de l’adresse e-mail du donneur
Rechercher par
 search string

Recherchez des cadeaux par nom ou adresse e-mail.
Fields
 fields array

Liste de champs séparés par des virgules dans la réponse.
Taille de page
 page_size integer

Représente le nombre d’enregistrements à retourner. La valeur par défaut est 10. Le maximum est de 50.
Numéro de page
 page integer

Représente les numéros de page (décalage). Pour une utilisation avec la pagination.
Commande par
 ordering string

Définissez l’ordre des cadeaux dans la réponse. Un préfixe « - » représente l’ordre décroissant et l’absence du préfixe renvoie les résultats dans l’ordre croissant.

Retours

Nom Chemin d’accès Type Description
URL des résultats suivants
 nextlink uri

URL du jeu de résultats de la page suivante. Pour une utilisation avec la pagination.
URL des résultats précédents
 previouslink uri

URL de l’ensemble de résultats précédent. Pour une utilisation avec la pagination.
Nombre total de cadeaux
 total integer

Nombre total de cadeaux pour les filtres donnés
Cadeaux
 value array of v1.GivingApi.GiftRead

Liste des cadeaux retournés pour les filtres donnés. Les résultats sont paginés.

Répertorier les enregistrements

ID d’opération :
ListRecords

Retourne une liste d’enregistrements.

Paramètres

Nom Clé Obligatoire Type Description
Rechercher par nom
 search string

Recherchez les enregistrements par nom.
Rechercher par adresse e-mail
 email_addresses__address string

Recherchez des enregistrements par adresse e-mail.
Rechercher par ID de base de données externe
 external_database_id string

Recherchez des enregistrements par ID de base de données externe.
Fields
 fields array

Liste de champs séparés par des virgules dans la réponse.
Mise à jour sur ou après
 updated_at__gte date-time

Mise à jour ou après une date.
Créé sur ou après
 created_at__gte date-time

Créé le ou après une date.
Taille de page
 page_size integer

Représente le nombre d’enregistrements à retourner. La valeur par défaut est 10. Le maximum est de 50.
Numéro de page
 page integer

Représente les numéros de page (décalage). Pour une utilisation avec la pagination.

Retours

Nom Chemin d’accès Type Description
URL des résultats suivants
 nextlink uri

URL du jeu de résultats de la page suivante. Pour une utilisation avec la pagination.
URL des résultats précédents
 previouslink uri

URL de l’ensemble de résultats précédent. Pour une utilisation avec la pagination.
Nombre total d’enregistrements
 total integer

Nombre total d’enregistrements pour les filtres donnés
Enregistrements
 value array of v1.RecordApi.RecordRead

Liste des enregistrements d’un enregistrement retourné pour les filtres donnés.

Répertorier les fonds

ID d’opération :
ListFunds

Retourne une liste de fonds

Paramètres

Nom Clé Obligatoire Type Description
Fields
 fields array

Liste de champs séparés par des virgules dans la réponse.

Retours

response
array of v1.GivingApi.FundRead

Répertorier les formulaires

ID d’opération :
ListForms

Obtenez une liste de formulaires.

Paramètres

Nom Clé Obligatoire Type Description
Fields
 fields array

Liste de champs séparés par des virgules dans la réponse.

Retours

response
array of v1.FormApi.FormRead

Répertorier les personnes de contact

ID d’opération :
ListEventContactPersons

Retourne une liste de toutes les personnes de contact sur un événement.

Paramètres

Nom Clé Obligatoire Type Description
ID de l’événement
 id True integer

ID généré par le système pour identifier un événement de manière unique.

Retours

response
array of v1.EventApi.ContactPersonRead

Supprimer une adresse e-mail d’un enregistrement

ID d’opération :
DeleteRecordEmailAddress

Supprimez une adresse e-mail d’un enregistrement.

Paramètres

Nom Clé Obligatoire Type Description
ID enregistrement
 record_id True integer

ID généré par le système pour identifier un enregistrement de manière unique.
ID
 email_id True integer

ID généré par le système pour identifier de manière unique une adresse e-mail d’un enregistrement.

Déclencheurs

Lorsqu’un e-mail est créé, mis à jour ou supprimé sur un enregistrement

Se déclenche lorsqu’un e-mail est créé sur un enregistrement ou qu’un e-mail existant est mis à jour ou supprimé d’un enregistrement.
Lorsqu’un enregistrement est créé ou mis à jour sur Almabase

Se déclenche lorsqu’un nouvel enregistrement est créé sur Almabase ou qu’un enregistrement existant est mis à jour.
Lorsqu’un formulaire est envoyé ou qu’une soumission de formulaire existante est mise à jour

Se déclenche lorsqu’un formulaire est envoyé ou qu’une soumission de formulaire existante est mise à jour.
Lorsqu’un nouveau cadeau réussit ou qu’un paiement cadeau en ligne a échoué

Déclenche l’échec de l’enregistrement d’un nouveau cadeau sur une page de dons par un donneur ou l’échec du paiement à un cadeau.

Lorsqu’un e-mail est créé, mis à jour ou supprimé sur un enregistrement

ID d’opération :
EmailChangedWebhook

Se déclenche lorsqu’un e-mail est créé sur un enregistrement ou qu’un e-mail existant est mis à jour ou supprimé d’un enregistrement.

Paramètres

Nom Clé Obligatoire Type Description
Quand
 events True string

Liste des événements à déclencher.

Retours

Corps
v1.RecordApi.EmailWebhookResponse

Lorsqu’un enregistrement est créé ou mis à jour sur Almabase

ID d’opération :
RecordChangedWebhook

Se déclenche lorsqu’un nouvel enregistrement est créé sur Almabase ou qu’un enregistrement existant est mis à jour.

Paramètres

Nom Clé Obligatoire Type Description
Quand
 events True string

Liste des événements à déclencher.

Retours

Corps
v1.RecordApi.RecordWebhookResponse

Lorsqu’un formulaire est envoyé ou qu’une soumission de formulaire existante est mise à jour

ID d’opération :
FormEntryCreateOrUpdateWebhook

Se déclenche lorsqu’un formulaire est envoyé ou qu’une soumission de formulaire existante est mise à jour.

Paramètres

Nom Clé Obligatoire Type Description
Quand
 events True string

Liste des événements à déclencher.
Formulaire
 object_id True integer

ID généré par le système pour identifier de manière unique un formulaire.

Retours

Les sorties de cette opération sont dynamiques.

Lorsqu’un nouveau cadeau réussit ou qu’un paiement cadeau en ligne a échoué

ID d’opération :
GiftSucceededOrFailedWebhook

Déclenche l’échec de l’enregistrement d’un nouveau cadeau sur une page de dons par un donneur ou l’échec du paiement à un cadeau.

Paramètres

Nom Clé Obligatoire Type Description
Quand
 events True string

Liste des événements à déclencher.
Page d’attribution
 object_id integer

ID généré par le système pour identifier de manière unique une page d’attribution.

Retours

Corps
v1.GivingApi.GiftWebhookResponse

Définitions

v1. FormApi.FormRead

Formulaire

Nom Chemin d’accès Type Description
ID
 id integer

ID généré par le système pour identifier de manière unique un formulaire.
Nom du formulaire
 title string

Nom du formulaire

v1. GivingApi.GiftWebhookRecordRead

Enregistrement

Nom Chemin d’accès Type Description
ID de base de données externe
 external_database_id string

ID unique attribué par le système pour l’enregistrement par la base de données externe. Par exemple, ID d’enregistrement système pour Raiser Edge NXT, ID de contact pour Salesforce
Prénom
 first_name string

Prénom de l’enregistrement mappé
ID
 id integer

ID généré par le système pour identifier un enregistrement de manière unique.
Le donneur est-il inscrit sur Almabase ?
 is_registered boolean

Indiquez si l’enregistrement mappé ou le donneur enregistré sur Almabase
Nom de famille
 last_name string

Nom de l’enregistrement mappé

v1. GivingApi.GiftWebhookResponse

Nom Chemin d’accès Type Description
Montant
 data.amount string

Montant du cadeau avec deux décimales.
Date
 data.completed_at date-time

Date à laquelle l’état du cadeau est marqué comme terminé.
E-mail du donneur
 data.email email

ID d’e-mail utilisé par le donneur pour le cadeau.
ID de base de données externe
 data.external_database_id string

ID unique attribué par le système pour le cadeau par la base de données externe.
ID
 data.id integer

ID généré par le système pour identifier de façon unique un cadeau.
Nouveau message électronique ?
 data.is_email_new boolean

Indique si l’e-mail fourni par le donneur existe déjà sur les enregistrements Almabase.
schéma
 data.mapped_profile.schema v1.GivingApi.GiftWebhookRecordRead

Enregistrement
Mode
 data.mode string

Mode du cadeau.
Nom du donneur
 data.name string

Nom complet du donneur.
ID
 data.page.id integer

ID généré par le système pour identifier de manière unique une page d’attribution.
Donner le nom de la page
 data.page.name string

Nom de la page d’attribution associée
Statut
 data.status string

État du cadeau.
Événement déclenché à
 time string

Heure de l’événement.
Type d'événement
 type string

Type d’événement.

v1. GivingApi.LocationRead

La ville utilisée par le donneur pour le don.

Nom Chemin d’accès Type Description
Ville
 city string

La ville du donneur
Nom court de la ville
 city_short_name string

Représentation courte de la Ville, par exemple SF
Latitude
 coordinates.latitude string

Latitude de l’emplacement
Longitude
 coordinates.longitude string

Longitude de l’emplacement
Pays
 country string

Pays du donneur
Nom court du pays
 country_short_name string

La représentation courte du pays, par exemple les États-Unis
Google Place Id
 gpid string

ID d’emplacement obtenu à partir de Google
Ville, État, Pays
 name string

La ville du donneur. Format : Nom de la ville, Nom de l’état court, Nom du pays court
État
 state string

État du donneur
Nom court d’état
 state_short_name string

Représentation courte de l’état, par exemple l’autorité de certification

v1. GivingApi.FormFieldRead

Champ de formulaire

Nom Chemin d’accès Type Description
Valeur
 display_value string

Valeur mise en forme entrée par les répondeurs. Par exemple, nom du chargement du fichier.
Nom du champ Question/Formulaire
 label string

Nom du champ question/formulaire sur le formulaire

v1. GivingApi.FundRead

Le fonds associé au fractionnement du cadeau.

Nom Chemin d’accès Type Description
ID de base de données externe
 external_database_id string

ID unique attribué par le fonds par la base de données externe. Par exemple, ID d’enregistrement système pour Raiser Edge NXT, ID d’objet pour Salesforce
ID
 id integer

ID généré par le système pour identifier de manière unique un fonds.
Le fonds par défaut est-il ?
 is_default boolean

Indique à tous les fractionnements associés à ce fonds si aucun autre fonds n’est défini sur La page Donner.
Est-ce que d’autres fonds ?
 is_other_fund boolean

Indique que les donateurs de ce fonds ont donné un nom de fonds personnalisé.
Nom
 name string

Nom du fonds

v1. GivingApi.GiftRead

Cadeau

Nom Chemin d’accès Type Description
Montant du cadeau
 amount string

Montant du cadeau avec deux décimales.
Numéro de lot
 batch_number string

Numéro de lot du cadeau.
Date de cadeau
 completed_at date-time

Date à laquelle l’état du cadeau est marqué comme terminé.
Monnaie
 currency integer

Devise utilisée par le donneur pour le cadeau.
Device
 device string

Identifiez l’appareil utilisé pour faire le cadeau, par exemple pc, mobile ou tablette.
Adresse du donneur : ligne 1
 donor_address_line1 string

Ligne d’adresse 1 utilisée par le donneur pour le cadeau.
Adresse du donneur : ligne 2
 donor_address_line2 string

Ligne d’adresse 2 utilisée par le donneur pour le cadeau.
Adresse du donneur : emplacement
 donor_city_place v1.GivingApi.LocationRead

La ville utilisée par le donneur pour le don.
E-mail du donneur
 donor_email email

ID d’e-mail utilisé par le donneur pour le cadeau.
Nom du donneur
 donor_name string

Nom complet du donneur.
Numéro de téléphone du donneur
 donor_phone_number string

Numéro de téléphone utilisé par le donneur pour le cadeau.
Adresse du donneur : code postal
 donor_zip_code string

Code postal de l’adresse utilisée par le donneur pour le cadeau.
Est-il masqué dans le classement ?
 exclude_from_leaderboard boolean

Est-il masqué dans le classement ?
ID de base de données externe
 external_database_id string

ID unique attribué par le système pour le cadeau par la base de données externe.
Message d’hommage
 honor_message string

Un message pour un hommage cadeau.
Préfixe d’hommage
 honor_prefix string

Préfixe d’un hommage cadeau. Les options disponibles sont in_honor_of, in_memory_of, in_support_of
ID
 id integer

ID généré par le système pour identifier de façon unique un cadeau.
Influenceur
 influencer v1.GivingApi.InfluencerRead

Lien de partage public et lien de tableau de bord privé
Anonyme ?
 is_anonymous boolean

Indique que le souhait de donneur soit anonyme auprès d’autres donateurs pour ce cadeau.
Le donneur a-t-il couvert les frais de passerelle de paiement ?
 is_donor_covered_charges boolean

Indique si le donneur a choisi de couvrir les frais de passerelle de paiement lors de la réalisation de ce cadeau ?
L’e-mail est-il ajouté à un enregistrement sur Almabase ?
 is_email_added_to_profile boolean

Indique si l’e-mail fourni par le donneur est ajouté sur l’enregistrement Almabase (quel que soit l’état de is_email_new)
Nouveau message électronique ?
 is_email_new boolean

Indique si l’e-mail fourni par le donneur existe déjà sur les enregistrements Almabase.
Le mappage à un enregistrement sur Almabase est-il ignoré ?
 is_profile_mapping_ignored boolean

Indique si le mappage d’enregistrements doit être ignoré.
Mode de paiement
 mode string

Mode de paiement, en ligne ou hors connexion.
Note
 note string

Texte de la note.
Autre nom du fonds
 other_fund_name string

Lorsque le donneur sélectionne un fonds marqué comme is_other_fund, il ajoute un nom de fonds personnalisé pour attribuer le cadeau.
Page d’attribution
 page v1.GivingApi.GivingPageAssociatedWithGift

Page d’octroi associée au cadeau.
Fields
 post_payment_form_entry.fields array of v1.GivingApi.FormFieldRead
ID de réponse
 post_payment_form_entry.id integer

ID généré par le système pour identifier de manière unique une soumission de formulaire.
Fields
 pre_payment_form_entry.fields array of v1.GivingApi.FormFieldRead
ID de réponse
 pre_payment_form_entry.id integer

ID généré par le système pour identifier de manière unique une soumission de formulaire.
Enregistrement mappé
 profile v1.GivingApi.RecordRead

Enregistrement mappé sur Almabase
Lien de référence
 referrer_link string

Lien du site web pour identifier la source de la visite du donneur. Par exemple, le donneur a visité la campagne De dons de Facebook, Google, etc.
Montant du remboursement
 refund_amount string

Montant remboursé au donneur. Si le montant entier est remboursé, l’état du cadeau sera remboursé au lieu d’être terminé.
Divise
 splits array of v1.GivingApi.GiftSplitRead

Les fractionnements associés au cadeau.
Statut
 status string

État du cadeau.
Transaction en ligne
 transaction v1.GivingApi.TransactionRead

Transaction de paiement en ligne associée au cadeau.
CAMPAGNE DE L’ANALYSE DES DONNÉES
 utm_campaign string

Utilisé pour l’analyse des mots clés. utm_campaign identifier une campagne de promotion ou de stratégie de produit spécifique. par exemple, annual_fund_2020
MEDIUM DE L’APPLIANCE
 utm_medium string

utm_medium identifier un support tel que l’e-mail ou le coût par clic. par exemple, cpc
SOURCE OLE
 utm_source string

utm_source identifier un moteur de recherche, un nom de bulletin d’informations ou une autre source. Par exemple, Google

v1. GivingApi.GiftSplitRead

Fractionnement du cadeau

Nom Chemin d’accès Type Description
Montant
 amount string

Le montant du cadeau fractionné.
Fonds
 fund v1.GivingApi.FundRead

Le fonds associé au fractionnement du cadeau.
ID
 id integer

ID généré par le système pour identifier de façon unique un fractionnement de cadeau.

v1. GivingApi.GivingPageAssociatedWithGift

Page d’octroi associée au cadeau.

Nom Chemin d’accès Type Description
ID
 id integer

ID généré par le système pour identifier de manière unique une page d’attribution.
Nom
 name string

Nom de la page d’attribution associée.

v1. GivingApi.GivingPageRead

Page d’attribution

Nom Chemin d’accès Type Description
ID
 id integer

ID généré par le système pour identifier de manière unique une page d’attribution.
Nom
 name string

Nom de la page d’attribution

v1. GivingApi.InfluenceurRead

Lien de partage public et lien de tableau de bord privé

Nom Chemin d’accès Type Description
Lien du tableau de bord d’influenceur privé
 dashboard_url uri

Tableau de bord privé du donneur pour surveiller le nombre de visites de pages et de dons influencés par eux
Lien de partage public
 page_share_url uri

Lien public du don de page/campagne de donateurs pour suivre l’influence sur les visites à La Page de dons et les dons.

v1. GivingApi.PaymentAccountRead

Compte de paiement associé à la transaction, par exemple BBMS, Stripe, PayPal, etc.

Nom Chemin d’accès Type Description
ID
 id integer

ID généré par le système pour identifier de manière unique un compte de paiement.
Nom
 name string

Nom du compte de paiement.
Gateway
 type string

Nom de la passerelle de paiement.

v1. GivingApi.RecordRead

Enregistrement mappé sur Almabase

Nom Chemin d’accès Type Description
ID de base de données externe
 external_database_id string

ID unique attribué par le système pour l’enregistrement par la base de données externe. Par exemple, ID d’enregistrement système pour Raiser Edge NXT, ID de contact pour Salesforce
Prénom
 first_name string

Prénom de l’enregistrement mappé
Nom complet
 formatted_name string

Nom complet de l’enregistrement mappé
ID
 id integer

ID généré par le système pour identifier un enregistrement de manière unique.
Le donneur est-il inscrit sur Almabase ?
 is_registered boolean

Indiquez si l’enregistrement mappé ou le donneur enregistré sur Almabase
Nom de famille
 last_name string

Nom de l’enregistrement mappé
URL de l’image
 present_picture uri

URL de l’image d’enregistrement
Lien
 profile_url uri

Lien d’enregistrement sur Almabase

v1. GivingApi.TransactionRead

Transaction de paiement en ligne associée au cadeau.

Nom Chemin d’accès Type Description
Compte de paiement
 account v1.GivingApi.PaymentAccountRead

Compte de paiement associé à la transaction, par exemple BBMS, Stripe, PayPal, etc.
Créé à
 created_at date-time

Heure de création de cette transaction.
Raison de l’échec
 failure_reason string

Raison de l’échec de la transaction retournée par la passerelle de paiement.
ID
 id uuid

ID généré par le système pour identifier de manière unique une transaction.
Statut
 status integer

État de la transaction. - 1 (Non traité) - 2 (Réussi) - 3 (Échec) - 4 (En attente) - 5 (Erreur) REMARQUE : Ces états sont associés à l’état de la transaction par la passerelle de paiement
ID de référence de la passerelle de paiement
 transaction_id string

ID unique généré par la passerelle de paiement pour identifier la transaction. Par exemple, Blackbaud Merchant Services (BBMS) ID de transaction, ou ID de charge de bande, PayPal ID de transaction

v1. AlmasightsApi.RecordAddOrEdit

Enregistrement sur Almabase.

Nom Chemin d’accès Type Description
ID
 id integer

ID généré par le système pour identifier un enregistrement de manière unique.

v1. AlmasightsApi.TouchpointCustomObjectAdd

Corps du point de contact pour créer un point tactile

Nom Chemin d’accès Type Description
Messagerie électronique
 email email

ID d’e-mail utilisé pour l’activité.
Enregistrement
 mapped_profile v1.AlmasightsApi.RecordAddOrEdit

Enregistrement sur Almabase.
Enregistré à
 recorded_at date-time

Horodatage de l’activité.
Type
 touchpoint_type.id integer

v1. RecordApi.LocationRead

Emplacement de l’adresse

Nom Chemin d’accès Type Description
Ville
 city string

Nom de la ville de l’emplacement
Pays
 country string

Nom du pays de l’emplacement
Latitude
 latitude double

Latitude de l’emplacement
Longitude
 longitude double

Longitude de l’emplacement
État
 state string

Nom de l’état de l’emplacement

v1. RecordApi.AddressRead

Adresse

Nom Chemin d’accès Type Description
Line1
 line1 string

Ligne 1 de l’adresse
Line2
 line2 string

Ligne 2 de l’adresse
schéma
 location.schema v1.RecordApi.LocationRead

Emplacement de l’adresse
Code postal
 zipcode string

Code postal de l’adresse

v1. RecordApi.EmailWebhookRecordRead

Enregistrement

Nom Chemin d’accès Type Description
ID de base de données externe
 external_database_id string

ID unique attribué par le système pour l’enregistrement par la base de données externe. Par exemple, ID d’enregistrement système pour Raiser Edge NXT, ID de contact pour Salesforce
Prénom
 first_name string

Prénom de l’enregistrement mappé
ID
 id integer

ID généré par le système pour identifier un enregistrement de manière unique.
L’enregistrement est-il inscrit sur Almabase ?
 is_registered boolean

Indiquer si l’enregistrement mappé inscrit sur Almabase
Nom de famille
 last_name string

Nom de l’enregistrement mappé

v1. RecordApi.EmailWebhookResponse

Nom Chemin d’accès Type Description
Adresse électronique
 data.address email

Adresse e-mail.
ID
 data.id integer

ID généré par le système pour identifier de manière unique un e-mail.
Est principal
 data.is_primary boolean

Indique si l’e-mail est principal ou non.
schéma
 data.profile.schema v1.RecordApi.EmailWebhookRecordRead

Enregistrement
Type d’e-mail
 data.type string

Type de l’adresse e-mail (principal, personnel, professionnel, etc.).
Événement déclenché à
 time string

Heure de l’événement.
Type d'événement
 type string

Type d’événement.

v1. RecordApi.RecordWebhookResponse

Nom Chemin d’accès Type Description
Affiliations
 data.affiliations array of string
Année de classe
 data.class_year string

Année de classe de l’enregistrement
Adresse électronique
 data.email email

Adresse e-mail.
ID de base de données externe
 data.external_database_id string

ID unique attribué par le système pour l’enregistrement par la base de données externe. Par exemple, ID d’enregistrement système pour Raiser Edge NXT, ID de contact pour Salesforce
Prénom
 data.first_name string

Prénom de l’enregistrement mappé
schéma
 data.home_address.schema v1.RecordApi.AddressRead

Adresse
ID
 data.id integer

ID généré par le système pour identifier un enregistrement de manière unique.
Nom de famille
 data.last_name string

Nom de l’enregistrement mappé
Date d’expiration de l’appartenance
 data.membership_expiry_date date-time

Date d’expiration de l’appartenance à l’enregistrement
Nom du type d’appartenance
 data.membership_type_name string

Nom du type d’appartenance de l’enregistrement
Numéro de téléphone mobile
 data.mobile_number string

Numéro mobile de l’enregistrement
schéma
 data.office_address.schema v1.RecordApi.AddressRead

Adresse
Numéro de téléphone du bureau
 data.office_phone_number string

Numéro de téléphone du bureau de l’enregistrement
Numéro de téléphone de résidence
 data.residence_phone_number string

Numéro de téléphone de résidence de l’enregistrement
Événement déclenché à
 time string

Heure de l’événement.
Type d'événement
 type string

Type d’événement.

v1. RecordApi.EmailAddressRead

Adresse électronique

Nom Chemin d’accès Type Description
Adresse
 address email

Adresse e-mail
ID
 id integer

ID généré par le système pour identifier de manière unique une adresse e-mail d’un enregistrement.
Est-ce engagé ?
 is_engaged boolean

Indique si un e-mail en bloc est cliqué ou ouvert, ou si l’utilisateur répond à un e-mail
Utiliser pour la connexion ?
 is_login_email boolean

Indique si l’utilisateur est autorisé à se connecter à la plateforme à l’aide de cette adresse e-mail.
Est-ce que primaire ?
 is_primary boolean

Un e-mail principal est utilisé pour envoyer les e-mails automatisés déclenchés par le système. Il est également utilisé pour envoyer l’e-mail en bloc à l’enregistrement. Il est obligatoire qu’un seul e-mail soit défini comme principal.
Est-ce vérifié par l’utilisateur ?
 is_verified boolean

Indiquez si l’utilisateur a vérifié qu’il possède l’e-mail.
Source
 source string

La source indique comment l’e-mail est ajouté à la base de données.
status
 status string
Type
 type string

Type de l’e-mail

v1. RecordApi.RecordRead

enregistrement

Nom Chemin d’accès Type Description
Adresses électroniques
 email_addresses array of v1.RecordApi.EmailAddressRead

Liste des adresses e-mail d’un profil
ID de base de données externe
 external_database_id string

ID unique attribué par le système pour l’enregistrement par la base de données externe. Par exemple, ID d’enregistrement système pour Raiser Edge NXT, ID de contact pour Salesforce
Prénom
 first_name string

Prénom de l’enregistrement.
Nom complet
 formatted_name string

Nom complet de l’enregistrement.
ID
 id integer

ID généré par le système pour identifier un enregistrement de manière unique.
Est-ce inscrit sur Almabase ?
 is_registered boolean

Indiquez si l’enregistrement ou le donneur enregistré sur Almabase
Nom de famille
 last_name string

Nom de l’enregistrement.
URL de l’image
 present_picture uri

URL de l’image d’enregistrement
Lien
 record_url uri

Lien d’enregistrement sur Almabase

v1. EventApi.ContactPersonRead

Personne de contact d’un événement

Nom Chemin d’accès Type Description
Messagerie électronique
 email email

E-mail de la personne de contact
ID
 id integer

ID généré par le système pour identifier de manière unique une personne de contact.
Nom
 name string

Nom de la personne de contact
Numéro de téléphone
 phone_number string

Numéro de téléphone de la personne de contact

v1. EventApi.EventRead

Événement

Nom Chemin d’accès Type Description
Descriptif
 description string

Description de l’événement
Heure de fin
 end_datetime string

Heure de fin de l’événement
ID de base de données externe
 external_database_id string

ID unique attribué par le système pour l’enregistrement par la base de données externe. Par exemple, ID d’enregistrement système pour Raiser Edge NXT, ID de contact pour Salesforce
URL d’inscription externe
 external_registration_url string

URL d’inscription de l’événement sur un site web externe
ID
 id integer

ID généré par le système pour identifier un événement de manière unique.
Nom
 name string

Le nom de l’événement
Heure de début
 start_datetime string

Heure de début de l’événement
Timezone
 timezone string

Fuseau horaire de l’événement