Blackbaud Raisers Edge NXT Events

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 Events connector to manage events and participants.

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	[email protected]

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

Events
Participants
Fees and donations
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 participant	Creates a new participant for an event.
Create a participant donation	Creates a new donation for a participant.
Create a participant fee	Creates a new fee for a participant.
Create a participant fee payment	Creates a new fee payment for a participant.
Create a participant option	Creates a new participant option for a participant.
Create an event	Creates a new event.
Create an event attachment	Creates a new event attachment.
Create an event fee	Creates a new fee for an event.
Create an event participant option	Creates a new participant option for an event.
Get a participant	Returns information about a specific event participant.
Get an event	Returns information about an event.
List event attachments	Lists the attachments for an event.
List event fees	Lists the fees for an event.
List event participant options	Lists the participant options for an event.
List event participants	Lists the participants for an event.
List events	Returns a list of events.
List participant donations	Lists the donations for a participant.
List participant fee payments	Lists the fee payments for a participant.
List participant fees	Lists the fees for a participant.
List participant options	Lists the participant options for a participant.
Update a participant	Updates the details about a participant.
Update a participant option	Updates the details about a participant option.
Update an event	Updates the details about an event.
Update an event attachment	Updates an event attachment.

Create a participant

Operation ID:: CreateParticipant

Creates a new participant for an event.

Parameters

Name	Key	Required	Type	Description
Event ID	event_id	True	string	The system record ID of the event.
Constituent ID	constituent_id	True	string	The constituent ID of the participant.
Host ID	host_id		string	The ID of the host's participant record.
RSVP status	rsvp_status		string	The status of the participant's engagement with the event.
Attended?	attended		boolean	Did the participant attend the event?
Invitation status	invitation_status		string	The status of the invitation to the participant.
day	d		integer	The day in the fuzzy date.
month	m		integer	The month in the fuzzy date.
year	y		integer	The year in the fuzzy date.
day	d		integer	The day in the fuzzy date.
month	m		integer	The month in the fuzzy date.
year	y		integer	The year in the fuzzy date.
Participation level	name	True	string	The name of the participation level.
Summary note	summary_note		string	Quick reference information pinned to the participant's record.

Returns

Created participant

Body: EventApi.CreatedParticipant

Create a participant donation

Operation ID:: CreateParticipantDonation

Creates a new donation for a participant.

Parameters

Name	Key	Required	Type	Description
Participant ID	participant_id	True	string	The system record ID of the participant.
Gift ID	gift_id	True	string	The systetm record ID of the gift to which the participant donation is linked.

Returns

Created participant donation

Body: EventApi.CreatedParticipantDonation

Create a participant fee

Operation ID:: CreateParticipantFee

Creates a new fee for a participant.

Parameters

Name	Key	Required	Type	Description
Participant ID	participant_id	True	string	The system record ID of the participant.
Event ID	event_id	True	string	The system record ID of the event.
Fee	event_fee_id	True	string	The event fee.
Quantity	quantity	True	integer	The quantity purchased.
Fee amount	fee_amount	True	double	The amount of money associated with the fee.
Contribution amount	contribution_amount	True	double	The amount of the fee that's a donation above the costs of the event. This is the amount that typically appears on receipts.
day	d		integer	The day in the fuzzy date.
month	m		integer	The month in the fuzzy date.
year	y		integer	The year in the fuzzy date.

Returns

Created participant fee

Body: EventApi.CreatedParticipantFee

Create a participant fee payment

Operation ID:: CreateParticipantFeePayment

Creates a new fee payment for a participant.

Parameters

Name	Key	Required	Type	Description
Participant ID	participant_id	True	string	The system record ID of the participant.
Gift ID	gift_id	True	string	The systetm record ID of the gift to which the participant fee is linked.
Applied amount	applied_amount	True	double	The amount of the payment that applies toward the participant fees.

Returns

Created participant fee payment

Body: EventApi.CreatedParticipantFeePayment

Create a participant option

Operation ID:: CreateParticipantOption

Creates a new participant option for a participant.

Parameters

Name	Key	Required	Type	Description
Participant ID	participant_id	True	string	The ID of the participant.
body	body	True	dynamic	An object that represents the participant option to create.

Returns

Created participant option

Body: EventApi.CreatedParticipantOption

Create an event

Operation ID:: CreateEvent

Creates a new event.

Parameters

