Blackbaud Altru Constituent (Preview)

Reference

Altru is a comprehensive enterprise-grade ticketing software solution built specifically for nonprofits and the entire social good community. Use the Constituents connector to manage constituent biographical details, contact information, and relationships.

This connector is available in the following products and regions:

Service	Class	Regions
Copilot Studio	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	Blackbaud Support
URL	https://www.blackbaud.com/support
Email	skyapi@blackbaud.com

Connector Metadata
Publisher	Blackbaud, Inc.
Website	https://www.blackbaud.com/products/blackbaud-altru
Privacy policy	https://www.blackbaud.com/privacy-shield
Categories	Sales and CRM;Productivity

Blackbaud Altru is the complete solution built to support effective multi-channel ticketing, memberships, donations, and web sales.

This connector is built on top of Blackbaud's SKY API and provides operations to help manage constituents and related entities found within Blackbaud Altru.

For more information, please view the documentation.

Prerequisites

To use this connector, you must have a Blackbaud ID account with access to one or more Blackbaud environments.

In addition, your organization's administrator must also perform an admin-level action within the system to enable this connector to access your Blackbaud environment. More information about these prerequisites can be found in the initial setup documentation.

How to get credentials?

Your organization's administrator will send you an invitation to the organization's Blackbaud Altru environment and configure your user account permissions within the environment. No additional credentials are required to use this connector.

Known issues and limitations

The connector will operate in the context of your user account, and will therefore be subject to your user permissions within the environment.

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Create a constituent address	Creates a new constituent address.
Create a constituent alternate lookup ID	Creates a new constituent alternate lookup ID.
Create a constituent appeal	Creates a new constituent appeal.
Create a constituent appeal response	Creates a new constituent appeal response.
Create a constituent education	Creates a new constituent education.
Create a constituent email address	Creates a new constituent email address.
Create a constituent employment history	Creates a new constituent employment history.
Create a constituent interaction	Creates a new constituent interaction.
Create a constituent note	Creates a new constituent note.
Create a constituent phone	Creates a new constituent phone.
Create a constituent solicit code	Creates a new constituent solicit code.
Create a fundraiser constituency	Creates a new fundraiser constituency for a constituent.
Create an individual constituent	Creates a new individual constituent.
Create an organization constituent	Creates a new organization constituent.
Delete a constituent	Deletes a constituent.
Delete a constituent address	Deletes a constituent address.
Delete a constituent alternate lookup ID	Deletes a constituent alternate lookup ID.
Delete a constituent appeal	Deletes a constituent appeal.
Delete a constituent attribute	Deletes a constituent attribute.
Delete a constituent education	Deletes a constituent education record.
Delete a constituent email address	Deletes a constituent email address.
Delete a constituent employment history	Deletes a constituent employment history.
Delete a constituent interaction	Deletes a constituent interaction.
Delete a constituent note	Deletes a constituent note.
Delete a constituent phone	Deletes a constituent phone.
Delete a constituent solicit code	Deletes a constituent solicit code.
Delete a fundraiser constituency	Deletes a fundraiser constituency from a constituent.
Get a constituent interaction	Returns details about the specified constituent interaction.
Get a constituent profile picture	Returns the profile picture for a constituent.
Get a constituent summary profile	Returns the summary profile information for a constituent.
Get an individual constituent	Returns information about an individual constituent.
Get an organization constituent	Returns information about an organization constituent.
Get constituent primary contact information	Returns the primary contact information for a constituent.
List constituent addresses	Lists the addresses for a constituent.
List constituent alternate lookup IDs	Lists the alternate lookup IDs for a constituent.
List constituent appeals	Lists the appeals sent to a constituent.
List constituent attributes	Lists the attributes for a constituent.
List constituent educations	Lists the educations for a constituent.
List constituent email addresses	Lists the email addresses for a constituent.
List constituent employment history	Lists the employment history for a constituent.
List constituent phones	Lists the phones for a constituent.
List constituent solicit codes	Lists the solicit codes for a constituent.
List constituent tributes	Lists the tributes for a constituent.
Merge two constituents	Merge two constituent records.
Search for a constituent	Searches for constituent records using the given filter criteria.
Update a constituent address	Updates a constituent address.
Update a constituent alternate lookup ID	Updates a constituent alternate lookup ID.
Update a constituent appeal	Updates a constituent appeal.
Update a constituent education	Updates a constituent education.
Update a constituent email address	Updates a constituent email address.
Update a constituent employment history	Updates a constituent employment history.
Update a constituent interaction	Updates a constituent interaction.
Update a constituent note	Updates a constituent note.
Update a constituent phone	Updates a constituent phone.
Update a constituent solicit code	Updates a constituent note.
Update a fundraiser constituency	Updates a fundraiser constituency on a constituent.
Update an individual constituent	Updates an individual 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 an organization constituent	Updates an organization constituent.

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.
Country	country	True	string	The address country.
Type	address_type		string	The address type.
Address	address_block		string	The address block. Character limit: 150.
City	city		string	The address city. Character limit: 50.
State	state		string	The address state.
Postal code	postcode		string	The address potal code. Character limit: 12.
Primary?	primary		boolean	Is this the constituent's primary address?
Do not mail?	do_not_mail		boolean	Do not contact the constituent at this address?
Do not mail reason	do_not_mail_reason		string	The reason for not contacting the constituent at this address.
Is confidential?	confidential		boolean	Is this address confidential?
month	month		integer	The month.
day	day		integer	The day.
month	month		integer	The month.
day	day		integer	The day.
Historical start date	historical_start_date		date	The historical start date (ex: '2005-09-18').
County	county		string	The address county.
Region	region		string	The address region.
DPC	dpc		string	The address delivery point code. Character limit: 8.
CART	cart		string	The address carrier route. Character limit: 10.
LOT	lot		string	The address lot. Character limit: 5.
Congressional district	congressional_district		string	The address congressional district.
State house district	state_house_district		string	The address state house district.
State senate district	state_senate_district		string	The address state senate district.
Local precinct	local_precinct		string	The address local precinct.
Origin	origin		string	The address origin.
Information source	info_source		string	The information source for the address.
Info source comments	info_source_comments		string	The information source comments. Character limit: 256.
Recently moved?	recent_move		boolean	Recently moved/changed from this address?
Old address	old_address		string	The old address.
Omit from validation?	omit_from_validation		boolean	Omit this address from validation?
Copy to spouse?	update_matching_spouse_addresses		boolean	Copy address information to the spouse (only applicable for individual constituents)?
Copy to household?	update_matching_household_addresses		boolean	Copy address information to household members (only applicable for individual constituents)?

Returns

Created constituent address

Body: Conmg.CreatedConstituentAddress

Create a constituent alternate lookup ID

Operation ID:: CreateConstituentAlternateLookupID

Creates a new constituent alternate lookup ID.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent.
Type	alternate_lookup_id_type	True	string	The alternatle lookup ID type.
Alternate lookup ID	alternate_lookup_id	True	string	The alternate lookup ID. Character limit: 100.

Returns

Created constituent alternate lookup ID

Body: Conmg.CreatedConstituentAlternateLookupID

Create a constituent appeal

Operation ID:: CreateConstituentAppeal

Creates a new constituent appeal.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent.
Appeal ID	appeal_id	True	string	The system record ID of the appeal.
Mailing	mkt_segmentation		string	The mailing associated with the appeal.
Date sent	date_sent		date	The date sent (ex: '2005-09-18').
Package	mkt_package_id		string	The system record ID of the package.
Source code	source_code		string	The source code. Character limit: 50.
Comments	comments		string	The constituent appeal comments. Character limit: 255.

Returns

Created constituent appeal

Body: Conmg.CreatedConstituentAppeal

Create a constituent appeal response

Operation ID:: CreateConstituentAppealResponse

Creates a new constituent appeal response.

Parameters

Name	Key	Required	Type	Description
Constituent appeal ID	constituent_appeal_id	True	string	The system record ID of the constituent appeal.
Category	response_category	True	string	The response category.
Response	response	True	string	The response.
Date	date		date	The response date (ex: '2005-09-18').

Returns

Created constituent appeal response

