Blackbaud Raisers Edge NXT Constituents

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 Constituents connector to manage constituent biographical details, contact information, and relationships.

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

• Constituents
• Addresses
• Phones and emails
• Aliases
• Custom fields
• Notes
• Attachments
• Relationships
• 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

Convert to constituent	Converts a non-constituent to a constituent.
Create a constituent address	Creates a new constituent address.
Create a constituent alias	Creates a new constituent alias.
Create a constituent attachment	Creates a new constituent attachment.
Create a constituent code	Creates a new constituent code.
Create a constituent consent record	Creates a new constituent consent record.
Create a constituent custom field	Creates a new constituent custom field.
Create a constituent education	Creates a new constituent education.
Create a constituent email address	Creates a new constituent email address.
Create a constituent name format	Creates a new constituent name format.
Create a constituent note	Creates a new constituent note.
Create a constituent online presence	Creates a new constituent online presence.
Create a constituent phone	Creates a new constituent phone.
Create a constituent primary name format	Creates a primary name format for a constituent.
Create a constituent solicit code	Creates a new constituent solicit code.
Create a constituent tribute	Creates a new constituent tribute.
Create a fundraiser assignment	Creates a new fundraiser assignment.
Create a tribute acknowledgee	Creates a new tribute acknowledgee.
Create an individual constituent	Creates a new individual constituent.
Create an individual relationship	Creates a new individual relationship. If the relationship is with another constituent, a reciprocal relationship is created for that constituent.
Create an organization constituent	Creates a new organization constituent.
Create an organization relationship	Creates a new organization relationship. If the relationship is with another constituent, a reciprocal relationship is created for that constituent.
Delete a constituent code	Deletes a constituent code.
Get a constituent	Returns information about a constituent.
Get a constituent by lookup ID	Returns a constituent's system record ID from the specified lookup ID.
Get a constituent profile picture	Returns the current profile picture for a constituent.
Get a constituent tribute	Returns details about a constituent tribute.
Get constituent name format summary	Returns the name format summary for a constituent.
List constituent addresses	Lists the addresses for a constituent.
List constituent aliases	Lists the aliases for a constituent.
List constituent attachments	Lists the attachments for a constituent.
List constituent codes	Lists the constituent codes for a constituent.
List constituent consent records	Lists the consent records for a constituent.
List constituent custom fields	Lists the custom fields for a constituent.
List constituent educations	Lists the education records for a constituent.
List constituent email addresses	Lists the email addresses for a constituent.
List constituent fundraisers	Lists the fundraiser assignments for a constituent.
List constituent memberships	Lists the memberships for a constituent.
List constituent notes	Lists the notes for a constituent.
List constituent online presences	Lists the online presences for a constituent.
List constituent phones	Lists the phones for a constituent.
List constituent relationships	Lists the relationships for a constituent.
List constituent solicit codes	Lists the solicit codes for a constituent.
List constituent tributes	Lists the tributes for a constituent.
List constituents	Returns a list of constituents.
List fundraiser assignments	List the assignments for a fundraiser.
List tribute acknowledgees	Lists the acknowledgees for a tribute.
Search for a constituent	Performs a constituent search based on the provided search text. Supports first name, last name, preferred name, former name, alias, email address, phone number, address, or lookup ID. Name combinations such as first name and last name or preferred name and last name are valid, but otherwise search only supports one parameter at a time. By default, searches include results that sound similar to your criteria. For example, searches for "Smith" include matches for "Smyth" and other alternative spellings. This search does not support wildcard characters such as * or ?. Search results are limited to 500 records.
Search for a constituent (enhanced)	Searches for constituent records using the given filter criteria.
Search for duplicate constituents	Searches individual, organization, and related contact records and ranks potential duplicates based on the specified search filters. Records that match multiple filters rank higher as potential duplicates.
Update a constituent	Updates a constituent.
Update a constituent address	Updates a constituent address.
Update a constituent alias	Updates an constituent alias.
Update a constituent attachment	Updates a constituent attachment.
Update a constituent code	Updates a constituent code.
Update a constituent custom field	Updates a constituent custom field.
Update a constituent education	Updates a constituent education.
Update a constituent email address	Updates a constituent email address.
Update a constituent name format	Updates a constituent name format.
Update a constituent note	Updates a constituent note.
Update a constituent online presence	Updates a constituent online presence.
Update a constituent phone	Updates a constituent phone.
Update a constituent primary name format	Updates the primary name format for a constituent.
Update a constituent profile picture	Updates the current profile picture for a constituent.
Update a constituent relationship	Updates a relationship for a constituent. If a reciprocal relationship exists, it is also modified to reflect the changes. This does not include changes to the "comments" property, which is specific to each record and can be modified independently on each record.
Update a constituent solicit code	Updates a constituent solicit code.

Convert to constituent

Operation ID:

ConvertToConstituent

Converts a non-constituent to a constituent.

Parameters

Name	Key	Required	Type	Description
Non-constituent ID	non_constituent_id	True	string	The system record ID of the non-constituent record to convert.
ID	id		string	The system record ID of the constituent code.
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.
sequence	sequence		integer	The sequence of the constituent code.

Returns

Converted constituent

Body

ConstituentApi.ConvertedConstituent

Create a constituent address

Operation ID:

CreateConstituentAddress

Creates a new constituent address.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent associated with the address.
Address type	type	True	string	The address type.
Country	country		string	The country of the address (can be the ID, name, or abbreviation).
Address lines	address_lines		string	The address lines.
City	city		string	The city of the address (do not use in combination with the Suburb field).
State	state		string	The state of the address.
Postal code	postal_code		string	The postal code of the address.
Suburb	suburb		string	The suburb of the address (do not use in combination with the City field).
County	county		string	The county of the address.
Information source	information_source		string	The information source for the address.
Region	region		string	The region for the address.
CART	cart		string	The carrier route (CART) for the address.
LOT	lot		string	The line of travel (LOT) for the address.
DPC	dpc		string	The delivery point code (DPC) for the address.
Valid from	start		date	The date when the constituent began residing at this address (ex: '2005-09-18').
Valid to	end		date	The date when the constituent ceased to reside at this address (ex: '2005-09-18').
Primary?	preferred		boolean	Is this the constituent's preferred address?
Do not mail?	do_not_mail		boolean	Can the constituent be contacted at this address?
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.

Returns

Created constituent address

Body

ConstituentApi.CreatedConstituentAddress

Create a constituent alias

Operation ID:

CreateConstituentAlias

Creates a new constituent alias.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent associated with the alias.
Alias	name	True	string	The name to use as the constituent's alias. Character limit: 100.
Type	type		string	The alias type.

Returns

Created constituent alias

Body

ConstituentApi.CreatedConstituentAlias

Create a constituent attachment

Operation ID:

CreateConstituentAttachment

Creates a new constituent attachment.

Parameters

Name	Key	Required	Type	Description
Constituent ID	parent_id	True	string	The system record ID of the constituent 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 constituent attachment

Body

ConstituentApi.CreatedConstituentAttachment

Create a constituent code

Operation ID:

CreateConstituentCode

Creates a new constituent code.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent associated with the constituent code.
Constituent code	description	True	string	The constituent code.
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.
Sequence	sequence		integer	The numeric sequence associated with the constituent code.

Returns

Created constituent code

Body

ConstituentApi.CreatedConstituentCode

Create a constituent consent record

Operation ID:

CreateConstituentConsent

Creates a new constituent consent record.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent associated with the consent record.
Channel	channel	True	string	The channel that the consent response applies to.
Category	category		string	The category that the consent response applies to.
Source	source		string	The source of the consent response from the constituent.
Response	constituent_consent_response	True	string	How the constituent responded to consent for the specified channel/category.
Date	consent_date	True	date-time	The date the consent response was received (ex: '2020-09-18T04:13:56Z').
Consent statement	consent_statement		string	The statement the constituent responded to when providing consent.
Privacy notice	privacy_notice		string	The privacy notice provided to the constituent.

Returns

Created constituent consent

Body

CommPrefApi.CreatedConstituentConsent

Create a constituent custom field

Operation ID:

CreateConstituentCustomField

Creates a new constituent custom field.

Parameters

Name	Key	Required	Type	Description
body	body	True	dynamic	An object that represents the custom field to create.

Returns

Created constituent custom field

Body

ConstituentApi.CreatedConstituentCustomField

Create a constituent education

Operation ID:

CreateConstituentEducation

Creates a new constituent education.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent associated with the education.
School	school	True	string	The school/establishment name.
Type	type		string	The type of education.
Class of	class_of		string	The year the constituent graduated.
Status	status		string	The status of the education.
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.
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.
Degree	degree		string	The degree received.
GPA	gpa		double	The grade point average.
Subject of study	subject_of_study		string	The subject of study.
Primary?	primary		boolean	Is this the constituent's primary school association?
Majors	majors		array of string	The major courses of study.
Minors	minors		array of string	The minor courses of study.
Campus	campus		string	The campus. Character limit: 50.
Social organization	social_organization		string	The social organization. Character limit: 50.
Known name	known_name		string	The known name. Character limit: 50.
Class of degree	class_of_degree		string	The class of degree (only applicable for UK versions).
Department	department		string	The name of the education department (only applicable for UK versions).
Faculty	faculty		string	The name of the faculty (only applicable for UK versions).
Registration number	registration_number		string	The registration number (only applicable for UK versions). Character limit: 50.

