Share via

Blackbaud CRM Prospect (Preview)

Blackbaud CRM is a comprehensive enterprise-grade fundraising and donor management software solution built specifically for nonprofits and the entire social good community. Use the Prospect connector to manage prospects, plans, and opportunities.

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Blackbaud Support
URL https://www.blackbaud.com/support
Email [email protected]
Connector Metadata
Publisher Blackbaud, Inc.
Website https://www.blackbaud.com/products/blackbaud-crm
Privacy policy https://www.blackbaud.com/privacy-shield
Categories Sales and CRM;Productivity

Blackbaud CRM is the world's most powerful fundraising management system purpose-built for enterprise-scale nonprofit and higher education fundraising teams.

This connector is built on top of Blackbaud's SKY API and provides operations to help manage prospects and related entities found within Blackbaud CRM.

For more information, please view the documentation.

Prerequisites

To use this connector, you must have a Blackbaud ID account with access to one or more Blackbaud environments.

In addition, your organization's administrator must also perform an admin-level action within the system to enable this connector to access your Blackbaud environment. More information about these prerequisites can be found in the initial setup documentation.

How to get credentials?

Your organization's administrator will send you an invitation to the organization's Blackbaud CRM environment and configure your user account permissions within the environment. No additional credentials are required to use this connector.

Known issues and limitations

The connector will operate in the context of your user account, and will therefore be subject to your user permissions within the environment.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create a major giving plan

Creates a new major giving plan for a prospect.
Create a major giving plan step

Creates a new major giving plan step.
Create a prospect constituency

Creates a new prospect constituency for a constituent.
Create a stewardship plan

Creates a new stewardship plan for a prospect.
Create a stewardship plan step

Creates a new stewardship plan step.
Create an opportunity

Creates a new prospect plan opportunity.
Create an unplanned contact report

Creates a new unplanned contact report for a plan.
Delete a major giving plan

Deletes a major giving plan.
Delete a major giving plan step

Deletes a major giving plan step.
Delete a stewardship plan

Deletes a stewardship plan.
Delete a stewardship plan step

Deletes a stewardship plan step.
Delete an opportunity

Deletes a prospect plan opportunity.
Get a major giving plan

Returns information for a major giving plan.
Get a prospect summary

Returns prospect information for a constituent.
Get an opportunity

Returns information for a prospect plan opportunity.
List plan opportunities

Lists the opportunities for a prospect plan.
List prospect plans

Lists the plans for a prospect.
Search for prospect opportunities

Searches for prospect opportunity records using the given filter criteria.
Search for prospects

Searches for prospect records using the given filter criteria.
Update a contact report

Updates a contact report.
Update a major giving plan step

Updates a major giving plan step.
Update a prospect

Updates a prospect.
Update a stewardship plan step

Updates a stewardship plan step.
Update an opportunity

Updates a prospect plan opportunity.

Create a major giving plan

Operation ID:
CreateMajorGivingPlan

Creates a new major giving plan for a prospect.

Parameters

Name Key Required Type Description
Prospect ID
 prospect_id True string

The system record ID of the prospect constituent.
Name
 prospect_plan_name True string

The plan name. Character limit: 100.
Type
 prospect_plan_type True string

The plan type.
Start date
 start_date date

The plan start date (ex: '2005-09-18').
Narrative
 narrative string

The plan narrative. Character limit: 1000.
Primary manager ID
 primary_manager_fundraiser_id string

The system record ID of the primary prospect manager fundraiser.
Primary start date
 primary_manager_date_from date

The primary manager start date (ex: '2005-09-18').
Secondary manager ID
 secondary_manager_fundraiser_id string

The system record ID of the secondary prospect manager fundraiser.
Secondary start date
 secondary_manager_date_from date

The secondary manager start date (ex: '2005-09-18').
ID
 constituent_id True string

The system record ID of the constituent participant.
role
 plan_participant_role string

The participant role.
ID
 fundraiser_id True string

The system record ID of the secondary fundraiser constituent.
role
 solicitor_role string