Body: Conmg.CreatedConstituentAppealResponse

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.
Educational institution	educational_institution_id	True	string	The educational institution.
Status	educational_history_status	True	string	The status of the education.
Primary?	primary_record		boolean	Is this the constituent's primary education?
Program	educational_program		string	The educational program.
Degree	educational_degree		string	The educational degree.
Honor awarded	educational_award		string	The honor awarded.
Source	educational_source		string	The information source.
year	year		integer	The year in the fuzzy date.
month	month		integer	The month in the fuzzy date.
day	day		integer	The day in the fuzzy date.
Comments	comment		string	The education comments. Character limit: 500.
year	year		integer	The year in the fuzzy date.
month	month		integer	The month in the fuzzy date.
day	day		integer	The day in the fuzzy date.
Class of	class_year		integer	The class of.
Preferred class of	preferred_class_year		integer	The preferred class of.
Affiliated?	affiliated		boolean	Is the educational institution affiliated with the organization?
year	year		integer	The year in the fuzzy date.
month	month		integer	The month in the fuzzy date.
day	day		integer	The day in the fuzzy date.
year	year		integer	The year in the fuzzy date.
month	month		integer	The month in the fuzzy date.
day	day		integer	The day in the fuzzy date.
Reason	educational_history_reason		string	The educational history reason (only applicable for 'Unknown' education status).
Level	educational_history_level		string	The educational history level (only applicable for 'Currently attending' education status).

Returns

Created constituent education

Body: Conmg.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.
Type	email_address_type		string	The email address type.
Email address	email_address	True	string	The email address. Character limit: 100.
Start date	start_date		date	The email address start date (ex: '2005-09-18').
Primary?	primary		boolean	Is this the constituent's primary email address?
Do not email?	do_not_email		boolean	Do not contact the constituent at this email address?
Origin	origin		string	The email address origin.
Information source	info_source		string	The information source for the email address.
Info source comments	info_source_comments		string	The information source comments. Character limit: 256.
Copy to spouse?	update_matching_spouse_email_address		boolean	Copy email address information to the spouse (only applicable for individual constituents)?
Copy to household?	update_matching_household_email_address		boolean	Copy email address information to household members (only applicable for individual constituents)?

Returns

Created constituent email address

Body: Conmg.CreatedConstituentEmailAddress

Create a constituent employment history

Operation ID:: CreateConstituentEmploymentHistory

Creates a new constituent employment history.

Parameters

Name	Key	Required	Type	Description
Constituent ID	context_id	True	string	The system record ID of the constituent.
Relationship	relationship	True	string	The constituent relationship.
Job title	job_title		string	The job title. Character limit: 100.
Career level	career_level		string	The career level.
Category	job_category		string	The job category.
Start date	start_date		date	The employment start date (ex: '2005-09-18').
End date	end_date		date	The employment end date (ex: '2005-09-18').
Department	job_department		string	The job department. Character limit: 100.
Division	job_division		string	The job division. Character limit: 100.
Career level	job_schedule		string	The career level.
Responsibilities	job_responsibility		string	The job responsibilities. Character limit: 250.
Is private?	private_record		boolean	Is the employment history private?

Returns

Created constituent employment history

Body: Conmg.CreatedConstituentEmploymentHistory

Create a constituent interaction

Operation ID:: CreateConstituentInteraction

Creates a new constituent interaction.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent.
Summary	objective	True	string	The interaction summary. Character limit: 100.
Status	status	True	string	The interaction status.
Category	interaction_category		string	The interaction category.
Subcategory	interaction_subcategory		string	The interaction subcategory.
Expected date	expected_date	True	date	The expected interaction date (ex: '2005-09-18').
hour	hour		integer	The hour.
minute	minute		integer	The minute.
hour	hour		integer	The hour.
minute	minute		integer	The minute.
Actual date	actual_date		date	The interaction actual date (ex: '2005-09-18').
hour	hour		integer	The hour.
minute	minute		integer	The minute.
hour	hour		integer	The hour.
minute	minute		integer	The minute.
Time zone	time_zone_entry		string	The interaction time zone.
All-day event?	is_all_day_event		boolean	Is the interaction an all-day event?
Owner ID	fundraiser_id		string	The system record ID of the fundraiser that owns the interaction.
Contact method	interaction_type	True	string	The interaction contact method.
Event ID	event_id		string	The system record ID of the interaction event.
Comments	comment		string	The interaction comments.
constit ID	constituent_id	True	string	The system record ID of the participating constituent.

Returns

Created constituent interaction

Body: Conmg.CreatedConstituentInteraction

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.
Type	note_type	True	string	The note type.
Date	date_entered	True	date	The note date (ex: '2005-09-18').
Title	title		string	The note title. Character limit: 50.
Author ID	author_id		string	The system record ID of the author of the note.
Note	text_note		string	The plain text of the note.
HTML	html_note		string	The html text of the note.

Returns

Created constituent note

Body: Conmg.CreatedConstituentNote

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.
Type	phone_type		string	The phone type.
Number	number	True	string	The phone number. Character limit: 100.
Country	country		string	The phone country.
hour	hour		integer	The hour.
minute	minute		integer	The minute.
hour	hour		integer	The hour.
minute	minute		integer	The minute.
Start date	start_date		date	The phone start date (ex: '2005-09-18').
Primary?	primary		boolean	Is this the constituent's primary phone?
Do not call?	do_not_call		boolean	Do not contact the constituent at this number?
Do not call reason	do_not_call_reason		string	The reason for not contacting the constituent at this number.
Do not text?	donottext		boolean	Do not contact the constituent via text message at this number?
Is confidential?	confidential		boolean	Is this phone number confidential?
month	month		integer	The month.
day	day		integer	The day.
month	month		integer	The month.
day	day		integer	The day.
Origin	origin		string	The phone origin.
Information source	info_source		string	The information source for the phone number.
Info source comments	info_source_comments		string	The information source comments. Character limit: 256.
Copy to spouse?	update_matching_spouse_phone		boolean	Copy phone information to the spouse (only applicable for individual constituents)?
Copy to household?	update_matching_household_phone		boolean	Copy phone information to household members (only applicable for individual constituents)?

Returns

Created constituent phone

Body: Conmg.CreatedConstituentPhone

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.
Solicit code	solicit_code	True	string	The solicit code.
Start date	start_date		date	The solicit code start date (ex: '2005-09-18').
End date	end_date		date	The solicit code end date (ex: '2005-09-18').
Comments	comments		string	The solicit code comments. Character limit: 100.

Returns

Created constituent solicit code

Body: Conmg.CreatedConstituentSolicitCode

Create a fundraiser constituency

Operation ID:: CreateFundraiserConstituency

Creates a new fundraiser constituency for a constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the constituent.
Date from	date_from		date	The starting date for the constituency (ex: '2005-09-18').
Date to	date_to		date	The ending date for the constituency (ex: '2005-09-18').

Returns

Created fundraiser constituency

Body: Conmg.CreatedFundraiserConstituency

Create an individual constituent

Operation ID:: CreateIndividualConstituent

Creates a new individual constituent.

Parameters

Name	Key	Required	Type	Description
Last name	last_name	True	string	The constituent's last name. Character limit: 100.
Title	title		string	The constituent's primary title.
First name	first_name		string	The constituent's first name. Character limit: 50.
Suffix	suffix		string	The constituent's primary suffix.
Address type	address_type		string	The primary address type.
Country	address_country		string	The primary address country.
Address	address_block		string	The constituent's primary address. Character limit: 150.
City	address_city		string	The primary addres city. Character limit: 50.
State	address_state		string	The address state.
Postal code	address_post_code		string	The postal code of the primary address. Character limit: 12.
Do not send mail?	address_do_not_mail		boolean	Do not send mail to this address?
Do not mail reason	address_do_not_mail_reason		string	The reason for not sending mail to this address.
DPC	address_dpc		string	The address DPC. Character limit: 8.
CART	address_cart		string	The address CART. Character limit: 10.
LOT	address_lot		string	The address LOT. Character limit: 5.
County	address_county		string	The address county code.
Congressional district	address_congressional_district		string	The congressional district code.
Phone type	phone_type		string	The phone type.
Phone number	phone_number		string	The phone number. Character limit: 100.
Email type	email_address_type		string	The email type.
Email address	email_address		string	The email address. Character limit: 100.
Middle name	middle_name		string	The constituent's middle name. Character limit: 50.
Title 2	title_2		string	The constituent's secondary title.
Suffix 2	suffix_2		string	The constituent's secondary suffix
Nickname	nickname		string	The constituent's nickname. Character limit: 50.
Maiden name	maiden_name		string	The constituent's maiden name. Character limit: 100.
Marital status	marital_status		string	The marital status.
year	year		integer	The year in the fuzzy date.
month	month		integer	The month in the fuzzy date.
day	day		integer	The day in the fuzzy date.
Gender	gender_code		string	The constituent's gender.

