Blackbaud Church Management

Reference

Blackbaud Church Management is designed to effectively manage your people, gifts, communications, events, small groups, ministries, and payments, all in one place.

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/solutions/organizational-and-program-management/church-management
Privacy policy	https://www.blackbaud.com/privacy-shield
Categories	Sales and CRM;Productivity

This connector is built on top of Blackbaud's SKY API, and provides operations to help manage entities found within Blackbaud Church Management, including:

Constituents
Gifts
Actions
Notes
Custom Fields
Campaigns
Funds
Appeals
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 Blackbaud Church Management. 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 Blackbaud Church Management 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

Add a gift to batch	Add a gift to the specified gift batch.
Add records to a list	Add a set of records to an existing list.
Convert to constituent	Converts a non-constituent to a constituent.
Create a campaign attachment	Creates a new campaign attachment.
Create a campaign custom field	Creates a new campaign custom field.
Create a constituent action	Creates a new constituent action.
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 rating	Creates a new constituent rating.
Create a constituent solicit code	Creates a new constituent solicit code.
Create a document location	Creates a new unique document identifier and upload location for use with physical attachments. The response will include instructions for where and how to upload the document contents.
Create a fund attachment	Creates a new fund attachment.
Create a fund custom field	Creates a new fund custom field.
Create a gift	Creates a new gift.
Create a gift attachment	Creates a new gift attachment.
Create a gift batch	Creates a new gift batch.
Create a gift custom field	Creates a new gift custom field.
Create a list from a set of records	Creates a new list filtered to the specified set of records.
Create a relationship manager assignment	Creates a new relationship manager assignment.
Create an action attachment	Creates a new action attachment.
Create an action custom field	Creates a new action custom field.
Create an appeal attachment	Creates a new appeal attachment.
Create an appeal custom field	Creates a new appeal custom field.
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 campaign	Returns information about a campaign.
Get a constituent	Returns information about a constituent.
Get a constituent action	Returns information about a constituent action.
Get a constituent profile picture	Returns the current profile picture for a constituent.
Get a fund	Returns information about a fund.
Get a gift	Returns information about a gift.
Get a package	Returns information about a package.
Get an appeal	Returns information about an appeal.
Get constituent first gift	Returns the first gift for a constituent.
Get constituent greatest gift	Returns the greatest gift for a constituent.
Get constituent latest gift	Returns the latest gift for a constituent.
Get constituent lifetime giving	Returns the lifetime giving summary for a constituent.
Get constituent name format summary	Returns the name format summary for a constituent.
List action attachments	Lists the attachments for an action.
List action custom fields	Lists the custom fields for an action.
List actions	Returns a list of actions.
List appeal attachments	Lists the attachments for an appeal.
List appeal custom fields	Lists the custom fields for an appeal.
List appeals	Returns a list of appeals.
List campaign attachments	Lists the attachments for an campaign.
List campaign custom fields	Lists the custom fields for a campaign.
List campaigns	Returns a list of campaigns.
List constituent actions	Lists the actions for a constituent.
List constituent addresses	Lists the addresses for a constituent.
List constituent aliases	Lists the aliases for a constituent.
List constituent appeals	Lists the appeals 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 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 ratings	Returns the list of ratings for a constituent.
List constituent relationship managers	Lists the relationship manager assignments for a constituent.
List constituent relationships	Lists the relationships for a constituent.
List constituent solicit codes	Lists the solicit codes for a constituent.
List constituents	Returns a list of constituents.
List fund attachments	Lists the attachments for a fund.
List fund custom fields	Lists the custom fields for a fund.
List funds	Returns a list of funds.
List gift attachments	Lists the attachments for a gift.
List gift batches	List the gift batches.
List gift custom fields	Lists the custom fields for a gift.
List gifts	Returns a list of gifts.
List packages	Returns a list of packages.
List relationship manager assignments	List the assignments for a relationship manager.
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.
Update a campaign attachment	Updates a campaign attachment.
Update a campaign custom field	Updates a campaign custom field.
Update a constituent	Updates a constituent.
Update a constituent action	Updates a constituent action.
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.
Update a fund attachment	Updates a fund attachment.
Update a fund custom field	Updates a fund custom field.
Update a gift attachment	Updates a gift attachment.
Update a gift custom field	Updates a gift custom field.
Update an action attachment	Updates an action attachment.
Update an action custom field	Updates an action custom field.
Update an appeal attachment	Updates an appeal attachment.
Update an appeal custom field	Updates an appeal custom field.
Update gift acknowledgement details	Updates the acknowledgement details for a gift.
Update gift receipt details	Updates the receipt details for a gift.
Validate a user identity token	Validates a user identity token.

Add a gift to batch

Operation ID:: AddGiftToBatch

Add a gift to the specified gift batch.

Parameters

Name	Key	Required	Type	Description
Batch	batch_id	True	string	The batch to which the gift will be added.
Constituent ID	constituent_id	True	string	The system record ID of the constituent associated with the gift.
Amount	value	True	double	The monetary amount of the gift.
Date	date	True	date	The gift date (ex: '2020-09-18').
Type	type	True	string	The gift type.
campaign ID	campaign_id		string	The system record ID of the campaign associated with the gift split.
fund ID	fund_id	True	string	The system record ID of the fund associated with the gift split.
appeal ID	appeal_id		string	The system record ID of the appeal associated with the gift split.
package ID	package_id		string	The system record ID of the package associated with the gift split.
amount	value	True	double	The monetary amount of the gift split.
Payment method	payment_method	True	string	The payment method.
Check number	check_number		string	The check number (only applicable when payment method is "PersonalCheck").
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.
Reference	reference		string	The payment reference (only applicable when payment method is "Other").
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 anonymous?	is_anonymous		boolean	Is the gift anonymous? If no value is provided, the default anonymity of the donor will be used.
Subtype	subtype		string	The subtype of the gift.
Comment	reference		string	Notes to track special details about a gift such as the motivation behind it or a detailed description of a gift-in-kind.
Lookup ID	lookup_id		string	The user-defined identifier for the gift.
Use relationship manager credits?	default_fundraiser_credits		boolean	Use the default relationship manager credits?
Use soft credits?	default_soft_credits		boolean	Use the default soft credits?
Constituency	constituency		string	The constituency of the gift.
Post status	post_status		string	The post status of the gift.
Post date	post_date		date	The date the gift was posted (ex: '2020-09-18').
Receipt status	status	True	string	The receipt status of the gift.
Receipt amount	value	True	double	The monetary amount of the receipt for the gift.
Receipt date	date		date	The date that the gift was receipted (ex: '2020-09-18').

Returns

Contains a collection of batch gift error records and the batch gifts that the operation added

Results: GiftApi.BatchGiftAddResults

Add records to a list

Operation ID:: AppendIDsToList

Add a set of records to an existing list.

Parameters

Name	Key	Required	Type	Description
List type	list_type	True	string	The type of list.
List	list_id	True	string	The system record ID of the list.
ID(s)	ids	True	array of string	The unique identifiers for the records to be added to the list (maximumum of 100,000 values).

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 campaign attachment

Operation ID:: CreateCampaignAttachment

Creates a new campaign attachment.

Parameters

Name	Key	Required	Type	Description
Campaign ID	parent_id	True	string	The system record ID of the campaign 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.

Returns

Created campaign attachment

Body: FundraisingApi.CreatedCampaignAttachment

Create a campaign custom field

Operation ID:: CreateCampaignCustomField

Creates a new campaign custom field.

Parameters

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

Returns

Created campaign custom field

Body: FundraisingApi.CreatedCampaignCustomField

Create a constituent action

Operation ID:: CreateAction