The fundraiser role.
start
 date_from date

The secondary fundraiser start date (ex: '2005-09-18').

Returns

Created major giving plan

Body
Prsmg.CreatedMajorGivingPlan

Create a major giving plan step

Operation ID:
CreateMajorGivingPlanStep

Creates a new major giving plan step.

Parameters

Name Key Required Type Description
Plan ID
 prospect_plan_id True string

The system record ID of the major giving plan.
Objective
 objective True string

The step objective. Character limit: 100.
Type
 prospect_plan_status True string

The stage for the plan step.
Status
 status True string

The status of the plan step.
Expected date
 expected_date True date

The step expected date (ex: '2005-09-18').
Owner
 owner_id string

The system record ID of the step owner fundraiser constituent.
Comment
 comment string

The step comment.
Contact method
 interaction_type string

The interaction contact method for the step.
Category
 interaction_category string

The step interaction category.
Subcategory
 interaction_subcategory string

The step interaction subcategory.
All-day event?
 is_all_day_event boolean

Is the interaction an all-day event?
hour
 hour integer

The hour.
minute
 minute integer

The minute.
hour
 hour integer

The hour.
minute
 minute integer

The minute.
Time zone
 time_zone_entry string

The time zone for the step.
Actual date
 actual_date date

The step actual date (ex: '2005-09-18').
hour
 hour integer

The hour.
minute
 minute integer

The minute.
hour
 hour integer

The hour.
minute
 minute integer

The minute.
Location
 location string

The step location.
Other location
 other_location string

The other location for the step interaction. Character limit: 300.
ID
 fundraiser_id True string

The system record ID of the fundraiser constituent.
ID
 constituent_id True string

The system record ID of the participant constituent.

Returns

Created major giving plan step

Body
Prsmg.CreatedMajorGivingPlanStep

Create a prospect constituency

Operation ID:
CreateProspectConstituency

Creates a new prospect constituency for a constituent.

Parameters

Name Key Required Type Description
Constituent ID
 constituent_id True string

The system record ID of the constituent.
Date from
 date_from date

The starting date for the constituency (ex: '2005-09-18').
Date to
 date_to date

The ending date for the constituency (ex: '2005-09-18').

Returns

Created prospect constituency

Body
Prsmg.CreatedProspectConstituency

Create a stewardship plan

Operation ID:
CreateStewardshipPlan

Creates a new stewardship plan for a prospect.

Parameters

Name Key Required Type Description
Prospect ID
 constituent_id True string

The system record ID of the prospect constituent.
Name
 name True string

The plan name. Character limit: 100.
Type
 plan_type_id string

The plan type.
Subtype
 plan_sub_type_id string

The plan subtype.
Start date
 start_date date

The plan start date (ex: '2005-09-18').
Manager ID
 manager_id string

The system record ID of the prospect manager fundraiser.
Manager start date
 manager_start_date date

The manager start date (ex: '2005-09-18').
ID
 constituent_id True string

The system record ID of the steward constituent.
role
 role string

The steward role.
start date
 start_date date

The steward start date (ex: '2005-09-18').

Returns

Created stewardship plan

Body
Prsmg.CreatedStewardshipPlan

Create a stewardship plan step

Operation ID:
CreateStewardshipPlanStep

Creates a new stewardship plan step.

Parameters

Name Key Required Type Description
Plan ID
 stewardship_plan_id True string

The system record ID of the stewardship plan.
Objective
 objective True string

The step objective. Character limit: 100.
Target date
 target_date True date

The step target date (ex: '2005-09-18').
Locked?
 date_locked boolean

Is the target date locked?
All-day event?
 all_day_event boolean

Is the interaction an all-day event?
hour
 hour integer

The hour.
minute
 minute integer

The minute.
hour
 hour integer

The hour.
minute
 minute integer

The minute.
Time zone
 time_zone_entry string

The time zone for the step.
Status
 status_code string

The status of the plan step.
Category
 category string

The plan step category.
Assigned to
 constituent_id string

The system record ID of the step owner fundraiser constituent.
Contact method
 contact_method string