Returns

Created individual constituent

Body: Conmg.CreatedIndividualConstituent

Create an organization constituent

Operation ID:: CreateOrganizationConstituent

Creates a new organization constituent.

Parameters

Name	Key	Required	Type	Description
Name	name	True	string	The organization constituent's name. Character limit: 100.
Industry	industry		string	The industry code.
No. of employees	num_employees		integer	The number of employees.
No. of subsidiary orgs	num_subsidiaries		integer	The number of subsidiary organizations.
Parent org	parent_corp_id		string	The system record ID of the parent corporation.
Address type	address_type		string	The address type.
Country	address_country		string	The address country.
Address	address_block		string	The address block. Character limit: 150.
City	address_city		string	The city of the address. Character limit: 50.
State	address_state		string	The address state.
Postal code	address_postcode		string	The postal code of the address. Character limit: 12.
Do not send mail?	address_do_not_mail		boolean	Do not send mail to this address?
Do not mail reason	address_do_not_mail_reason		string	The reason for not sending mail to this address.
DPC	dpc		string	The address DPC. Character limit: 8.
CART	cart		string	The address CART. Character limit: 10.
LOT	lot		string	The address LOT. Character limit: 5.
County	county		string	The address county code.
Congressional district	congressional_district		string	The congressional district code.
Phone type	phone_type		string	The phone type.
Phone number	phone_number		string	The phone number. Character limit: 100.
Email type	email_address_type		string	The email type.
Email address	email_address		string	The email address. Character limit: 100.
Web address	web_address		string	The website. Character limit: 100
Is primary organization?	is_primary		boolean	Is this a primary organization?
Information source	info_source		string	The information source.
Profile picture	picture		string	The constituent's profile picture.
Profile thumbnail	picture_thumbnail		string	The constituent's profile picture thumbnail.

Returns

Created organization constituent

Body: Conmg.CreatedOrganizationConstituent

Delete a constituent

Operation ID:: DeleteConstituent

Deletes a constituent.

Parameters

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

Delete a constituent address

Operation ID:: DeleteConstituentAddress

Deletes a constituent address.

Parameters

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

Delete a constituent alternate lookup ID

Operation ID:: DeleteConstituentAlternateLookupID

Deletes a constituent alternate lookup ID.

Parameters

Name	Key	Required	Type	Description
Alternate lookup ID	alternate_lookup_id	True	string	The system record ID of the constituent alternate lookup ID to delete.

Delete a constituent appeal

Operation ID:: DeleteConstituentAppeal

Deletes a constituent appeal.

Parameters

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

Delete a constituent attribute

Operation ID:: DeleteConstituentAttribute

Deletes a constituent attribute.

Parameters

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

Delete a constituent education

Operation ID:: DeleteConstituentEducation

Deletes a constituent education record.

Parameters

Name	Key	Required	Type	Description
Educational history ID	educational_history_id	True	string	The system record ID of the education record to delete.

Delete a constituent email address

Operation ID:: DeleteConstituentEmailAddress

Deletes a constituent email address.

Parameters

Name	Key	Required	Type	Description
Email address ID	email_address_id	True	string	The system record ID of the constituent email address to delete.

Delete a constituent employment history

Operation ID:: DeleteConstituentEmploymentHistory

Deletes a constituent employment history.

Parameters

Name	Key	Required	Type	Description
Employment history ID	relationship_job_info_id	True	string	The system record ID of the constituent employment history to delete.

Delete a constituent interaction

Operation ID:: DeleteConstituentInteraction

Deletes a constituent interaction.

Parameters

Name	Key	Required	Type	Description
Interaction ID	constituent_interaction_id	True	string	The system record ID of the constituent interaction to delete.

Delete a constituent note

Operation ID:: DeleteConstituentNote

Deletes a constituent note.

Parameters

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

Delete a constituent phone

Operation ID:: DeleteConstituentPhone

Deletes a constituent phone.

Parameters

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

Delete a constituent solicit code

Operation ID:: DeleteConstituentSolicitCode

Deletes 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 constituent solicit code to delete.

Delete a fundraiser constituency

Operation ID:: DeleteFundraiserConstituency

Deletes a fundraiser constituency from a constituent.

Parameters

Name	Key	Required	Type	Description
Constituency ID	fundraiser_constituency_id	True	string	The system record ID of the fundraiser constituency to delete.

Get a constituent interaction

Operation ID:: GetConstituentInteraction

Returns details about the specified constituent interaction.

Parameters

Name	Key	Required	Type	Description
Interaction ID	constituent_interaction_id	True	string	The system record ID of the constituent interaction to get.

Returns

Interaction

Body: Conmg.ConstituentInteraction

Get a constituent profile picture

Operation ID:: GetConstituentProfilePicture

Returns the profile picture for a constituent.

Parameters

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

Returns

Constituent primary contact info

Body: Conmg.ConstituentProfilePicture

Get a constituent summary profile

Operation ID:: GetConstituentSummaryProfile

Returns the summary profile information for a constituent.

Parameters

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

Returns

Constituent summary profile

Body: Conmg.ConstituentSummaryProfile

Get an individual constituent

Operation ID:: GetIndividualConstituent

Returns information about an individual constituent.

Parameters

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

Returns

Individual constituent

Body: Conmg.IndividualConstituent

Get an organization constituent

Operation ID:: GetOrganizationConstituent

Returns information about an organization constituent.

Parameters

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

Returns

Organization constituent

Body: Conmg.OrganizationConstituent

Get constituent primary contact information

Operation ID:: GetConstituentPrimaryContactInfo

Returns the primary contact information for a constituent.

Parameters

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

Returns

Constituent primary contact info

Body: Conmg.ConstituentPrimaryContactInfo

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 former?	include_former		boolean	Include former addresses?

Returns

Addresses

Body: Conmg.AddressCollection

List constituent alternate lookup IDs

Operation ID:: ListConstituentAlternateLookupIDs

Lists the alternate lookup IDs for a constituent.

Parameters

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

Returns

Alternate lookup IDs

Body: Conmg.AlternateLookupIDCollection

List constituent appeals

Operation ID:: ListConstituentAppeals

Lists the appeals sent to a constituent.

Parameters

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

Returns

Appeals

Body: Conmg.ConstituentAppealCollection

List constituent attributes

Operation ID:: ListConstituentAttributes

Lists the attributes for a constituent.

Parameters

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

Returns

Attributes

Body: Conmg.AttributeCollection

List constituent educations

Operation ID:: ListConstituentEducations

Lists the educations 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: Conmg.EducationCollection

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.

Returns

Email addresses

Body: Conmg.EmailAddressCollection

List constituent employment history

Operation ID:: ListConstituentEmploymentHistory

Lists the employment history 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 records?

Returns

Employment histories

Body: Conmg.EmploymentHistoryCollection

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.

Returns

Phones

Body: Conmg.PhoneCollection

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.
Show expired?	show_expired		boolean	Show expired solicit codes?
Date range	date_range		string	Filter the results to the specified date range.

Returns

Solicit codes

Body: Conmg.SolicitCodeCollection

List constituent tributes

Operation ID:: ListConstituentTributes

Lists the tributes for a constituent.

Parameters

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

Returns

Tributes

Body: Conmg.TributeCollection

Merge two constituents

Operation ID:: MergeTwoConstituents

Merge two constituent records.

Parameters