Returns

Created constituent education

Body

ConstituentApi.CreatedConstituentEducation

Create a constituent email address

Operation ID:

CreateConstituentEmailAddress

Creates a new constituent email address.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent associated with the email address.
Email type	type	True	string	The type of email address.
Email address	address	True	string	The email address.
Primary?	primary		boolean	Is this the constituent's primary email address?
Do not email?	do_not_email		boolean	Can the constituent be contacted at this email address?
Inactive?	inactive		boolean	Is this email address inactive?

Returns

Created constituent email address

Body

ConstituentApi.CreatedConstituentEmailAddress

Create a constituent name format

Operation ID:

CreateConstituentNameFormat

Creates a new constituent name format.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent.
Type	type	True	string	The name format type.
Custom name format?	custom_format		boolean	Is a custom format?
Format	configuration_id		string	Name format configuration (required unless a custom format is used).
Custom name	formatted_name		string	Formatted name (required when a custom format is used). Character limit: 255.

Returns

Created name format

Body

ConstituentApi.CreatedNameFormat

Create a constituent note

Operation ID:

CreateConstituentNote

Creates a new constituent note.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent associated with the note.
Type	type	True	string	The note type.
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.
Summary	summary		string	The note summary. Character limit: 50.
Note	text		string	The note text.
Author	author		string	The note author. If not supplied, will have a default set based on the user's account. Character limit: 50.

Returns

Created constituent note

Body

ConstituentApi.CreatedConstituentNote

Create a constituent online presence

Operation ID:

CreateConstituentOnlinePresence

Creates a new constituent online presence.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent associated with the online presence.
Type	type	True	string	The online presence type.
Link	address	True	string	The web address for the online presence.
Primary?	primary		boolean	Is this the constituent's primary online presence?
Inactive?	inactive		boolean	Is this online presence inactive?

Returns

Created constituent online presence

Body

ConstituentApi.CreatedConstituentOnlinePresence

Create a constituent phone

Operation ID:

CreateConstituentPhone

Creates a new constituent phone.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent associated with the phone.
Type	type	True	string	The phone type.
Number	number	True	string	The phone number.
Primary?	primary		boolean	Is this the constituent's primary phone?
Do not call?	do_not_call		boolean	Can the constituent be contacted at this number?
Inactive?	inactive		boolean	Is this phone number inactive?

Returns

Created constituent phone

Body

ConstituentApi.CreatedConstituentPhone

Create a constituent primary name format

Operation ID:

CreateConstituentPrimaryNameFormat

Creates a primary name format for a constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent.
Type	primary_type	True	string	The primary name format type.
Custom name format?	custom_format		boolean	Is a custom format?
Format	configuration_id		string	Name format configuration (required unless a custom format is used).
Custom name	formatted_name		string	Formatted name (required when a custom format is used). Character limit: 255.

Returns

Created name format

Body

ConstituentApi.CreatedNameFormat

Create a constituent solicit code

Operation ID:

CreateConstituentSolicitCode

Creates a new constituent solicit code.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent associated with the solicit code.
Solicit code	solicit_code	True	string	Communication instructions and/or restrictions for a constituent.
Start date	start_date		date	The start date of the solicit code (ex: '2005-09-18').
End date	end_date		date	The end date of the solicit code (ex: '2005-09-18').

Returns

Created constituent solicit code

Body

CommPrefApi.CreatedConstituentSolicitCode

Create a constituent tribute

Operation ID:

CreateConstituentTribute

Creates a new constituent tribute.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_record_id	True	integer	The system record ID of the constituent associated with the tribute.
Tribute type	tribute_type_id	True	integer	The tribute type.
Description	description		string	The tribute description.
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.
Default fund ID	default_fund_id		integer	The system record ID of the default fund associated with the tribute.
Notes	notes		string	The tribute notes.
Active?	is_active		boolean	Is this tribute active?

Returns

Created constituent tribute

Body

NXTDataIntegrationApi.CreatedConstituentTribute

Create a fundraiser assignment

Operation ID:

CreateFundraiserAssignment

Creates a new fundraiser assignment.

Parameters

Name	Key	Required	Type	Description
Fundraiser ID	fundraiser_id	True	string	The system record ID of the fundraiser.
Constituent ID	constituent_id	True	string	The system record ID of the assigned constituent.
Type	type		string	The type of fundraiser.
Assignment starts	start		date-time	The start date of the assignment (ex: '2020-09-18T04:13:56Z').
Assignment ends	end		date-time	The end date of the assignment (ex: '2020-09-18T04:13:56Z').
Amount	value	True	double	The goal amount for the fundraiser to solicit from the assigned constituent.
Campaign ID	campaign_id		string	The system record ID of the campaign to which which resulting gifts will be applied.
Fund ID	fund_id		string	The system record ID of the fund to which which resulting gifts will be applied.
Appeal ID	appeal_id		string	The system record ID of the appeal to which which resulting gifts will be applied.

Returns

Created fundraiser assignment

Body

FundraisingApi.CreatedFundraiserAssignment

Create a tribute acknowledgee

Operation ID:

CreateTributeAcknowledgee

Creates a new tribute acknowledgee.

Parameters

Name	Key	Required	Type	Description
Tribute ID	tribute_id	True	integer	The system record ID of the tribute associated with the acknowledgee.
Relationship ID	relationship_id		integer	The system record ID of the relationship (if null, this represents a self-acknowledgee).
Letter ID	letter_id		integer	The letter ID.

Returns

Created tribute acknowledgee

Body

NXTDataIntegrationApi.CreatedTributeAcknowledgee

Create an individual constituent

Operation ID:

CreateIndividualConstituent

Creates a new individual constituent.

Parameters

Name	Key	Required	Type	Description
Title	title		string	The constituent's primary title.
First name	first		string	The constituent's first name. Character limit: 50.
Last name	last	True	string	The constituent's last name. Character limit: 100.
Suffix	suffix		string	The constituent's primary suffix.
Lookup ID	lookup_id		string	The user-defined identifier for the constituent.
type	type	True	string	The address type.
country	country		string	The country of the address (can be the ID, name, or abbreviation).
lines	address_lines		string	The address lines. Character limit: 150.
city	city		string	The city of the address (do not use in combination with the Suburb field).
state	state		string	The state of the address.
postal code	postal_code		string	The postal code of the address. Character limit: 12.
suburb	suburb		string	The suburb of the address (do not use in combination with the City field).
county	county		string	The county of the address.
start	start		date	The date when the constituent began residing at this address (ex: '2005-09-18').
end	end		date	The date when the constituent ceased to reside at this address (ex: '2005-09-18').
type	type	True	string	The phone type.
number	number	True	string	The phone number.
is primary?	primary		boolean	Is this the constituent's primary phone number?
type	type	True	string	The type of email address.
address	address	True	string	The email address.
is primary?	primary		boolean	Is this the constituent's primary email address?
type	type	True	string	The online presence type.
address	address	True	string	The web address for the online presence.
is primary?	primary		boolean	Is this the constituent's primary online presence?
Preferred name	preferred_name		string	The constituent's preferred name. Character limit: 50.
Middle name	middle		string	The constituent's middle name. Character limit: 50.
Former name	former_name		string	The constituent's former name. Character limit: 100.
Title 2	title_2		string	The constituent's secondary title.
Suffix 2	suffix_2		string	The constituent's secondary suffix.
Gender	gender		string	The constituent's gender.
Marital status	marital_status		string	The constituent's marital status.
Gives anonymously?	gives_anonymously		boolean	Does the constituent give anonymously?
Requests no email?	requests_no_email		boolean	Does the constituent request no email?
Is a solicitor?	is_solicitor		boolean	Is the constituent a solicitor?
No valid addresses?	no_valid_address		boolean	Does the constituent have no valid addresses?
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.
Birthplace	birthplace		string	The birthplace of the constituent.
Ethnicity	ethnicity		string	The ethnicity of the constituent.
Target	target		string	The target of the constituent.
Income	income		string	The income for the constituent.
Receipt type	receipt_type		string	The receipt type of the constituent.
Religion	religion		string	The religion of the constituent.
Custom addressee?	custom_format		boolean	Is the primary addressee a custom format?
Addressee format	configuration_id		string	Primary addressee configuration (required unless a custom format is used).
Addressee custom name	formatted_name		string	Primary addressee formatted name (required when a custom format is used). Character limit: 255.
Custom salutation?	custom_format		boolean	Is the primary salutation a custom format?
Salutation format	configuration_id		string	Primary salutation configuration (required unless a custom format is used).
Salutation custom name	formatted_name		string	Primary salutation formatted name (required when a custom format is used). Character limit: 255.
Is memorial?	is_memorial		boolean	Is the constituent an honor/memorial?

Returns

Created individual constituent

Body

ConstituentApi.CreatedIndividualConstituent

Create an individual relationship

Operation ID:

CreateIndividualRelationship