The interaction contact method for the step.
Frequency
 recurs True string

The step frequency.
Start date
 start_date date

The step actual date (ex: '2005-09-18').
End date
 end_date date

The step actual date (ex: '2005-09-18').
Next target date
 next_target_date date

The step next target date (ex: '2005-09-18').
Connect to
 link_type_code string

The type of record connected to the step.
Benefit ID
 benefit_id string

The system record ID of the connected benefit.
Event ID
 event_id string

The system record ID of the connected event.
Mailing ID
 mailing_id string

The system record ID of the connected mailing.
Actual date
 actual_date date

The step actual date (ex: '2005-09-18').
hour
 hour integer

The hour.
minute
 minute integer

The minute.
hour
 hour integer

The hour.
minute
 minute integer

The minute.
ID
 constituent_id True string

The system record ID of the participant constituent.
plan ID
 prospect_plan_id True string

The system record ID of the associated plan.

Returns

Created stewardship plan step

Body
Prsmg.CreatedStewardshipPlanStep

Create an opportunity

Operation ID:
CreateProspectOpportunity

Creates a new prospect plan opportunity.

Parameters

Name Key Required Type Description
Plan ID
 prospect_plan_id True string

The system record ID of the prospect plan.
Status
 status True string

The status of the opportunity.
Type
 opportunity_type string

The opportunity type.
Expected ask amount
 expected_ask_amount double

The expected ask amount.
Expected ask date
 expected_ask_date date

The expected ask date (ex: '2005-09-18').
Likelihood
 likelihood_type_code string

The opportunity likelihood.
Ask amount
 ask_amount double

The ask amount.
Ask date
 ask_date date

The ask date (ex: '2005-09-18').
Accepted amount
 accepted_amount double

The accepted ask amount.
Response date
 response_date date

The response date (ex: '2005-09-18').
Comment
 comment string

The opportunity comment.
Transaction currency
 transaction_currency string

The transaction currency.

Returns

Created prospect opportunity

Body
Prsmg.CreatedProspectOpportunity

Create an unplanned contact report

Operation ID:
CreateUnplannedContactReport

Creates a new unplanned contact report for a plan.

Parameters

Name Key Required Type Description
Plan ID
 prospect_plan_id True string

The system record ID of the major giving plan.
Objective
 objective True string

The step objective. Character limit: 100.
Owner
 owner_id string

The system record ID of the contact report owner fundraiser constituent.
Actual date
 actual_date True date

The step actual date (ex: '2005-09-18').
hour
 hour integer

The hour.
minute
 minute integer

The minute.
hour
 hour integer

The hour.
minute
 minute integer

The minute.
Stage
 prospect_plan_status True string

The stage for the plan step.
Contact method
 interaction_type True string

The interaction contact method for the step.
Category
 interaction_category string

The step interaction category.
Subcategory
 interaction_subcategory string

The step interaction subcategory.
Comment
 comment True string

The step comment.
ID
 fundraiser_id True string

The system record ID of the fundraiser constituent.
ID
 constituent_id True string

The system record ID of the participant constituent.

Returns

Created unplanned contact report

Body
Prsmg.CreatedUnplannedContactReport

Delete a major giving plan

Operation ID:
DeleteMajorGivingPlan

Deletes a major giving plan.

Parameters

Name Key Required Type Description
Plan ID
 plan_id True string

The system record ID of the major giving plan to delete.

Delete a major giving plan step

Operation ID:
DeleteMajorGivingPlanStep

Deletes a major giving plan step.

Parameters

Name Key Required Type Description
Step ID
 step_id True string

The system record ID of the major giving plan step to delete.

Delete a stewardship plan

Operation ID:
DeleteStewardshipPlan

Deletes a stewardship plan.

Parameters

Name Key Required Type Description
Plan ID
 plan_id True string

The system record ID of the stewardship plan to delete.

Delete a stewardship plan step

Operation ID:
DeleteStewardshipPlanStep

Deletes a stewardship plan step.

Parameters

Name Key Required Type Description
Step ID
 step_id True string