Name	Key	Required	Type	Description
Source constituent ID	source_id	True	string	The system record ID of the source constituent whose data will be merged into the target constituent.
Target constituent ID	target_id	True	string	The system record ID of the target constituent that will represent the consolidated view of data after the merge has completed.
Configuration	config	True	string	The merge configuration.
Delete source?	delete_source	True	boolean	Delete the source constituent after the merge is complete?
Delete action	delete_source_constituent	True	string	The delete source constituent. Available values are delete source constituent, mark source constituent inactive
Inactive reason	constituent_inactivity_reason_code		string	The inactive reason.
Inactivity details	constituent_inactivity_details		string	The inactive details. Character limit: 300.

Returns

Merged constituent

Body: Conmg.MergedConstituent

Search for a constituent

Operation ID:: SearchConstituent

Searches for constituent records using the given filter criteria.

Parameters

Name	Key	Type	Description
Key name	key_name	string	The constituent key name (last name for individuals, organization name for organizations).
First name	first_name	string	The constituent first name.
Lookup ID	lookup_id	string	The constituent lookup ID.
Email address	email_address	string	The constituent email address.
Phone number	phone_number	string	The constituent phone number.
Country	country	string	A filter for the constituent address country.
Address	address_block	string	A filter for the constituent address block.
City	city	string	A filter for the constituent address city.
State	state	string	A filter for the constituent address state.
Postal code	post_code	string	A filter for the constituent address postal code.
Class of	classof	integer	A filter for the primary class year of the constituent.
Match exactly?	exact_match_only	boolean	Match all criteria exactly?
Middle name	middle_name	string	The constituent middle name.
Constituency	constituency	string	A filter for the constituency of the constituent.
Source code	sourcecode	string	A filter for the constituent appeal source code.
Include individuals?	include_individuals	boolean	Include individual constituents?
Include organizations?	include_organizations	boolean	Include organization constituents?
Include groups?	include_groups	boolean	Include groups when searching?
Exclude households?	exclude_households	boolean	Exclude households when searching?
Check nickname?	check_nickname	boolean	Check nickname when searching?
Check aliases?	check_aliases	boolean	Check aliases when searching?
Check alt lookup IDs?	check_alternate_lookup_ids	boolean	Check alternate lookup IDs when searching?
Only primary?	only_primary_address	boolean	Only search primary addresses?
Include deceased?	include_deceased	boolean	Include deceased constituents?
Include inactive?	include_inactive	boolean	Include inactive constituents?
Use fuzzy search?	fuzzy_search_on_name	boolean	Use fuzzy search on name?
Limit	limit	integer	Represents the number of records to return.

Returns

Search results

Body: Conmg.ConstituentSearchResultCollection

Update a constituent address

Operation ID:: EditConstituentAddress

Updates a constituent address.

Parameters

Name	Key	Required	Type	Description
Constituent address ID	constituent_address_id	True	string	The system record ID of the constituent address to update.
Country	country		string	The address country.
Type	address_type		string	The address type.
Address	address_block		string	The address block. Character limit: 150.
City	city		string	The address city. Character limit: 50.
State	state		string	The address state.
Postal code	postcode		string	The address potal code. Character limit: 12.
Primary?	primary		boolean	Is this the constituent's primary address?
Do not mail?	do_not_mail		boolean	Do not contact the constituent at this address?
Do not mail reason	do_not_mail_reason		string	The reason for not contacting the constituent at this address.
Is confidential?	confidential		boolean	Is this address confidential?
month	month		integer	The month.
day	day		integer	The day.
month	month		integer	The month.
day	day		integer	The day.
Historical start date	historical_start_date		date	The historical start date (ex: '2005-09-18').
Historical end date	historical_end_date		date	The historical end date (ex: '2005-09-18').
County	county		string	The address county.
Region	region		string	The address region.
DPC	dpc		string	The address delivery point code. Character limit: 8.
CART	cart		string	The address carrier route. Character limit: 10.
LOT	lot		string	The address lot. Character limit: 5.
Congressional district	congressional_district		string	The address congressional district.
State house district	state_house_district		string	The address state house district.
State senate district	state_senate_district		string	The address state senate district.
Local precinct	local_precinct		string	The address local precinct.
Information source	info_source		string	The information source for the address.
Info source comments	info_source_comments		string	The information source comments. Character limit: 256.
Omit from validation?	omit_from_validation		boolean	Omit this address from validation?
Update contacts?	update_contacts		boolean	Update contacts that use this address?
Copy to household?	update_matching_household_addresses		boolean	Copy address information to household members?

Update a constituent alternate lookup ID

Operation ID:: EditConstituentAlternateLookupID

Updates a constituent alternate lookup ID.

Parameters

Name	Key	Required	Type	Description
Alternate lookup ID	alternate_lookup_id	True	string	The system record ID of the constituent alternate lookup ID to update.
Type	alternate_lookup_id_type		string	The alternatle lookup ID type.
Alternate lookup ID	alternate_lookup_id		string	The alternate lookup ID. Character limit: 100.

Update a constituent appeal

Operation ID:: EditConstituentAppeal

Updates a constituent appeal.

Parameters

Name	Key	Required	Type	Description
Constituent appeal ID	constituent_appeal_id	True	string	The system record ID of the constituent appeal to update.
Appeal ID	appeal_id		string	The system record ID of the appeal.
Mailing	mkt_segmentation		string	The mailing associated with the appeal.
Date sent	date_sent		date	The date sent (ex: '2005-09-18').
Package	mkt_package_id		string	The system record ID of the package.
Source code	source_code		string	The source code. Character limit: 50.
Comments	comments		string	The constituent appeal comments. Character limit: 255.

Update a constituent education

Operation ID:: EditConstituentEducation

Updates a constituent education.

Parameters

Name	Key	Required	Type	Description
Educational history ID	educational_history_id	True	string	The system record ID of the constituent education to update.
Educational institution	educational_institution_id		string	The educational institution.
Status	educational_history_status		string	The status of the education.
Primary?	primary_record		boolean	Is this the constituent's primary education?
Program	educational_program		string	The educational program.
Degree	educational_degree		string	The educational degree.
Honor awarded	educational_award		string	The honor awarded.
Source	educational_source		string	The information source.
year	year		integer	The year in the fuzzy date.
month	month		integer	The month in the fuzzy date.
day	day		integer	The day in the fuzzy date.
Comments	comment		string	The education comments. Character limit: 500.
year	year		integer	The year in the fuzzy date.
month	month		integer	The month in the fuzzy date.
day	day		integer	The day in the fuzzy date.
Class of	class_year		integer	The class of.
Preferred class of	preferred_class_year		integer	The preferred class of.
Affiliated?	affiliated		boolean	Is the educational institution affiliated with the organization?
year	year		integer	The year in the fuzzy date.
month	month		integer	The month in the fuzzy date.
day	day		integer	The day in the fuzzy date.
year	year		integer	The year in the fuzzy date.
month	month		integer	The month in the fuzzy date.
day	day		integer	The day in the fuzzy date.
Reason	educational_history_reason		string	The educational history reason (only applicable for 'Unknown' education status).
Level	educational_history_level		string	The educational history level (only applicable for 'Currently attendeing' education status).

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 constituent email address to update.
Type	email_address_type		string	The email address type.
Email address	email_address		string	The email address. Character limit: 100.
Start date	start_date		date	The email address start date (ex: '2005-09-18').
End date	end_date		date	The email address end date (ex: '2005-09-18').
Primary?	primary		boolean	Is this the constituent's primary email address?
Do not email?	do_not_email		boolean	Do not contact the constituent at this email address?
Information source	info_source		string	The information source for the email address.
Info source comments	info_source_comments		string	The information source comments. Character limit: 256.
Copy to spouse?	update_matching_spouse_email_address		boolean	Copy email address information to the spouse (only applicable for individual constituents)?
Copy to household?	update_matching_household_email_address		boolean	Copy email address information to household members (only applicable for individual constituents)?

Update a constituent employment history

Operation ID:: EditConstituentEmploymentHistory

Updates a constituent employment history.

Parameters

