Blackbaud Raisers Edge NXT Prospects
Blackbaud Raiser's Edge NXT is a comprehensive cloud-based fundraising and donor management software solution built specifically for nonprofits and the entire social good community. Use the Prospects connector to manage prospects, opportunities, and ratings.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - 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) |
| 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) |
| Contact | |
|---|---|
| Name | Blackbaud Support |
| URL | https://www.blackbaud.com/support |
| skyapi@blackbaud.com |
| Connector Metadata | |
|---|---|
| Publisher | Blackbaud, Inc. |
| Website | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| Privacy policy | https://www.blackbaud.com/privacy-shield |
| Categories | Sales and CRM;Productivity |
Raiser's Edge NXT is a comprehensive cloud-based fundraising and donor management software solution built specifically for nonprofits and the entire social good community.
This connector is built on top of Blackbaud's SKY API, and provides operations to help manage prospects and related entities found within The Raiser's Edge NXT, including:
- Prospects
- Opportunities
- Ratings
- and more...
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 Raiser's Edge NXT 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 constituent rating |
Creates a new constituent rating. |
| Create an opportunity |
Creates a new opportunity. |
| Create an opportunity attachment |
Creates a new opportunity attachment. |
| Create an opportunity custom field |
Creates a new opportunity custom field. |
| Get an opportunity |
Returns information about an opportunity. Note: This endpoint returns the status property with a latency of about 10 minutes. |
| Get constituent prospect status |
Returns the current prospect status for a constituent. |
| List constituent ratings |
Returns the list of ratings for a constituent. |
| List opportunities |
Returns a list of opportunities. |
| List opportunity attachments |
Lists the attachments for an opportunity. |
| List opportunity custom fields |
Lists the custom fields for an opportunity. |
| Update an opportunity |
Updates an opportunity. |
| Update an opportunity attachment |
Updates an opportunity attachment. |
| Update an opportunity custom field |
Updates an opportunity custom field. |
Create a constituent rating
Creates a new constituent rating.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
An object that represents the rating to create. |
Returns
Created constituent rating
Create an opportunity
Creates a new opportunity.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Constituent ID
|
constituent_id | True | string |
The system record ID of the constituent associated with the opportunity. |
|
Purpose
|
purpose | True | string |
The intended use for any money raised as a result of the opportunity. |
|
Name
|
name | True | string |
The name that identifies the opportunity throughout the program, such as in lists or on constituent records. Character limit: 255. |
|
Status
|
status | string |
The status that indicates where the opportunity is in the solicitation process. |
|
|
Deadline
|
deadline | date-time |
The goal date for the opportunity to result in a gift (ex: '2020-09-18T04:13:56Z'). |
|
|
Ask date
|
ask_date | date-time |
The date when the solicitation was made (ex: '2020-09-18T04:13:56Z'). |
|
|
value
|
value | double |
The monetary value. |
|
|
Expected date
|
expected_date | date-time |
The date when the prospect is expected to give in response to the opportunity (ex: '2020-09-18T04:13:56Z'). |
|
|
value
|
value | double |
The monetary value. |
|
|
Funded date
|
funded_date | date-time |
The date when the prospect gave in response to the opportunity (ex: '2020-09-18T04:13:56Z'). |
|
|
value
|
value | double |
The monetary value. |
|
|
Campaign ID
|
campaign_id | string |
The system record ID of the campaign associated with the opportunity. The campaign sets the overall objectives for raising money. |
|
|
Fund ID
|
fund_id | string |
The system record ID of the fund associated with the opportunity. The fund designates the specific financial purpose of a gift and identifies the financial account for that gift. |
|
|
Constituent ID
|
constituent_id | string |
The system record ID of the constituent associated with the fundraiser. |
|
|
value
|
value | double |
The monetary value. |
|
|
Inactive?
|
inactive | boolean |
Is the opportunity inactive? |
Returns
Created opportunity
Create an opportunity attachment
Creates a new opportunity attachment.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Opportunity ID
|
parent_id | True | string |
The system record ID of the opportunity associated with the attachment. |
|
Type
|
type | True | string |
The attachment type. Physical attachments are uploaded files such as images, PDFs, or Word documents that are saved locally or on the network. They are stored and managed in the system. Link attachments are links to files such as images, blog posts, or YouTube videos that are online or in a cloud storage account. They are stored and managed externally. |
|
Name
|
name | string |
The name of the attachment. Character limit: 150. |
|
|
Date
|
date | date-time |
The date of the attachment (ex: '2020-09-18T04:13:56Z'). This field defaults to the current date and time if not supplied. |
|
|
URL
|
url | string |
The URL for the attachment. This is required for link attachments and not applicable for physical attachments. |
|
|
File name
|
file_name | string |
The name of the file. Character limit: 36. For physical attachments only. |
|
|
File ID
|
file_id | string |
The identifier of the file. Character limit: 36. For physical attachments only. |
|
|
Thumbnail ID
|
thumbnail_id | string |
The identifier of the thumbnail. Character limit: 36. For physical attachments only. |
|
|
Tags
|
tags | array of string |
The tags associated with the attachment. |
Returns
Created opportunity attachment
Create an opportunity custom field
Creates a new opportunity custom field.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
An object that represents the custom field to create. |
Returns
Created opportunity attachment
Get an opportunity
Returns information about an opportunity. Note: This endpoint returns the status property with a latency of about 10 minutes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Opportunity ID
|
opportunity_id | True | string |
The system record ID of the opportunity to get. |
Returns
Opportunity
Get constituent prospect status
Returns the current prospect status for a constituent.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Constituent ID
|
constituent_id | True | string |
The system record ID of the constituent for whom the prospect status is to be retrieved. |
Returns
Prospect status
List constituent ratings
Returns the list of ratings for a constituent.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Constituent ID
|
constituent_id | True | string |
The system record ID of the constituent |
|
Include inactive?
|
include_inactive | boolean |
Include inactive ratings? |
|
|
Only most recent?
|
most_recent_only | boolean |
Include only the most recent ratings? |
Returns
Ratings
List opportunities
Returns a list of opportunities.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List
|
list_id | string |
Defines a list identifier used to filter the set of opportunities to those included in the specified list. If this value is set, other specified filters will be ignored. |
|
|
Constituent ID
|
constituent_id | string |
Represents a comma-separated list of constituent system record IDs to filter the results. For example, "280,1232" returns only opportunities from constituent 280 or constituent 1232. |
|
|
Limit
|
limit | integer |
Represents the number of records to return. The default is 500. The maximum is 5000. |
|
|
Offset
|
offset | integer |
Represents the number of records to skip. For use with pagination. |
|
|
Include inactive?
|
include_inactive | boolean |
Include inactive opportunities? |
|
|
Added on or after
|
date_added | date-time |
Filter the results to opportunities created on or after the specified date (ex: '2020-09-18T04:13:56Z'). |
|
|
Modified on or after
|
last_modified | date-time |
Filter the results to opportunities modified on or after the specified date (ex: '2020-09-18T04:13:56Z'). |
Returns
Opportunities
List opportunity attachments
Lists the attachments for an opportunity.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Opportunity ID
|
opportunity_id | True | string |
The system record ID of the opportunity. |
Returns
Attachments
List opportunity custom fields
Lists the custom fields for an opportunity.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Opportunity ID
|
opportunity_id | True | string |
The system record ID of the opportunity. |
Returns
Custom fields
Update an opportunity
Updates an opportunity.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Opportunity ID
|
opportunity_id | True | string |
The system record ID of the opportunity to update. |
|
Purpose
|
purpose | string |
The intended use for any money raised as a result of the opportunity. |
|
|
Name
|
name | string |
The name that identifies the opportunity throughout the program, such as in lists or on constituent records. Character limit: 255. |
|
|
Status
|
status | string |
The status that indicates where the opportunity is in the solicitation process. |
|
|
Deadline
|
deadline | date-time |
The goal date for the opportunity to result in a gift (ex: '2020-09-18T04:13:56Z'). |
|
|
Ask date
|
ask_date | date-time |
The date when the solicitation was made (ex: '2020-09-18T04:13:56Z'). |
|
|
value
|
value | double |
The monetary value. |
|
|
Expected date
|
expected_date | date-time |
The date when the prospect is expected to give in response to the opportunity (ex: '2020-09-18T04:13:56Z'). |
|
|
value
|
value | double |
The monetary value. |
|
|
Funded date
|
funded_date | date-time |
The date when the prospect gave in response to the opportunity (ex: '2020-09-18T04:13:56Z'). |
|
|
value
|
value | double |
The monetary value. |
|
|
Campaign ID
|
campaign_id | string |
The system record ID of the campaign associated with the opportunity. The campaign sets the overall objectives for raising money. |
|
|
Fund ID
|
fund_id | string |
The system record ID of the fund associated with the opportunity. The fund designates the specific financial purpose of a gift and identifies the financial account for that gift. |
|
|
Constituent ID
|
constituent_id | string |
The system record ID of the constituent associated with the fundraiser. |
|
|
value
|
value | double |
The monetary value. |
|
|
Inactive?
|
inactive | boolean |
Is the opportunity inactive? |
Update an opportunity attachment
Updates an opportunity attachment.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Attachment ID
|
attachment_id | True | string |
The system record ID of the attachment to update. |
|
Name
|
name | string |
The name of the attachment. Character limit: 150. |
|
|
Date
|
date | date-time |
The date of the attachment (ex: '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
The URL for the attachment. This is required for link attachments and not applicable for physical attachments. |
|
|
Tags
|
tags | array of string |
The tags associated with the attachment. |
Update an opportunity custom field
Updates an opportunity custom field.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Custom field ID
|
custom_field_id | True | string |
The system record ID of the custom field to update. |
|
body
|
body | True | dynamic |
An object that represents the properties of the custom field to update. |
Definitions
ConstituentApi.ApiCollectionOfRatingRead
Ratings
| 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 ConstituentApi.RatingRead |
The set of items included in the response. This may be a subset of the items in the collection. |
ConstituentApi.CreatedConstituentRating
Created constituent rating
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The ID of the newly created constituent rating. |
ConstituentApi.ProspectStatusRead
Prospect status
| Name | Path | Type | Description |
|---|---|---|---|
|
Status
|
status | string |
The constituent's current prospect status. |
|
Days elapsed
|
days_elapsed | integer |
Total number of days in the current prospect status based on the start date. |
|
Start date
|
start | date-time |
The start date of the prospect status. |
|
Comments
|
comments | string |
The comments on the prospect status. |
ConstituentApi.RatingRead
Rating
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The system record ID of the rating. |
|
Constituent ID
|
constituent_id | string |
The system record ID of the constituent associated with the rating. |
|
Source
|
source | string |
The source of the new rating. |
|
Category
|
category | string |
The category of the rating. |
|
Date
|
date | date-time |
The date of the rating. |
|
Description
|
value |
The value of the rating. |
|
|
Comments
|
comment | string |
A comment about the rating. |
|
Inactive?
|
inactive | boolean |
Is the rating inactive? |
|
Type
|
type | string |
This computed field indicates the type of data that the rating represents based on the category property. |
OpportunityApi.ApiCollectionOfOpportunityAttachmentRead
Attachments
| 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 OpportunityApi.OpportunityAttachmentRead |
The set of items included in the response. This may be a subset of the items in the collection. |
OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead
Custom fields
| 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 OpportunityApi.OpportunityCustomFieldRead |
The set of items included in the response. This may be a subset of the items in the collection. |
OpportunityApi.ApiCollectionOfOpportunityRead
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 OpportunityApi.OpportunityRead |
The set of items included in the response. This may be a subset of the items in the collection. |
OpportunityApi.CreatedOpportunity
Created opportunity
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The ID of the newly created opportunity. |
OpportunityApi.CreatedOpportunityAttachment
Created opportunity attachment
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The ID of the newly created opportunity attachment. |
OpportunityApi.CreatedOpportunityCustomField
Created opportunity attachment
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The ID of the newly created opportunity attachment. |
OpportunityApi.Fundraiser
Fundraiser
| Name | Path | Type | Description |
|---|---|---|---|
|
Constituent ID
|
constituent_id | string |
The system record ID of the constituent associated with the fundraiser. |
|
value
|
credit_amount.value | double |
The monetary value. |
OpportunityApi.OpportunityAttachmentRead
Attachment
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The system record ID of the attachment. |
|
Opportunity ID
|
parent_id | string |
The system record ID of the opportunity associated with the attachment. |
|
Type
|
type | string |
The attachment type. Physical attachments are uploaded files such as images, PDFs, or Word documents that are saved locally or on the network. They are stored and managed in the system. Link attachments are links to files such as images, blog posts, or YouTube videos that are online or in a cloud storage account. They are stored and managed externally. |
|
Name
|
name | string |
The name of the attachment. Character limit: 150. |
|
Date
|
date | date-time |
The date of the attachment. |
|
URL
|
url | string |
The URL for the attachment. This is required for link attachments and not applicable for physical attachments. |
|
File name
|
file_name | string |
The name of the file. Character limit: 36. For physical attachments only. |
|
File ID
|
file_id | string |
The identifier of the file. Character limit: 36. For physical attachments only. |
|
Thumbnail ID
|
thumbnail_id | string |
The identifier of the thumbnail. Character limit: 36. For physical attachments only. |
|
Thumbnail URL
|
thumbnail_url | string |
The URL for a thumbnail. For physical attachments that are images only. Contains a time-bound signature that limits access to 60 minutes. |
|
Content type
|
content_type | string |
The content type. For physical attachments only. |
|
File size
|
file_size | integer |
The file size in bytes. For physical attachments only. |
|
Tags
|
tags | array of string |
The tags associated with the attachment. |
OpportunityApi.OpportunityCustomFieldRead
Custom field
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The system record ID of the custom field. |
|
Opportunity ID
|
parent_id | string |
The system record ID of the opportunity associated with the custom field. |
|
Category
|
category | string |
The custom field category. |
|
Type
|
type | string |
The type of data that the custom field represents. |
|
Value
|
value |
The value of the custom field. |
|
|
Text value
|
text_value | string |
The text value of the custom field. |
|
Number value
|
number_value | integer |
The numeric value of the custom field. |
|
Date value
|
date_value | date |
The date value of the custom field. |
|
Currency value
|
currency_value | double |
The currency value of the custom field. |
|
Boolean value
|
boolean_value | boolean |
The boolean value of the custom field. |
|
Table entry value
|
codetableentry_value | string |
The table entry value of the custom field. |
|
Constituent ID value
|
constituentid_value | string |
The constituent ID value of the custom field. |
|
day
|
fuzzydate_value.d | integer |
The day in the fuzzy date. |
|
month
|
fuzzydate_value.m | integer |
The month in the fuzzy date. |
|
year
|
fuzzydate_value.y | integer |
The year in the fuzzy date. |
|
Date
|
date | date |
The date on the custom field. |
|
Comment
|
comment | string |
The comment on the custom field. Character limit: 50. |
|
Date added
|
date_added | date-time |
The date when the custom field was created. |
|
Date modified
|
date_modified | date-time |
The date when the custom field was last modified. |
OpportunityApi.OpportunityRead
Opportunity
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The system record ID of the opportunity. |
|
Constituent ID
|
constituent_id | string |
The system record ID of the constituent associated with the opportunity. |
|
Purpose
|
purpose | string |
The intended use for any money raised as a result of the opportunity. |
|
Name
|
name | string |
The name that identifies the opportunity throughout the program, such as in lists or on constituent records. Character limit: 255. |
|
Status
|
status | string |
The status that indicates where the opportunity is in the solicitation process. |
|
Deadline
|
deadline | date-time |
The goal date for the opportunity to result in a gift. |
|
Ask date
|
ask_date | date-time |
The date when the solicitation was made. |
|
value
|
ask_amount.value | double |
The monetary value. |
|
Expected date
|
expected_date | date-time |
The date when the prospect is expected to give in response to the opportunity. |
|
value
|
expected_amount.value | double |
The monetary value. |
|
Funded date
|
funded_date | date-time |
The date when the prospect gave in response to the opportunity. |
|
value
|
funded_amount.value | double |
The monetary value. |
|
Campaign ID
|
campaign_id | string |
The system record ID of the campaign associated with the opportunity. The campaign sets the overall objectives for raising money. |
|
Fund ID
|
fund_id | string |
The system record ID of the fund associated with the opportunity. The fund designates the specific financial purpose of a gift and identifies the financial account for that gift. |
|
Fundraiser(s)
|
fundraisers | array of OpportunityApi.Fundraiser |
The set of system record IDs for the fundraisers assigned to the opportunity. |
|
Inactive?
|
inactive | boolean |
Is the opportunity inactive? |
|
linked_gifts
|
linked_gifts | array of string |
The system record IDs of the gifts related to the opportunity. |
|
Date added
|
date_added | date-time |
The date when the opportunity was created. |
|
Date modified
|
date_modified | date-time |
The date when the opportunity was last modified. |