The system record ID of the stewardship plan step to delete.

Delete an opportunity

Operation ID:
DeleteProspectOpportunity

Deletes a prospect plan opportunity.

Parameters

Name Key Required Type Description
Opportunity ID
 opportunity_id True string

The system record ID of the opportunity to delete.

Get a major giving plan

Operation ID:
GetMajorGivingPlan

Returns information for a major giving plan.

Parameters

Name Key Required Type Description
Plan ID
 plan_id True string

The system record ID of the major giving plan.

Returns

Major giving plan

Body
Prsmg.MajorGivingPlan

Get a prospect summary

Operation ID:
GetProspectSummary

Returns prospect information for a constituent.

Parameters

Name Key Required Type Description
Constituent ID
 constituent_id True string

The system record ID of the constituent.

Returns

Prospect summary

Body
Prsmg.ProspectSummary

Get an opportunity

Operation ID:
GetProspectOpportunity

Returns information for a prospect plan opportunity.

Parameters

Name Key Required Type Description
Opportunity ID
 opportunity_id True string

The system record ID of the opportunity to update.

Returns

Opportunity

Body
Prsmg.ProspectOpportunity

List plan opportunities

Operation ID:
ListPlanOpportunities

Lists the opportunities for a prospect plan.

Parameters

Name Key Required Type Description
Plan ID
 plan_id True string

The system record ID of the prospect plan.
Status
 status string

Filter the results to opportunities with the specified status.

Returns

Opportunities

Body
Prsmg.PlanOpportunityCollection

List prospect plans

Operation ID:
ListProspectPlans

Lists the plans for a prospect.

Parameters

Name Key Required Type Description
Constituent ID
 constituent_id True string

The system record ID of the prospect constituent.
Include inactive?
 include_inactive_plans boolean

Include inactive plans?

Returns

Prospect plans

Body
Prsmg.ProspectPlanCollection

Search for prospect opportunities

Operation ID:
SearchProspectOpportunities

Searches for prospect opportunity records using the given filter criteria.

Parameters

Name Key Required Type Description
Key name
 keyname string

The constituent key name (last name for individuals, organization name for organizations).
First name
 firstname string

The constituent first name.
Lookup ID
 lookup_id string

The constituent lookup ID.
Match exactly?
 exactmatchonly boolean

Match all criteria exactly?
Status
 status string

Filter the results to the specified opportunity status.
Ask date
 ask_date date

Filter the results based on the opportunity ask date.
Ask amount
 ask_amount double

Filter the results based on the opportunity ask amount.
Designation user ID
 designationuserid string

Filter the results to the specified designation user system record ID
Only prospects?
 only_prospects boolean

Include only prospect constituents?
Only fundraisers?
 only_fundraisers boolean

Include only fundraiser constituents?
Only staff?
 only_staff boolean

Include only staff constituents?
Only volunteers?
 only_volunteers boolean

Include only volunteers?
Only primary?
 only_primary_address boolean

Only search primary addresses?
Include deceased?
 includedeceased boolean

Include deceased constituents?
Include inactive?
 includeinactive boolean

Include inactive constituents?
Check nickname?
 checknickname boolean

Check nickname when searching?
Check aliases?
 checkaliases boolean

Check aliases when searching?
Check alt lookup IDs?
 checkalternatelookupids boolean

Check alternate lookup IDs when searching?
Limit
 limit integer

Represents the number of records to return.

Returns

Search results

Body
Prsmg.ProspectOpportunitySearchResultCollection

Search for prospects

Operation ID:
SearchProspects

Searches for prospect records using the given filter criteria.

Parameters

Name Key Required Type Description
Key name
 key_name string

The constituent key name (last name for individuals, organization name for organizations).
First name
 first_name string

The constituent first name.
Lookup ID
 lookup_id string

The constituent lookup ID.
Phone number
 phone_number string

The constituent phone number.
Country
 country string

A filter for the constituent address country.
Address
 address_block string

A filter for the constituent address block.
City
 city string

A filter for the constituent address city.
State
 state string