Name	Key	Required	Type	Description
Employment history ID	relationship_job_info_id	True	string	The system record ID of the constituent employment history to delete.
Job title	job_title		string	The job title. Character limit: 100.
Career level	career_level		string	The career level.
Category	job_category		string	The job category.
Start date	start_date		date	The employment start date (ex: '2005-09-18').
End date	end_date		date	The employment end date (ex: '2005-09-18').
Department	job_department		string	The job department. Character limit: 100.
Division	job_division		string	The job division. Character limit: 100.
Career level	job_schedule		string	The career level.
Responsibilities	job_responsibility		string	The job responsibilities. Character limit: 250.
Is private?	private_record		boolean	Is the employment history private?

Update a constituent interaction

Operation ID:: EditConstituentInteraction

Updates a constituent interaction.

Parameters

Name	Key	Required	Type	Description
Interaction ID	constituent_interaction_id	True	string	The system record ID of the constituent interaction to delete.
Summary	objective		string	The interaction summary. Character limit: 100.
Status	status		string	The interaction status.
Category	interaction_category		string	The interaction category.
Subcategory	interaction_subcategory		string	The interaction subcategory.
Expected date	expected_date		date	The expected interaction date (ex: '2005-09-18').
hour	hour		integer	The hour.
minute	minute		integer	The minute.
hour	hour		integer	The hour.
minute	minute		integer	The minute.
Actual date	actual_date		date	The interaction actual date (ex: '2005-09-18').
hour	hour		integer	The hour.
minute	minute		integer	The minute.
hour	hour		integer	The hour.
minute	minute		integer	The minute.
Time zone	time_zone_entry		string	The interaction time zone.
All-day event?	all_day_event		boolean	Is the interaction an all-day event?
Owner ID	fundraiser_id		string	The system record ID of the fundraiser that owns the interaction.
Contact method	interaction_type		string	The interaction contact method.
Event ID	event_id		string	The system record ID of the interaction event.
Comments	comment		string	The interaction comments.
ID	id		string	The system record ID of the interaction participant.
constituent ID	constituent_id	True	string	The system record ID of the participating constituent.

Update a constituent note

Operation ID:: EditConstituentNote

Updates a constituent note.

Parameters

Name	Key	Required	Type	Description
Constituent note ID	constituent_note_id	True	string	The system record ID of the constituent note to update.
Type	note_type		string	The note type.
Date	date_entered		date	The note date (ex: '2005-09-18').
Title	title		string	The note title. Character limit: 50.
Author ID	author_id		string	The system record ID of the author of the note.
Note	text_note		string	The plain text of the note.
HTML	html_note		string	The html text of the note.

Update a constituent phone

Operation ID:: EditConstituentPhone

Updates a constituent phone.

Parameters

Name	Key	Required	Type	Description
Constituent phone ID	constituent_phone_id	True	string	The system record ID of the constituent phone to update.
Type	phone_type		string	The phone type.
Number	number		string	The phone number. Character limit: 100.
Country	country		string	The phone country.
hour	hour		integer	The hour.
minute	minute		integer	The minute.
hour	hour		integer	The hour.
minute	minute		integer	The minute.
Start date	start_date		date	The phone start date (ex: '2005-09-18').
End date	end_date		date	The phone end date (ex: '2005-09-18').
Primary?	primary		boolean	Is this the constituent's primary phone?
Do not call?	do_not_call		boolean	Do not contact the constituent at this number?
Do not call reason	do_not_call_reason		string	The reason for not contacting the constituent at this number.
Do not text?	donottext		boolean	Do not contact the constituent via text message at this number?
Is confidential?	confidential		boolean	Is this phone number confidential?
month	month		integer	The month.
day	day		integer	The day.
month	month		integer	The month.
day	day		integer	The day.
Information source	info_source		string	The information source for the phone number.
Info source comments	info_source_comments		string	The information source comments. Character limit: 256.
Copy to spouse?	update_matching_spouse_phone		boolean	Copy phone information to the spouse (only applicable for individual constituents)?
Copy to household?	update_matching_household_phone		boolean	Copy phone information to household members (only applicable for individual constituents)?

Update a constituent solicit code

Operation ID:: EditConstituentSolicitCode

Updates a constituent note.

Parameters

Name	Key	Required	Type	Description
Solicit code ID	constituent_solicit_code_id	True	string	The system record ID of the constituent solicit code to update.
Solicit code	solicit_code		string	The solicit code.
Start date	start_date		date	The solicit code start date (ex: '2005-09-18').
End date	end_date		date	The solicit code end date (ex: '2005-09-18').
Comments	comments		string	The solicit code comments. Character limit: 100.

Update a fundraiser constituency

Operation ID:: EditFundraiserConstituency

Updates a fundraiser constituency on a constituent.

Parameters

Name	Key	Required	Type	Description
Constituency ID	fundraiser_constituency_id	True	string	The system record ID of the fundraiser constituency to update.
Date from	date_from		date	The starting date for the constituency (ex: '2005-09-18').
Date to	date_to		date	The ending date for the constituency (ex: '2005-09-18').

Update an individual constituent

Operation ID:: EditIndividualConstituent

Updates an individual 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
Constituent ID	constituent_id	True	string	The system record ID of the individual to update.
Last name	last_name		string	The constituent's last name. Character limit: 100.
Title	title		string	The constituent's primary title.
First name	first_name		string	The constituent's first name. Character limit: 50.
Suffix	suffix		string	The constituent's primary suffix.
Middle name	middle_name		string	The constituent's middle name. Character limit: 50.
Title 2	title_2		string	The constituent's secondary title.
Suffix 2	suffix_2		string	The constituent's secondary suffix
Nickname	nickname		string	The constituent's nickname. Character limit: 50.
Maiden name	maiden_name		string	The constituent's maiden name. Character limit: 100.
Marital status	marital_status		string	The marital status.
year	year		integer	The year in the fuzzy date.
month	month		integer	The month in the fuzzy date.
day	day		integer	The day in the fuzzy date.
Gender	gender_code		string	The constituent's gender.
Website	web_address		string	The constituent's website.
Gives anonymously?	gives_anonymously		boolean	Does the constituent give anonymously?
Deceased?	deceased		boolean	Is the constituent deceased?
Profile picture	picture		string	The constituent's profile picture.
Profile thumbnail	picture_thumbnail		string	The constituent's profile picture thumbnail.

Update an organization constituent

Operation ID:: EditOrganizationConstituent

Updates an organization constituent.

Parameters

Name	Key	Required	Type	Description
Constituent ID	constituent_id	True	string	The system record ID of the organization constituent to update.
Name	organization_name		string	The organization constituent's name. Character limit: 100.
Industry	industry		string	The industry code.
No. of employees	num_employees		integer	The number of employees.
No. of subsidiary orgs	num_subsidiaries		integer	The number of subsidiary organizations.
Parent org	parent_corp_id		string	The system record ID of the parent corporation.
Web address	web_address		string	The website. Character limit: 100
Is primary organization?	is_primary		boolean	Is this a primary organization?
Profile picture	picture		string	The constituent's profile picture.
Profile thumbnail	picture_thumbnail		string	The constituent's profile picture thumbnail.

Definitions

Conmg.Address

Address

Name	Path	Type	Description
ID	id	string	The system record ID of the address.
Type	type	string	The type of address.
Address	contact_info	string	The address.
Is primary?	primary	string	Is this the constituent's primary address?
Is confidential?	confidential	boolean	Is the address confidential?
Is former?	former	boolean	Is the address a former address?
Do not contact?	do_not_contact	string	Do not contact the constituent at this address?
Start date	start_date	date-time	The address start date.
End date	end_date	date	The address end date.
Geocoded?	geocoded	boolean	Has the address been geocoded?
Pending geocode?	pending_geocode	boolean	Is the address pending geocoding?
Invalid geocode?	invalid_geocode	boolean	Is the address geocoding invalid?
Map context ID	map_context_id	string	The address map context ID

Conmg.AddressCollection

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

Conmg.AlternateLookupID

Alternate lookup ID

Name	Path	Type	Description
ID	id	string	The system record ID of the alternate lookup ID.
Type	type	string	The type of alternate lookup ID.
Alternate lookup ID	alternate_lookup_id	string	The alternate lookup ID.