Creates a new individual relationship. If the relationship is with another constituent, a reciprocal relationship is created for that constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent associated with the relationship.
Relation ID	relation_id	True	string	The system record ID of the related individual.
Type	type		string	The type of relation that the relationship represents.
Reciprocal type	reciprocal_type		string	Describes the constituent's relationship to the related constituent. For example, in a relationship between a male constituent and a female sibling, the reciprocal relationship type would be brother.
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.
Is spouse?	is_spouse		boolean	Is the related individual the constituent's spouse?
Is constituent head of household?	is_constituent_head_of_household		boolean	Is the constituent the head of the household?
Is spouse head of household?	is_spouse_head_of_household		boolean	Is the spouse the head of the household?
Notes	comment		string	Additional notes about the relationship.

Returns

Created individual relationship

Body

ConstituentApi.CreatedIndividualRelationship

Create an organization constituent

Operation ID:

CreateOrganizationConstituent

Creates a new organization constituent.

Parameters

Name	Key	Required	Type	Description
Name	name	True	string	The organization name. Character limit: 100.
Lookup ID	lookup_id		string	The user-defined identifier for the constituent.
type	type	True	string	The address type.
country	country		string	The country of the address (can be the ID, name, or abbreviation).
lines	address_lines		string	The address lines. Character limit: 150.
city	city		string	The city of the address (do not use in combination with the Suburb field).
state	state		string	The state of the address.
postal code	postal_code		string	The postal code of the address. Character limit: 12.
suburb	suburb		string	The suburb of the address (do not use in combination with the City field).
county	county		string	The county of the address.
start	start		date	The date when the constituent began residing at this address (ex: '2005-09-18').
end	end		date	The date when the constituent ceased to reside at this address (ex: '2005-09-18').
type	type	True	string	The phone type.
number	number	True	string	The phone number.
is primary?	primary		boolean	Is this the constituent's primary phone number?
type	type	True	string	The type of email address.
address	address	True	string	The email address.
is primary?	primary		boolean	Is this the constituent's primary email address?
type	type	True	string	The online presence type.
address	address	True	string	The web address for the online presence.
is primary?	primary		boolean	Is this the constituent's primary online presence?
Gives anonymously?	gives_anonymously		boolean	Does the constituent give anonymously?
Requests no email?	requests_no_email		boolean	Does the constituent request no email?
Is a solicitor?	is_solicitor		boolean	Is the constituent a solicitor?
No valid addresses?	no_valid_address		boolean	Does the constituent have no valid addresses?
Target	target		string	The target of the constituent.
Income	income		string	The income for the constituent.
Receipt type	receipt_type		string	The receipt type of the constituent.
Industry	industry		string	The industry of the constituent.
Number of employees	num_employees		integer	The number of employees at the organization.
Matches gifts?	matches_gifts		boolean	Does the organization match gifts?
Matching gift factor	matching_gift_factor		double	The matching gift factor.
Min match per gift	value		double	The minimum match amount per gift for the constituent.
Max match per gift	value		double	The maximum match amount per gift for the constituent.
Min match per constit	value		double	The minimum match total for the constituent.
Max match per constit	value		double	The maximum match total for the constituent.
Matching gift notes	matching_gift_notes		string	The matching gift notes for the constituent.
Is memorial?	is_memorial		boolean	Is the constituent an honor/memorial?

Returns

Created organization constituent

Body

ConstituentApi.CreatedOrganizationConstituent

Create an organization relationship

Operation ID:

CreateOrganizationRelationship

Creates a new organization relationship. If the relationship is with another constituent, a reciprocal relationship is created for that constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent associated with the relationship.
Relation ID	relation_id	True	string	The system record ID of the related organization.
Type	type		string	The type of relation that the relationship represents.
Reciprocal type	reciprocal_type		string	Describes the constituent's relationship to the related organization.
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.
Is contact?	is_organization_contact		boolean	Does the constituent represent this organization as a contact?
Contact type	organization_contact_type		string	Provides context for interactions with the related individual who represents the organization as a contact.
Position	position		string	The individual's position in the organization. Character limit: 50.
Is primary business?	is_primary_business		boolean	Is this the constituent's primary business?
Notes	comment		string	Additional notes about the relationship.

Returns

Created organization relationship

Body

ConstituentApi.CreatedOrganizationRelationship

Delete a constituent code

Operation ID:

DeleteConstituentCode

Deletes a constituent code.

Parameters

Name	Key	Required	Type	Description
Constituent code ID	constituent_code_id	True	string	The system record ID of the constituent code to delete.

Get a constituent

Operation ID:

GetConstituent

Returns information about a constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent to get.

Returns

Constituent

Body

ConstituentApi.ConstituentRead

Get a constituent by lookup ID

Operation ID:

GetConstituentIdFromLookupId

Returns a constituent's system record ID from the specified lookup ID.

Parameters

Name	Key	Required	Type	Description
Lookup ID	constituent_id	True	string	The constituent lookup ID.

Returns

Constituent ID map

Body

NXTDataIntegrationApi.ConstituentIdMap

Get a constituent profile picture

Operation ID:

GetConstituentProfilePicture

Returns the current profile picture 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 profile picture is to be retrieved.

Returns

Profile picture

Body

ConstituentApi.ProfilePictureRead

Get a constituent tribute

Operation ID:

GetConstituentTribute

Returns details about a constituent tribute.

Parameters

Name	Key	Required	Type	Description
Tribute ID	tribute_id	True	string	The tribute ID.

Returns

Tribute

Body

NXTDataIntegrationApi.Tribute

Get constituent name format summary

Operation ID:

GetConstituentNameFormatSummary

Returns the name format summary for a constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent.

Returns

Name format summary

Body

ConstituentApi.NameFormatSummaryRead

List constituent addresses

Operation ID:

ListConstituentAddresses

Lists the addresses 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 addresses?

Returns

Addresses

Body

ConstituentApi.ApiCollectionOfAddressRead

List constituent aliases

Operation ID:

ListConstituentAliases

Lists the aliases for a constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent.

Returns

Aliases

Body

ConstituentApi.ApiCollectionOfAliasRead

List constituent attachments

Operation ID:

ListConstituentAttachments

Lists the attachments for a constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent.

Returns

Attachments

Body

ConstituentApi.ApiCollectionOfConstituentAttachmentRead

List constituent codes

Operation ID:

ListConstituentCodes

Lists the constituent codes for a constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent.

Returns

Constituent codes

Body

ConstituentApi.ApiCollectionOfConstituentCodeRead

List constituent consent records

Operation ID:

ListConstituentConsents

Lists the consent records for a constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent.
Most recent only?	most_recent_only		boolean	Include only the most recent consent records for each channel category combination in the response?

Returns

Consent records

Body

CommPrefApi.ConstituentConsentReadCollection

List constituent custom fields

Operation ID:

ListConstituentCustomFields

Lists the custom fields for a constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent.

Returns

Custom fields

Body

ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

List constituent educations

Operation ID:

ListConstituentEducations

Lists the education records for a constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent.

Returns

Educations

Body

ConstituentApi.ApiCollectionOfEducationRead

List constituent email addresses

Operation ID:

ListConstituentEmailAddresses

Lists the email addresses 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 email addresses?

Returns

Email addresses

Body

ConstituentApi.ApiCollectionOfEmailAddressRead

List constituent fundraisers

Operation ID:

ListConstituentFundraiserAssignments

Lists the fundraiser assignments 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 fundraiser assignments?

Returns

Fundraiser assignments

Body

ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

List constituent memberships

Operation ID:

ListConstituentMemberships

Lists the memberships for a constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent.

Returns

Memberships

Body

ConstituentApi.ApiCollectionOfMembershipRead

List constituent notes

Operation ID:

ListConstituentNotes

Lists the notes for a constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent.

Returns

Notes

Body

ConstituentApi.ApiCollectionOfNoteRead

List constituent online presences

Operation ID:

ListConstituentOnlinePresences

Lists the online presences 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 online presences?

Returns

Online presences

Body

ConstituentApi.ApiCollectionOfOnlinePresenceRead

List constituent phones

Operation ID:

ListConstituentPhones

Lists the phones 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 phones?

Returns

Phones

Body

ConstituentApi.ApiCollectionOfPhoneRead

List constituent relationships

Operation ID:

ListConstituentRelationships

Lists the relationships for a constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent.
Limit	limit		integer	Represents the number of records to return. The default is 500. There is no maximum.
Offset	offset		integer	Represents the number of records to skip. For use with pagination.

Returns

Relationships

Body

ConstituentApi.ApiCollectionOfRelationshipRead

List constituent solicit codes

Operation ID:

ListConstituentSolicitCodes

Lists the solicit codes for a constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent.

Returns

Solicit codes

Body

CommPrefApi.ConstituentSolicitCodeReadCollection

List constituent tributes

Operation ID:

ListConstituentTributes

Lists the tributes for a constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituentId	True	integer	The system record ID of the constituent.

Returns

Tributes

Body

NXTDataIntegrationApi.TributeCollection

List constituents

Operation ID:

ListConstituents

Returns a list of constituents.

Parameters