A filter for the constituent address state.
Postal code
 post_code string

A filter for the constituent address postal code.
Match exactly?
 exact_match_only boolean

Match all criteria exactly?
Constituency
 constituency string

A filter for the constituency of the constituent.
Only prospects?
 only_prospects boolean

Include only prospect constituents?
Only fundraisers?
 only_fundraisers boolean

Include only fundraiser constituents?
Only staff?
 only_staff boolean

Include only staff constituents?
Only volunteers?
 only_volunteers boolean

Include only volunteers?
Only primary?
 only_primary_address boolean

Only search primary addresses?
Include deceased?
 include_deceased boolean

Include deceased constituents?
Include inactive?
 include_inactive boolean

Include inactive constituents?
Use fuzzy search?
 fuzzy_search_on_name boolean

Use fuzzy search on name?
Limit
 limit integer

Represents the number of records to return.

Returns

Search results

Body
Prsmg.ProspectSearchResultCollection

Update a contact report

Operation ID:
EditProspectContactReport

Updates a contact report.

Parameters

Name Key Required Type Description
Report ID
 contact_report_id True string

The system record ID of the contact report to update.
Objective
 objective string

The step objective. Character limit: 100.
Owner
 owner_id string

The system record ID of the contact report owner fundraiser constituent.
Actual date
 actual_date date

The step actual date (ex: '2005-09-18').
hour
 hour integer

The hour.
minute
 minute integer

The minute.
hour
 hour integer

The hour.
minute
 minute integer

The minute.
Stage
 prospect_plan_status string

The stage for the plan step.
Contact method
 interaction_type string

The interaction contact method for the step.
Category
 interaction_category string

The step interaction category.
Subcategory
 interaction_subcategory string

The step interaction subcategory.
Comment
 comment string

The step comment.

Update a major giving plan step

Operation ID:
EditMajorGivingPlanStep

Updates a major giving plan step.

Parameters

Name Key Required Type Description
Plan ID
 v_prospect_plan_id True string

The system record ID of the major giving plan.
Step ID
 step_id True string

The system record ID of the major giving plan step to update.
Objective
 objective string

The step objective. Character limit: 100.
Type
 prospect_plan_status string

The stage for the plan step.
Status
 status string

The status of the plan step.
Expected date
 expected_date date

The step expected date (ex: '2005-09-18').
Owner
 owner_id string

The system record ID of the step owner fundraiser constituent.
Comment
 comment string

The step comment.
Contact method
 interaction_type string

The interaction contact method for the step.
Category
 interaction_category string

The step interaction category.
Subcategory
 interaction_subcategory string

The step interaction subcategory.
All-day event?
 is_all_day_event boolean

Is the interaction an all-day event?
hour
 hour integer

The hour.
minute
 minute integer

The minute.
hour
 hour integer

The hour.
minute
 minute integer

The minute.
Time zone
 time_zone_entry string

The time zone for the step.
Actual date
 actual_date date

The step actual date (ex: '2005-09-18').
hour
 hour integer

The hour.
minute
 minute integer

The minute.
hour
 hour integer

The hour.
minute
 minute integer

The minute.
Other location
 other_location string

The other location for the step interaction. Character limit: 300.

Update a prospect

Operation ID:
EditProspect

Updates a prospect.

Parameters

Name Key Required Type Description
Constituent ID
 constituent_id True string

The system record ID of the prospect constituent to update.
Manager ID
 prospect_manager_fundraiser_id string

The system record ID of the prospect manager constituent.
Status
 prospect_status string

The prospect status.

Update a stewardship plan step

Operation ID:
EditStewardshipPlanStep

Updates a stewardship plan step.

Parameters

Name Key Required Type Description
Step ID
 step_id True string

The system record ID of the stewardship plan step to update.
Objective
 objective string

The step objective. Character limit: 100.
Target date
 target_date date

The step target date (ex: '2005-09-18').
Locked?
 date_locked boolean

Is the target date locked?
All-day event?
 all_day_event boolean

Is the interaction an all-day event?
hour
 hour integer