Creates a new constituent action.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent associated with the action.
Date	date	True	date-time	The action date (ex: '2020-09-18T04:13:56Z').
Category	category	True	string	The channel or intent of the constituent interaction.
Type	type		string	Additional description of the action to complement the category.
Summary	summary		string	The short description of the action that appears at the top of the record. Character limit: 255.
Note	description		string	The detailed explanation that elaborates on the action summary.
Completed?	completed		boolean	Is the action completed? If the system is configured to use custom action statuses, this value is based on the action status value.
Completed on	completed_date		date-time	The date when the action was completed (ex: '2020-09-18T04:13:56Z').
Status	status		string	The action status.
Direction	direction		string	The direction of the action.
Location	location		string	The location of the action.
Outcome	outcome		string	The outcome of the action.
Priority	priority		string	The priority of the action.
Start time	start_time		string	The start time of the action. Uses 24-hour time in the HH:mm format.
End time	end_time		string	The end time of the action. Uses 24-hour time in the HH:mm format.
Relationship manager(s)	fundraisers		array of string	The set of system record IDs for the relationship managers associated with the action.

Returns

Created action

Body: ConstituentApi.CreatedAction

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.

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

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.

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 rating

Operation ID:: CreateConstituentRating

Creates a new constituent rating.

Parameters

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

Returns

Created constituent rating

Body: ConstituentApi.CreatedConstituentRating

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 document location

Operation ID:: CreateDocument

Creates a new unique document identifier and upload location for use with physical attachments. The response will include instructions for where and how to upload the document contents.

Parameters

Name	Key	Required	Type	Description
File name	file_name		string	The file name of the document to be uploaded.
Include thumbnail?	upload_thumbnail		boolean	Include a thumbnail document location?

Returns

File definition

Body: ConstituentApi.FileDefinition

Create a fund attachment

Operation ID:: CreateFundAttachment

Creates a new fund attachment.

Parameters

Name	Key	Required	Type	Description
Fund ID	parent_id	True	string	The system record ID of the fund 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.

Returns

Created fund attachment

Body: FundraisingApi.CreatedFundAttachment

Create a fund custom field

Operation ID:: CreateFundCustomField

Creates a new fund custom field.

Parameters

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

Returns

Created fund custom field

Body: FundraisingApi.CreatedFundCustomField

Create a gift

Operation ID:: CreateGift

Creates a new gift.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent associated with the gift.
Amount	value	True	double	The monetary amount of the gift.
Date	date	True	date	The gift date (ex: '2020-09-18').
Type	type	True	string	The gift type.
campaign ID	campaign_id		string	The system record ID of the campaign associated with the gift split.
fund ID	fund_id	True	string	The system record ID of the fund associated with the gift split.
appeal ID	appeal_id		string	The system record ID of the appeal associated with the gift split.
package ID	package_id		string	The system record ID of the package associated with the gift split.
amount	value	True	double	The monetary amount of the gift split.
Payment method	payment_method	True	string	The payment method.
Check number	check_number		string	The check number (only applicable when payment method is "PersonalCheck").
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.
Reference	reference		string	The payment reference (only applicable when payment method is "Other").
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 anonymous?	is_anonymous		boolean	Is the gift anonymous? If no value is provided, the default anonymity of the donor will be used.
Subtype	subtype		string	The subtype of the gift.
Comment	reference		string	Notes to track special details about a gift such as the motivation behind it or a detailed description of a gift-in-kind.
Lookup ID	lookup_id		string	The user-defined identifier for the gift.
Use relationship manager credits?	default_fundraiser_credits		boolean	Use the default relationship manager credits?
Use soft credits?	default_soft_credits		boolean	Use the default soft credits?
Constituency	constituency		string	The constituency of the gift.
Batch prefix	batch_prefix		string	The prefix to use for batch gifts. This must include at least one letter, and is required when 'Batch number' has a value.
Batch number	batch_number		string	The batch number. Character limit: 50 (including the batch prefix).
Post status	post_status		string	The post status of the gift.
Post date	post_date		date	The date the gift was posted (ex: '2020-09-18').
Receipt status	status	True	string	The receipt status of the gift.
Receipt amount	value	True	double	The monetary amount of the receipt for the gift.
Receipt date	date		date	The date that the gift was receipted (ex: '2020-09-18').

Returns

Created gift

Body: GiftApi.CreatedGift

Create a gift attachment

Operation ID:: CreateGiftAttachment

Creates a new gift attachment.

Parameters

Name	Key	Required	Type	Description
Gift ID	parent_id	True	string	The system record ID of the gift 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.

Returns

Created gift attachment

Body: GiftApi.CreatedGiftAttachment

Create a gift batch

Operation ID:: CreateGiftBatch

Creates a new gift batch.

Parameters

Name	Key	Type	Description
Description	batch_description	string	The description of the batch.
Expected number	expected_number	integer	The number of gifts expected in the batch.
Expected total	expected_batch_total	double	The total value of gifts in the batch.
Batch number	batch_number	string	The unique identifier specific to the batch.

Returns

Created gift batch

Body: GiftBatchApi.CreatedBatch

Create a gift custom field

Operation ID:: CreateGiftCustomField

Creates a new gift custom field.

Parameters

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

Returns

Created gift custom field

Body: GiftApi.CreatedGiftCustomField

Create a list from a set of records

Operation ID:: CreateListFromIDs

Creates a new list filtered to the specified set of records.

Parameters

Name	Key	Required	Type	Description
Name	name	True	string	The name of the list. Character limit: 50.
Description	description	True	string	The description of the list.
List type	list_type	True	string	Determines the type of list to create.
Permissions	list_permissions	True	string	Determines whether other users can access the list.
ID(s)	ids	True	array of string	The unique identifiers for the records contained in the list (maximumum of 100,000 values).

Returns

Created list

Body: ListApi.CreatedList

Create a relationship manager assignment

Operation ID:: CreateFundraiserAssignment

Creates a new relationship manager 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 start 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 an action attachment

Operation ID:: CreateActionAttachment

Creates a new action attachment.

Parameters

Name	Key	Required	Type	Description
Action ID	parent_id	True	string	The system record ID of the action associated with the attachment.
Type	type	True	string	The attachment type. Physical attachments are uploaded files such as images, PDFs, or Word documents that are saved locally or on the network. They are stored and managed in the system. Link attachments are links to files such as images, blog posts, or YouTube videos that are online or in a cloud storage account. They are stored and managed externally.
Name	name		string	The name of the attachment. Character limit: 150.
Date	date		date-time	The date of the attachment (ex: '2020-09-18T04:13:56Z'). This field defaults to the current date and time if not supplied.
URL	url		string	The URL for the attachment. This is required for link attachments and not applicable for physical attachments.
File name	file_name		string	The name of the file. Character limit: 36. For physical attachments only.
File ID	file_id		string	The identifier of the file. Character limit: 36. For physical attachments only.
Thumbnail ID	thumbnail_id		string	The identifier of the thumbnail. Character limit: 36. For physical attachments only.

Returns

Created action attachment

Body: ConstituentApi.CreatedActionAttachment

Create an action custom field

Operation ID:: CreateActionCustomField

Creates a new action custom field.

Parameters

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

Returns

Created action custom field

Body: ConstituentApi.CreatedActionCustomField

Create an appeal attachment

Operation ID:: CreateAppealAttachment

Creates a new appeal attachment.

Parameters

Name	Key	Required	Type	Description
Appeal ID	parent_id	True	string	The system record ID of the appeal 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.

Returns

Created appeal attachment

Body: FundraisingApi.CreatedAppealAttachment

Create an appeal custom field

Operation ID:: CreateAppealCustomField

Creates a new appeal custom field.

Parameters

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

Returns