Name	Key	Required	Type	Description
List	list_id		string	Defines a list identifier used to filter the set of constituents to those included in the specified list. If this value is set, other specified filters will be ignored.
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.
Constituent code	constituent_code		string	Represents a constituent code to filter the list. For example, "Board Member" returns only constituents with a Board Member constituent code.
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 constituent 280 or constituent 1232.
Custom field category	custom_field_category		string	Represents a custom field category to filter the results. For example, "Anniversary" returns only constituents with an active Anniversary custom field.
Fundraiser status	fundraiser_status		string	Represents a comma-separated list of fundraiser statuses to filter the results. For example, "Active,None" returns only constituents whose fundraiser status is Active or None. Valid values for this filter are Active, Inactive, and None.
Include deceased?	include_deceased		boolean	Include deceased constituents in the response?
Include inactive?	include_inactive		boolean	Include inactive constituents in the response?
Postal code	postal_code		string	Represents a comma-separated list of postal codes to filter the results. For example, "29466,29492" returns only constituents whose preferred address has a postal code that starts with 29466 or 29492, such as 29466, 29492, or 29492-0727.
Added on or after	date_added		date-time	Filter the results to constituents 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 constituents modified on or after the specified date (ex: '2020-09-18T04:13:56Z').
Sorted by	sort		string	Represents a list of fields to sort the results by. Results are in ascending order by default, and a '-' sign denotes descending order. For example, "date_added,-last" sorts constituents by the "date_added" field in ascending order and then by the "last" field in descending order.

Returns

Constituents

Body

ConstituentApi.ApiCollectionOfConstituentRead

List fundraiser assignments

Operation ID:

ListFundraiserAssignments

List the assignments for a fundraiser.

Parameters

Name	Key	Required	Type	Description
Fundraiser ID	fundraiser_id	True	string	The system record ID of the fundraiser for whom assignments are to be returned.
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.

Returns

Assignments

Body

FundraisingApi.ApiCollectionOfFundraiserAssignmentRead

List tribute acknowledgees

Operation ID:

ListTributeAcknowledgees

Lists the acknowledgees for a tribute.

Parameters

Name	Key	Required	Type	Description
Tribute ID	tributeId	True	integer	The system record ID of the tribute.

Returns

Tribute acknowledgees

Body

NXTDataIntegrationApi.TributeAcknowledgeeCollection

Search for a constituent

Operation ID:

SearchConstituent

Performs a constituent search based on the provided search text. Supports first name, last name, preferred name, former name, alias, email address, phone number, address, or lookup ID. Name combinations such as first name and last name or preferred name and last name are valid, but otherwise search only supports one parameter at a time. By default, searches include results that sound similar to your criteria. For example, searches for "Smith" include matches for "Smyth" and other alternative spellings. This search does not support wildcard characters such as * or ?. Search results are limited to 500 records.

Parameters

Name	Key	Required	Type	Description
Search text	search_text	True	string	The search text. Supports first name, last name, preferred name, former name, alias, email address, phone number, address, or lookup ID. Name combinations such as first name and last name or preferred name and last name are valid, but otherwise search only supports one parameter at a time. By default, searches include results that sound similar to your criteria. For example, searches for "Smith" include matches for "Smyth" and other alternative spellings. This search does not support wildcard characters such as * or ?. Search results are limited to 500 records.
Fundraiser statuses	fundraiser_status		string	Represents a comma-separated list of fundraiser statuses to filter the results. For example, "Active,None" returns only constituents whose fundraiser status is Active or None. Valid values for this filter are Active, Inactive, and None.
Include inactive?	include_inactive		boolean	Include inactive constituents in the response?
Search field	search_field		string	Represents a field to search on. Currently, it only supports lookup_id. If it is provided with search_text, a constituent with lookup_id that matches the search_text will be returned.
Use strict search?	strict_search		boolean	Exclude constituents whose names sound like the search text but are spelled differently?
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.

Returns

Search results

Body

ConstituentApi.ApiCollectionOfSearchResultRead

Search for a constituent (enhanced)

Operation ID:

SearchConstituentEnhanced

Searches for constituent records using the given filter criteria.

Parameters

Name	Key	Required	Type	Description
First name	first_name		string	Constituent first name.
Last name	last_name		string	Constituent last name.
Lookup ID	lookup_id		string	Constituent lookup ID.
Email address	email		string	Constituent email address.
Phone number	phone_number		string	Phone number.
Limit	limit		integer	Represents the number of records to return. The default is 500. The maximum is 1000.
Address lines	address_lines		string	Address lines.
City	city		string	Address city.
State	state		string	Address state.
Postal code	post_code		string	Address postal code.
Include alias?	include_alias		boolean	Include alias when searching on last name?
Alias type	alias_type		string	Alias type.
Include maiden name?	include_maiden_name		boolean	Include maiden name when searching on last name?

Returns

Constituents

Body

NXTDataIntegrationApi.ConstituentSearchResultCollection

Search for duplicate constituents

Operation ID:

GetDuplicateSearchResults

Searches individual, organization, and related contact records and ranks potential duplicates based on the specified search filters. Records that match multiple filters rank higher as potential duplicates.

Parameters

Name	Key	Required	Type	Description
Last/org name	last_org_name	True	string	A filter for records that match the specified last name or organization name.
First name	first_name		string	A filter for individual records that match the specified first name.
Middle name	middle_name		string	A filter for individual records that match the specified middle name.
Suffix	suffix		string	A filter for individual records that match the specified suffix.
Address block	address_block		string	A filter for records that match the specified address block.
City	city		string	A filter for records that match the specified city.
State	state		string	A filter for records that match the specified state.
Postal code	post_code		string	A filter for records that match the specified postal code.
Email	email		array	A filter for records that match the specified email addresses.
Phone	phone		array	A filter for records that match the specified phone numbers.
Search individuals?	search_individuals		boolean	Search for duplicate individual records?
Search aliases?	search_aliases		boolean	Search by the alias, as specified by the Last/org name parameter?
Search contacts?	search_contacts		boolean	Search relationship contact records?
Limit	limit		integer	The number of records to return when paging results (Default = 3).
Offset	offset		integer	The number of records to skip when paging results.

Returns

Duplicate search results

Body

ConstituentApi.DuplicateSearchResultCollection

Update a constituent

Operation ID:

EditConstituent

Updates a constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent to update.
Title	title		string	The constituent's primary title (for individuals only).
First name	first		string	The constituent's first name (for individuals only). Character limit: 50.
Last name	last		string	The constituent's last name (for individuals only). Character limit: 100.
Organization name	name		string	For individuals, this is a computed field that is not applicable for edit operations. For organization, this field is required and represents the organization's name. Character limit: 100.
Suffix	suffix		string	The constituent's primary suffix (for individuals only).
Preferred name	preferred_name		string	The constituent's preferred name (for individuals only). Character limit: 50.
Lookup ID	lookup_id		string	The user-defined identifier for the constituent.
Gender	gender		string	The constituent's gender (for individuals only).
Middle name	middle		string	The constituent's middle name (for individuals only). Character limit: 50.
Former name	former_name		string	The constituent's former name (for individuals only). Character limit: 100.
Title 2	title_2		string	The constituent's secondary title (for individuals only).
Suffix 2	suffix_2		string	The constituent's secondary suffix (for individuals only).
Marital status	marital_status		string	The constituent's marital status (for individuals only).
Gives anonymously?	gives_anonymously		boolean	Does the constituent give anonymously?
Requests no email?	requests_no_email		boolean	Does the constituent request no email?
Is a solicitor?	is_solicitor		boolean	Is the constituent a solicitor?
No valid addresses?	no_valid_address		boolean	Does the constituent have no valid addresses?
Inactive?	inactive		boolean	Is the constituent inactive?
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.
Birthplace	birthplace		string	The birthplace of the constituent (for individuals only).
Ethnicity	ethnicity		string	The ethnicity of the constituent (for individuals only).
Target	target		string	The target of the constituent.
Income	income		string	The income for the constituent (for individuals only).
Receipt type	receipt_type		string	The receipt type of the constituent.
Religion	religion		string	The religion of the constituent (for individuals only).
Industry	industry		string	The industry of the constituent (for organizations only).
Number of employees	num_employees		integer	The number of employees at the organization.
Matches gifts?	matches_gifts		boolean	Does the organization match gifts?
Matching gift factor	matching_gift_factor		double	The matching gift factor (for organizations only).
Min match per gift	value		double	The minimum match amount per gift for the constituent (for organizations only).
Max match per gift	value		double	The maximum match amount per gift for the constituent (for organizations only).
Min match per constit	value		double	The minimum match total for the constituent (for organizations only).
Max match per constit	value		double	The maximum match total for the constituent (for organizations only).
Matching gift notes	matching_gift_notes		string	The matching gift notes for the constituent (for organizations only).
Deceased?	deceased		boolean	Is the constituent deceased (for individuals only)?
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.
Is memorial?	is_memorial		boolean	Is the constituent an honor/memorial?

Update a constituent address

Operation ID:

EditConstituentAddress

Updates a constituent address.

Parameters

Name	Key	Required	Type	Description
Address ID	address_id	True	string	The system record ID of the address to update.
Address type	type		string	The address type.
Country	country		string	The country of the address (can be the ID, name, or abbreviation).
Address lines	address_lines		string	The address lines.
City	city		string	The city of the address (do not use in combination with the Suburb field).
State	state		string	The state of the address.
Postal code	postal_code		string	The postal code of the address.
Suburb	suburb		string	The suburb of the address (do not use in combination with the City field).
County	county		string	The county of the address.
Information source	information_source		string	The information source for the address.
Region	region		string	The region for the address.
CART	cart		string	The carrier route (CART) for the address.
LOT	lot		string	The line of travel (LOT) for the address.
DPC	dpc		string	The delivery point code (DPC) for the address.
Valid from	start		date	The date when the constituent began residing at this address (ex: '2005-09-18').
Valid to	end		date	The date when the constituent ceased to reside at this address (ex: '2005-09-18').
Primary?	preferred		boolean	Is this the constituent's preferred address?
Do not mail?	do_not_mail		boolean	Can the constituent be contacted at this address?
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.