The hour.
minute
 minute integer

The minute.
hour
 hour integer

The hour.
minute
 minute integer

The minute.
Time zone
 time_zone_entry string

The time zone for the step.
Status
 status string

The status of the plan step.
Category
 category string

The plan step category.
Assigned to
 constituent_id string

The system record ID of the step owner fundraiser constituent.
Contact method
 contact_method string

The interaction contact method for the step.
Frequency
 recurs string

The step frequency.
Start date
 start_date date

The step actual date (ex: '2005-09-18').
End date
 end_date date

The step actual date (ex: '2005-09-18').
Next target date
 next_target_date date

The step next target date (ex: '2005-09-18').
Connect to
 link_type string

The type of record connected to the step.
Benefit ID
 benefit_id string

The system record ID of the connected benefit.
Event ID
 event_id string

The system record ID of the connected event.
Mailing ID
 mailing_id string

The system record ID of the connected mailing.
Actual date
 actual_date date

The step actual date (ex: '2005-09-18').
hour
 hour integer

The hour.
minute
 minute integer

The minute.
hour
 hour integer

The hour.
minute
 minute integer

The minute.

Update an opportunity

Operation ID:
EditProspectOpportunity

Updates a prospect plan opportunity.

Parameters

Name Key Required Type Description
Opportunity ID
 opportunity_id True string

The system record ID of the opportunity to update.
Status
 status string

The status of the opportunity.
Type
 opportunity_type string

The opportunity type.
Expected ask amount
 expected_ask_amount double

The expected ask amount.
Expected ask date
 expected_ask_date date

The expected ask date (ex: '2005-09-18').
Likelihood
 likelihood_type_code string

The opportunity likelihood.
Ask amount
 ask_amount double

The ask amount.
Ask date
 ask_date date

The ask date (ex: '2005-09-18').
Accepted amount
 accepted_amount double

The accepted ask amount.
Response date
 response_date date

The response date (ex: '2005-09-18').
Comment
 comment string

The opportunity comment.
Transaction currency
 transaction_currency string

The transaction currency.

Definitions

Prsmg.CreatedMajorGivingPlan

Created major giving plan

Name Path Type Description
ID
 id string

The ID of the newly created major giving plan.

Prsmg.CreatedMajorGivingPlanStep

Created major giving plan step

Name Path Type Description
ID
 id string

The ID of the newly created major giving plan step.

Prsmg.CreatedProspectConstituency

Created prospect constituency

Name Path Type Description
ID
 id string

The ID of the newly created prospect constituency.

Prsmg.CreatedProspectOpportunity

Created prospect opportunity

Name Path Type Description
ID
 id string

The ID of the newly created prospect opportunity.

Prsmg.CreatedStewardshipPlan

Created stewardship plan

Name Path Type Description
ID
 id string

The ID of the newly created stewardship plan.

Prsmg.CreatedStewardshipPlanStep

Created stewardship plan step

Name Path Type Description
ID
 id string

The ID of the newly created stewardship plan step.

Prsmg.CreatedUnplannedContactReport

Created unplanned contact report

Name Path Type Description
ID
 id string

The ID of the newly created unplanned contact report.

Prsmg.MajorGivingPlan

Major giving plan

Name Path Type Description
Prospect ID
 prospect_id string

The system record ID of the prospect.
Prospect name
 prospect string

The prospect name.
Name
 prospect_plan_name string

The major giving plan name.
Type
 prospect_plan_type string

The prospect plan type.
Fiscal year start date
 fiscal_year_start_date date-time

The fiscal year start date.
Fiscal year end date
 fiscal_year_end_date date-time

The fiscal year end date.
Steps
 steps array of Prsmg.MajorGivingPlanStep

The plan steps.

Prsmg.MajorGivingPlanStep

Major giving plan step

Name Path Type Description
ID
 id string

The system record ID of the major giving plan step.
Plan outline step ID
 plan_outline_step_id string

The system record ID of the plan outline step.
Objective
 objective string

The step objective.
Type
 prospect_plan_status string