Created appeal custom field

Body: FundraisingApi.CreatedAppealCustomField

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?
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.
Income	income		string	The income for 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.

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

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 campaign

Operation ID:: GetCampaign

Returns information about a campaign.

Parameters

Name	Key	Required	Type	Description
Campaign ID	campaign_id	True	string	The system record ID of the campaign to get.

Returns

Campaign

Body: FundraisingApi.CampaignRead

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 action

Operation ID:: GetAction

Returns information about a constituent action.

Parameters

Name	Key	Required	Type	Description
Action ID	action_id	True	string	The system record ID of the action to get.

Returns

Action

Body: ConstituentApi.ActionRead

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 fund

Operation ID:: GetFund

Returns information about a fund.

Parameters

Name	Key	Required	Type	Description
Fund ID	fund_id	True	string	The system record ID of the fund to get.

Returns

Fund

Body: FundraisingApi.FundRead

Get a gift

Operation ID:: GetGift

Returns information about a gift.

Parameters

Name	Key	Required	Type	Description
Gift ID	gift_id	True	string	The system record ID of the gift to get.

Returns

Gift

Body: GiftApi.GiftRead

Get a package

Operation ID:: GetPackage

Returns information about a package.

Parameters

Name	Key	Required	Type	Description
Package ID	package_id	True	string	The system record ID of the package to get.

Returns

Package

Body: FundraisingApi.PackageRead

Get an appeal

Operation ID:: GetAppeal

Returns information about an appeal.

Parameters

Name	Key	Required	Type	Description
Appeal ID	appeal_id	True	string	The system record ID of the appeal to get.

Returns

Appeal

Body: FundraisingApi.AppealRead

Get constituent first gift

Operation ID:: GetConstituentFirstGift

Returns the first gift for a constituent.

Parameters

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

Returns

Giving summary

Body: ConstituentApi.GivingSummaryRead

Get constituent greatest gift

Operation ID:: GetConstituentGreatestGift

Returns the greatest gift for a constituent.

Parameters

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

Returns

Giving summary

Body: ConstituentApi.GivingSummaryRead

Get constituent latest gift

Operation ID:: GetConstituentLatestGift

Returns the latest gift for a constituent.

Parameters

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

Returns

Giving summary

Body: ConstituentApi.GivingSummaryRead

Get constituent lifetime giving

Operation ID:: GetConstituentLifetimeGiving

Returns the lifetime giving summary for a constituent.

Parameters

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

Returns

Lifetime giving

Body: ConstituentApi.LifetimeGivingRead

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 action attachments

Operation ID:: ListActionAttachments

Lists the attachments for an action.

Parameters

Name	Key	Required	Type	Description
Action ID	action_id	True	string	The system record ID of the action.

Returns

Attachments

Body: ConstituentApi.ApiCollectionOfActionAttachmentRead

List action custom fields

Operation ID:: ListActionCustomFields

Lists the custom fields for an action.

Parameters

Name	Key	Required	Type	Description
Action ID	action_id	True	string	The system record ID of the action.

Returns

Custom fields

Body: ConstituentApi.ApiCollectionOfActionCustomFieldRead

List actions

Operation ID:: ListActions

Returns a list of actions.

Parameters

Name	Key	Type	Description
List	list_id	string	Defines a list identifier used to filter the set of actions to those included in the specified list. If this value is set, other specified filters will be ignored.
Computed status	computed_status	string	Represents a filter for results based on the computed action status. Available values are Open, Completed, or PastDue.
Status	status_code	string	Represents an action status code to filter the results (only applicable when the system is configured to use action status codes). For example, "Pending" returns actions with a status of "Pending".
Limit	limit	integer	Represents the number of records to return. The default is 500. The maximum is 5000.
Offset	offset	integer	Represents the number of records to skip. For use with pagination.
Added on or after	date_added	date-time	Filter the results to actions created on or after the specified date (ex: '2020-09-18T04:13:56Z').
Modified on or after	last_modified	date-time	Filter the results to actions modified on or after the specified date (ex: '2020-09-18T04:13:56Z').

Returns

Actions

Body: ConstituentApi.ApiCollectionOfActionRead

List appeal attachments

Operation ID:: ListAppealAttachments

Lists the attachments for an appeal.

Parameters

Name	Key	Required	Type	Description
Appeal ID	appeal_id	True	string	The system record ID of the appeal.

Returns

Attachments

Body: FundraisingApi.ApiCollectionOfAppealAttachmentRead

List appeal custom fields

Operation ID:: ListAppealCustomFields

Lists the custom fields for an appeal.

Parameters

Name	Key	Required	Type	Description
Appeal ID	appeal_id	True	string	The system record ID of the appeal.

Returns

Custom fields

Body: FundraisingApi.ApiCollectionOfAppealCustomFieldRead

List appeals

Operation ID:: ListAppeals

Returns a list of appeals.

Parameters

Name	Key	Type	Description
Limit	limit	integer	Represents the number of records to return. The default is 500. The maximum is 5000.
Offset	offset	integer	Represents the number of records to skip. For use with pagination.
Include inactive?	include_inactive	boolean	Include inactive appeals?
Added on or after	date_added	date-time	Filter the results to appeals 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 appeals modified on or after the specified date (ex: '2020-09-18T04:13:56Z').

Returns

Appeals

Body: FundraisingApi.ApiCollectionOfAppealRead

List campaign attachments

Operation ID:: ListCampaignAttachments

Lists the attachments for an campaign.

Parameters

Name	Key	Required	Type	Description
Campaign ID	campaign_id	True	string	The system record ID of the campaign.

Returns

Attachments

Body: FundraisingApi.ApiCollectionOfCampaignAttachmentRead

List campaign custom fields

Operation ID:: ListCampaignCustomFields

Lists the custom fields for a campaign.

Parameters

Name	Key	Required	Type	Description
Campaign ID	campaign_id	True	string	The system record ID of the campaign.

Returns

Custom fields

Body: FundraisingApi.ApiCollectionOfCampaignCustomFieldRead

List campaigns

Operation ID:: ListCampaigns

Returns a list of campaigns.

Parameters

Name	Key	Type	Description
Limit	limit	integer	Represents the number of records to return. The default is 500. The maximum is 5000.
Offset	offset	integer	Represents the number of records to skip. For use with pagination.
Include inactive?	include_inactive	boolean	Include inactive campaigns?
Added on or after	date_added	date-time	Filter the results to campaigns 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 campaigns modified on or after the specified date (ex: '2020-09-18T04:13:56Z').

Returns

Campaigns

Body: FundraisingApi.ApiCollectionOfCampaignRead

List constituent actions

Operation ID:: ListConstituentActions

Lists the actions for a constituent.

Parameters

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

Returns

Actions

Body: ConstituentApi.ApiCollectionOfActionRead

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 appeals

Operation ID:: ListConstituentAppeals

Lists the appeals for a constituent.

Parameters

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

Returns

Constituent appeals

Body: ConstituentApi.ApiCollectionOfConstituentAppealRead

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

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 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 ratings

Operation ID:: ListConstituentRatings

Returns the list of ratings for a constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent
Include inactive?	include_inactive		boolean	Include inactive ratings?
Only most recent?	most_recent_only		boolean	Include only the most recent ratings?

Returns

Ratings

Body: ConstituentApi.ApiCollectionOfRatingRead

List constituent relationship managers

Operation ID:: ListConstituentFundraiserAssignments

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

Returns

Relationship manager assignments

Body: ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

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 constituents

Operation ID:: ListConstituents

Returns a list of constituents.

Parameters

Name	Key	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 identifiers 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.
Relationship manager status	fundraiser_status	string	Represents a comma-separated list of relationship manager statuses to filter the results. For example, "Active,None" returns only constituents whose relationship manager 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 fund attachments