Update a constituent alias

Operation ID:

EditConstituentAlias

Updates an constituent alias.

Parameters

Name	Key	Required	Type	Description
Alias ID	alias_id	True	string	The system record ID of the alias to update.
Alias	name		string	The name to use as the constituent's alias. Character limit: 100.
Type	type		string	The alias type.

Update a constituent attachment

Operation ID:

EditConstituentAttachment

Updates a constituent 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 a constituent code

Operation ID:

EditConstituentCode

Updates a constituent code.

Parameters

Name	Key	Required	Type	Description
Constituent code ID	constituent_code_id	True	string	The system record ID of the constituent code to update.
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.
Sequence	sequence		integer	The numeric sequence associated with the constituent code.

Update a constituent custom field

Operation ID:

EditConstituentCustomField

Updates a constituent 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.

Update a constituent education

Operation ID:

EditConstituentEducation

Updates a constituent education.

Parameters

Name	Key	Required	Type	Description
Education ID	education_id	True	string	The system record ID of the education record to update.
School	school		string	The school/establishment name.
Type	type		string	The type of education.
Class of	class_of		string	The year the constituent graduated.
Status	status		string	The status of the education.
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.
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.
Degree	degree		string	The degree received.
GPA	gpa		double	The grade point average.
Subject of study	subject_of_study		string	The subject of study.
Primary?	primary		boolean	Is this the constituent's primary school association?
Majors	majors		array of string	The major courses of study.
Minors	minors		array of string	The minor courses of study.
Campus	campus		string	The campus. Character limit: 50.
Social organization	social_organization		string	The social organization. Character limit: 50.
Known name	known_name		string	The known name. Character limit: 50.
Class of degree	class_of_degree		string	The class of degree.
Department	department		string	The name of the education department.
Faculty	faculty		string	The name of the faculty.
Registration number	registration_number		string	The registration number. Character limit: 50.

Update a constituent email address

Operation ID:

EditConstituentEmailAddress

Updates a constituent email address.

Parameters

Name	Key	Required	Type	Description
Email address ID	email_address_id	True	string	The system record ID of the email address to update.
Email type	type		string	The type of email address.
Email address	address		string	The email address.
Primary?	primary		boolean	Is this the constituent's primary email address?
Do not email?	do_not_email		boolean	Can the constituent be contacted at this email address?
Inactive?	inactive		boolean	Is this email address inactive?

Update a constituent name format

Operation ID:

EditConstituentNameFormat

Updates a constituent name format.

Parameters

Name	Key	Required	Type	Description
Name format ID	name_format_id	True	string	The system record ID of the name format to update.
Type	type		string	The name format type.
Custom name format?	custom_format		boolean	Is a custom format?
Format	configuration_id		string	Name format configuration (required unless a custom format is used).
Custom name	formatted_name		string	Formatted name (required when a custom format is used). Character limit: 255.

Update a constituent note

Operation ID:

EditConstituentNote

Updates a constituent note.

Parameters

Name	Key	Required	Type	Description
Note ID	note_id	True	string	The system record ID of the note to update.
Type	type		string	The note type.
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.
Summary	summary		string	The note summary. Character limit: 50.
Note	text		string	The note text.

Update a constituent online presence

Operation ID:

EditConstituentOnlinePresence

Updates a constituent online presence.

Parameters

Name	Key	Required	Type	Description
Online presence ID	online_presence_id	True	string	The system record ID of the online presence to update.
Type	type		string	The online presence type.
Link	address		string	The web address for the online presence.
Primary?	primary		boolean	Is this the constituent's primary online presence?
Inactive?	inactive		boolean	Is this online presence inactive?

Update a constituent phone

Operation ID:

EditConstituentPhone

Updates a constituent phone.

Parameters

Name	Key	Required	Type	Description
Phone ID	phone_id	True	string	The system record ID of the phone to update.
Type	type		string	The phone type.
Number	number		string	The phone number.
Primary?	primary		boolean	Is this the constituent's primary phone?
Do not call?	do_not_call		boolean	Can the constituent be contacted at this number?
Inactive?	inactive		boolean	Is this phone number inactive?

Update a constituent primary name format

Operation ID:

EditConstituentPrimaryNameFormat

Updates the primary name format for a constituent.

Parameters

Name	Key	Required	Type	Description
Name format ID	primary_name_format_id	True	string	The system record ID of the primary name format to update.
Custom name format?	custom_format		boolean	Is a custom format?
Format	configuration_id		string	Name format configuration (required unless a custom format is used).
Custom name	formatted_name		string	Formatted name (required when a custom format is used). Character limit: 255.

Update a constituent profile picture

Operation ID:

EditConstituentProfilePicture

Updates the current profile picture for a constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent whose profile picture is to be updated.
File name	file_name	True	string	The name of the file.
Document ID	document_id	True	uuid	The document identifier.
Thumbnail ID	thumbnail_id	True	uuid	The thumbnail document identifier.

Update a constituent relationship

Operation ID:

EditConstituentRelationship

Updates a relationship for a constituent. If a reciprocal relationship exists, it is also modified to reflect the changes. This does not include changes to the "comments" property, which is specific to each record and can be modified independently on each record.

Parameters

Name	Key	Required	Type	Description
Relationship ID	relationship_id	True	string	The system record ID of the relationship to update.
Type	type		string	The type of relation that the relationship represents.
Reciprocal type	reciprocal_type		string	Describes the constituent's relationship to the related constituent. For example, in a relationship between a male constituent and a female sibling, the reciprocal relationship type would be brother.
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.
Is spouse?	is_spouse		boolean	Is the related individual the constituent's spouse (only applies to relationships between individuals)?
Is constituent head of household?	is_constituent_head_of_household		boolean	Is the constituent the head of the household?
Is spouse head of household?	is_spouse_head_of_household		boolean	Is the spouse the head of the household?
Notes	comment		string	Additional notes about the relationship.
Is contact?	is_organization_contact		boolean	Does the constituent represent this organization as a contact (only applies to relationships between organizations and individuals)?
Is primary business?	is_primary_business		boolean	Is this the constituent's primary business (only applies to relationships between organizations and individuals)?
Contact type	organization_contact_type		string	Provides context for interactions with the related individual who represents the organization as a contact. Only applies to relationships between organizations and individuals.
Position	position		string	The individual's position in the organization. Only applies to relationships between organizations and individuals. Character limit: 50.

Update a constituent solicit code

Operation ID:

EditConstituentSolicitCode

Updates a constituent solicit code.

Parameters

Name	Key	Required	Type	Description
Solicit code ID	constituent_solicit_code_id	True	string	The system record ID of the solicit code to update.
Solicit code	solicit_code		string	Communication instructions and/or restrictions for a constituent.
Start date	start_date		date	The start date of the solicit code (ex: '2005-09-18').
End date	end_date		date	The end date of the solicit code (ex: '2005-09-18').

Definitions

CommPrefApi.ConstituentConsentRead

Represents a consent entity for a constituent.

Name	Path	Type	Description
ID	id	string	The system record ID of the consent record.
Channel	channel	string	The channel that the consent response applies to.
Category	category	string	The category that the consent response applies to.
Source	source	string	The source of the consent response from the constituent.
Response	constituent_consent_response	string	How the constituent responded to consent for the specified channel/category.
Date	consent_date	date-time	The date the consent response was received.
Consent statement	consent_statement	string	The statement the constituent responded to when providing consent.
Privacy notice	privacy_notice	string	The privacy notice provided to the constituent.
Date added	date_added	date-time	The date the consent response was added.
Added by	user_name	string	The user that added the consent response.

CommPrefApi.ConstituentConsentReadCollection

Consent records

Name	Path	Type	Description
Count	count	integer	The number of consent records in the list.
value	value	array of CommPrefApi.ConstituentConsentRead	The set of consent records included in the response.

CommPrefApi.ConstituentSolicitCodeRead

Solicit code

Name	Path	Type	Description
ID	id	string	The system record ID of the constituent solicit code.
Solicit code	solicit_code	string	Communication instructions and/or restrictions for a constituent.
Start date	start_date	date	The start date of the solicit code (ex: '2005-09-18').
End date	end_date	date	The end date of the solicit code (ex: '2005-09-18').

CommPrefApi.ConstituentSolicitCodeReadCollection

Solicit codes

Name	Path	Type	Description
Count	count	integer	The number of constituent solicit codes in the list.
value	value	array of CommPrefApi.ConstituentSolicitCodeRead	The set of constituent solicit codes included in the response.

CommPrefApi.CreatedConstituentConsent

Created constituent consent

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

CommPrefApi.CreatedConstituentSolicitCode

Created constituent solicit code

Name	Path	Type	Description
ID	id	string	The ID of the newly created constituent solicit code.

