Blackbaud CRM Prospect (préversion)
Blackbaud CRM est une solution complète de collecte de fonds et de gestion des donateurs conçue spécifiquement pour les associations et l’ensemble de la communauté sociale. Utilisez le connecteur Prospect pour gérer les prospects, les plans et les opportunités.
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 de Blackbaud |
| URL | https://www.blackbaud.com/support |
| Messagerie électronique | skyapi@blackbaud.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Blackbaud, Inc. |
| Site internet | https://www.blackbaud.com/products/blackbaud-crm |
| Politique de confidentialité | https://www.blackbaud.com/privacy-shield |
| Catégories | Ventes et CRM ; Productivité |
Blackbaud CRM est le système mondial de gestion des collectes de fonds le plus puissant conçu pour les équipes de collecte de fonds à l’échelle de l’entreprise à but non lucratif et d’enseignement supérieur.
Ce connecteur repose sur l’API SKY de Blackbaud et fournit des opérations pour gérer les prospects et les entités associées trouvées dans Blackbaud CRM.
Pour plus d’informations, consultez la documentation.
Prerequisites
Pour utiliser ce connecteur, vous devez disposer d’un compte Blackbaud ID avec accès à un ou plusieurs environnements Blackbaud.
En outre, l’administrateur de votre organisation doit également effectuer une action au niveau de l’administrateur au sein du système pour permettre à ce connecteur d’accéder à votre environnement Blackbaud. Vous trouverez plus d’informations sur ces prérequis dans la documentation de configuration initiale .
Comment obtenir des informations d’identification ?
L’administrateur de votre organisation vous envoie une invitation à l’environnement Blackbaud CRM de l’organisation et configure les autorisations de votre compte d’utilisateur dans l’environnement. Aucune information d’identification supplémentaire n’est requise pour utiliser ce connecteur.
Problèmes connus et limitations
Le connecteur fonctionne dans le contexte de votre compte d’utilisateur et sera donc soumis à vos autorisations utilisateur dans l’environnement.
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Créer un plan de don majeur |
Crée un plan d’octroi majeur pour une perspective. |
| Créer un plan de gestion |
Crée un plan de gestion pour une perspective. |
| Créer un rapport de contact non planifié |
Crée un rapport de contact non planifié pour un plan. |
| Créer une circonscription de prospect |
Crée une circonscription de prospect pour une constituante. |
| Créer une opportunité |
Crée une opportunité de plan de prospect. |
| Créer une étape de plan de gestion |
Crée une étape de plan de gestion. |
| Créer une étape majeure de plan d’octroi |
Crée une étape majeure de plan d’octroi. |
| Mettre à jour un rapport de contact |
Met à jour un rapport de contact. |
| Mettre à jour une opportunité |
Met à jour une opportunité de plan de prospect. |
| Mettre à jour une prospect |
Met à jour une prospect. |
| Mettre à jour une étape de plan de gestion |
Met à jour une étape de plan de gestion. |
| Mettre à jour une étape majeure du plan d’octroi |
Met à jour une étape majeure du plan d’octroi. |
| Obtenir un plan de don majeur |
Retourne des informations pour un plan de don majeur. |
| Obtenir un résumé des prospects |
Retourne des informations de prospect pour un constituant. |
| Obtenir une opportunité |
Retourne des informations pour une opportunité de plan de prospect. |
| Rechercher des opportunités de prospect |
Recherche des enregistrements d’opportunités de prospects à l’aide des critères de filtre donnés. |
| Rechercher des prospects |
Recherche des enregistrements prospects à l’aide des critères de filtre donnés. |
| Répertorier les opportunités de plan |
Répertorie les opportunités d’un plan de prospect. |
| Répertorier les plans de prospect |
Répertorie les plans d’une perspective. |
| Supprimer un plan de don majeur |
Supprime un plan de don majeur. |
| Supprimer un plan de gestion |
Supprime un plan de gestion. |
| Supprimer une opportunité |
Supprime une opportunité de plan de prospect. |
| Supprimer une étape de plan de gestion |
Supprime une étape de plan de gestion. |
| Supprimer une étape majeure du plan d’octroi |
Supprime une étape majeure du plan d’octroi. |
Créer un plan de don majeur
Crée un plan d’octroi majeur pour une perspective.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Prospect ID
|
prospect_id | True | string |
ID d’enregistrement système de la constituante de prospect. |
|
Nom
|
prospect_plan_name | True | string |
Nom du plan. Limite de caractères : 100. |
|
Type
|
prospect_plan_type | True | string |
Type de plan. |
|
Date de début
|
start_date | date |
Date de début du plan (par exemple : « 2005-09-18 »). |
|
|
Narration
|
narrative | string |
Le plan narratif. Limite de caractères : 1 000. |
|
|
ID du gestionnaire principal
|
primary_manager_fundraiser_id | string |
ID d’enregistrement système de la collecte de fonds du responsable de prospect principal. |
|
|
Date de début principale
|
primary_manager_date_from | date |
Date de début du gestionnaire principal (par exemple : « 2005-09-18 »). |
|
|
ID du gestionnaire secondaire
|
secondary_manager_fundraiser_id | string |
ID d’enregistrement système de la collecte de fonds du gestionnaire de prospects secondaire. |
|
|
Date de début secondaire
|
secondary_manager_date_from | date |
Date de début du gestionnaire secondaire (par exemple : « 2005-09-18 »). |
|
|
ID
|
constituent_id | True | string |
ID d’enregistrement système du participant constituant. |
|
role
|
plan_participant_role | string |
Rôle de participant. |
|
|
ID
|
fundraiser_id | True | string |
ID d’enregistrement système de la constituante de collecte de fonds secondaire. |
|
role
|
solicitor_role | string |
Le rôle de collecte de fonds. |
|
|
start
|
date_from | date |
Date de début de la collecte de fonds secondaire (par exemple : « 2005-09-18 »). |
Retours
Création d’un plan de don majeur
Créer un plan de gestion
Crée un plan de gestion pour une perspective.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Prospect ID
|
constituent_id | True | string |
ID d’enregistrement système de la constituante de prospect. |
|
Nom
|
name | True | string |
Nom du plan. Limite de caractères : 100. |
|
Type
|
plan_type_id | string |
Type de plan. |
|
|
Sous-type
|
plan_sub_type_id | string |
Sous-type de plan. |
|
|
Date de début
|
start_date | date |
Date de début du plan (par exemple : « 2005-09-18 »). |
|
|
ID du gestionnaire
|
manager_id | string |
ID d’enregistrement système du collecteur de fonds du responsable des prospects. |
|
|
Date de début du gestionnaire
|
manager_start_date | date |
Date de début du gestionnaire (par exemple : « 2005-09-18 »). |
|
|
ID
|
constituent_id | True | string |
ID d’enregistrement système de la constituante du gestionnaire. |
|
role
|
role | string |
Rôle de gestionnaire. |
|
|
date de début
|
start_date | date |
Date de début du gestionnaire (par exemple : « 2005-09-18 »). |
Retours
Plan de gestion créé
Créer un rapport de contact non planifié
Crée un rapport de contact non planifié pour un plan.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID plan
|
prospect_plan_id | True | string |
ID d’enregistrement système du plan d’octroi principal. |
|
Objective
|
objective | True | string |
Objectif d’étape. Limite de caractères : 100. |
|
Propriétaire
|
owner_id | string |
ID d’enregistrement système de la personne-ressource du propriétaire du rapport de contact constituant la collecte de fonds. |
|
|
Date réelle
|
actual_date | True | date |
Date réelle de l’étape (par exemple : « 2005-09-18 »). |
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
|
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
|
|
Étape
|
prospect_plan_status | True | string |
Étape de l’étape de plan. |
|
Méthode contact
|
interaction_type | True | string |
Méthode de contact d’interaction pour l’étape. |
|
Catégorie
|
interaction_category | string |
Catégorie d’interaction étape. |
|
|
Sous-catégorie
|
interaction_subcategory | string |
Sous-catégorie d’interaction de l’étape. |
|
|
Commentaire
|
comment | True | string |
Commentaire de l’étape. |
|
ID
|
fundraiser_id | True | string |
ID d’enregistrement système de la constituante de collecte de fonds. |
|
ID
|
constituent_id | True | string |
ID d’enregistrement système du participant. |
Retours
Création d’un rapport de contact non planifié
Créer une circonscription de prospect
Crée une circonscription de prospect pour une constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
|
Date à partir de
|
date_from | date |
Date de début de la circonscription (par exemple : « 2005-09-18 »). |
|
|
Date à
|
date_to | date |
Date de fin de la circonscription (par exemple : '2005-09-18'). |
Retours
Création d’une circonscription de prospect
Créer une opportunité
Crée une opportunité de plan de prospect.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID plan
|
prospect_plan_id | True | string |
ID d’enregistrement système du plan de prospect. |
|
Statut
|
status | True | string |
L’état de l’opportunité. |
|
Type
|
opportunity_type | string |
Type d’opportunité. |
|
|
Montant attendu de la demande
|
expected_ask_amount | double |
Montant attendu de la demande. |
|
|
Date de demande attendue
|
expected_ask_date | date |
Date de demande attendue (par exemple : « 2005-09-18 »). |
|
|
Vraisemblance
|
likelihood_type_code | string |
Probabilité d’opportunité. |
|
|
Demander le montant
|
ask_amount | double |
Montant de la demande. |
|
|
Demander la date
|
ask_date | date |
Date de demande (par exemple : « 2005-09-18 »). |
|
|
Montant accepté
|
accepted_amount | double |
Montant de la demande acceptée. |
|
|
Date de réponse
|
response_date | date |
Date de réponse (par exemple : « 2005-09-18 »). |
|
|
Commentaire
|
comment | string |
Le commentaire de l’opportunité. |
|
|
Devise de transaction
|
transaction_currency | string |
Devise de transaction. |
Retours
Opportunité de prospect créée
Créer une étape de plan de gestion
Crée une étape de plan de gestion.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID plan
|
stewardship_plan_id | True | string |
ID d’enregistrement système du plan de gestion. |
|
Objective
|
objective | True | string |
Objectif d’étape. Limite de caractères : 100. |
|
Date cible
|
target_date | True | date |
Date cible de l’étape (par exemple : « 2005-09-18 »). |
|
Verrouillé?
|
date_locked | boolean |
La date cible est-elle verrouillée ? |
|
|
Événement d’une journée entière ?
|
all_day_event | boolean |
L’interaction est-elle un événement d’une journée entière ? |
|
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
|
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
|
|
Fuseau horaire
|
time_zone_entry | string |
Fuseau horaire de l’étape. |
|
|
Statut
|
status_code | string |
État de l’étape du plan. |
|
|
Catégorie
|
category | string |
Catégorie d’étape du plan. |
|
|
Affectée à
|
constituent_id | string |
ID d’enregistrement système de l’élément de collecte de fonds du propriétaire de l’étape. |
|
|
Méthode contact
|
contact_method | string |
Méthode de contact d’interaction pour l’étape. |
|
|
Fréquence
|
recurs | True | string |
Fréquence de l’étape. |
|
Date de début
|
start_date | date |
Date réelle de l’étape (par exemple : « 2005-09-18 »). |
|
|
Date de fin
|
end_date | date |
Date réelle de l’étape (par exemple : « 2005-09-18 »). |
|
|
Date cible suivante
|
next_target_date | date |
Date cible suivante de l’étape (par exemple : « 2005-09-18 »). |
|
|
Se connecter à
|
link_type_code | string |
Type d’enregistrement connecté à l’étape. |
|
|
ID d’avantage
|
benefit_id | string |
ID d’enregistrement système de l’avantage connecté. |
|
|
ID de l’événement
|
event_id | string |
ID d’enregistrement système de l’événement connecté. |
|
|
ID de publipostage
|
mailing_id | string |
ID d’enregistrement système du publipostage connecté. |
|
|
Date réelle
|
actual_date | date |
Date réelle de l’étape (par exemple : « 2005-09-18 »). |
|
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
|
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
|
|
ID
|
constituent_id | True | string |
ID d’enregistrement système du participant. |
|
ID de plan
|
prospect_plan_id | True | string |
ID d’enregistrement système du plan associé. |
Retours
Étape du plan de gestion créé
Créer une étape majeure de plan d’octroi
Crée une étape majeure de plan d’octroi.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID plan
|
prospect_plan_id | True | string |
ID d’enregistrement système du plan d’octroi principal. |
|
Objective
|
objective | True | string |
Objectif d’étape. Limite de caractères : 100. |
|
Type
|
prospect_plan_status | True | string |
Étape de l’étape de plan. |
|
Statut
|
status | True | string |
État de l’étape du plan. |
|
Date attendue
|
expected_date | True | date |
Date attendue de l’étape (par exemple : « 2005-09-18 »). |
|
Propriétaire
|
owner_id | string |
ID d’enregistrement système de l’élément de collecte de fonds du propriétaire de l’étape. |
|
|
Commentaire
|
comment | string |
Commentaire de l’étape. |
|
|
Méthode contact
|
interaction_type | string |
Méthode de contact d’interaction pour l’étape. |
|
|
Catégorie
|
interaction_category | string |
Catégorie d’interaction étape. |
|
|
Sous-catégorie
|
interaction_subcategory | string |
Sous-catégorie d’interaction de l’étape. |
|
|
Événement d’une journée entière ?
|
is_all_day_event | boolean |
L’interaction est-elle un événement d’une journée entière ? |
|
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
|
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
|
|
Fuseau horaire
|
time_zone_entry | string |
Fuseau horaire de l’étape. |
|
|
Date réelle
|
actual_date | date |
Date réelle de l’étape (par exemple : « 2005-09-18 »). |
|
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
|
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
|
|
Emplacement
|
location | string |
Emplacement de l’étape. |
|
|
Autre emplacement
|
other_location | string |
Autre emplacement de l’interaction de l’étape. Limite de caractères : 300. |
|
|
ID
|
fundraiser_id | True | string |
ID d’enregistrement système de la constituante de collecte de fonds. |
|
ID
|
constituent_id | True | string |
ID d’enregistrement système du participant. |
Retours
Création d’une étape de plan d’octroi majeur
Mettre à jour un rapport de contact
Met à jour un rapport de contact.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du rapport
|
contact_report_id | True | string |
ID d’enregistrement système du rapport de contact à mettre à jour. |
|
Objective
|
objective | string |
Objectif d’étape. Limite de caractères : 100. |
|
|
Propriétaire
|
owner_id | string |
ID d’enregistrement système de la personne-ressource du propriétaire du rapport de contact constituant la collecte de fonds. |
|
|
Date réelle
|
actual_date | date |
Date réelle de l’étape (par exemple : « 2005-09-18 »). |
|
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
|
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
|
|
Étape
|
prospect_plan_status | string |
Étape de l’étape de plan. |
|
|
Méthode contact
|
interaction_type | string |
Méthode de contact d’interaction pour l’étape. |
|
|
Catégorie
|
interaction_category | string |
Catégorie d’interaction étape. |
|
|
Sous-catégorie
|
interaction_subcategory | string |
Sous-catégorie d’interaction de l’étape. |
|
|
Commentaire
|
comment | string |
Commentaire de l’étape. |
Mettre à jour une opportunité
Met à jour une opportunité de plan de prospect.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’opportunité
|
opportunity_id | True | string |
ID d’enregistrement système de l’opportunité de mise à jour. |
|
Statut
|
status | string |
L’état de l’opportunité. |
|
|
Type
|
opportunity_type | string |
Type d’opportunité. |
|
|
Montant attendu de la demande
|
expected_ask_amount | double |
Montant attendu de la demande. |
|
|
Date de demande attendue
|
expected_ask_date | date |
Date de demande attendue (par exemple : « 2005-09-18 »). |
|
|
Vraisemblance
|
likelihood_type_code | string |
Probabilité d’opportunité. |
|
|
Demander le montant
|
ask_amount | double |
Montant de la demande. |
|
|
Demander la date
|
ask_date | date |
Date de demande (par exemple : « 2005-09-18 »). |
|
|
Montant accepté
|
accepted_amount | double |
Montant de la demande acceptée. |
|
|
Date de réponse
|
response_date | date |
Date de réponse (par exemple : « 2005-09-18 »). |
|
|
Commentaire
|
comment | string |
Le commentaire de l’opportunité. |
|
|
Devise de transaction
|
transaction_currency | string |
Devise de transaction. |
Mettre à jour une prospect
Met à jour une prospect.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante prospect à mettre à jour. |
|
ID du gestionnaire
|
prospect_manager_fundraiser_id | string |
ID d’enregistrement système du composant du gestionnaire de prospects. |
|
|
Statut
|
prospect_status | string |
État des prospects. |
Mettre à jour une étape de plan de gestion
Met à jour une étape de plan de gestion.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’étape
|
step_id | True | string |
ID d’enregistrement système de l’étape de plan de gestion à mettre à jour. |
|
Objective
|
objective | string |
Objectif d’étape. Limite de caractères : 100. |
|
|
Date cible
|
target_date | date |
Date cible de l’étape (par exemple : « 2005-09-18 »). |
|
|
Verrouillé?
|
date_locked | boolean |
La date cible est-elle verrouillée ? |
|
|
Événement d’une journée entière ?
|
all_day_event | boolean |
L’interaction est-elle un événement d’une journée entière ? |
|
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
|
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
|
|
Fuseau horaire
|
time_zone_entry | string |
Fuseau horaire de l’étape. |
|
|
Statut
|
status | string |
État de l’étape du plan. |
|
|
Catégorie
|
category | string |
Catégorie d’étape du plan. |
|
|
Affectée à
|
constituent_id | string |
ID d’enregistrement système de l’élément de collecte de fonds du propriétaire de l’étape. |
|
|
Méthode contact
|
contact_method | string |
Méthode de contact d’interaction pour l’étape. |
|
|
Fréquence
|
recurs | string |
Fréquence de l’étape. |
|
|
Date de début
|
start_date | date |
Date réelle de l’étape (par exemple : « 2005-09-18 »). |
|
|
Date de fin
|
end_date | date |
Date réelle de l’étape (par exemple : « 2005-09-18 »). |
|
|
Date cible suivante
|
next_target_date | date |
Date cible suivante de l’étape (par exemple : « 2005-09-18 »). |
|
|
Se connecter à
|
link_type | string |
Type d’enregistrement connecté à l’étape. |
|
|
ID d’avantage
|
benefit_id | string |
ID d’enregistrement système de l’avantage connecté. |
|
|
ID de l’événement
|
event_id | string |
ID d’enregistrement système de l’événement connecté. |
|
|
ID de publipostage
|
mailing_id | string |
ID d’enregistrement système du publipostage connecté. |
|
|
Date réelle
|
actual_date | date |
Date réelle de l’étape (par exemple : « 2005-09-18 »). |
|
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
|
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
Mettre à jour une étape majeure du plan d’octroi
Met à jour une étape majeure du plan d’octroi.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID plan
|
v_prospect_plan_id | True | string |
ID d’enregistrement système du plan d’octroi principal. |
|
ID d’étape
|
step_id | True | string |
ID d’enregistrement système de l’étape de plan d’attribution principale à mettre à jour. |
|
Objective
|
objective | string |
Objectif d’étape. Limite de caractères : 100. |
|
|
Type
|
prospect_plan_status | string |
Étape de l’étape de plan. |
|
|
Statut
|
status | string |
État de l’étape du plan. |
|
|
Date attendue
|
expected_date | date |
Date attendue de l’étape (par exemple : « 2005-09-18 »). |
|
|
Propriétaire
|
owner_id | string |
ID d’enregistrement système de l’élément de collecte de fonds du propriétaire de l’étape. |
|
|
Commentaire
|
comment | string |
Commentaire de l’étape. |
|
|
Méthode contact
|
interaction_type | string |
Méthode de contact d’interaction pour l’étape. |
|
|
Catégorie
|
interaction_category | string |
Catégorie d’interaction étape. |
|
|
Sous-catégorie
|
interaction_subcategory | string |
Sous-catégorie d’interaction de l’étape. |
|
|
Événement d’une journée entière ?
|
is_all_day_event | boolean |
L’interaction est-elle un événement d’une journée entière ? |
|
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
|
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
|
|
Fuseau horaire
|
time_zone_entry | string |
Fuseau horaire de l’étape. |
|
|
Date réelle
|
actual_date | date |
Date réelle de l’étape (par exemple : « 2005-09-18 »). |
|
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
|
|
heure
|
hour | integer |
L’heure. |
|
|
minute
|
minute | integer |
La minute. |
|
|
Autre emplacement
|
other_location | string |
Autre emplacement de l’interaction de l’étape. Limite de caractères : 300. |
Obtenir un plan de don majeur
Retourne des informations pour un plan de don majeur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID plan
|
plan_id | True | string |
ID d’enregistrement système du plan d’octroi principal. |
Retours
Plan de don majeur
- Corps
- Prsmg.MajorGivingPlan
Obtenir un résumé des prospects
Retourne des informations de prospect pour un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
Retours
Résumé des prospects
- Corps
- Prsmg.ProspectSummary
Obtenir une opportunité
Retourne des informations pour une opportunité de plan de prospect.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’opportunité
|
opportunity_id | True | string |
ID d’enregistrement système de l’opportunité de mise à jour. |
Retours
Opportunité
Rechercher des opportunités de prospect
Recherche des enregistrements d’opportunités de prospects à l’aide des critères de filtre donnés.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de clé
|
keyname | string |
Nom de la clé constituante (nom des personnes, nom de l’organisation pour les organisations). |
|
|
Prénom
|
firstname | string |
Prénom de la constituante. |
|
|
ID de recherche
|
lookup_id | string |
ID de recherche constituant. |
|
|
Match exactement ?
|
exactmatchonly | boolean |
Correspond à tous les critères exactement ? |
|
|
Statut
|
status | string |
Filtrez les résultats sur l’état d’opportunité spécifié. |
|
|
Demander la date
|
ask_date | date |
Filtrez les résultats en fonction de la date de demande d’opportunité. |
|
|
Demander le montant
|
ask_amount | double |
Filtrez les résultats en fonction du montant de la demande d’opportunité. |
|
|
ID d’utilisateur de désignation
|
designationuserid | string |
Filtrer les résultats sur l’ID d’enregistrement système utilisateur de désignation spécifié |
|
|
Seules les perspectives ?
|
only_prospects | boolean |
Inclure uniquement les constituants des prospects ? |
|
|
Seulement des collectes de fonds ?
|
only_fundraisers | boolean |
Inclure uniquement les constituants de collecte de fonds ? |
|
|
Seul le personnel ?
|
only_staff | boolean |
Inclure uniquement les constituants du personnel ? |
|
|
Seuls les bénévoles ?
|
only_volunteers | boolean |
Inclure uniquement des bénévoles ? |
|
|
Seul le principal ?
|
only_primary_address | boolean |
Recherchez uniquement les adresses primaires ? |
|
|
Inclure décédé ?
|
includedeceased | boolean |
Inclure les constituants décédés ? |
|
|
Inclure inactif ?
|
includeinactive | boolean |
Inclure des constituants inactifs ? |
|
|
Vérifier le surnom ?
|
checknickname | boolean |
Vérifiez le surnom lors de la recherche ? |
|
|
Vérifiez les alias ?
|
checkaliases | boolean |
Vérifiez les alias lors de la recherche ? |
|
|
Vérifiez les ID de recherche de remplacement ?
|
checkalternatelookupids | boolean |
Vérifiez les ID de recherche alternatifs lors de la recherche ? |
|
|
Limit
|
limit | integer |
Représente le nombre d’enregistrements à retourner. |
Retours
Résultats de la recherche
Rechercher des prospects
Recherche des enregistrements prospects à l’aide des critères de filtre donnés.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de clé
|
key_name | string |
Nom de la clé constituante (nom des personnes, nom de l’organisation pour les organisations). |
|
|
Prénom
|
first_name | string |
Prénom de la constituante. |
|
|
ID de recherche
|
lookup_id | string |
ID de recherche constituant. |
|
|
Numéro de téléphone
|
phone_number | string |
Numéro de téléphone constituant. |
|
|
Pays
|
country | string |
Filtre pour le pays d’adresse constituant. |
|
|
Adresse
|
address_block | string |
Filtre pour le bloc d’adresses constituant. |
|
|
Ville
|
city | string |
Filtre pour la ville d’adresse constituante. |
|
|
État
|
state | string |
Filtre pour l’état d’adresse constituant. |
|
|
Code postal
|
post_code | string |
Filtre pour le code postal de l’adresse constituante. |
|
|
Match exactement ?
|
exact_match_only | boolean |
Correspond à tous les critères exactement ? |
|
|
Circonscription
|
constituency | string |
Filtre pour la circonscription de la constituante. |
|
|
Seules les perspectives ?
|
only_prospects | boolean |
Inclure uniquement les constituants des prospects ? |
|
|
Seulement des collectes de fonds ?
|
only_fundraisers | boolean |
Inclure uniquement les constituants de collecte de fonds ? |
|
|
Seul le personnel ?
|
only_staff | boolean |
Inclure uniquement les constituants du personnel ? |
|
|
Seuls les bénévoles ?
|
only_volunteers | boolean |
Inclure uniquement des bénévoles ? |
|
|
Seul le principal ?
|
only_primary_address | boolean |
Recherchez uniquement les adresses primaires ? |
|
|
Inclure décédé ?
|
include_deceased | boolean |
Inclure les constituants décédés ? |
|
|
Inclure inactif ?
|
include_inactive | boolean |
Inclure des constituants inactifs ? |
|
|
Utilisez la recherche approximative ?
|
fuzzy_search_on_name | boolean |
Utilisez la recherche approximative sur le nom ? |
|
|
Limit
|
limit | integer |
Représente le nombre d’enregistrements à retourner. |
Retours
Résultats de la recherche
Répertorier les opportunités de plan
Répertorie les opportunités d’un plan de prospect.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID plan
|
plan_id | True | string |
ID d’enregistrement système du plan de prospect. |
|
Statut
|
status | string |
Filtrez les résultats en opportunités avec l’état spécifié. |
Retours
Possibilités
Répertorier les plans de prospect
Répertorie les plans d’une perspective.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante de prospect. |
|
Inclure inactif ?
|
include_inactive_plans | boolean |
Inclure des plans inactifs ? |
Retours
Plans de prospect
Supprimer un plan de don majeur
Supprime un plan de don majeur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID plan
|
plan_id | True | string |
ID d’enregistrement système du plan d’attribution principal à supprimer. |
Supprimer un plan de gestion
Supprime un plan de gestion.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID plan
|
plan_id | True | string |
ID d’enregistrement système du plan de gestion à supprimer. |
Supprimer une opportunité
Supprime une opportunité de plan de prospect.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’opportunité
|
opportunity_id | True | string |
ID d’enregistrement système de l’opportunité de suppression. |
Supprimer une étape de plan de gestion
Supprime une étape de plan de gestion.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’étape
|
step_id | True | string |
ID d’enregistrement système de l’étape de plan de gestion à supprimer. |
Supprimer une étape majeure du plan d’octroi
Supprime une étape majeure du plan d’octroi.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’étape
|
step_id | True | string |
ID d’enregistrement système de l’étape de plan d’attribution principale à supprimer. |
Définitions
Prsmg.CreatedMajorGivingPlan
Création d’un plan de don majeur
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID du plan de don majeur nouvellement créé. |
Prsmg.CreatedMajorGivingPlanStep
Création d’une étape de plan d’octroi majeur
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de l’étape de plan d’octroi principal nouvellement créée. |
Prsmg.CreatedProspectConstituency
Création d’une circonscription de prospect
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de la circonscription de prospect nouvellement créée. |
Prsmg.CreatedProspectOpportunity
Opportunité de prospect créée
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de l’opportunité de prospect nouvellement créée. |
Prsmg.CreatedStewardshipPlan
Plan de gestion créé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID du plan de gestion nouvellement créé. |
Prsmg.CreatedStewardshipPlanStep
Étape du plan de gestion créé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de l’étape de plan de gestion nouvellement créée. |
Prsmg.CreatedUnplannedContactReport
Création d’un rapport de contact non planifié
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID du rapport de contact non planifié nouvellement créé. |
Prsmg.MajorGivingPlan
Plan de don majeur
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Prospect ID
|
prospect_id | string |
ID d’enregistrement système de la prospect. |
|
Nom de prospect
|
prospect | string |
Nom de prospect. |
|
Nom
|
prospect_plan_name | string |
Nom principal du plan d’attribution. |
|
Type
|
prospect_plan_type | string |
Type de plan de prospect. |
|
Date de début de l’exercice fiscal
|
fiscal_year_start_date | date-time |
Date de début de l’exercice. |
|
Date de fin de l’exercice fiscal
|
fiscal_year_end_date | date-time |
Date de fin de l’exercice. |
|
Étapes
|
steps | array of Prsmg.MajorGivingPlanStep |
Étapes du plan. |
Prsmg.MajorGivingPlanStep
Étape majeure du plan de don
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de l’étape principale du plan d’octroi. |
|
ID de l’étape plan plan
|
plan_outline_step_id | string |
ID d’enregistrement système de l’étape hiérarchique du plan. |
|
Objective
|
objective | string |
Objectif d’étape. |
|
Type
|
prospect_plan_status | string |
Étape de l’étape de plan. |
|
Statut
|
status | string |
État de l’étape du plan. |
|
Date attendue
|
expected_date | date |
Date attendue de l’étape. |
|
Propriétaire
|
fundraiser_id | string |
ID d’enregistrement système de l’élément de collecte de fonds du propriétaire de l’étape. |
|
Événement d’une journée entière ?
|
all_day_event | boolean |
L’interaction est-elle un événement d’une journée entière ? |
|
heure
|
expected_start_time.hour | integer |
L’heure. |
|
minute
|
expected_start_time.minute | integer |
La minute. |
|
heure
|
expected_end_time.hour | integer |
L’heure. |
|
minute
|
expected_end_time.minute | integer |
La minute. |
|
Fuseau horaire
|
time_zone_entry | string |
Fuseau horaire de l’étape. |
|
Date réelle
|
actual_date | date |
Date réelle de l’étape (par exemple : « 2005-09-18 »). |
|
heure
|
actual_start_time.hour | integer |
L’heure. |
|
minute
|
actual_start_time.minute | integer |
La minute. |
|
heure
|
actual_end_time.hour | integer |
L’heure. |
|
minute
|
actual_end_time.minute | integer |
La minute. |
|
Commentaire
|
comment | string |
Commentaire de l’étape. |
|
Méthode contact
|
interaction_type | string |
Méthode de contact d’interaction pour l’étape. |
|
Catégorie
|
interaction_category | string |
Catégorie d’interaction étape. |
|
Sous-catégorie
|
interaction_subcategory | string |
Sous-catégorie d’interaction de l’étape. |
|
Emplacement
|
location | string |
Emplacement d’interaction de l’étape. |
|
Autre emplacement
|
other_location | string |
Autre emplacement de l’interaction de l’étape. |
|
Collectes de fonds supplémentaires
|
additional_fundraisers | array of Prsmg.MajorGivingPlanStepAdditionalFundraiser |
L’interaction étape des collectes de fonds supplémentaires. |
|
Participants
|
participants | array of Prsmg.MajorGivingPlanStepParticipant |
Participants à l’interaction étape. |
Prsmg.MajorGivingPlanStepAdditionalFundraiser
Étape majeure du plan d’octroi de fonds supplémentaire
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de la collecte de fonds d’étape du plan d’octroi principal. |
|
ID de collecte de fonds
|
fundraiser_id | string |
ID d’enregistrement système de la principale étape de collecte de fonds du plan d’octroi. |
Prsmg.MajorGivingPlanStepParticipant
Participant à l’étape principale du plan de don
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du participant à l’étape du plan d’octroi principal. |
|
Identifiant du participant
|
constituent_id | string |
ID d’enregistrement système du participant à l’étape du plan d’octroi principal. |
Prsmg.PlanOpportunity
Opportunité
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de l’opportunité. |
|
Type
|
opportunity_type | string |
Type d’opportunité. |
|
Statut
|
status | string |
L’état de l’opportunité. |
|
Montant
|
amount | double |
Le montant de l’opportunité. |
|
Date de demande attendue
|
expected_ask_date | date-time |
Date de demande attendue pour l’opportunité. |
|
Demander la date
|
ask_date | date-time |
Date de demande de l’opportunité. |
|
Date de réponse
|
response_date | date-time |
Date de réponse de l’opportunité. |
|
ID monétaire de base
|
base_currency_id | string |
ID d’enregistrement système de la devise de base pour l’opportunité. |
Prsmg.PlanOpportunityCollection
Possibilités
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
count | integer |
Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. Les paramètres de limite et de décalage n’affectent pas le nombre, mais pour faciliter la pagination, ils peuvent affecter le nombre d’éléments dans le jeu de résultats de valeur. |
|
value
|
value | array of Prsmg.PlanOpportunity |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
Prsmg.ProspectOpportunitySearchResult
Résultat de la recherche
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de l’opportunité. |
|
Statut
|
status | string |
L’état de l’opportunité. |
|
Demander le montant
|
ask_amount | double |
L’opportunité demande le montant. |
|
Demander la date
|
ask_date | date-time |
Date de demande de l’opportunité. |
|
Désignation
|
designation | date-time |
La désignation d’opportunité. |
|
ID de devise de transaction
|
transaction_currency_id | string |
ID d’enregistrement système de la devise de transaction pour l’opportunité. |
|
Type de plan
|
prospect_plan_type | string |
Type de plan de prospect. |
|
Nom du plan
|
prospect_plan_name | string |
Nom du plan de prospect. |
|
ID de recherche
|
lookup_id | string |
ID de recherche de la prospect. |
|
Nom de prospect
|
name | string |
Nom de prospect. |
Prsmg.ProspectOpportunitySearchResultCollection
Résultats de la recherche
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
count | integer |
Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. |
|
value
|
value | array of Prsmg.ProspectOpportunitySearchResult |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
Prsmg.ProspectOpportunity
Opportunité
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Header
|
header | string |
En-tête d’opportunité. |
|
Type
|
opportunity_type | string |
Type d’opportunité. |
|
Statut
|
status | string |
L’état de l’opportunité. |
|
Montant attendu de la demande
|
expected_ask_amount | double |
L’opportunité attendue demander le montant de la demande. |
|
Date de demande attendue
|
expected_ask_date | date-time |
Date de demande attendue pour l’opportunité. |
|
Vraisemblance
|
likelihood_type_code | string |
Probabilité d’opportunité. |
|
Demander le montant
|
ask_amount | double |
L’opportunité demande le montant. |
|
Demander la date
|
ask_date | date-time |
Date de demande de l’opportunité. |
|
Montant accepté
|
accepted_amount | double |
L’opportunité a accepté le montant. |
|
Date de réponse
|
response_date | date-time |
Date de réponse de l’opportunité. |
|
ID de devise de transaction
|
transaction_currency | string |
ID d’enregistrement système de la devise de transaction pour l’opportunité. |
|
Commentaire
|
comment | string |
Le commentaire de l’opportunité. |
|
Prospect ID
|
prospect_id | string |
ID d’enregistrement système de la prospect. |
|
Nom du plan de prospect
|
prospect_plan | string |
Nom du plan de prospect. |
|
Désignations
|
designation | array of Prsmg.ProspectOpportunityDesignation |
Les désignations d’opportunité. |
Prsmg.ProspectOpportunityDesignation
Désignation de l’opportunité de prospect
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de la désignation d’opportunité de prospect. |
|
ID de désignation
|
designation_id | string |
ID d’enregistrement système de la désignation. |
|
montant
|
amount | double |
Montant de la désignation. |
|
méthode de financement
|
funding_method | string |
Méthode de financement de la désignation. |
|
catégorie
|
category | string |
Catégorie de désignation. |
|
type
|
type | string |
Type de désignation. |
|
utiliser du code
|
use | string |
Code d’utilisation de la désignation. |
|
constituant
|
constituent | string |
Constituant de la désignation. |
|
constituant
|
constituent_name | string |
Nom de la constituante de la désignation. |
|
ID de devise de transaction
|
transaction_currency_id | string |
ID d’enregistrement système de la devise de transaction de désignation. |
|
Séquence
|
sequence | integer |
Séquence de désignation. |
Prsmg.ProspectPlan
Plan de prospect
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du plan de prospect. |
|
Nom
|
plan_name | string |
Nom du plan de prospect. |
|
Type
|
plan_type | string |
Type de plan de prospect. |
|
La gestion est-elle ?
|
stewardship_plan | boolean |
Est-ce qu’un plan d’administration ? |
|
Actif?
|
active | boolean |
Le plan est-il actif ? |
|
Date de début
|
start_date | date-time |
Date de début du plan. |
|
ID d’interaction suivant
|
next_interaction_id | string |
ID d’enregistrement système de l’interaction suivante. |
|
Date d’ajout
|
date_added | date |
Date à laquelle le plan a été ajouté. |
Prsmg.ProspectPlanCollection
Plans de prospect
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
count | integer |
Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. Les paramètres de limite et de décalage n’affectent pas le nombre, mais pour faciliter la pagination, ils peuvent affecter le nombre d’éléments dans le jeu de résultats de valeur. |
|
value
|
value | array of Prsmg.ProspectPlan |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
Prsmg.ProspectSearchResult
Résultat de la recherche
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de la constituante. |
|
Nom
|
name | string |
Nom de la constituante. Pour les individus, ce champ calculé indique le nom complet de la constituante en fonction des paramètres de nom complet de l’organisation cible. |
|
Responsable des prospects
|
prospect_manager | string |
Responsable des prospects de la constituante. |
|
Gestionnaire(s) principal(s)
|
primary_managers | string |
Gestionnaire(s) de plan principal(s). |
|
ID de recherche
|
lookup_id | string |
Identificateur défini par l’utilisateur pour la constituante. |
|
Nom du tri
|
sort_constituent_name | string |
Nom de tri constituant. |
|
Type constituant
|
constituent_type | string |
Type constituant. |
|
Adresse
|
address | string |
Adresse par défaut de la constituante. |
|
Ville
|
city | string |
La ville d’adresse préférée de la constituante. |
|
État
|
state | string |
État d’adresse préféré de la constituante. |
|
Cp
|
post_code | string |
Code postal d’adresse préféré de la constituante. |
|
Téléphone
|
phone | string |
Le téléphone de la constituante. |
Prsmg.ProspectSearchResultCollection
Résultats de la recherche
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
count | integer |
Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. |
|
value
|
value | array of Prsmg.ProspectSearchResult |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
Prsmg.ProspectSummary
Résumé des prospects
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Est-ce que la perspective ?
|
prospect | boolean |
Est-ce que la constituante est une perspective ? |
|
Est-ce qu’un indicateur est marqué ?
|
flagged | boolean |
La perspective est-elle marquée ? |
|
Statut
|
prospect_status | string |
État des prospects. |
|
Nom du gestionnaire
|
prospect_manager_name | string |
Nom du responsable des prospects. |
|
ID du gestionnaire
|
prospect_manager_fundraiser_id | string |
ID d’enregistrement système du composant du gestionnaire de prospects. |
|
Date de début
|
prospect_manager_start_date | date-time |
Date de début du responsable des prospects. |