Name	Key	Required	Type	Description
Event name	name	True	string	The name of the event.
Description	description		string	The description of the event.
Category	name	True	string	The category name.
Start date	start_date	True	date	The start date of the event (ex: '2020-09-18').
Start time	start_time		string	The start time of the event (ex: '07:30').
End date	end_date		date	The end date of the event (ex: '2020-09-18').
End time	end_time		string	The end time of the event (ex: '07:30)'.
Lookup ID	lookup_id		string	The lookup ID of the event.
Capacity	capacity		integer	The number of people that can attend the event.
Goal	goal		double	The monetary goal of the event.
Campaign ID	campaign_id		string	The system record ID of the campaign associated with the event.
Fund ID	fund_id		string	The system record ID of the fund associated with the event.
Inactive?	inactive		boolean	Is the event active?

Returns

Created event

Body: EventApi.CreatedEvent

Create an event attachment

Operation ID:: CreateEventAttachment

Creates a new event attachment.

Parameters

Name	Key	Required	Type	Description
Event ID	event_id	True	string	The system record ID of the event.
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 event attachment

Body: EventApi.CreatedEventAttachment

Create an event fee

Operation ID:: CreateEventFee

Creates a new fee for an event.

Parameters

Name	Key	Required	Type	Description
Event ID	event_id	True	string	The system record ID of the event.
Name	name	True	string	The name of the fee.
Fee amount	cost	True	double	The amount of money associated with the fee.
Contribution amount	contribution_amount	True	double	The amount of the fee that's a donation above the costs of the event.

Returns

Created event fee

Body: EventApi.CreatedEventFee

Create an event participant option

Operation ID:: CreateEventParticipantOption

Creates a new participant option for an event.

Parameters

Name	Key	Required	Type	Description
Event ID	event_id	True	string	The ID of the event.
Name	name	True	string	The name of the event participant option.
Input type	input_type	True	string	The types of values participants can use to provide responses.
Allow multi-select?	multi_select		boolean	Allow more than one value for lists?
name	name		string	The name of the list option.
sequence	sequence		integer	The 0-based sequence used for ordering.

Returns

Created event participant option

Body: EventApi.CreatedEventParticipantOption

Get a participant

Operation ID:: GetParticipant

Returns information about a specific event participant.

Parameters

Name	Key	Required	Type	Description
Participant ID	participant_id	True	string	The system record ID of the participant.

Returns

Participant

Body: EventApi.Participant

Get an event

Operation ID:: GetEvent

Returns information about an event.

Parameters

Name	Key	Required	Type	Description
Event ID	event_id	True	string	The system record ID of the event to get.

Returns

Event

Body: EventApi.Event

List event attachments

Operation ID:: ListEventAttachments

Lists the attachments for an event.

Parameters

Name	Key	Required	Type	Description
Event ID	event_id	True	string	The system record ID of the event.

Returns

Attachments

Body: EventApi.EventAttachmentCollection

List event fees

Operation ID:: ListEventFees

Lists the fees for an event.

Parameters

Name	Key	Required	Type	Description
Event ID	event_id	True	string	The system record ID of the event.

Returns

Fees

Body: EventApi.ApiCollectionOfEventFee

List event participant options

Operation ID:: ListEventParticipantOptions

Lists the participant options for an event.

Parameters

Name	Key	Required	Type	Description
Event ID	event_id	True	string	The ID of the event.

Returns

Event participant options

Body: EventApi.ApiCollectionOfEventParticipantOption

List event participants

Operation ID:: ListEventParticipants

Lists the participants for an event.

Parameters

Name	Key	Required	Type	Description
Event ID	event_id	True	string	The system record ID of the event.
RSVP status	rsvp_status		string	Filter participants based on RSVP status.
Invitation status	invitation_status		string	Filter participants based on invitation status.
Participation level	participation_level		string	Filter participants based on level of involvement.
Attended?	attended_filter		boolean	Filter for including or excluding participants marked as attended.
Fees paid?	fees_paid_filter		boolean	Filter for including or excluding participants that have paid their fees.
Limit	limit		integer	Represents the number of records to return. The default is 500. The maximum is 10000.
Offset	offset		integer	Represents the number of records to skip. For use with pagination.
Is a constituent?	is_constituent_filter		boolean	Filter for including or excluding participants who are constituents.
Has an eligible email?	email_eligible_filter		boolean	Filter for including or excluding participants based on whether they have a primary email address that's not marked Do not email?
Has an eligible phone?	phone_call_eligible_filter		boolean	Filter for including or excluding participants based on whether they have a primary phone number that's not marked Do not call.
Name	name		string	Filter for participants that match the specified name.
Added on or after	date_added		date-time	Filter the results to participants 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 participants modified on or after the specified date (ex: '2020-09-18T04:13:56Z').

Returns

Participants

Body: EventApi.ApiCollectionOfParticipantListEntry

List events

Operation ID:: ListEvents

Returns a list of events.

Parameters

Name	Key	Type	Description
Category	category	string	Filter based on event category.
Lookup ID	lookup_id	string	A filter for results that match the custom identifier for the event record.
Start date from	start_date_from	date	Filter the results to events with start date on or after the specified date (ex: '2020-09-18').
Start date to	start_date_to	date	Filter the results to events with start date on or before the specified date (ex: '2020-09-18').
Include inactive?	include_inactive	boolean	Include inactive events?
Limit	limit	integer	Represents the number of records to return. The default is 500. The maximum is 10000.
Offset	offset	integer	Represents the number of records to skip. For use with pagination.
Event ID	event_id	string	Filter the events that match the specified system record ID.
Name	name	string	Filter for events that match the specified name.
Added on or after	date_added	date-time	Filter the results to events 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 events modified on or after the specified date (ex: '2020-09-18T04:13:56Z').

Returns

Events

Body: EventApi.ApiCollectionOfEventListEntry

List participant donations

Operation ID:: ListParticipantDonations

Lists the donations for a participant.

Parameters

Name	Key	Required	Type	Description
Participant ID	participant_id	True	string	The system record ID of the participant.
Limit	limit		integer	Represents the number of records to return. The default is 500. The maximum is 10000.
Offset	offset		integer	Represents the number of records to skip. For use with pagination. The default is 0.

Returns

Donations

Body: EventApi.ApiCollectionOfParticipantDonation

List participant fee payments

Operation ID:: ListParticipantFeePayments

Lists the fee payments for a participant.

Parameters

Name	Key	Required	Type	Description
Participant ID	participant_id	True	string	The system record ID of the participant.
Limit	limit		integer	Represents the number of records to return. The default is 500. The maximum is 10000.
Offset	offset		integer	Represents the number of records to skip. For use with pagination. The default is 0.

Returns

Fee payments

Body: EventApi.ApiCollectionOfParticipantFeePayment

List participant fees

Operation ID:: ListParticipantFees

Lists the fees for a participant.

Parameters

Name	Key	Required	Type	Description
Participant ID	participant_id	True	string	The system record ID of the participant.
Limit	limit		integer	Represents the number of records to return. The default is 500. The maximum is 10000.
Offset	offset		integer	Represents the number of records to skip. For use with pagination. The default is 0.

Returns

Fees

Body: EventApi.ApiCollectionOfParticipantFee

List participant options

Operation ID:: ListParticipantOptions

Lists the participant options for a participant.

Parameters

Name	Key	Required	Type	Description
Participant ID	participant_id	True	string	The system record ID of the participant.

Returns

Participant options

Body: EventApi.ApiCollectionOfParticipantOption

Update a participant

Operation ID:: EditParticipant

Updates the details about a participant.

Parameters

Name	Key	Required	Type	Description
Participant ID	participant_id	True	string	The system record ID of the participant to update.
Constituent ID	constituent_id		string	The constituent ID of the participant.
Host ID	host_id		string	The ID of the host's participant record.
RSVP status	rsvp_status		string	The status of the participant's engagement with the event.
Attended?	attended		boolean	Did the participant attend the event?
Invitation status	invitation_status		string	The status of the invitation to the participant.
day	d		integer	The day in the fuzzy date.
month	m		integer	The month in the fuzzy date.
year	y		integer	The year in the fuzzy date.
day	d		integer	The day in the fuzzy date.
month	m		integer	The month in the fuzzy date.
year	y		integer	The year in the fuzzy date.
Participation level	name	True	string	The name of the participation level.
Summary note	summary_note		string	Quick reference information pinned to the participant's record.

Update a participant option

Operation ID:: EditParticipantOption

Updates the details about a participant option.

Parameters

Name	Key	Required	Type	Description
Participant option ID	option_id	True	string	The system record ID of the participant option to update.
Value	option_value	True	string	The participant's response to the option.

Update an event

Operation ID:: EditEvent

Updates the details about an event.

Parameters

Name	Key	Required	Type	Description
Event ID	event_id	True	string	The system record ID of the event to update.
Event name	name		string	The name of the event.
Description	description		string	The description of the event.
Category	name	True	string	The category name.
Start date	start_date		date	The start date of the event (ex: '2020-09-18').
Start time	start_time		string	The start time of the event (ex: '07:30').
End date	end_date		date	The end date of the event (ex: '2020-09-18').
End time	end_time		string	The end time of the event (ex: '07:30').
Lookup ID	lookup_id		string	The lookup ID of the event.
Capacity	capacity		integer	The number of people that can attend the event.
Goal	goal		double	The monetary goal of the event.
Campaign ID	campaign_id		string	The system record ID of the campaign associated with the event.
Fund ID	fund_id		string	The system record ID of the fund associated with the event.
Inactive?	inactive		boolean	Is the event active?

Update an event attachment

Operation ID:: EditEventAttachment

Updates an event attachment.

Parameters

Name	Key	Required	Type	Description
Event ID	event_id	True	string	The system record ID of the event.
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.

Definitions

EventApi.AdministrativeArea

Defines the data model used for an address' administrative area (ex: state in the US).

Name	Path	Type	Description
ID	id	string	The record ID of the administrative area.
name	name	string	The name of the administrative area.
short description	short_description	string	The short description of the administrative area.

EventApi.ApiCollectionOfEventFee

Fees

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 EventApi.EventFee	The set of items included in the response. This may be a subset of the items in the collection.

EventApi.ApiCollectionOfEventListEntry

Events

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 EventApi.EventListEntry	The set of items included in the response. This may be a subset of the items in the collection.

EventApi.ApiCollectionOfEventParticipantOption

Event participant options

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 EventApi.EventParticipantOption	The set of items included in the response. This may be a subset of the items in the collection.

EventApi.ApiCollectionOfParticipantDonation

Donations

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 EventApi.ParticipantDonation	The set of items included in the response. This may be a subset of the items in the collection.

EventApi.ApiCollectionOfParticipantFee

Fees

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 EventApi.ParticipantFee	The set of items included in the response. This may be a subset of the items in the collection.

EventApi.ApiCollectionOfParticipantFeePayment

Fee payments

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 EventApi.ParticipantFeePayment	The set of items included in the response. This may be a subset of the items in the collection.

EventApi.ApiCollectionOfParticipantListEntry

Participants

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 EventApi.ParticipantListEntry	The set of items included in the response. This may be a subset of the items in the collection.

EventApi.ApiCollectionOfParticipantOption

Participant options

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 EventApi.ParticipantOption	The set of items included in the response. This may be a subset of the items in the collection.

EventApi.Country

Defines the data model used for an address' country.

Name	Path	Type	Description
ID	id	string	The ID of the country record.
display name	display_name	string	The display name of the country.
ISO code	iso_alpha2_code	string	The ISO 3166-1 alpha-2 code for the country.

EventApi.CreatedEvent

Created event

Name	Path	Type	Description
ID	id	string	The ID of the newly created event.

EventApi.CreatedEventAttachment

Created event attachment

Name	Path	Type	Description
ID	id	string	The ID of the newly created event attachment.

EventApi.CreatedEventFee

Created event fee

Name	Path	Type	Description
ID	id	string	The ID of the newly created event fee.

EventApi.CreatedEventParticipantOption

Created event participant option

Name	Path	Type	Description
ID	id	string	The ID of the newly created event participant option.

EventApi.CreatedParticipant

Created participant

Name	Path	Type	Description
ID	id	string	The ID of the newly created participant.

EventApi.CreatedParticipantDonation

Created participant donation

Name	Path	Type	Description
ID	id	string	The ID of the newly created participant donation.

EventApi.CreatedParticipantFee

Created participant fee

Name	Path	Type	Description
ID	id	string	The ID of the newly created participant fee.

EventApi.CreatedParticipantFeePayment

Created participant fee payment

Name	Path	Type	Description
ID	id	string	The ID of the newly created participant fee payment.

EventApi.CreatedParticipantOption

Created participant option

Name	Path	Type	Description
ID	id	string	The ID of the newly created participant option.

EventApi.Event

Event

Name	Path	Type	Description
ID	id	string	The system record ID of the event. This is not the same as the user-definable event identifier, which is stored in the lookup_id.
Name	name	string	The name of the event.
Description	description	string	The description of the event.
Start date	start_date	date	The start date of the event.
Start time	start_time	string	The start time of the event.
End date	end_date	date	The end date of the event.
End time	end_time	string	The end time of the event.
Category	category	EventApi.EventCategory	Event category is the custom categorization for the event.
Lookup ID	lookup_id	string	The lookup ID of the event.
Location	location	EventApi.Location	Defines the data model used for a location.
Capacity	capacity	integer	The number of people that can attend the event.
Goal	goal	double	The monetary goal of the event.
Campaign ID	campaign_id	string	The system record ID of the campaign associated with the event.
Fund ID	fund_id	string	The system record ID of the fund associated with the event.
Inactive?	inactive	boolean	Is the event inactive?
Date added	date_added	date-time	The date when the event was created.
Date modified	date_modified	date-time	The date when the event was last modified.

EventApi.EventAttachment

Attachment

Name	Path	Type	Description
ID	id	string	The system record ID of the attachment.
Event ID	parent_id	string	The system record ID of the event 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.

EventApi.EventAttachmentCollection

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 EventApi.EventAttachment	The set of items included in the response. This may be a subset of the items in the collection.

EventApi.EventCategory

Event category is the custom categorization for the event.

Name	Path	Type	Description
ID	id	string	The system record ID of the event category.
name	name	string	The name of the event category.
inactive?	inactive	boolean	Is this category inactive?

EventApi.EventFee

Event fees are how much an organization charges for individuals or organizations to participate in or attend the event.

Name	Path	Type	Description
ID	id	string	The system record ID of the event fee.
name	name	string	The name of the event fee.
amount	cost	double	The fee's cost.
contribution amount	contribution_amount	double	The tax deductible amount for this fee.
number sold	number_sold	integer	The number of fees sold.

EventApi.EventListEntry

Event

Name	Path	Type	Description
ID	id	string	The system record ID of the event.
Name	name	string	The name of the event.
Start date	start_date	date	The start date of the event.
Start time	start_time	string	The start time of the event.
End date	end_date	date	The end date of the event.
End time	end_time	string	The end time of the event.
Category	category	EventApi.EventCategory	Event category is the custom categorization for the event.
Lookup ID	lookup_id	string	The lookup ID of the event.
Capacity	capacity	integer	The number of people that can attend the event.
Attending	attending_count	integer	The number of event participants who plan to attend.
Attended	attended_count	integer	The number of event attendees.
Invited	invited_count	integer	The number of event invitees.
Revenue	revenue	double	The realized revenue of the event.
Goal	goal	double	The monetary goal of the event.
Percent of goal	percent_of_goal	integer	The realized revenue as a percentage of the goal revenue.
Inactive?	inactive	boolean	Is the event inactive?
Date added	date_added	date-time	The date when the event was created.
Date modified	date_modified	date-time	The date when the event was last modified.

EventApi.EventParticipantOption

Event participant options are fields that collects details about participants, such as t-shirt sizes, meal preferences, or seating requests. Set options and their values for an event and then add responses for each participant.

Name	Path	Type	Description
ID	id	string	The system record ID of the event participant option.
name	name	string	The name of the event participant option.
input type	input_type	string	The type of the event participant option.
allow multi-select?	multi_select	boolean	Allow more than one value for lists?
list_options	list_options	array of EventApi.EventParticipantOptionListOption	The available list options.
added by user	added_by_user	string	The ID of the user that added the option.
modified by user	updated_by_user	string	The ID of the user who modified the option.
added by service	added_by_service	string	The name of the service that added this option.
modified by service	updated_by_service	string	The name of the service that modified this option.
date added	date_added	date-time	The date when the option was created.
date modified	date_updated	date-time	The date when the option was last modified.
version	version	integer	The version number of the option.

EventApi.EventParticipantOptionListOption

A event participant option list option

Name	Path	Type	Description
ID	id	string	The ID of the list option
name	name	string	The name of the list option
sequence	sequence	integer	The sequence used to order the list options

EventApi.Locality

Defines the data model used for an address' locality.

Name	Path	Type	Description
ID	id	string	The record ID of the locality record.
name	name	string	The name of the locality.

EventApi.Location

Defines the data model used for a location.

Name	Path	Type	Description
name	name	string	The name of the location.
address lines	address_lines	string	The location's address lines.
postal code	postal_code	string	The location's postal code.
locality	locality	EventApi.Locality	Defines the data model used for an address' locality.
administrative area	administrative_area	EventApi.AdministrativeArea	Defines the data model used for an address' administrative area (ex: state in the US).
sub-administrative area	sub_administrative_area	EventApi.SubAdministrativeArea	Defines the data model used for an address' sub-administrative area (ex: city in the US).
country	country	EventApi.Country	Defines the data model used for an address' country.
formatted address	formatted_address	string	The location's formatted address

EventApi.Membership

Membership information for the participant.

Name	Path	Type	Description
Membership category	category	EventApi.MembershipCategory	The individual's membership category.

EventApi.MembershipCategory

The individual's membership category.

Name	Path	Type	Description
ID	id	string	The system record ID of the membership category.
name	name	string	The name of the membership category.

EventApi.Participant

Participant

Name	Path	Type	Description
ID	id	string	The system record ID of the participant.
Constituent ID	constituent_id	string	The constituent ID of the participant.
Event ID	event_id	string	The system record ID of the event being attended.
Host ID	host_id	string	The ID of the host's participant record.
RSVP status	rsvp_status	string	The status of the participant's engagement with the event.
Attended?	attended	boolean	Did the participant attend the event?
Invitation status	invitation_status	string	The status of the invitation to the participant.
day	rsvp_date.d	integer	The day in the fuzzy date.
month	rsvp_date.m	integer	The month in the fuzzy date.
year	rsvp_date.y	integer	The year in the fuzzy date.
day	invitation_date.d	integer	The day in the fuzzy date.
month	invitation_date.m	integer	The month in the fuzzy date.
year	invitation_date.y	integer	The year in the fuzzy date.
Summary note	summary_note	string	Quick reference information pinned to the participant's record.
Participation level	participation_level	EventApi.ParticipationLevel	Participation levels are the level of involvement participants have in an event.
Date added	date_added	date-time	The date when the participant was created.
Date modified	date_modified	date-time	The date when the participant was last modified.

EventApi.ParticipantDonation

Defines a data model for a participant donation

Name	Path	Type	Description
ID	id	string	The system record ID of the participant donation.
gift ID	gift_id	string	The system record ID of the gift to which the participant donation is linked.

EventApi.ParticipantFee

Defines a data model for a participant fee

Name	Path	Type	Description
ID	id	string	The ID of the participant fee.
participant ID	participant_id	string	The ID of the record that the participant fee is linked to.
quantity	quantity	integer	The quantity purchased.
fee amount	fee_amount	double	The amount of the participant fee.
contribution amount	tax_receiptable_amount	double	The tax deductible amount for this fee.
day	date.d	integer	The day in the fuzzy date.
month	date.m	integer	The month in the fuzzy date.
year	date.y	integer	The year in the fuzzy date.
Event fee	event_fee	EventApi.EventFee	Event fees are how much an organization charges for individuals or organizations to participate in or attend the event.

EventApi.ParticipantFeePayment

Defines a data model for a participant fee payment

Name	Path	Type	Description
ID	id	string	The system record ID of the participant fee payment.
participant ID	participant_id	string	The system record ID of the participant to which the participant fee payment is linked.
gift ID	gift_id	string	The system record ID of the gift to which the participant fee payment is linked.
applied amount	applied_amount	double	The applied amount of the participant fee payment.

EventApi.ParticipantListEntry

Participant

Name	Path	Type	Description
ID	id	string	The system record ID of the participant.
Contact ID	contact_id	string	The ID of the contact attending the event.
RSVP status	rsvp_status	string	The status of the participant's engagement with the event.
Attended?	attended	boolean	Did the participant attend the event?
Invitation status	invitation_status	string	The status of the invitation to the participant.
day	rsvp_date.d	integer	The day in the fuzzy date.
month	rsvp_date.m	integer	The month in the fuzzy date.
year	rsvp_date.y	integer	The year in the fuzzy date.
Participation level	participation_level	EventApi.ParticipationLevel	Participation levels are the level of involvement participants have in an event.
Title	title	string	The participant's title.
First name	first_name	string	The participant's first name.
Last name	last_name	string	The participant's last name.
Name	name	string	The participant's full name.
Preferred name	preferred_name	string	The participant's preferred name.
Suffix	suffix	string	The participant's suffix.
Lookup ID	lookup_id	string	The LookupId of the participant.
Email	email	string	The participant's email address.
Do not email?	do_not_email	boolean	Can the participant be contacted at this email address?
Phone	phone	string	The participant's phone number.
Do not call?	do_not_call	boolean	Can the participant be contacted at this number?
Middle name	middle_name	string	The participant's middle name.
Former name	former_name	string	The participant's former name.
Is a constituent?	is_constituent	boolean	Is the participant a constituent?
Class of	class_of	string	The participant's graduating class.
Total registration fees	total_registration_fees	double	The sum of the participant's fee amounts.
Total paid	total_paid	double	The sum of the participant's paid gifts with a type of Registration Fees.
Donations	donations	double	The sum of the participant's paid gifts with a type of Donations.
Revenue	revenue	double	The sum of the participant's paid gifts across all types.
Seat	seat	string	The seat assignment for the participant.
Name tag	name_tag	string	The name tag for the participant
Summary note	summary_note	string	Quick reference information pinned to the participant's record.
Date added	date_added	date-time	The date when the participant was created.
Date modified	date_modified	date-time	The date when the participant was last modified.
contact ID	host.contact_id	string	The ID of the contact attending the event.
participant ID	host.participant_id	string	The ID of the participant.
name	host.name	string	The participant's full name.
guests	guests	array of EventApi.ParticipantListParticipantSummary	The guests of the participant.
memberships	memberships	array of EventApi.Membership	The membership information for the participant.

EventApi.ParticipantListParticipantSummary

The participant's basic summary information.

Name	Path	Type	Description
contact ID	contact_id	string	The ID of the contact attending the event.
participant ID	participant_id	string	The ID of the participant.
name	name	string	The participant's full name.

EventApi.ParticipantOption

The participant option associated with a given participant

Name	Path	Type	Description
ID	id	string	The system record ID of the participant option.
participant ID	participant_id	string	The system record ID of the participant.
event ID	event_id	string	The system record ID of the event.
event participant option ID	event_participant_option_id	string	The system record ID of the event participant option.
value	option_value	string	The participant's response to the option.
added by user	added_by_user	string	The ID of the user that added the participant option.
modified by user	updated_by_user	string	The ID of the user who modified the participant option.
added by service	added_by_service	string	The name of the service that added this participant option.
modified by service	updated_by_service	string	The name of the service that modified this participant option.
date added	date_added	date-time	The date when the participant option was created.
date modified	date_updated	date-time	The date when the participant option was last modified.

EventApi.ParticipationLevel

Participation levels are the level of involvement participants have in an event.

Name	Path	Type	Description
ID	id	string	The system record ID of the participation level.
name	name	string	The name of the participation level.
inactive?	is_inactive	boolean	Is the participation level inactive?

EventApi.SubAdministrativeArea

Defines the data model used for an address' sub-administrative area (ex: city in the US).

Name	Path	Type	Description
ID	id	string	The ID of the sub-administrative area.
name	name	string	The name of the sub-administrative area.

Поделиться через

Blackbaud Raisers Edge NXT Events

Prerequisites

How to get credentials?

Known issues and limitations

Throttling Limits

Actions

Create a participant

Parameters

Returns

Create a participant donation

Parameters

Returns

Create a participant fee

Parameters

Returns

Create a participant fee payment

Parameters

Returns

Create a participant option

Parameters

Returns

Create an event

Parameters

Returns

Create an event attachment

Parameters

Returns

Create an event fee

Parameters

Returns

Create an event participant option

Parameters

Returns

Get a participant

Parameters

Returns

Get an event

Parameters

Returns

List event attachments

Parameters

Returns

List event fees

Parameters

Returns

List event participant options

Parameters

Returns

List event participants

Parameters

Returns

List events

Parameters

Returns

List participant donations

Parameters

Returns

List participant fee payments

Parameters

Returns

List participant fees

Parameters

Returns

List participant options

Parameters

Returns

Update a participant

Parameters

Update a participant option

Parameters

Update an event

Parameters

Update an event attachment

Parameters

Definitions

EventApi.AdministrativeArea

EventApi.ApiCollectionOfEventFee

EventApi.ApiCollectionOfEventListEntry

EventApi.ApiCollectionOfEventParticipantOption