ConstituentApi.AddressRead

Address

Name	Path	Type	Description
ID	id	string	The system record ID of the address.
Type	type	string	The address type.
Country	country	string	The country of the address (can be the ID, name, or abbreviation).
Address lines	address_lines	string	The address lines.
City	city	string	The city of the address (do not use in combination with the Suburb field).
State	state	string	The state of the address.
Postal code	postal_code	string	The postal code of the address.
Suburb	suburb	string	The suburb of the address (do not use in combination with the City field).
County	county	string	The county of the address.
Formatted address	formatted_address	string	The formatted address in the configured format of the country.
Information source	information_source	string	The information source for the address.
Region	region	string	The region for the address.
CART	cart	string	The carrier route (CART) for the address.
LOT	lot	string	The line of travel (LOT) for the address.
DPC	dpc	string	The delivery point code (DPC) for the address.
Valid from	start	date-time	The date when the constituent began residing at this address.
Valid to	end	date-time	The date when the constituent ceased to reside at this address.
Primary?	preferred	boolean	Is this the constituent's preferred address?
Inactive?	inactive	boolean	Is the address inactive (meaning, the current date is before any end date)?
Do not mail?	do_not_mail	boolean	Can the constituent be contacted at this address?
day	seasonal_start.d	integer	The day in the fuzzy date.
month	seasonal_start.m	integer	The month in the fuzzy date.
year	seasonal_start.y	integer	The year in the fuzzy date.
day	seasonal_end.d	integer	The day in the fuzzy date.
month	seasonal_end.m	integer	The month in the fuzzy date.
year	seasonal_end.y	integer	The year in the fuzzy date.
Date added	date_added	date-time	The date when the address was created.
Date modified	date_modified	date-time	The date when the address was last modified.

ConstituentApi.AliasRead

Alias

Name	Path	Type	Description
ID	id	string	The system record ID of the alias.
Alias	name	string	The name to use as the constituent's alias.
Type	type	string	The alias type.

ConstituentApi.ApiCollectionOfAddressRead

Addresses

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

ConstituentApi.ApiCollectionOfAliasRead

Aliases

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

ConstituentApi.ApiCollectionOfConstituentAttachmentRead

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

ConstituentApi.ApiCollectionOfConstituentCodeRead

Constituent codes

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

ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

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

ConstituentApi.ApiCollectionOfConstituentRead

Constituents

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

ConstituentApi.ApiCollectionOfEducationRead

Educations

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

ConstituentApi.ApiCollectionOfEmailAddressRead

Email addresses

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

ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

Fundraiser assignments

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

ConstituentApi.ApiCollectionOfMembershipRead

Memberships

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

ConstituentApi.ApiCollectionOfNoteRead

Notes

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

ConstituentApi.ApiCollectionOfOnlinePresenceRead

Online presences

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

ConstituentApi.ApiCollectionOfPhoneRead

Phones

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

ConstituentApi.ApiCollectionOfRelationshipRead

Relationships

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

ConstituentApi.ApiCollectionOfSearchResultRead

Search results

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

ConstituentApi.ConstituentAttachmentRead

Attachment

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

Constituent code

Name	Path	Type	Description
ID	id	string	The system record ID of the constituent code.
Constituent ID	constituent_id	string	The system record ID of the constituent associated with the constituent code.
Constituent code	description	string	The constituent code.
day	start.d	integer	The day in the fuzzy date.
month	start.m	integer	The month in the fuzzy date.
year	start.y	integer	The year in the fuzzy date.
day	end.d	integer	The day in the fuzzy date.
month	end.m	integer	The month in the fuzzy date.
year	end.y	integer	The year in the fuzzy date.
Inactive?	inactive	boolean	Is the constituent code inactive?
Sequence	sequence	integer	The numeric sequence associated with the constituent code.
Date added	date_added	date-time	The date when the constituent code was created.
Date modified	date_modified	date-time	The date when the constituent code was last modified.

ConstituentApi.ConstituentCustomFieldRead

Custom field

Name	Path	Type	Description
ID	id	string	The system record ID of the custom field.
Constituent ID	parent_id	string	The system record ID of the constituent 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.ConstituentRead

Constituent

Name	Path	Type	Description
ID	id	string	The system record ID for the constituent. This is not the same as the user-definable constituent identifier, which is stored in the lookup_id.
Type	type	string	The type of constituent.
Title	title	string	The constituent's primary title (for individuals only).
First name	first	string	The constituent's first name (for individuals only).
Last name	last	string	The constituent's last name (for individuals only).
Name	name	string	For individuals, this field is the full name of the constituent based on the target organization's display name settings. For organizations, this is the organization's name.
Preferred name	preferred_name	string	The constituent's preferred name (for individuals only).
Suffix	suffix	string	The constituent's primary suffix (for individuals only).
Lookup ID	lookup_id	string	The user-defined identifier for the constituent.
ID	email.id	string	The system record ID of the email address.
type	email.type	string	The type of email address.
address	email.address	string	The email address.
do not email?	email.do_not_email	boolean	Can the constituent be contacted at this email address?
inactive?	email.inactive	boolean	Is this email address inactive?
date added	email.date_added	date-time	The date when the email address was created.
date modified	email.date_modified	date-time	The date when the email address was last modified.
ID	phone.id	string	The system record ID of the phone.
type	phone.type	string	The phone type.
number	phone.number	string	The phone number.
do not call?	phone.do_not_call	boolean	Can the constituent be contacted at this number?
inactive?	phone.inactive	boolean	Is this phone number inactive?
date added	phone.date_added	date-time	The date when the phone was created.
date modified	phone.date_modified	date-time	The date when the phone was last modified.
ID	online_presence.id	string	The system record ID of the online presence.
type	online_presence.type	string	The online presence type.
link	online_presence.address	string	The web address for the online presence.
inactive?	online_presence.inactive	boolean	Is this online presence inactive?
date added	online_presence.date_added	date-time	The date when the online presence was created.
date modified	online_presence.date_modified	date-time	The date when the online presence was last modified.
ID	address.id	string	The system record ID of the address.
type	address.type	string	The address type.
country	address.country	string	The country of the address (can be the ID, name, or abbreviation).
lines	address.address_lines	string	The address lines.
city	address.city	string	The city of the address (do not use in combination with the Suburb field).
state	address.state	string	The state of the address.
postal code	address.postal_code	string	The postal code of the address.
suburb	address.suburb	string	The suburb of the address (do not use in combination with the City field).
county	address.county	string	The county of the address.
formatted	address.formatted_address	string	The formatted address in the configured format of the country.
valid from	address.start	date-time	The date when the constituent began residing at this address.
valid to	address.end	date-time	The date when the constituent ceased to reside at this address.
inactive?	address.inactive	boolean	Is the address inactive (meaning, the current date is before any end date)?
do not mail?	address.do_not_mail	boolean	Can the constituent be contacted at this address?
day	address.seasonal_start.d	integer	The day in the fuzzy date.
month	address.seasonal_start.m	integer	The month in the fuzzy date.
year	address.seasonal_start.y	integer	The year in the fuzzy date.
day	address.seasonal_end.d	integer	The day in the fuzzy date.
month	address.seasonal_end.m	integer	The month in the fuzzy date.
year	address.seasonal_end.y	integer	The year in the fuzzy date.
date added	address.date_added	date-time	The date when the address was created.
date modified	address.date_modified	date-time	The date when the address was last modified.
Gender	gender	string	The constituent's gender (for individuals only).
Middle name	middle	string	The constituent's middle name (for individuals only).
Former name	former_name	string	The constituent's former name (for individuals only).
Title 2	title_2	string	The constituent's secondary title (for individuals only).
Suffix 2	suffix_2	string	The constituent's secondary suffix (for individuals only).
Marital staus	marital_status	string	The constituent's marital status (for individuals only).
Gives anonymously?	gives_anonymously	boolean	Does the constituent give anonymously?
Requests no email?	requests_no_email	boolean	Does the constituent request no email?
Is a solicitor?	is_solicitor	boolean	Is the constituent a solicitor?
No valid addresses?	no_valid_address	boolean	Does the constituent have no valid addresses?
Inactive?	inactive	boolean	Is the constituent inactive?
day	birthdate.d	integer	The day in the fuzzy date.
month	birthdate.m	integer	The month in the fuzzy date.
year	birthdate.y	integer	The year in the fuzzy date.
Birthplace	birthplace	string	The birthplace of the constituent (for individuals only).
Ethnicity	ethnicity	string	The ethnicity of the constituent (for individuals only).
Target	target	string	The target of the constituent.
Income	income	string	The income for the constituent (for individuals only).
Receipt type	receipt_type	string	The receipt type of the constituent.
Religion	religion	string	The religion of the constituent (for individuals only).
Industry	industry	string	The industry of the constituent (for organizations only).
Number of employees	num_employees	integer	The number of employees at the organization.
Matches gifts?	matches_gifts	boolean	Does the organization match gifts?
Matching gift factor	matching_gift_factor	double	The matching gift factor (for organizations only).
value	matching_gift_per_gift_min.value	double	The amount value.
value	matching_gift_per_gift_max.value	double	The amount value.
value	matching_gift_total_min.value	double	The amount value.
value	matching_gift_total_max.value	double	The amount value.
Matching gift notes	matching_gift_notes	string	The matching gift notes for the constituent (for organizations only).
Age	age	integer	The constituent's age, as calculated based on the birthdate property (for individuals only).
Deceased?	deceased	boolean	Is the constituent deceased (for individuals only)?
day	deceased_date.d	integer	The day in the fuzzy date.
month	deceased_date.m	integer	The month in the fuzzy date.
year	deceased_date.y	integer	The year in the fuzzy date.
Fundraiser status	fundraiser_status	string	Indicates whether the constituent is a fundraiser (for individuals only).
Is memorial?	is_memorial	boolean	Is the constituent an honor/memorial?
ID	spouse.id	string	The system record ID of the spouse.
first name	spouse.first	string	The spouse's first name.
last name	spouse.last	string	The spouse's last name.
is head of household?	spouse.is_head_of_household	boolean	Is the spouse the head of the household?
Date added	date_added	date-time	The date when the constituent was created.
Date modified	date_modified	date-time	The date when the constituent was last modified.