The stage for the plan step.
Status
 status string

The status of the plan step.
Expected date
 expected_date date

The step expected date.
Owner
 fundraiser_id string

The system record ID of the step owner fundraiser constituent.
All-day event?
 all_day_event boolean

Is the interaction an all-day event?
hour
 expected_start_time.hour integer

The hour.
minute
 expected_start_time.minute integer

The minute.
hour
 expected_end_time.hour integer

The hour.
minute
 expected_end_time.minute integer

The minute.
Time zone
 time_zone_entry string

The time zone for the step.
Actual date
 actual_date date

The step actual date (ex: '2005-09-18').
hour
 actual_start_time.hour integer

The hour.
minute
 actual_start_time.minute integer

The minute.
hour
 actual_end_time.hour integer

The hour.
minute
 actual_end_time.minute integer

The minute.
Comment
 comment string

The step comment.
Contact method
 interaction_type string

The interaction contact method for the step.
Category
 interaction_category string

The step interaction category.
Subcategory
 interaction_subcategory string

The step interaction subcategory.
Location
 location string

The step interaction location.
Other location
 other_location string

The other location for the step interaction.
Additional fundraisers
 additional_fundraisers array of Prsmg.MajorGivingPlanStepAdditionalFundraiser

The step interaction additional fundraisers.
Participants
 participants array of Prsmg.MajorGivingPlanStepParticipant

The step interaction participants.

Prsmg.MajorGivingPlanStepAdditionalFundraiser

Major giving plan step additional fundraiser

Name Path Type Description
ID
 id string

The system record ID of the major giving plan step fundraiser.
Fundraiser ID
 fundraiser_id string

The system record ID of the major giving plan step fundraiser constituent.

Prsmg.MajorGivingPlanStepParticipant

Major giving plan step participant

Name Path Type Description
ID
 id string

The system record ID of the major giving plan step participant.
Participant ID
 constituent_id string

The system record ID of the major giving plan step participant constituent.

Prsmg.PlanOpportunity

Opportunity

Name Path Type Description
ID
 id string

The system record ID of the opportunity.
Type
 opportunity_type string

The opportunity type.
Status
 status string

The opportunity status.
Amount
 amount double

The opportunity amount.
Expected ask date
 expected_ask_date date-time

The expected ask date for the opportunity.
Ask date
 ask_date date-time

The ask date for the opportunity.
Response date
 response_date date-time

The response date for the opportunity.
Base currency ID
 base_currency_id string

The system record ID of the base currency for the opportunity.

Prsmg.PlanOpportunityCollection

Opportunities

Name Path Type Description
Count
 count integer

The number of items available for retrieval into the collection after applying any request parameters. The limit and offset parameters do not affect the count, but to facilitate paging, they may affect the number of items in the value result set.
value
 value array of Prsmg.PlanOpportunity

The set of items included in the response. This may be a subset of the items in the collection.

Prsmg.ProspectOpportunitySearchResult

Search result

Name Path Type Description
ID
 id string

The system record ID of the opportunity.
Status
 status string

The opportunity status.
Ask amount
 ask_amount double

The opportunity ask amount.
Ask date
 ask_date date-time

The ask date for the opportunity.
Designation
 designation date-time

The opportunity designation.
Transaction currency ID
 transaction_currency_id string

The system record ID of the transaction currency for the opportunity.
Plan type
 prospect_plan_type string

The prospect plan type.
Plan name
 prospect_plan_name string

The prospect plan name.
Lookup ID
 lookup_id string

The lookup ID for the prospect.
Prospect name
 name string

The prospect name.

Prsmg.ProspectOpportunitySearchResultCollection

Search results

Name Path Type Description
Count
 count integer

The number of items available for retrieval into the collection after applying any request parameters.
value
 value array of Prsmg.ProspectOpportunitySearchResult

The set of items included in the response. This may be a subset of the items in the collection.

Prsmg.ProspectOpportunity

Opportunity

Name Path Type Description
Header
 header string

The opportunity header.
Type
 opportunity_type string