Conmg.AlternateLookupIDCollection

Alternate lookup IDs

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

Conmg.Attribute

Attribute

Name	Path	Type	Description
ID	id	string	The system record ID of the attribute.
Category	category	string	The attribute category.
Category ID	attribute_category_id	string	The system record ID of the attribute category.
Group	attribute_group	string	The attribute group.
Value	value	string	The attribute value.
Start date	start_date	date-time	The attribute start date.
End date	end_date	date-time	The attribute end date.
Comment	comment	string	The attribute comment.

Conmg.AttributeCollection

Attributes

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

Conmg.ConstituentAppeal

Appeal

Name	Path	Type	Description
ID	id	string	The system record ID of the constituent appeal.
Appeal ID	appeal_id	string	The system record ID of the appeal.
Appeal name	appeal	string	The appeal name.
Appeal description	description	string	The appeal description.
Mailing ID	mkt_segmentation_id	string	The system record ID of the mailing.
Mailing name	mailing	string	The mailing name.
Mailing family type code	mailing_family_type_code	integer	The mailing family type code.
Date sent	date_sent	date-time	The date sent.
Package name	package	string	The package name.
Source code	source_code	string	The source code.
Segment ID	mkt_segmentation_segment_id	string	The system record ID of the mailing segment.
Segment	segment	string	The mailing segment.
Finder number	finder_number	integer	The finder number.
Test segment	test_segment	string	The test segment.
Letter	letter	string	The constituent appeal mailing letter.
Comments	comments	string	The constituent appeal comments.
Has responses?	has_responses	boolean	Did this appeal have responses?
Appeal mailing?	appeal_mailing	boolean	Is this an appeal mailing?
Time frame	time_frame_text	string	The constituent appeal time frame.
Time frame group sort	time_frame_group_sort	string	The time frame group sort order.

Conmg.ConstituentAppealCollection

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

Conmg.ConstituentInteractionParticipant

An object representing a constituent interaction participant.

Name	Path	Type	Description
ID	id	string	The system record ID of the interaction participant.
constituent ID	constituent_id	string	The system record ID of the participating constituent.

Conmg.ConstituentInteraction

Interaction

Name	Path	Type	Description
Constituent ID	constituent_id	string	The system record ID of the constituent.
Constituent name	constituent_name	string	The constituent name.
Summary	objective	string	The interaction summary.
Status	status	string	The interaction status.
Category	interaction_category	string	The interaction category.
Subcategory	interaction_subcategory	string	The interaction subcategory.
Expected date	expected_date	date-time	The expected interaction date.
hour	expected_start_time.hour	integer	The hour.
minute	expected_start_time.minute	integer	The minute.
hour	expected_end_time.hour	integer	The hour.
minute	expected_end_time.minute	integer	The minute.
Actual date	actual_date	date-time	The interaction actual date.
hour	actual_start_time.hour	integer	The hour.
minute	actual_start_time.minute	integer	The minute.
hour	actual_end_time.hour	integer	The hour.
minute	actual_end_time.minute	integer	The minute.
Time zone	time_zone_entry	string	The interaction time zone.
All-day event?	all_day_event	boolean	Is the interaction an all-day event?
Owner ID	fundraiser_id	string	The system record ID of the fundraiser that owns the interaction.
Contact method	interaction_type	string	The interaction contact method.
Event ID	event_id	string	The system record ID of the interaction event.
Comments	comment	string	The interaction comments.
Participants	participants	array of Conmg.ConstituentInteractionParticipant	The interaction participants.

Conmg.ConstituentPrimaryContactInfo

Constituent primary contact info

Name	Path	Type	Description
Address type	address_type_label	string	The primary address type.
Address type ID	address_type_id	string	The system record ID of the primary address type.
Primary address country ID	country_id	string	The system record ID of the primary address country.
Primary address	address	string	The primary address.
Primary address city	city	string	The primary address city.
Primary address state ID	state_id	string	The system record ID of the primary address state.
Primary address postal code	post_code	string	The primary address postal code.
Is address confidential?	confidential	boolean	Is the address confidential?
Do not mail?	do_not_mail	boolean	Do not contact the constituent at this address?
Do not mail reason ID	do_not_mail_reason_code_id	string	The system record ID of reason for not contacting the constituent at this address.
Primary phone type	phone_type_label	string	The primary phone type.
Primary phone type ID	phone_type_id	string	The system record ID of the primary phone type.
Primary phone number	phone	string	The primary phone number.
Is phone confidential?	phone_is_confidential	boolean	Is the phone number confidential?
Do not call?	do_not_call	boolean	Do not contact the constituent at this number?
Do not call reason ID	do_not_call_reason_code_id	string	The system record ID of reason for not contacting the constituent at this number.
Primary email address type	email_type_label	string	The primary email address type.
Primary email address type ID	email_type_id	string	The system record ID of the primary email address type.
Primary email address	email	string	The primary email address.
Do not email?	do_not_email	boolean	Do not contact the constituent at this email address?
Website	web_address	string	The constituent's website.

Conmg.ConstituentProfilePicture

Constituent primary contact info

Name	Path	Type	Description
Picture	picture	string	The contituent profile picture.
Title	title	string	The constituent's primary title.
First name	first_name	string	The constituent's first name.
Key name	key_name	string	The constituent's key name.
Suffix	suffix	string	The constituent's primary suffix.
Middle name	middle_name	string	The constituent's middle name.
Nickname	nick_name	string	The constituent's nickname.
Maiden name	maiden_name	string	The constituent's maiden name.
Gives anonymously?	gives_anonymously	boolean	Does the constituent give anonymously?

Conmg.ConstituentSearchResult

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.
Middle name	middle_name	string	The constituent's middle name.
Suffix code ID	suffixcodeid	string	The system record ID of the constituent's suffix.
Lookup ID	lookup_id	string	The user-defined identifier for the constituent.
Sort name	sort_constituent_name	string	The constituent sort name.
Country ID	country_id	string	The system record ID of the constituent's primary address country.
Address	address	string	The constituent's preferred address.
City	city	string	The constituent's preferred address city.
State	state	string	The constituent's preferred address state.
Postcode	post_code	string	The constituent's preferred address postcode.
Phone	phone	string	The constituent's phone.
Email address	email_address	string	The constituent's email address.
Class of	classof	integer	The constituent's primary class year.
Gives anonymously?	gives_anonymously	boolean	Does the constituent give anonymously?
Is organization?	organization	boolean	Is the constituent an organization?
Is group?	group	boolean	Is the constituent a group?
Is household?	household	boolean	Is the constituent a household?
Prospect manager	prospectmanager	string	The constituent's prospect manager

Conmg.ConstituentSearchResultCollection

Search results

Name	Path	Type	Description
Count	count	integer	The number of items available for retrieval into the collection after applying any request parameters.
value	value	array of Conmg.ConstituentSearchResult	The set of items included in the response. This may be a subset of the items in the collection.

Conmg.ConstituentSummaryProfile

Constituent summary profile