ConstituentApi.ConvertedConstituent

Converted constituent

Name	Path	Type	Description
ID	id	string	The ID of the converted constituent.

ConstituentApi.CreatedConstituentAddress

Created constituent address

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

ConstituentApi.CreatedConstituentAlias

Created constituent alias

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

ConstituentApi.CreatedConstituentAttachment

Created constituent attachment

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

ConstituentApi.CreatedConstituentCode

Created constituent code

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

ConstituentApi.CreatedConstituentCustomField

Created constituent custom field

Name	Path	Type	Description
ID	id	string	The ID of the newly created constituent custom field.

ConstituentApi.CreatedConstituentEducation

Created constituent education

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

ConstituentApi.CreatedConstituentEmailAddress

Created constituent email address

Name	Path	Type	Description
ID	id	string	The ID of the newly created constituent email address.

ConstituentApi.CreatedConstituentNote

Created constituent note

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

ConstituentApi.CreatedConstituentOnlinePresence

Created constituent online presence

Name	Path	Type	Description
ID	id	string	The ID of the newly created constituent online presence.

ConstituentApi.CreatedConstituentPhone

Created constituent phone

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

ConstituentApi.CreatedIndividualConstituent

Created individual constituent

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

ConstituentApi.CreatedIndividualRelationship

Created individual relationship

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

ConstituentApi.CreatedNameFormat

Created name format

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

ConstituentApi.CreatedOrganizationConstituent

Created organization constituent

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

ConstituentApi.CreatedOrganizationRelationship

Created organization relationship

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

ConstituentApi.DuplicateSearchResult

Duplicate search result

Name	Path	Type	Description
ID	id	string	The system record ID for the constituent.
Name	name	string	The constituent name. For individuals, this computed field indicates the full name of the constituent based on the target organization's display name settings.
Display name	display_name	string	The constituent's display name.
Address	formatted_address	string	The formatted primary address for the constituent.
Deceased?	deceased	boolean	Is the constituent is deceased?
Is a constituent?	is_constituent	boolean	Is the record a constituent?
Lookup ID	constituent_id	string	The user-defined identifier for the constituent.
Date added	date_added	date-time	The date the constituent was added.
Rank	rank	string	The search rank indicating what the constituent was matched on.

ConstituentApi.DuplicateSearchResultCollection

Duplicate search results

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

ConstituentApi.EducationRead

Education

Name	Path	Type	Description
ID	id	string	The system record ID of the education.
Constituent ID	constituent_id	string	The system record ID of the constituent associated with the education.
School	school	string	The school/establishment name.
Type	type	string	The type of education.
Class of	class_of	string	The year the constituent graduated.
Status	status	string	The status of the education.
day	date_entered.d	integer	The day in the fuzzy date.
month	date_entered.m	integer	The month in the fuzzy date.
year	date_entered.y	integer	The year in the fuzzy date.
day	date_left.d	integer	The day in the fuzzy date.
month	date_left.m	integer	The month in the fuzzy date.
year	date_left.y	integer	The year in the fuzzy date.
day	date_graduated.d	integer	The day in the fuzzy date.
month	date_graduated.m	integer	The month in the fuzzy date.
year	date_graduated.y	integer	The year in the fuzzy date.
Degree	degree	string	The degree received.
GPA	gpa	double	The grade point average.
Majors	majors	array of string	The major courses of study.
Minors	minors	array of string	The minor courses of study.
Is primary education?	primary	boolean	Is this the constituent's primary school association?
Campus	campus	string	The campus.
Social organization	social_organization	string	The social organization.
Known name	known_name	string	The known name.
Class of degree	class_of_degree	string	The class of degree.
Department	department	string	The name of the education department.
Faculty	faculty	string	The name of the faculty.
Registration number	registration_number	string	The registration number.
Subject of study	subject_of_study	string	The subject of study.
Date added	date_added	date-time	The date when the education was created.
Date modified	date_modified	date-time	The date when the education was last modified.

ConstituentApi.EmailAddressRead

Email address

Name	Path	Type	Description
ID	id	string	The system record ID of the email address.
Constituent ID	constituent_id	string	The system record ID of the constituent associated with the email address.
Email type	type	string	The type of email address.
Email address	address	string	The email address.
Primary?	primary	boolean	Is this the constituent's primary email address?
Do not email?	do_not_email	boolean	Can the constituent be contacted at this email address?
Inactive?	inactive	boolean	Is this email address inactive?
Date added	date_added	date-time	The date when the email address was created.
Date modified	date_modified	date-time	The date when the email address was last modified.

ConstituentApi.FundraiserAssignmentRead

Fundraiser assignment

Name	Path	Type	Description
ID	id	string	The system record ID of the fundraiser assignment.
Constituent ID	constituent_id	string	The system record ID of the constituent assigned to the fundraiser.
Fundraiser ID	fundraiser_id	string	The system record ID of the fundraiser.
Type	type	string	The type of fundraiser.
value	amount.value	double	The monetary value.
Campaign ID	campaign_id	string	The system record ID of the campaign to apply resulting gifts to.
Fund ID	fund_id	string	The system record ID of the fund any resulting gifts should be applied to. If a restricted fund is selected, only campaigns and appeals associated with that fund may be selected.
Appeal ID	appeal_id	string	The system record ID of the appeal the fundraiser should use to request gifts.
Start date	start	date-time	The fundraiser assignment start date.
End date	end	date-time	The fundraiser assignment end date.

ConstituentApi.MembershipMemberRead

Member

Name	Path	Type	Description
ID	id	string	The system record ID of the member.
Constituent ID	constituent_id	string	The system record ID of the constituent associated with the member.
Is primary member?	primary	boolean	Is this the primary member?

ConstituentApi.MembershipRead

Membership

Name	Path	Type	Description
ID	id	string	The system record ID of the membership.
Constituent ID	constituent_id	string	The system record ID of the constituent associated with the membership.
Program	program	string	The membership program.
Category	category	string	The membership category.
Subcategory	subcategory	string	The membership subcategory.
Standing	standing	string	The membership status.
Expires	expires	date-time	The date when the membership expires.
Joined	joined	date-time	The date when the membership becomes active.
value	dues.value	double	The monetary value.
Members	members	array of ConstituentApi.MembershipMemberRead	The set of members who belong to the membership.
Date added	date_added	date-time	The date when the membership was created.
Date modified	date_modified	date-time	The date when the membership was last modified.

ConstituentApi.NameFormatRead

Name formats define how to address constituents in communications. How you refer to individuals sets the tone of your communications with them and how well they receive your interactions.

Name	Path	Type	Description
ID	id	string	The system record ID of the name format.
type	type	string	The name format type.
custom format?	custom_format	boolean	Is this a custom format?
configuration ID	configuration_id	string	The configuration ID of the name format (for non-custom formats).
formatted name	formatted_name	string	The formatted name (for custom formats).

ConstituentApi.NameFormatSummaryRead

Name format summary

Name	Path	Type	Description
ID	primary_addressee.id	string	The system record ID of the name format.
type	primary_addressee.primary_type	string	The name format type.
custom format?	primary_addressee.custom_format	boolean	Is this a custom format?
configuration ID	primary_addressee.configuration_id	string	The configuration ID of the name format (for non-custom formats).
formatted name	primary_addressee.formatted_name	string	The formatted name (for custom formats).
ID	primary_salutation.id	string	The system record ID of the name format.
type	primary_salutation.primary_type	string	The name format type.
custom format?	primary_salutation.custom_format	boolean	Is this a custom format?
configuration ID	primary_salutation.configuration_id	string	The configuration ID of the name format (for non-custom formats).
formatted name	primary_salutation.formatted_name	string	The formatted name (for custom formats).
Additional name formats	additional_name_formats	array of ConstituentApi.NameFormatRead	The additional name formats of the constituent.

ConstituentApi.NoteRead

Note

Name	Path	Type	Description
ID	id	string	The system record ID of the note.
Constituent ID	constituent_id	string	The system record ID of the constituent associated with the note.
Type	type	string	The note type.
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.
Summary	summary	string	The note summary.
Note	text	string	The note text.
Date added	date_added	date-time	The date when the note was created.
Date modified	date_modified	date-time	The date when the note was last modified.

ConstituentApi.OnlinePresenceRead

Online presence