Operation ID:: ListFundAttachments

Lists the attachments for a fund.

Parameters

Name	Key	Required	Type	Description
Fund ID	fund_id	True	string	The system record ID of the fund.

Returns

Attachments

Body: FundraisingApi.ApiCollectionOfFundAttachmentRead

List fund custom fields

Operation ID:: ListFundCustomFields

Lists the custom fields for a fund.

Parameters

Name	Key	Required	Type	Description
Fund ID	fund_id	True	string	The system record ID of the fund.

Returns

Custom fields

Body: FundraisingApi.ApiCollectionOfFundCustomFieldRead

List funds

Operation ID:: ListFunds

Returns a list of funds.

Parameters

Name	Key	Type	Description
Limit	limit	integer	Represents the number of records to return. The default is 500. The maximum is 5000.
Offset	offset	integer	Represents the number of records to skip. For use with pagination.
Include inactive?	include_inactive	boolean	Include inactive funds?
Added on or after	date_added	date-time	Filter the results to funds 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 funds modified on or after the specified date (ex: '2020-09-18T04:13:56Z').

Returns

Funds

Body: FundraisingApi.ApiCollectionOfFundRead

List gift attachments

Operation ID:: ListGiftAttachments

Lists the attachments for a gift.

Parameters

Name	Key	Required	Type	Description
Gift ID	gift_id	True	string	The system record ID of the gift.

Returns

Attachments

Body: GiftApi.ApiCollectionOfGiftAttachmentRead

List gift batches

Operation ID:: ListGiftBatches

List the gift batches.

Parameters

Name	Key	Type	Description
Batch number	batch_number	string	Represents a filter for results that match the specified number.
Approved?	approved	boolean	Represents a filter for the status of the gift batch.
Has exceptions?	has_exceptions	boolean	Represents a filter for whether the gift batch contains exceptions.
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.
Search text	search_text	string	Represents a filter for text included in the batch description or batch number fields.
Created by	created_by	string	Represents a filter for gift batches created by the specified user.

Returns

Gift batches

Body: GiftBatchApi.ApiCollectionOfGiftBatch

List gift custom fields

Operation ID:: ListGiftCustomFields

Lists the custom fields for a gift.

Parameters

Name	Key	Required	Type	Description
Gift ID	gift_id	True	string	The system record ID of the gift.

Returns

Custom fields

Body: GiftApi.ApiCollectionOfGiftCustomFieldRead

List gifts

Operation ID:: ListGifts

Returns a list of gifts.

Parameters

Name	Key	Type	Description
List	list_id	string	Defines a list identifier used to filter the set of gifts to those included in the specified list. If this value is set, other specified filters will be ignored.
Type	gift_type	string	Represents a comma-separated list of gift types to filter the results. For example, "MatchingGiftPledge,RecurringGift" returns only gifts of type MatchingGiftPledge or RecurringGift.
Constituent ID	constituent_id	string	Represents a comma-separated list of constituent identifiers to filter the results. For example, "280,1232" returns only gifts from constituent 280 or constituent 1232.
Campaign ID	campaign_id	string	Represents a comma-separated list of campaign identifiers to filter the results. For example, "506,918" returns only gifts to campaign 506 or campaign 918.
Fund ID	fund_id	string	Represents a comma-separated list of fund identifiers to filter the results. For example, "506,918" returns only gifts to fund 506 or fund 918.
Appeal ID	appeal_id	string	Represents a comma-separated list of appeal identifiers to filter the results. For example, "506,918" returns only gifts to appeal 506 or appeal 918.
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.
Start gift date	start_gift_date	date-time	Represents a filter for gifts with a gift date on or after the specified date (ex: '2020-09-18T04:13:56Z').
End gift date	end_gift_date	date-time	Represents a filter for gifts with a gift date on or before the specified date (ex: '2020-09-18T04:13:56Z').
Start gift amount	start_gift_amount	double	Represents a filter for gifts with an amount greater than or equal to the specified amount.
End gift amount	end_gift_amount	double	Represents a filter for gifts with an amount less than or equal to the specified amount.
Post status	post_status	string	Represents a comma-separated list of gift post statuses to filter the results. For example, "DoNotPost,Posted" returns only gifts that are marked as DoNotPost or Posted.
Receipt status	receipt_status	string	Represents a comma-separated list of gift receipt statuses to filter the results. For example, "DoNotReceipt,Receipted" returns only gifts that are marked as DoNotReceipt or Receipted.
Acknowledgement status	acknowledgement_status	string	Represents a comma-separated list of gift acknowledgement statuses to filter the results. For example, "DoNotAcknowledge,Acknowledged" returns only gifts that are marked as DoNotAcknowledge or Acknowledged.
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,-date" sorts gifts by the "date_added" field in ascending order and then by the "gift date" field in descending order. If only the date_modified field or only the date_added field is provided, then this adds the sort_token parameter to the next_link URL to ensure that gifts are stably sorted.
Added on or after	date_added	date-time	Filter the results to gifts 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 gifts modified on or after the specified date (ex: '2020-09-18T04:13:56Z').

Returns

Gifts

Body: GiftApi.ApiCollectionOfGiftRead

List packages

Operation ID:: ListPackages

Returns a list of packages.

Parameters

Name	Key	Type	Description
Appeal ID	appeal_id	string	Represents a comma-separated list of appeal identifiers to filter the results. For example, "506,918" returns only packages for appeal 506 or appeal 918.
Limit	limit	integer	Represents the number of records to return. The default is 500. The maximum is 5000.
Offset	offset	integer	Represents the number of records to skip. For use with pagination.
Include inactive?	include_inactive	boolean	Include inactive packages?
Added on or after	date_added	date-time	Filter the results to packages 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 packages modified on or after the specified date (ex: '2020-09-18T04:13:56Z').

Returns

Packages

Body: FundraisingApi.ApiCollectionOfPackageRead

List relationship manager assignments

Operation ID:: ListFundraiserAssignments

List the assignments for a relationship manager.

Parameters

Name	Key	Required	Type	Description
Relationship manager ID	fundraiser_id	True	string	The system record ID of the relationship manager 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

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.
Relationship manager statuses	fundraiser_status		string	Represents a comma-separated list of relationship manager statuses to filter the results. For example, "Active,None" returns only constituents whose relationship manager 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

Update a campaign attachment

Operation ID:: EditCampaignAttachment

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

Update a campaign custom field

Operation ID:: EditCampaignCustomField

Updates a campaign 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

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?
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).
Income	income		string	The income for the constituent (for individuals only).
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.

Update a constituent action

Operation ID:: EditAction

Updates a constituent action.

Parameters

Name	Key	Required	Type	Description
Action ID	action_id	True	string	The system record ID of the action to update.
Date	date		date-time	The action date (ex: '2020-09-18T04:13:56Z').
Category	category		string	The channel or intent of the constituent interaction.
Type	type		string	Additional description of the action to complement the category.
Summary	summary		string	The short description of the action that appears at the top of the record. Character limit: 255.
Note	description		string	The detailed explanation that elaborates on the action summary.
Completed?	completed		boolean	Is the action completed? If the system is configured to use custom action statuses, this value is based on the action status value.
Completed on	completed_date		date-time	The date when the action was completed (ex: '2020-09-18T04:13:56Z').
Status	status		string	The action status.
Direction	direction		string	The direction of the action.
Location	location		string	The location of the action.
Outcome	outcome		string	The outcome of the action.
Priority	priority		string	The priority of the action.
Start time	start_time		string	The start time of the action. Uses 24-hour time in the HH:mm format.
End time	end_time		string	The end time of the action. Uses 24-hour time in the HH:mm format.
Relationship manager(s)	fundraisers		array of string	The set of system record IDs for the relationship managers associated with the action.

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.

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').