Name	Path	Type	Description
Name	name	string	The constituent name.
Lookup ID	lookup_id	string	The constituent lookup ID.
Is a constituent profile?	constituent_profile	boolean	Is a constituent profile?
Is organization?	organization	boolean	Is the constituent an organization?
Parent organization	top_parent	string	The parent organization.
Parent organization ID	top_parent_id	string	The system record ID of the parent organization.
Is group?	group	boolean	Is the constituent a group?
Is group dissolved?	dissolved	boolean	Is the group dissolved?
Group type	group_type	string	The group type.
Number of group members	group_member_count	integer	The number of group members.
Is committee member?	committee_member	boolean	Is a committee member?
Is household?	household	boolean	Is the constituent a household?
Household ID	household_id	string	The system record ID of the household.
Household text	household_text	string	The household text.
Is inactive?	inactive	boolean	Is the constituent inactive?
Inactivity reason	constituent_inactivity_reason	string	The cosntituent inactivity reason.
Is deceased?	deceased	boolean	Is the constituent deceased?
year	deceaseddate.year	integer	The year in the fuzzy date.
month	deceaseddate.month	integer	The month in the fuzzy date.
day	deceaseddate.day	integer	The day in the fuzzy date.
Is spouse deceased?	spouse_deceased	boolean	Is the spouse deceased?
Gives anonymously?	gives_anonymously	boolean	Does the constituent give anonymously?
Declarations on file?	declarations_on_file	boolean	Does the constituent have declarations on file?
WealthPoint update pending?	wealthpoint_update_pending	boolean	Is a WealthPoint update pending?
Profile picture	picture	string	The constituent's profile picture.
Primary business	primary_business	string	The constituent's primary business.
Primary business ID	primary_business_id	string	The system record ID of the primary business.
Primary education	primary_education	string	The constituent's primary education.
Primary education ID	primary_education_id	string	The system record ID of the primary education.
Education attributes defined?	education_attribute_defined	boolean	Does the constituent have education attributes defined?
Related constituent	related_constituent	string	The related constituent.
Related constituent ID	related_constituent_id	string	The system record ID of the related constituent.
Solicit code count	solicit_code_count	integer	The number of solicit codes.
Primary address ID	address_id	string	The system record ID of the primary address.
Primary address	address	string	The primary address.
Is address confidential?	address_is_confidential	boolean	Is the address confidential?
Do not mail?	do_not_mail	boolean	Do not contact the constituent at this address?
Primary phone ID	phone_number_id	string	The system record ID of the primary phone.
Primary phone type	phone_type	string	The primary phone type.
Primary phone number	phone_number	string	The primary phone number.
Is phone confidential?	phone_is_confidential	boolean	Is the phone number confidential?
Do not call?	do_not_phone	boolean	Do not contact the constituent at this number?
Primary email address ID	email_address_id	string	The system record ID of the primary email address.
Primary email address	email_address	string	The primary email address.
Do not email?	do_not_email	boolean	Do not contact the constituent at this email address?
Website	web_address	string	The constituent's website.
Registrant status text	registrant_status_text	string	The registrant status text.
Vendor status text	vendor_status_text	string	The vendor status text.
Alumnus status text	alumnus_status_text	string	The alumnus status text.
Alumnus enrollment ID	alumnus_enrollment_id	string	The alumnus enrollment ID.
Current enrollment ID	current_enrollment_id	string	The current enrollment ID.
Current enrollment ID 2	current_enrollment_id_2	string	The current enrollment ID 2.
Current enrollment ID 3	current_enrollment_id_3	string	The current enrollment ID 3.
Student enrollment ID	student_enrollment_id	string	The student enrollment ID.
Current school	current_school	string	The current school.
Current school 2	current_school_2	string	The current school 2.
Current school 3	current_school_3	string	The current school 3.
Lifecycle stage	lifecycle_stage	string	The donor lifecycle stage.
Lifecycle stage as of	lifecycle_stage_as_of	date-time	The donor lifecycle stage as-of date.
Planned giver stage	planned_giver_stage	string	The planned giver stage.
Planned giver stage as of	planned_giver_stage_as_of	date-time	The planned giver stage as-of date.
Donor state	donor_state	string	The donor state.
Donor state code	donor_state_code	integer	The donor state code.
Sponsor type code	sponsor_type_code	integer	The sponsor type code.
Last revenue date	last_revenue_date	date-time	The last revenue date.
Alumnus constituency text	alumnus_constituency_text	string	The alumnus constituency text.
Advocate constituency text	advocate_constituency_text	string	The advocate constituency text.
Bank constituency text	bank_constituency_text	string	The bank constituency text.
Board member constituency text	board_member_constituency_text	string	The board member constituency text.
Committee constituency text	committee_constituency_text	string	The committee constituency text.
Committee member constituency text	committee_member_constituency_text	string	The committee member constituency text.
Community member constituency text	community_member_constituency_text	string	The community member constituency text.
Donor constituency text	donor_constituency_text	string	The donor constituency text.
Faculty constituency text	faculty_constituency_text	string	The faculty constituency text.
Fundraiser constituency text	fundraiser_constituency_text	string	The fundraiser constituency text.
Fundraising group constituency text	fundraising_group_constituency_text	string	The fundraising group constituency text.
Grantor constituency text	grantor_constituency_text	string	The grantor constituency text.
Loyal donor constituency text	loyal_donor_constituency_text	string	The loyal donor constituency text.
Major donor constituency text	major_donor_constituency_text	string	The major donor constituency text.
MatchFinder constituency text	matchfinder_constituency_text	string	The MatchFinder constituency text.
MatchFinder online record ID	matchfinder_online_record_id	integer	The MatchFinder online record ID.
Member constituency text	member_constituency_text	string	The member constituency text.
NFG constituency text	nfg_constituency_text	string	The NFG constituency text.
Patron constituency text	patron_constituency_text	string	The patron constituency text.
Planned giver constituency text	plannedgiverconstituencytext	string	The planned giver constituency text.
Prospect constituency text	prospect_constituency_text	string	The prospect constituency text.
Recognition constituency text	recognition_constituency_text	string	The recognition constituency text.
Relation constituency text	relation_constituency_text	string	The relation constituency text.
Sponsor constituency text	sponsor_constituency_text	string	The sponsor constituency text.
Staff constituency text	staff_constituency_text	string	The staff constituency text.
Student constituency text	student_constituency_text	string	The student constituency text.
Student relation constituency text	student_relation_constituency_text	string	The student relation constituency text.
User-defined constituency text	user_defined_constituency_text	string	The user-defined constituency text.
Volunteer constituency text	volunteer_constituency_text	string	The volunteer constituency text.
Constituencies display order	constituencies_display_order	array of Conmg.ConstituencyDisplayOrder	The display order for constituencies.
User-defined constituencies	user_defined_constituencies	array of Conmg.UserDefinedConstituency	The set of user-defined constituencies.
Student relation constituencies	student_relation_constituencies	array of Conmg.StudentRelationConstituency	The set of student relation constituencies.
Social media accounts	social_media_accounts	array of Conmg.ConstituentSocialMediaAccount	The set of social media accounts for the constituent.

Conmg.ConstituencyDisplayOrder

Constituency display order

Name	Path	Type	Description
ID	id	string	The constituency ID.
description	description	string	The constituency description.
sequence	sequence	integer	The constituency sequence.
is system?	system	boolean	Is the constituent system-defined?

Conmg.UserDefinedConstituency

User-defined constituency

Name	Path	Type	Description
description	description	string	The constituency description.
sequence	sequence	string	The constituency sequence.

Conmg.StudentRelationConstituency

Student relation constituency

Name	Path	Type	Description
description	description	string	The constituency description.
sequence	sequence	string	The constituency sequence.

Conmg.ConstituentSocialMediaAccount

Constituent social media account

Name	Path	Type	Description
ID	id	string	The system record ID of the social media account.
service ID	social_media_service_id	string	The system record ID of the social media service.
service name	social_media_service_name	string	The social media service.
icon	social_media_service_icon	string	The social media service icon.
account type ID	social_media_account_type_code_id	string	The system record ID of the social media service account type.
account type	social_media_account_type	string	The social media service account type.
user ID	user_id	string	The social media account user ID.
url	url	string	The social media url.
info source code ID	info_source_code_id	string	The system record ID of the social media account info source code.
info source	info_source	string	The social media account info source.
do not contact?	do_not_contact	boolean	Do not contact the constituent at this account?
sequence	sequence	integer	The social media account sequence.

Conmg.CreatedConstituentAddress

Created constituent address

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

Conmg.CreatedConstituentAlternateLookupID

Created constituent alternate lookup ID

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

Conmg.CreatedConstituentAppeal

Created constituent appeal

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

Conmg.CreatedConstituentAppealResponse

Created constituent appeal response

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

Conmg.CreatedConstituentEducation

Created constituent education

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

Conmg.CreatedConstituentEmailAddress

Created constituent email address

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

Conmg.CreatedConstituentEmploymentHistory

Created constituent employment history

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

Conmg.CreatedConstituentInteraction

Created constituent interaction

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

Conmg.CreatedConstituentNote

Created constituent note

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

Conmg.CreatedConstituentPhone

Created constituent phone

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

Conmg.CreatedConstituentSolicitCode