Name	Path	Type	Description
ID	id	string	The system record ID of the online presence.
Constituent ID	constituent_id	string	The system record ID of the constituent associated with the online presence.
Type	type	string	The online presence type.
Link	address	string	The web address for the online presence.
Primary?	primary	boolean	Is this the constituent's primary online presence?
Inactive?	inactive	boolean	Is this online presence inactive?
Date added	date_added	date-time	The date when the online presence was created.
Date modified	date_modified	date-time	The date when the online presence was last modified.

ConstituentApi.PhoneRead

Phone

Name	Path	Type	Description
ID	id	string	The system record ID of the phone.
Constituent ID	constituent_id	string	The system record ID of the constituent associated with the phone.
Type	type	string	The phone type.
Number	number	string	The phone number.
Primary?	primary	boolean	Is this the constituent's primary phone?
Do not call?	do_not_call	boolean	Can the constituent be contacted at this number?
Inactive?	inactive	boolean	Is this phone number inactive?
Date added	date_added	date-time	The date when the phone was created.
Date modified	date_modified	date-time	The date when the phone was last modified.

ConstituentApi.ProfilePictureRead

Profile picture

Name	Path	Type	Description
Constituent ID	constituent_id	string	The system record ID of the constituent associated with the profile picture.
URL	url	string	The URL for the profile picture. The URL contains a time-bound signature that limits access to 60 minutes.
Thumbnail URL	thumbnail_url	string	The URL for a thumbnail of the profile picture. Contains a time-bound signature that limits access to 60 minutes.

ConstituentApi.RelationshipRead

Relationship

Name	Path	Type	Description
ID	id	string	The system record ID of the relationship.
Constituent ID	constituent_id	string	The system record ID of the constituent associated with the relationship.
Relation ID	relation_id	string	The system record ID of the related individual or organization.
Reciprocal relationship ID	reciprocal_relationship_id	string	The identifier for the reciprocal relationship record. This value is read-only and is automatically generated when the relationship is created. Changes made to this record will also be reflected on the reciprocal, with the exception of the comments property.
Name	name	string	The name of the related constituent. If the related constituent is an individual, this will be the full name of the constituent based on the target organization's display name settings.
Type	type	string	The type of relation that the relationship represents.
Reciprocal type	reciprocal_type	string	Describes the constituent's relationship to the related constituent. For example, in a relationship between a male constituent and a female sibling, the reciprocal relationship type would be brother.
day	start.d	integer	The day in the fuzzy date.
month	start.m	integer	The month in the fuzzy date.
year	start.y	integer	The year in the fuzzy date.
day	end.d	integer	The day in the fuzzy date.
month	end.m	integer	The month in the fuzzy date.
year	end.y	integer	The year in the fuzzy date.
Is spouse?	is_spouse	boolean	Is the related individual the constituent's spouse (only applies to relationships between individuals)?
Is constituent head of household?	is_constituent_head_of_household	boolean	Is the constituent the head of the household?
Is spouse head of household?	is_spouse_head_of_household	boolean	Is the spouse the head of the household?
Notes	comment	string	The comment on the relationship.
Is contact?	is_organization_contact	boolean	Does the constituent represent this organization as a contact (only applies to relationships between organizations and individuals)?
Is primary business?	is_primary_business	boolean	Is this the constituent's primary business (only applies to relationships between organizations and individuals)?
Contact type	organization_contact_type	string	Provides context for interactions with the related individual who represents the organization as a contact. Only applies to relationships between organizations and individuals.
Position	position	string	The individual's position in the organization. Only applies to relationships between organizations and individuals.
Date added	date_added	date-time	The date when the relationship was created.
Date modified	date_modified	date-time	The date when the relationship was last modified.

ConstituentApi.SearchResultRead

Search result

Name	Path	Type	Description
ID	id	string	The system record ID of the constituent.
Name	name	string	The constituent name. For individuals, this computed field indicates the full name of the constituent based on the target organization's display name settings.
Address	address	string	The constituent's preferred address.
Deceased?	deceased	boolean	Is the constituent is deceased?
Email	email	string	The constituent's email address.
Fundraiser status	fundraiser_status	string	The constituent's fundraiser status. For individuals, this computed field indicates the whether the constituent is Active, Inactive, or None. For organizations, this value will always be None.
Inactive?	inactive	boolean	Is the constituent inactive?
Lookup ID	lookup_id	string	The user-defined identifier for the constituent.

FundraisingApi.ApiCollectionOfFundraiserAssignmentRead

Assignments

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

FundraisingApi.CreatedFundraiserAssignment

Created fundraiser assignment

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

FundraisingApi.FundraiserAssignmentRead

Assignment

Name	Path	Type	Description
ID	id	string	The system record ID of the fundraiser assignment.
Constituent ID	constituent_id	string	The system record ID of the assigned constituent.
Type	type	string	The fundraiser type.
Assignment starts	start	date-time	The start date of the assignment.
Assignment ends	end	date-time	The end date of the assignment.
value	amount.value	double	The monetary value.
Campaign ID	campaign_id	string	The system record ID of the campaign to which which resulting gifts will be applied.
Fund ID	fund_id	string	The system record ID of the fund to which which resulting gifts will be applied.
Appeal ID	appeal_id	string	The system record ID of the appeal to which which resulting gifts will be applied.

NXTDataIntegrationApi.ConstituentIdMap

Constituent ID map

Name	Path	Type	Description
ID	system_record_id	integer	The constituent system record ID.

NXTDataIntegrationApi.ConstituentSearchResult

Search result

Name	Path	Type	Description
ID	record_id	integer	The system record ID of the constituent.
Lookup ID	constituent_id	string	The constituent ID.
Key indicator	key_indicator	string	The key indicator for the record.
First name	first_name	string	The first name (individuals only).
Last name	last_name	string	The last name (individuals only).
Middle name	middle_name	string	The middle name (individuals only).
Preferred name	preferred_name	string	The preferred name (individuals only).
Former name	maiden_name	string	The former name (individuals only).
Title 1	title1	string	The title 1 (individuals only).
Suffix 1	suffix1	string	The suffix 1 (individuals only).
Gender	gender	string	The constituent gender (individuals only).
day	birth_date.d	integer	The day in the fuzzy date.
month	birth_date.m	integer	The month in the fuzzy date.
year	birth_date.y	integer	The year in the fuzzy date.
Spouse first name	spouse_first_name	string	The spouse's first name (individuals only).
Spouse last name	spouse_last_name	string	The spouse's last name (individuals only).
Organization name	org_name	string	The organization name (organizations only).
Address block	address_block	string	The address block.
City and state	address_city_state	string	The address city and state.
Postal code	address_post_code	string	The address post code.
Primary email address	primary_email	string	The primary email.
Primary phone number	primary_phone	string	The primary phone.
Matched alias	matched_alias	string	The matched alias name (individuals only).
Matched email	matched_email	string	The matched email address.
Matched phone	matched_phone	string	The matched phone number.
Is a constituent?	is_constituent	boolean	Is the record a constituent?
Is deceased?	is_deceased	boolean	Is the record deceased?
Is inactive?	is_inactive	boolean	Is the record inactive?

NXTDataIntegrationApi.ConstituentSearchResultCollection

Constituents

Name	Path	Type	Description
results	results	array of NXTDataIntegrationApi.ConstituentSearchResult	The set of items included in the response. This may be a subset of the items in the collection.

NXTDataIntegrationApi.CreatedConstituentTribute

Created constituent tribute

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

NXTDataIntegrationApi.CreatedTributeAcknowledgee

Created tribute acknowledgee

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

NXTDataIntegrationApi.Tribute

Tribute

Name	Path	Type	Description
ID	id	integer	The system record ID of the tribute.
Constituent ID	constituent_record_id	integer	The system record ID of the constituent associated with the tribute.
Tribute type	tribute_type_name	string	The tribute type.
Tribute type ID	tribute_type_id	integer	The tribute type ID.
Description	description	string	The tribute description.
day	start_date.d	integer	The day in the fuzzy date.
month	start_date.m	integer	The month in the fuzzy date.
year	start_date.y	integer	The year in the fuzzy date.
day	end_date.d	integer	The day in the fuzzy date.
month	end_date.m	integer	The month in the fuzzy date.
year	end_date.y	integer	The year in the fuzzy date.
Default fund ID	default_fund_id	integer	The system record ID of the default fund associated with the tribute.
Notes	notes	string	The tribute notes.
Active?	is_active	boolean	Is this tribute active?
Sequence	sequence	integer	The tribute sequence.
Date added	date_added	date-time	The date when the tribute was created.
Date modified	date_modified	date-time	The date when the tribute was last modified.

NXTDataIntegrationApi.TributeAcknowledgee

Tribute acknowledgee

Name	Path	Type	Description
ID	id	integer	The system record ID of the tribute acknowledgee.
Tribute ID	tribute_id	integer	The system record ID of the tribute associated with the acknowledgee.
Relationship ID	relationships_id	integer	The system record ID of the relationship (if null, this represents a self-acknowledgee).
Letter ID	letter	integer	The letter ID.
Sequence	sequence	integer	The tribute acknowledgee sequence.

NXTDataIntegrationApi.TributeAcknowledgeeCollection

Tribute acknowledgees

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

NXTDataIntegrationApi.TributeCollection

Tributes

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