The opportunity type.
Status
 status string

The opportunity status.
Expected ask amount
 expected_ask_amount double

The opportunity expected ask amount.
Expected ask date
 expected_ask_date date-time

The expected ask date for the opportunity.
Likelihood
 likelihood_type_code string

The opportunity likelihood.
Ask amount
 ask_amount double

The opportunity ask amount.
Ask date
 ask_date date-time

The ask date for the opportunity.
Accepted amount
 accepted_amount double

The opportunity accepted amount.
Response date
 response_date date-time

The response date for the opportunity.
Transaction currency ID
 transaction_currency string

The system record ID of the transaction currency for the opportunity.
Comment
 comment string

The opportunity comment.
Prospect ID
 prospect_id string

The system record ID of the prospect.
Prospect plan name
 prospect_plan string

The prospect plan name.
Designations
 designation array of Prsmg.ProspectOpportunityDesignation

The opportunity designations.

Prsmg.ProspectOpportunityDesignation

Prospect opportunity designation

Name Path Type Description
ID
 id string

The system record ID of the prospect opportunity designation.
designation ID
 designation_id string

The system record ID of the designation.
amount
 amount double

The designation amount.
funding method
 funding_method string

The designation funding method.
category
 category string

The designation category.
type
 type string

The designation type.
use code
 use string

The designation use code.
constituent
 constituent string

The designation constituent.
constituent
 constituent_name string

The designation constituent name.
transaction currency ID
 transaction_currency_id string

The system record ID of the designation transaction currency.
sequence
 sequence integer

The designation sequence.

Prsmg.ProspectPlan

Prospect plan

Name Path Type Description
ID
 id string

The system record ID of the prospect plan.
Name
 plan_name string

The prospect plan name.
Type
 plan_type string

The prospect plan type.
Is stewardship?
 stewardship_plan boolean

Is a stewardship plan?
Active?
 active boolean

Is the plan active?
Start date
 start_date date-time

The plan start date.
Next interaction ID
 next_interaction_id string

The system record ID of the next interaction.
Date added
 date_added date

The date the plan was added.

Prsmg.ProspectPlanCollection

Prospect plans

Name Path Type Description
Count
 count integer

The number of items available for retrieval into the collection after applying any request parameters. The limit and offset parameters do not affect the count, but to facilitate paging, they may affect the number of items in the value result set.
value
 value array of Prsmg.ProspectPlan

The set of items included in the response. This may be a subset of the items in the collection.

Prsmg.ProspectSearchResult

Search result

Name Path Type Description
ID
 id string

The system record ID of the constituent.
Name
 name string

The constituent name. For individuals, this computed field indicates the full name of the constituent based on the target organization's display name settings.
Prospect manager
 prospect_manager string

The constituent's prospect manager.
Primary manager(s)
 primary_managers string

The primary plan manager(s).
Lookup ID
 lookup_id string

The user-defined identifier for the constituent.
Sort name
 sort_constituent_name string

The constituent sort name.
Constituent type
 constituent_type string

The constituent type.
Address
 address string

The constituent's preferred address.
City
 city string

The constituent's preferred address city.
State
 state string

The constituent's preferred address state.
Postcode
 post_code string

The constituent's preferred address postcode.
Phone
 phone string

The constituent's phone.

Prsmg.ProspectSearchResultCollection

Search results

Name Path Type Description
Count
 count integer

The number of items available for retrieval into the collection after applying any request parameters.
value
 value array of Prsmg.ProspectSearchResult

The set of items included in the response. This may be a subset of the items in the collection.

Prsmg.ProspectSummary

Prospect summary

Name Path Type Description
Is prospect?
 prospect boolean

Is the constituent a prospect?
Is flagged?
 flagged boolean

Is the prospect flagged?
Status
 prospect_status string

The prospect status.
Manager name
 prospect_manager_name string

The prospect manager name.
Manager ID
 prospect_manager_fundraiser_id string

The system record ID of the prospect manager constituent.
Start date
 prospect_manager_start_date date-time

The prospect manager start date.