Update a fund attachment

Operation ID:: EditFundAttachment

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

Update a fund custom field

Operation ID:: EditFundCustomField

Updates a fund 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 gift attachment

Operation ID:: EditGiftAttachment

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

Update a gift custom field

Operation ID:: EditGiftCustomField

Updates a gift 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 an action attachment

Operation ID:: EditActionAttachment

Updates an action attachment.

Parameters

Name	Key	Required	Type	Description
Attachment ID	attachment_id	True	string	The system record ID of the attachment to update.
Name	name		string	The name of the attachment. Character limit: 150.
Date	date		date-time	The date of the attachment (ex: '2020-09-18T04:13:56Z').
URL	url		string	The URL for the attachment. This is required for link attachments and not applicable for physical attachments.

Update an action custom field

Operation ID:: EditActionCustomField

Updates an action custom field.

Parameters

Name	Key	Required	Type	Description
Custom field ID	custom_field_id	True	string	The system record ID of the custom field to update.
body	body	True	dynamic	An object that represents the properties of the custom field to update.

Update an appeal attachment

Operation ID:: EditAppealAttachment

Updates an appeal 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.

Update an appeal custom field

Operation ID:: EditAppealCustomField

Updates an appeal 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 gift acknowledgement details

Operation ID:: EditGiftAcknowledgement

Updates the acknowledgement details for a gift.

Parameters

Name	Key	Required	Type	Description
Acknowledgement ID	acknowledgement_id	True	string	The system record ID of the gift acknowledgement to update. It uses the parent gift's ID as its value.
Status	status		string	The status of the acknowledgement. When status is set to DoNotAcknowledge, letter and date should be null. When status is set to NeedsAcknowledgement, date should be null.
Date	date		date-time	The date associated with the acknowledgement (ex: '2020-09-18T04:13:56Z').
Letter	letter		string	The letter associated with the acknowledgement.

Update gift receipt details

Operation ID:: EditGiftReceipt

Updates the receipt details for a gift.

Parameters

Name	Key	Required	Type	Description
Receipt ID	receipt_id	True	string	The system record ID of the gift receipt to update. It uses the parent gift's ID as its value.
Status	status		string	The receipt status of the gift. When status is set to NeedsReceipt or DoNotReceipt, receipt date should be null.
value	value		double	The monetary value.
Date	date		date-time	The date on the receipt (ex: '2020-09-18T04:13:56Z').
Number	number		integer	The number of the receipt.

Validate a user identity token

Operation ID:: ValidateUserIdentityToken

Validates a user identity token.

Parameters

Name	Key	Required	Type	Description
User identity token	uit	True	string	The user identity token string.
Application ID	application_id	True	uuid	The expected SKY application identifier to which the user identity token was issued.

Returns

The user identity token details

Body: PowerAutomateUIApi.ValidateUserIdentityTokenResponse

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

Attachment

Name	Path	Type	Description
ID	id	string	The system record ID of the attachment.
Action ID	parent_id	string	The system record ID of the action associated with the attachment.
Type	type	string	The attachment type. Physical attachments are uploaded files such as images, PDFs, or Word documents that are saved locally or on the network. They are stored and managed in the system. Link attachments are links to files such as images, blog posts, or YouTube videos that are online or in a cloud storage account. They are stored and managed externally.
Name	name	string	The name of the attachment. Character limit: 150.
Date	date	date-time	The date of the attachment.
URL	url	string	The URL for the attachment. This is required for link attachments and not applicable for physical attachments.
File name	file_name	string	The name of the file. Character limit: 36. For physical attachments only.
File ID	file_id	string	The identifier of the file. Character limit: 36. For physical attachments only.
Thumbnail ID	thumbnail_id	string	The identifier of the thumbnail. Character limit: 36. For physical attachments only.
Thumbnail URL	thumbnail_url	string	The URL for a thumbnail. For physical attachments that are images only. Contains a time-bound signature that limits access to 60 minutes.
Content type	content_type	string	The content type. For physical attachments only.
File size	file_size	integer	The file size in bytes. For physical attachments only.

ConstituentApi.ActionCustomFieldRead

Custom field

Name	Path	Type	Description
ID	id	string	The system record ID of the custom field.
Action ID	parent_id	string	The system record ID of the action associated with the custom field.
Category	category	string	The custom field category.
Type	type	string	The type of data that the custom field represents.
Value	value		The value of the custom field.
Date	date	date	The date on the custom field.
Comment	comment	string	The comment on the custom field. Character limit: 50.
Date added	date_added	date-time	The date when the custom field was created.
Date modified	date_modified	date-time	The date when the custom field was last modified.

ConstituentApi.ActionRead

Action

Name	Path	Type	Description
ID	id	string	The system record ID of the action.
Constituent ID	constituent_id	string	The system record ID of the constituent associated with the action.
Category	category	string	The channel or intent of the constituent interaction.
Completed?	completed	boolean	Is the action completed? If the system is configured to use custom action statuses, this value is based on the action status value.
Completed on	completed_date	date-time	The date when the action was completed.
Date	date	date-time	The action date.
Note	description	string	The detailed explanation that elaborates on the action summary.
Direction	direction	string	The direction of the action.
Relationship manager(s)	fundraisers	array of string	The set of system record IDs for the relationship managers associated with the action.
Location	location	string	The location of the action.
Outcome	outcome	string	The outcome of the action.
Priority	priority	string	The priority of the action.
Start time	start_time	string	The start time of the action. Uses 24-hour time in the HH:mm format.
End time	end_time	string	The end time of the action. Uses 24-hour time in the HH:mm format.
Status	status	string	The action status.
Status code	status_code	string	The action status code. This property is only returned when the system is configured to use custom action statuses.
Computed status	computed_status	string	The computed action status. If the system is not configured to use custom action statuses, this field computes the status based on the completed and date properties. If not, the field calculates the status based on the action's date property and whether action's Action Status property is configured as completed.
Summary	summary	string	The short description of the action that appears at the top of the record. Character limit: 255.
Type	type	string	Additional description of the action to complement the category.
Date added	date_added	date-time	The date when the action was created.
Date modified	date_modified	date-time	The date when the action was last modified.

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

Attachments

Name	Path	Type	Description
Count	count	integer	The number of items available for retrieval into the collection after applying any request parameters. The limit and offset parameters do not affect the count, but to facilitate paging, they may affect the number of items in the value result set.
value	value	array of ConstituentApi.ActionAttachmentRead	The set of items included in the response. This may be a subset of the items in the collection.

ConstituentApi.ApiCollectionOfActionCustomFieldRead

Custom fields

Name	Path	Type	Description
Count	count	integer	The number of items available for retrieval into the collection after applying any request parameters. The limit and offset parameters do not affect the count, but to facilitate paging, they may affect the number of items in the value result set.
value	value	array of ConstituentApi.ActionCustomFieldRead	The set of items included in the response. This may be a subset of the items in the collection.

ConstituentApi.ApiCollectionOfActionRead

Actions

Name	Path	Type	Description
Count	count	integer	The number of items available for retrieval into the collection after applying any request parameters. The limit and offset parameters do not affect the count, but to facilitate paging, they may affect the number of items in the value result set.
value	value	array of ConstituentApi.ActionRead	The set of items included in the response. This may be a subset of the items in the collection.

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

Constituent appeals

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

Relationship manager 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.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.ApiCollectionOfRatingRead

Ratings

