Blackbaud RENXT Import (Preview)

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 Import connector to manage and execute import jobs.

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	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 import jobs within The Raiser's Edge NXT.

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.

Actions

Create an import job	Creates an import job that will be started later once the file has been uploaded.
Delete an import job	Deletes an import job.
Get an import job	Returns the details of a specific import job.
Get import job exception file download URI	Returns the download URI for the exception file for an import job.
Get import job file upload URI	Returns a new file upload URI for a pending import job.
List import jobs	Lists import jobs.
Start an import job	Starts a background job to execute the specified import.
Update an import job	Updates the details about an import job.

Create an import job

Operation ID:: CreateImportJob

Creates an import job that will be started later once the file has been uploaded.

Parameters

Name	Key	Required	Type	Description
File name	file_name	True	string	The name of the file to import.
Header row	header_row		string	The header row to use when importing a CSV file.

Returns

Created constituent consent

Body: ImportApi.CreateImportJobResponse

Delete an import job

Operation ID:: DeleteImportJob

Deletes an import job.

Parameters

Name	Key	Required	Type	Description
Import job ID	job_id	True	string	The system record ID of the import job to delete.

Get an import job

Operation ID:: GetImportJob

Returns the details of a specific import job.

Parameters

Name	Key	Required	Type	Description
Job ID	job_id	True	string	The system record ID of the import job.

Returns

Import job

Body: ImportApi.ImportJob

Get import job exception file download URI

Operation ID:: GetImportJobExceptionFileDownloadUri

Returns the download URI for the exception file for an import job.

Parameters

Name	Key	Required	Type	Description
Job ID	job_id	True	string	The system record ID of the import job.

Returns

File download info

Body: ImportApi.ImportJobExceptionFileDownloadInfo

Get import job file upload URI

Operation ID:: GetImportJobFileUploadUri

Returns a new file upload URI for a pending import job.

Parameters

Name	Key	Required	Type	Description
Job ID	job_id	True	string	The system record ID of the import job.

Returns

File upload info

Body: ImportApi.ImportJobFileUploadInfo

List import jobs

Operation ID:: ListImportJobs

Lists import jobs.

Parameters

Name	Key	Type	Description
Status	status	string	Filter jobs by status.
Limit	limit	integer	Represents the number of records to return. The default is 100. The maximum is 10000.
Continuation token	continuation_token	string	The continuation token to get the next page of results.

Returns

Import jobs

Body: ImportApi.ImportJobSummaryCollection

Start an import job

Operation ID:: StartImportJob

Starts a background job to execute the specified import.

Parameters

Name	Key	Required	Type	Description
Job ID	job_id	True	string	The ID of the import job to start.

Returns

Started report job

Body: ImportApi.StartImportJobResponse

Update an import job

Operation ID:: EditImportJob

Updates the details about an import job.

Parameters

Name	Key	Required	Type	Description
Import job ID	job_id	True	string	The system record ID of the import job to update.
File name	file_name		string	The name of the file to import.

Definitions

ImportApi.CreateImportJobResponse

Created constituent consent

Name	Path	Type	Description
ID	id	string	The ID of the newly created import job.
File upload URI	file_upload_uri	string	The URI for uploading the file to import.
Field mappings	field_mappings	array of ImportApi.FieldMapping	For CSV imports, the field mappings from the header row to the target fields.
Mapping validation messages	mapping_validation_messages	array of ImportApi.MappingValidationMessage	The mapping validation messages from the created job's header row. Only applies to CSV imports.

ImportApi.FieldMapping

Field mapping

Name	Path	Type	Description
source field	source_field	string	The name of the source field.
target field	target_field	string	The name of the target field.

ImportApi.ImportJobFileUploadInfo

File upload info

Name	Path	Type	Description
File upload URI	file_upload_uri	string	The URI for uploading the file to import.

ImportApi.ImportJob

Import job

Name	Path	Type	Description
ID	id	string	The import job identifier.
File name	file_name	string	The name of the file being imported.
Date started	start_date	date-time	The date when the import job was started.
Date completed	end_date	date-time	The date when the import job was completed.
Run duration	run_duration	integer	The duration of the import job in seconds.
Sequence	sequence	integer	The sequence number of the import job.
Rows processed	rows_processed	integer	The number of rows processed by the import job.
Rows committed	rows_committed	integer	The number of rows committed by the import job.
Rows rejected	rows_rejected	integer	The number of rows rejected by the import job.
Exception count	exception_count	integer	The number of exceptions encountered by the import job.
Failure message	failure_message	string	The failure message for the import job.
Status	status	string	The import job status.
Added by ID	added_by	string	The user who created the import job.
Date created	date_added	date-time	The date when the import job was created.
Date modified	date_modified	date-time	The date when the import job was last modified.

ImportApi.ImportJobExceptionFileDownloadInfo

File download info

Name	Path	Type	Description
File download URI	file_download_uri	string	The URI for downloading the exception file.

ImportApi.ImportJobSummary

Import job

Name	Path	Type	Description
ID	id	string	The import job identifier.
File name	file_name	string	The name of the file being imported.
Date started	start_date	date-time	The date when the import job was started.
Date completed	end_date	date-time	The date when the import job was completed.
Run duration	run_duration	integer	The duration of the import job in seconds.
Sequence	sequence	integer	The sequence number of the import job.
Rows processed	rows_processed	integer	The number of rows processed by the import job.
Rows committed	rows_committed	integer	The number of rows committed by the import job.
Rows rejected	rows_rejected	integer	The number of rows rejected by the import job.
Exception count	exception_count	integer	The number of exceptions encountered by the import job.
Failure message	failure_message	string	The failure message for the import job.
Status	status	string	The import job status.
Added by ID	added_by	string	The user who created the import job.
Date created	date_added	date-time	The date when the import job was created.
Date modified	date_modified	date-time	The date when the import job was last modified.

ImportApi.ImportJobSummaryCollection

Import jobs

Name	Path	Type	Description
Count	count	integer	The total number of jobs matching the filter.
Limit	limit	integer	The requested number of records to return.
Continuation token	continuation_token	string	The continuation token to get the next page of results.
jobs	jobs	array of ImportApi.ImportJobSummary	The set of items included in the response.

ImportApi.MappingValidationMessage

Mapping validation message

Name	Path	Type	Description
record mapping	record_mapping	string	The record mapping associated with the validation error message.
target field	target_field	string	The target field associated with the validation error message.
message type	message_type	string	The type of the validation message.
message	message	string	The validation message.
file fields	file_fields	array of string	The file fields associated with the validation error message.

ImportApi.StartImportJobResponse

Started report job

Name	Path	Type	Description
Status	status	string	The import job status.