Compartilhar via

Blackbaud Raisers Edge NXT Interactions

  • Reference

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 Interactions connector to manage constituent actions.

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
Email 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 constituent interations and related entities within The Raiser's Edge NXT, including:

  • Actions
  • Action custom fields
  • Action attachments
  • 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 action

Creates a new constituent action.
Create an action attachment

Creates a new action attachment.
Create an action custom field

Creates a new action custom field.
Get a constituent action

Returns information about a constituent action.
List action attachments

Lists the attachments for an action.
List action custom fields

Lists the custom fields for an action.
List actions

Returns a list of actions.
List constituent actions

Lists the actions for a constituent.
Update a constituent action

Updates a constituent action.
Update an action attachment

Updates an action attachment.
Update an action custom field

Updates an action custom field.

Create a constituent action

Operation ID:
CreateAction

Creates a new constituent action.

Parameters

Name Key Required Type Description
Constituent ID
 constituent_id True string

The system record ID of the constituent associated with the action.
Date
 date True date-time

The action date (ex: '2020-09-18T04:13:56Z').
Category
 category True string

The channel or intent of the constituent interaction.
Type
 type string

Additional description of the action to complement the category.
Summary
 summary string

The short description of the action that appears at the top of the record. Character limit: 255.
Note
 description string

The detailed explanation that elaborates on the action summary.
Completed?
 completed boolean

Is the action completed? If the system is configured to use custom action statuses, this value is based on the action status value.
Completed on
 completed_date date-time

The date when the action was completed (ex: '2020-09-18T04:13:56Z').
Status
 status string

The action status.
Direction
 direction string

The direction of the action.
Location
 location string

The location of the action.
Opportunity ID
 opportunity_id string

The system record ID of the opportunity associated with the action.
Outcome
 outcome string

The outcome of the action.
Priority
 priority string

The priority of the action.
Start time
 start_time string

The start time of the action. Uses 24-hour time in the HH:mm format.
End time
 end_time string

The end time of the action. Uses 24-hour time in the HH:mm format.
Author
 author string

The author of the action's summary and description. If not supplied, will have a default set based on the user's account. Character limit: 50.
Fundraiser(s)
 fundraisers array of string

The set of system record IDs for the fundraisers associated with the action.

Returns

Created action

Body
ConstituentApi.CreatedAction

Create an action attachment

Operation ID:
CreateActionAttachment

Creates a new action attachment.

Parameters

Name Key Required Type Description
Action ID
 parent_id True string

The system record ID of the action 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 action attachment

Body
ConstituentApi.CreatedActionAttachment

Create an action custom field

Operation ID:
CreateActionCustomField

Creates a new action custom field.

Parameters

Name Key Required Type Description
body
 body True dynamic

An object that represents the custom field to create.

Returns

Created action custom field

Body
ConstituentApi.CreatedActionCustomField

Get a constituent action

Operation ID:
GetAction

Returns information about a constituent action.

Parameters

Name Key Required Type Description
Action ID
 action_id True string

The system record ID of the action to get.

Returns

Action

Body
ConstituentApi.ActionRead

List action attachments

Operation ID:
ListActionAttachments

Lists the attachments for an action.

Parameters

Name Key Required Type Description
Action ID
 action_id True string

The system record ID of the action.

Returns

Attachments

Body
ConstituentApi.ApiCollectionOfActionAttachmentRead

List action custom fields

Operation ID:
ListActionCustomFields

Lists the custom fields for an action.

Parameters

Name Key Required Type Description
Action ID
 action_id True string

The system record ID of the action.

Returns

Custom fields

Body
ConstituentApi.ApiCollectionOfActionCustomFieldRead

List actions

Operation ID:
ListActions

Returns a list of actions.

Parameters

Name Key Required Type Description
List
 list_id string

Defines a list identifier used to filter the set of actions to those included in the specified list. If this value is set, other specified filters will be ignored.
Computed status
 computed_status string

Represents a filter for results based on the computed action status. Available values are Open, Completed, or PastDue.
Status
 status_code string

Represents an action status code to filter the results (only applicable when the system is configured to use action status codes). For example, "Pending" returns actions with a status of "Pending".
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.
Added on or after
 date_added date-time

Filter the results to actions 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 actions modified on or after the specified date (ex: '2020-09-18T04:13:56Z').

Returns

Actions

Body
ConstituentApi.ApiCollectionOfActionRead

List constituent actions

Operation ID:
ListConstituentActions