Name	Path	Type	Description
Count	count	integer	The number of items available for retrieval into the collection after applying any request parameters. The limit and offset parameters do not affect the count, but to facilitate paging, they may affect the number of items in the value result set.
value	value	array of ConstituentApi.RatingRead	The set of items included in the response. This may be a subset of the items in the collection.

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

Name	Path	Type	Description
ID	id	string	The system record ID of the appeal.
description	description	string	The appeal description.

ConstituentApi.CampaignRead

Name	Path	Type	Description
ID	id	string	The system record ID of the campaign.
description	description	string	The campaign description.

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.

ConstituentApi.ConstituentAppealRead

Constituent appeal

Name	Path	Type	Description
ID	id	string	The system record ID of the constituent appeal.
ID	appeal.id	string	The system record ID of the appeal.
description	appeal.description	string	The appeal description.
ID	package.id	string	The system record ID of the package.
description	package.description	string	The package description.
Date	date	date-time	The constituent appeal date.
Response	response	string	The response for the constituent appeal.
Marketing segment	marketing_segment	string	The marketing segment for the constituent appeal.
Marketing source code	marketing_source_code	string	The marketing source code for the constituent appeal.
Mailing ID	mailing_id	string	The user-defined mailing identifier for the constituent appeal.
Finder number	finder_number	string	The marketing finder number for the constituent appeal.
Comments	comments	string	User comments for the constituent appeal.

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.
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?
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).
Income	income	string	The income for the constituent (for individuals only).
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	matching_gift_per_gift_min.value	double	The minimum match amount per gift for the constituent (for organizations only).
Max match per gift	matching_gift_per_gift_max.value	double	The maximum match amount per gift for the constituent (for organizations only).
Min match per constit	matching_gift_total_min.value	double	The minimum match total for the constituent (for organizations only).
Max match per constit	matching_gift_total_max.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).
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.
Relationship manager status	fundraiser_status	string	Indicates whether the constituent is a relationship manager (for individuals only).
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.CreatedAction

Created action

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

ConstituentApi.CreatedActionAttachment

Created action attachment

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

ConstituentApi.CreatedActionCustomField

Created action custom field

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

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

Created constituent rating

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

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

File definition

Name	Path	Type	Description
File ID	file_id	string	The identifier of the file.
URL	file_upload_request.url	string	The URL to use for the upload request.
method	file_upload_request.method	string	The HTTP method to use with the upload request.
headers	file_upload_request.headers	array of ConstituentApi.Header	The headers to supply when making the request.
Thumbnail ID	thumbnail_id	string	The identifier of the thumbnail.
URL	thumbnail_upload_request.url	string	The URL to use for the upload request.
method	thumbnail_upload_request.method	string	The HTTP method to use with the upload request.
headers	thumbnail_upload_request.headers	array of ConstituentApi.Header	The headers to supply when making the request.

ConstituentApi.FundraiserAssignmentRead

Relationship manager assignment

Name	Path	Type	Description
ID	id	string	The system record ID of the relationship manager assignment.
Constituent ID	constituent_id	string	The system record ID of the constituent assigned to the relationship manager.
Relationship manager ID	fundraiser_id	string	The system record ID of the relationship manager.
Type	type	string	The type of relationship manager.
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 relationship manager should use to request gifts.
Start date	start	date-time	The relationship manager assignment start date.
End date	end	date-time	The relationship manager assignment end date.

ConstituentApi.FundRead

Name	Path	Type	Description
ID	id	string	The system record ID of the fund.
description	description	string	The fund description.

ConstituentApi.GivingSummaryRead

Giving summary

Name	Path	Type	Description
ID	id	string	The system record ID of the gift.
Type	type	string	The gift type.
Date	date	date-time	The gift date.
value	amount.value	double	The monetary value.
Appeal	appeals	array of ConstituentApi.AppealRead	The set of appeals associated with the gift.
Campaign	campaigns	array of ConstituentApi.CampaignRead	The set of campaigns associated with the gift.
Fund	funds	array of ConstituentApi.FundRead	The set of funds associated with the gift.

Request header used for uploading the physical attachment.

Name	Path	Type	Description
name	name	string	The name for the header.
value	value	string	The value for the header.

ConstituentApi.LifetimeGivingRead

Lifetime giving

Name	Path	Type	Description
Consecutive years given	consecutive_years_given	integer	The number of consecutive years the constituent has given.
Total years given	total_years_given	integer	The total number of years the constituent has given.
value	total_giving.value	double	The monetary value.
value	total_pledge_balance.value	double	The monetary value.
value	total_received_giving.value	double	The monetary value.
value	total_committed_matching_gifts.value	double	The monetary value.
value	total_received_matching_gifts.value	double	The monetary value.
value	total_soft_credits.value	double	The monetary value.

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

Rating

Name	Path	Type	Description
ID	id	string	The system record ID of the rating.
Constituent ID	constituent_id	string	The system record ID of the constituent associated with the rating.
Source	source	string	The source of the new rating.
Category	category	string	The category of the rating.
Date	date	date-time	The date of the rating.
Description	value		The value of the rating.
Comments	comment	string	A comment about the rating.
Inactive?	inactive	boolean	Is the rating inactive?
Type	type	string	This computed field indicates the type of data that the rating represents based on the category property.

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.
Relationship manager status	fundraiser_status	string	The constituent's relationship manager 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.ApiCollectionOfAppealAttachmentRead

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

FundraisingApi.ApiCollectionOfAppealCustomFieldRead

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

FundraisingApi.ApiCollectionOfAppealRead

Appeals

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

FundraisingApi.ApiCollectionOfCampaignAttachmentRead

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

FundraisingApi.ApiCollectionOfCampaignCustomFieldRead

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

FundraisingApi.ApiCollectionOfCampaignRead

Campaigns

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

FundraisingApi.ApiCollectionOfFundAttachmentRead

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

FundraisingApi.ApiCollectionOfFundCustomFieldRead

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

FundraisingApi.ApiCollectionOfFundRead

Funds

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

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

Packages

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

FundraisingApi.AppealAttachmentRead

Attachment

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

FundraisingApi.AppealCustomFieldRead

Custom field

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

FundraisingApi.AppealRead

Appeal

Name	Path	Type	Description
ID	id	string	The system record ID of the appeal.
Category	category	string	The category of the appeal.
Date added	date_added	date-time	The date when the appeal was created.
Date modified	date_modified	date-time	The date when the appeal was last modified.
Description	description	string	The display name of the appeal.
End date	end_date	date-time	The end date of the appeal.
value	goal.value	double	The monetary value.
Inactive?	inactive	boolean	Is the appeal active (meaning, the current date is after any start date and before any end date)?
Lookup ID	lookup_id	string	The user-defined identifier for the appeal.
Start date	start_date	date-time	The start date of the appeal.

FundraisingApi.CampaignAttachmentRead

Attachment

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

FundraisingApi.CampaignCustomFieldRead

Custom field

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

FundraisingApi.CampaignRead

Campaign

Name	Path	Type	Description
ID	id	string	The system record ID of the campaign.
Category	category	string	The category of the campaign.
Date added	date_added	date-time	The date when the campaign was created.
Date modified	date_modified	date-time	The date when the campaign was last modified.
Description	description	string	The display name of the campaign.
End date	end_date	date-time	The end date of the campaign.
value	goal.value	double	The monetary value.
Inactive?	inactive	boolean	Is the campaign inactive (meaning, the current date is after any start date and before any end date)?
Lookup ID	lookup_id	string	The user-defined identifier for the campaign.
Start date	start_date	date-time	The start date of the campaign.

FundraisingApi.CreatedAppealAttachment

Created appeal attachment

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

FundraisingApi.CreatedAppealCustomField

Created appeal custom field

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

FundraisingApi.CreatedCampaignAttachment

Created campaign attachment

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