Created constituent solicit code

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

Conmg.CreatedFundraiserConstituency

Created fundraiser constituency

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

Conmg.CreatedIndividualConstituent

Created individual constituent

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

Conmg.CreatedOrganizationConstituent

Created organization constituent

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

Conmg.Education

Education

Name	Path	Type	Description
ID	id	string	The system record ID of the constituent education.
Educational institution	name	string	The educational institution.
Status	education_history_status	string	The status of the education.
Primary?	primary_record	boolean	Is this the constituent's primary education?
Program	program	string	The educational program.
Degree	degree	string	The educational degree.
Class of	class_of	integer	The class of.
Afflilated?	affiliated	boolean	Is the educational institution affiliated with the organization?
year	start_date.year	integer	The year in the fuzzy date.
month	start_date.month	integer	The month in the fuzzy date.
day	start_date.day	integer	The day in the fuzzy date.
year	end_date.year	integer	The year in the fuzzy date.
month	end_date.month	integer	The month in the fuzzy date.
day	end_date.day	integer	The day in the fuzzy date.

Conmg.EducationCollection

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

Conmg.EmailAddress

Email address

Name	Path	Type	Description
ID	id	string	The system record ID of the email address.
Email type	type	string	The type of email address.
Email address	email_address	string	The email address.
Primary?	primary	boolean	Is this the constituent's primary email address?
Start date	start_date	date-time	The email address start date.
End date	end_date	date	The email address end date.
Info source	info_source	string	The information source.
Info source comments	info_source_comments	string	The information source comments.

Conmg.EmailAddressCollection

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

Conmg.EmploymentHistory

Employment history

Name	Path	Type	Description
ID	id	string	The system record ID of the constituent employment history.
Relationship	name	string	The constituent relationship.
Job title	job_title	string	The job title.
Career level	career_level	string	The career level.
Category	job_category	string	The job category.
Start date	start_date	date-time	The employment start date.
End date	end_date	date-time	The employment end date.
Department	job_department	string	The job department.
Division	job_division	string	The job division.
Career level	job_schedule	string	The career level.
Responsibilities	job_responsibility	string	The job responsibilities.
Is private?	private_record	boolean	Is the employment history private?

Conmg.EmploymentHistoryCollection

Employment histories

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

Conmg.IndividualConstituent

Individual constituent

Name	Path	Type	Description
Title	title	string	The constituent's primary title.
First name	first_name	string	The constituent's first name.
Last name	last_name	string	The constituent's last name.
Suffix	suffix	string	The constituent's primary suffix.
Middle name	middle_name	string	The constituent's middle name.
Nickname	nickname	string	The constituent's nickname.
Maiden name	maiden_name	string	The constituent's maiden name.
Marital status	marital_status	string	The marital status.
year	birth_date.year	integer	The year in the fuzzy date.
month	birth_date.month	integer	The month in the fuzzy date.
day	birth_date.day	integer	The day in the fuzzy date.
Age	age	integer	The constituent's age.
Gender	gender_code	string	The constituent's gender.
Website	web_address	string	The constituent's website.
Title 2	title_2	string	The constituent's secondary title.
Suffix 2	suffix_2	string	The constituent's secondary suffix
Gives anonymously?	gives_anonymously	boolean	Does the constituent give anonymously?
Deceased?	deceased	boolean	Is the constituent deceased?
Profile picture	picture	string	The constituent's profile picture.
Profile picture thumbnail	picture_thumbnail	string	The constituent's profile picture thumbnail.

Conmg.MergedConstituent

Merged constituent

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

Conmg.OrganizationConstituent

Organization constituent

Name	Path	Type	Description
Name	organization_name	string	The organization name.
Industry	industry	string	The industry.
Parent corporation	parent_corp_id	string	The system record ID of the parent corporation.
Number of employees	num_employees	integer	The number of employees.
Number of subsidiaries	num_subsidiaries	integer	The number of subsidiary organizations.
Website	web_address	string	The organization website.
Is a primary organization?	is_primary	boolean	Is the constituent a primary organization?
Profile picture	picture	string	The organization's profile picture.
Profile picture thumbnail	picture_thumbnail	string	The organization's profile picture thumbnail.
Primary address ID	primary_address_id	string	The system record ID of the primary address.
Primary address type	address_type	string	The primary address type.
Primary address country	address_country	string	The primary address country.
Primary address block	address_block	string	The primary address block.
Primary address city	address_city	string	The primary address city.
Primary address state	address_state	string	The primary address state.
Primary address postal code	address_postcode	string	The primary address postal code.
Do not mail?	address_do_not_mail	boolean	Do not contact the constituent at this address?
Do not mail reason	address_do_not_mail_reason	string	The reason for not contacting the constituent at this address.
Primary phone ID	primary_phone_id	string	The system record ID of the primary phone number.
Primary phone type	phone_type	string	The primary phone type.
Primary phone number	phone_number	string	The primary phone number.
Primary email address ID	primary_email_address_id	string	The system record ID of the primary email address.
Primary email address type	email_address_type	string	The primary email address type.
Primary email address	email_address	string	The primary email address.

Conmg.Phone

Phone

Name	Path	Type	Description
ID	id	string	The system record ID of the phone.
Type	type	string	The phone type.
Country	country	string	The phone country.
Number	phone_number	string	The phone number.
Primary?	primary	boolean	Is this the constituent's primary phone?
Do not call?	donotcall	boolean	Do not contact the constituent at this number?
Info source	info_source	string	The information source.
Info source comments	info_source_comments	string	The information source comments.
Start date	start_date	date-time	The phone call start date.
End date	end_date	date-time	The phone call end date.
hour	start_time.hour	integer	The hour.
minute	start_time.minute	integer	The minute.
hour	end_time.hour	integer	The hour.
minute	end_time.minute	integer	The minute.

Conmg.PhoneCollection

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

Conmg.SolicitCode

Solicit code

Name	Path	Type	Description
ID	id	string	The system record ID of the solicit code.
Solicit code	description	string	The solicit code.
Start date	start_date	date-time	The solicit code start date.
End date	end_date	date-time	The solicit code end date.
Comments	comments	string	The solicit code comments.
Expired?	expired	boolean	Is the solicit code expired?

Conmg.SolicitCodeCollection

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

Conmg.Tribute

Tribute

Name	Path	Type	Description
ID	id	string	The system record ID of the tribute.
Tribute type	tribute_type	string	The tribute type.
Tribute text	tribute_text	string	The tribute text.
Is tributee?	tributee	boolean	Is the constituent the tributee?
Is acknowledgee?	acknowledgee	boolean	Is the constituent an acknowledgee?
Active?	active	boolean	Is the tribute active?
Date created	date_created	date-time	The date the tribute was created.

Conmg.TributeCollection

Tributes

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

The future is yours

Share via

Blackbaud Altru Constituent (Preview)

Prerequisites

How to get credentials?

Known issues and limitations

Throttling Limits

Actions

Create a constituent address

Parameters

Returns

Create a constituent alternate lookup ID

Parameters

Returns

Create a constituent appeal

Parameters

Returns

Create a constituent appeal response

Parameters

Returns

Create a constituent education

Parameters

Returns

Create a constituent email address

Parameters

Returns

Create a constituent employment history

Parameters

Returns

Create a constituent interaction

Parameters

Returns

Create a constituent note

Parameters

Returns

Create a constituent phone

Parameters

Returns

Create a constituent solicit code

Parameters

Returns

Create a fundraiser constituency

Parameters

Returns

Create an individual constituent

Parameters

Returns

Create an organization constituent

Parameters

Returns

Delete a constituent

Parameters

Delete a constituent address

Parameters

Delete a constituent alternate lookup ID

Parameters

Delete a constituent appeal

Parameters

Delete a constituent attribute

Parameters

Delete a constituent education

Parameters

Delete a constituent email address

Parameters

Delete a constituent employment history

Parameters

Delete a constituent interaction

Parameters

Delete a constituent note

Parameters

Delete a constituent phone

Parameters

Delete a constituent solicit code

Parameters

Delete a fundraiser constituency

Parameters

Get a constituent interaction

Parameters

Returns

Get a constituent profile picture