Lists the actions for a constituent.

Parameters

Name Key Required Type Description
Constituent ID
 constituent_id True string

The system record ID of the constituent.

Returns

Actions

Body
ConstituentApi.ApiCollectionOfActionRead

Update a constituent action

Operation ID:
EditAction

Updates a constituent action.

Parameters

Name Key Required Type Description
Action ID
 action_id True string

The system record ID of the action to update.
Date
 date date-time

The action date (ex: '2020-09-18T04:13:56Z').
Category
 category string

The channel or intent of the constituent interaction.
Type
 type string

Additional description of the action to complement the category.
Summary
 summary string

The short description of the action that appears at the top of the record. Character limit: 255.
Note
 description string

The detailed explanation that elaborates on the action summary.
Completed?
 completed boolean

Is the action completed? If the system is configured to use custom action statuses, this value is based on the action status value.
Completed on
 completed_date date-time

The date when the action was completed (ex: '2020-09-18T04:13:56Z').
Status
 status string

The action status.
Direction
 direction string

The direction of the action.
Location
 location string

The location of the action.
Opportunity ID
 opportunity_id string

The system record ID of the opportunity associated with the action.
Outcome
 outcome string

The outcome of the action.
Priority
 priority string

The priority of the action.
Start time
 start_time string

The start time of the action. Uses 24-hour time in the HH:mm format.
End time
 end_time string

The end time of the action. Uses 24-hour time in the HH:mm format.
Fundraiser(s)
 fundraisers array of string

The set of system record IDs for the fundraisers associated with the action.

Update an action attachment

Operation ID:
EditActionAttachment

Updates an action 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 action custom field

Operation ID:
EditActionCustomField

Updates an action 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.ActionAttachmentRead

Attachment

Name Path Type Description
ID
 id string

The system record ID of the attachment.
Action ID
 parent_id string

The system record ID of the action 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.

ConstituentApi.ActionCustomFieldRead

Custom field

Name Path Type Description
ID
 id string

The system record ID of the custom field.
Action ID
 parent_id string

The system record ID of the action 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.

ConstituentApi.ActionRead

Action

Name Path Type Description
ID
 id string

The system record ID of the action.
Constituent ID
 constituent_id string

The system record ID of the constituent associated with the action.
Category
 category string

The channel or intent of the constituent interaction.
Completed?
 completed boolean

Is the action completed? If the system is configured to use custom action statuses, this value is based on the action status value.
Completed on
 completed_date date-time

The date when the action was completed.
Date
 date date-time

The action date.
Note
 description string

The detailed explanation that elaborates on the action summary.
Direction
 direction string

The direction of the action.
Fundraiser(s)
 fundraisers array of string

The set of system record IDs for the fundraisers associated with the action.
Location
 location string

The location of the action.
Opportunity ID
 opportunity_id string

The system record ID of the opportunity associated with the action.
Outcome
 outcome string

The outcome of the action.
Priority
 priority string

The priority of the action.
Start time
 start_time string

The start time of the action. Uses 24-hour time in the HH:mm format.
End time
 end_time string

The end time of the action. Uses 24-hour time in the HH:mm format.
Status
 status string

The action status.
Status code
 status_code string

The action status code. This property is only returned when the system is configured to use custom action statuses.
Computed status
 computed_status string

The computed action status. If the system is not configured to use custom action statuses, this field computes the status based on the completed and date properties. If not, the field calculates the status based on the action's date property and whether action's Action Status property is configured as completed.
Summary
 summary string

The short description of the action that appears at the top of the record. Character limit: 255.
Type
 type string

Additional description of the action to complement the category.
Date added
 date_added date-time

The date when the action was created.
Date modified
 date_modified date-time

The date when the action was last modified.

ConstituentApi.ApiCollectionOfActionAttachmentRead

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 ConstituentApi.ActionAttachmentRead

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

ConstituentApi.ApiCollectionOfActionCustomFieldRead

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 ConstituentApi.ActionCustomFieldRead

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

ConstituentApi.ApiCollectionOfActionRead

Actions

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.ActionRead

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

ConstituentApi.CreatedAction

Created action

Name Path Type Description
ID
 id string

The ID of the newly created action.

ConstituentApi.CreatedActionAttachment

Created action attachment

Name Path Type Description
ID
 id string

The ID of the newly created action attachment.

ConstituentApi.CreatedActionCustomField

Created action custom field

Name Path Type Description
ID
 id string

The ID of the newly created action custom field.