FundraisingApi.CreatedCampaignCustomField

Created campaign custom field

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

FundraisingApi.CreatedFundraiserAssignment

Created fundraiser assignment

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

FundraisingApi.CreatedFundAttachment

Created fund attachment

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

FundraisingApi.CreatedFundCustomField

Created fund custom field

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

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.

FundraisingApi.FundAttachmentRead

Attachment

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

FundraisingApi.FundCustomFieldRead

Custom field

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

FundraisingApi.FundRead

Fund

Name	Path	Type	Description
ID	id	string	The system record ID of the fund.
Category	category	string	The category of the fund.
Date added	date_added	date-time	The date when the fund was created.
Date modified	date_modified	date-time	The date when the fund was last modified.
Description	description	string	The display name of the fund.
End date	end_date	date-time	The end date of the fund.
value	goal.value	double	The monetary value.
Inactive?	inactive	boolean	Is the fund inactive (meaning, the current date is after any start date and before any end date)?
Lookup ID	lookup_id	string	The user-defined identifier for the fund.
Start date	start_date	date-time	The start date of the fund.
Type	type	string	The type of the fund.

FundraisingApi.PackageRead

Package

Name	Path	Type	Description
ID	id	string	The system record ID of the package.
Appeal ID	appeal_id	string	The system record ID of the appeal associated with this package.
Category	category	string	The category of the package.
Date added	date_added	date-time	The date when the package was created.
Date modified	date_modified	date-time	The date when the package was last modified.
value	default_gift_amount.value	double	The monetary value.
Description	description	string	The display name of the package.
End date	end	date-time	The end date of the package.
value	goal.value	double	The monetary value.
Inactive?	inactive	boolean	Is the package inactive (meaning, the current date is after any start date and before any end date)?
Lookup ID	lookup_id	string	The user-defined identifier for the package.
Notes	notes	string	The notes on the package.
Recipient count	recipient_count	integer	The number of recipients of the package.
Start date	start	date-time	The start date of the package.

GiftApi.AcknowledgementRead

Acknowledgement

Name	Path	Type	Description
date	date	date-time	The date associated with the acknowledgement.
letter	letter	string	The letter associated with the acknowledgement.
status	status	string	The status of the acknowledgement. Available values are: ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT, and DONOTACKNOWLEDGE.

GiftApi.ApiCollectionOfGiftAttachmentRead

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

GiftApi.ApiCollectionOfGiftCustomFieldRead

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

GiftApi.ApiCollectionOfGiftRead

Gifts

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

GiftApi.BatchGiftAddResults

Contains a collection of batch gift error records and the batch gifts that the operation added

Name	Path	Type	Description
errors	errors	array of GiftApi.GiftBatchGiftError	The batch gift errors associated with the batch gift add operation
gifts	gifts	array of GiftApi.BatchGiftRead	The collection of batch gifts that were added by the batch gift add operation

GiftApi.GiftBatchGiftError

Represents exceptions preventing items from being added to the batch.

Name	Path	Type	Description
affected field	affected_field	string	The field affected by the error
batch ID	batch_id	string	The system record ID of the batch
exception error code	exception_error_code	integer	The exception error code
exception error message	exception_error_message	string	The exception error message
exception error name	exception_error_name	string	The exception error name
gift ID	gift_id	string	The system record ID of the gift
lookup ID	lookup_id	string	The user-defined identifier for the gift.

GiftApi.BatchGiftRead

Batch gift

Name	Path	Type	Description
batch ID	batch_id	string	The ID of the batch to which the gift was added.
errors	errors	array of GiftApi.GiftBatchGiftError	The errors associated with the batch gift.
ID	id	string	The system record ID of the batch gift.
constituent ID	constituent_id	string	The system record ID of the constituent associated with the gift.
type	type	string	The gift type.
subtype	subtype	string	The subtype of the gift.
date	date	date-time	The gift date.
value	amount.value	double	The monetary value.
value	balance.value	double	The monetary value.
batch number	batch_number	string	The batch number associated with this gift.
status	gift_status	string	The status of the gift.
anonymous?	is_anonymous	boolean	Is the gift anonymous?
constituency	constituency	string	The constituency of the gift.
lookup ID	lookup_id	string	The user-defined identifier for the gift.
origin	origin	string	The origin of the gift.
post status	post_status	string	The general ledger post status of the gift. Available values are Posted, NotPosted, and DoNotPost. When post_status is set to DoNotPost>, post_date should be null. When it is set to NotPosted, post_date is required but remains editable. When it is set to Posted, post_date is required and is no longer editable.
post date	post_date	date-time	The date that the gift was posted to general ledger.
reference	reference	string	Notes to track special details about a gift such as the motivation behind it or a detailed description of a gift-in-kind.
day	recurring_gift_status_date.d	integer	The day in the fuzzy date.
month	recurring_gift_status_date.m	integer	The month in the fuzzy date.
year	recurring_gift_status_date.y	integer	The year in the fuzzy date.
frequency	recurring_gift_schedule.frequency	string	Installment frequency of the recurring gift to view. Available values are WEEKLY, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONTHLY, QUARTERLY, ANNUALLY.
start	recurring_gift_schedule.start_date	date-time	Date the recurring gift should start.
end	recurring_gift_schedule.end_date	date-time	Date the recurring gift should end.
value	gift_aid_amount.value	double	The monetary value.
gift aid qualification status	gift_aid_qualification_status	string	This computed field determines the Gift Aid qualification status based on tax declaration information and the database format. Available values are: Qualified, NotQualified, and PartlyQualified. For the UK only.
gift code	gift_code	string	The gift code value associated with the gift.
gift splits	gift_splits	array of GiftApi.GiftSplitRead	The set of gift splits associated with the gift.
relationship managers	fundraisers	array of GiftApi.GiftFundraiserRead	The set of relationship managers who receive credit for the gift.
Soft credits	soft_credits	array of GiftApi.SoftCreditRead	The set of soft credits associated with the gift.
Receipts	receipts	array of GiftApi.ReceiptRead	The set of receipts associated with the gift.
Acknowledgements	acknowledgements	array of GiftApi.AcknowledgementRead	The set of acknowledgements associated with the gift.
Payments	payments	array of GiftApi.PaymentRead	The payments on the gift.
Linked gifts	linked_gifts	array of string	The identifiers of other gifts that are linked to this gift.
Date added	date_added	date-time	The date when the gift was created.
Date modified	date_modified	date-time	The date when the gift was last modified.

GiftApi.CreatedGift

Created gift

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

GiftApi.CreatedGiftAttachment

Created gift attachment

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

GiftApi.CreatedGiftCustomField

Created gift custom field

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

GiftApi.GiftAttachmentRead

Attachment

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

GiftApi.GiftCustomFieldRead

Custom field

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

GiftApi.GiftFundraiserRead

Gift relationship manager

Name	Path	Type	Description
value	amount.value	double	The monetary value.
relationship manager ID	constituent_id	string	The constituent system record ID for the relationship manager associated with the gift.

GiftApi.GiftRead

Gift

Name	Path	Type	Description
ID	id	string	The system record ID of the gift.
Constituent ID	constituent_id	string	The system record ID of the constituent associated with the gift.
Type	type	string	The gift type.
Subtype	subtype	string	The subtype of the gift.
Date	date	date-time	The gift date.
value	amount.value	double	The monetary value.
value	balance.value	double	The monetary value.
Batch number	batch_number	string	The batch number associated with this gift.
Status	gift_status	string	The status of the gift.
Anonymous?	is_anonymous	boolean	Is the gift anonymous?
Constituency	constituency	string	The constituency of the gift.
Lookup ID	lookup_id	string	The user-defined identifier for the gift.
Origin	origin	string	The origin of the gift.
Post status	post_status	string	The general ledger post status of the gift. Available values are Posted, NotPosted, and DoNotPost. When post_status is set to DoNotPost>, post_date should be null. When it is set to NotPosted, post_date is required but remains editable. When it is set to Posted, post_date is required and is no longer editable.
Post date	post_date	date-time	The date that the gift was posted to general ledger.
Reference	reference	string	Notes to track special details about a gift such as the motivation behind it or a detailed description of a gift-in-kind.
day	recurring_gift_status_date.d	integer	The day in the fuzzy date.
month	recurring_gift_status_date.m	integer	The month in the fuzzy date.
year	recurring_gift_status_date.y	integer	The year in the fuzzy date.
frequency	recurring_gift_schedule.frequency	string	Installment frequency of the recurring gift to view. Available values are WEEKLY, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONTHLY, QUARTERLY, ANNUALLY.
start	recurring_gift_schedule.start_date	date-time	Date the recurring gift should start.
end	recurring_gift_schedule.end_date	date-time	Date the recurring gift should end.
value	gift_aid_amount.value	double	The monetary value.
Gift aid qualification status	gift_aid_qualification_status	string	This computed field determines the Gift Aid qualification status based on tax declaration information and the database format. Available values are: Qualified, NotQualified, and PartlyQualified. For the UK only.
Gift code	gift_code	string	The gift code value associated with the gift.
Gift splits	gift_splits	array of GiftApi.GiftSplitRead	The set of gift splits associated with the gift.
Relationship managers	fundraisers	array of GiftApi.GiftFundraiserRead	The set of relationship managers who receive credit for the gift.
Soft credits	soft_credits	array of GiftApi.SoftCreditRead	The set of soft credits associated with the gift.
Receipts	receipts	array of GiftApi.ReceiptRead	The set of receipts associated with the gift.
Acknowledgements	acknowledgements	array of GiftApi.AcknowledgementRead	The set of acknowledgements associated with the gift.
Payments	payments	array of GiftApi.PaymentRead	The payments on the gift.
Linked gifts	linked_gifts	array of string	The identifiers of other gifts that are linked to this gift.
Date added	date_added	date-time	The date when the gift was created.
Date modified	date_modified	date-time	The date when the gift was last modified.

GiftApi.ReceiptRead

Receipt

Name	Path	Type	Description
value	amount.value	double	The monetary value.
date	date	date-time	The date on the receipt.
number	number	integer	The number of the receipt.
status	status	string	The status of the receipt. Available values are: RECEIPTED, NEEDSRECEIPT, and DONOTRECEIPT.

GiftApi.GiftSplitRead

Gift split

Name	Path	Type	Description
ID	id	string	The system record ID of the gift split.
value	amount.value	double	The monetary value.
appeal ID	appeal_id	string	The system record ID of the appeal associated with the gift split.
campaign ID	campaign_id	string	The system record ID of the campaign associated with the gift split.
fund ID	fund_id	string	The system record ID of the fund associated with the gift split.
value	gift_aid_amount.value	double	The monetary value.
gift aid qualification status	gift_aid_qualification_status	string	The gift aid qualification status of the gift split. Available values are: Qualified, and NotQualified. For the UK only.
package ID	package_id	string	The system record ID of the package associated with the gift split.

GiftApi.PaymentRead

Payment

Name	Path	Type	Description
account token	account_token	string	The tokenized account information (ex: credit card) from the external payment provider. Only applies to payment methods of "CreditCard" and "DirectDebit".
BBPS configuration ID	bbps_configuration_id	string	The BBPS configuration ID. Only applies to payment methods of "CreditCard" and "DirectDebit".
BBPS transaction ID	bbps_transaction_id	string	The BBPS transaction ID. Only applies to payment methods of "CreditCard" and "DirectDebit".
day	check_date.d	integer	The day in the fuzzy date.
month	check_date.m	integer	The month in the fuzzy date.
year	check_date.y	integer	The year in the fuzzy date.
check number	check_number	string	The check number. Only applies to payment method of "PersonalCheck".
checkout transaction ID	checkout_transaction_id	string	The checkout transaction ID. Only applies to payment methods of "CreditCard" and "DirectDebit".
payment method	payment_method	string	The payment method. Available values are listed below.
reference	reference	string	The reference. Only applies to payment method of "Other".
day	reference_date.d	integer	The day in the fuzzy date.
month	reference_date.m	integer	The month in the fuzzy date.
year	reference_date.y	integer	The year in the fuzzy date.

GiftApi.SoftCreditRead

Soft credit

Name	Path	Type	Description
ID	id	string	The system record ID of the soft credit.
value	amount.value	double	The monetary value.
constituent ID	constituent_id	string	The system record ID of the constituent associated with the soft credit.
gift ID	gift_id	string	The system record ID of the gift associated with the soft credit.

GiftBatchApi.ApiCollectionOfGiftBatch

Gift batches

Name	Path	Type	Description
Count	count	integer	The total number of gift batches in the response.
value	value	array of GiftBatchApi.GiftBatch	The set of items included in the response.

GiftBatchApi.CreatedBatch

Created gift batch

Name	Path	Type	Description
ID	batch_id	string	The system record ID of the newly created gift batch.

GiftBatchApi.GiftBatch

Represents the gift batch object

Name	Path	Type	Description
ID	id	string	The system record ID of the batch.
description	batch_description	string	The batch description.
batch number	batch_number	string	The batch number
projected number	projected_number_of_gifts	integer	The projected number of gifts in the batch.
actual number	number_of_gifts	integer	The actual number of gifts in the batch.
projected amount	projected_amount	double	The projected value of gifts in the batch.
actual amount	actual_amount	double	The actual value of gifts in the batch.
has exceptions?	has_exceptions	boolean	Does the batch have exceptions?
approved?	is_approved	boolean	Is the batch approved?
Created by	created_by	string	The name of the user who created the batch.
Created on	created_on	date-time	The date when the batch was created.

ListApi.CreatedList

Created list

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

PowerAutomateUIApi.ValidateUserIdentityTokenResponse

The user identity token details

Name	Path	Type	Description
User ID	user_id	string	The Blackbaud user's identifier.
Email	email	string	The Blackbaud user's email address.
Last name	family_name	string	The Blackbaud user's last name.
First name	given_name	string	The Blackbaud user's first name.
SKY application ID	application_id	string	The identifier of the SKY application to which the user identity token was issued.
Environment ID	environment_id	string	The current environment identifier.

Jaa

Blackbaud Church Management

Prerequisites

How to get credentials?

Known issues and limitations

Throttling Limits

Actions

Add a gift to batch

Parameters

Returns

Add records to a list

Parameters

Convert to constituent

Parameters

Returns

Create a campaign attachment

Parameters

Returns

Create a campaign custom field

Parameters

Returns

Create a constituent action

Parameters

Returns

Create a constituent address

Parameters

Returns

Create a constituent alias

Parameters

Returns

Create a constituent attachment

Parameters

Returns

Create a constituent code

Parameters

Returns

Create a constituent consent record

Parameters

Returns

Create a constituent custom field

Parameters

Returns

Create a constituent education

Parameters

Returns

Create a constituent email address

Parameters

Returns

Create a constituent name format

Parameters

Returns

Create a constituent note

Parameters

Returns

Create a constituent online presence

Parameters

Returns

Create a constituent phone

Parameters

Returns

Create a constituent primary name format

Parameters

Returns

Create a constituent rating

Parameters

Returns

Create a constituent solicit code

Parameters

Returns

Create a document location

Parameters

Returns

Create a fund attachment

Parameters

Returns

Create a fund custom field

Parameters

Returns

Create a gift

Parameters