Connectors Reference

Blackbaud Raisers Edge NXT

Blackbaud Raiser's Edge NXT is a comprehensive cloud-based fundraising and donor management software solution built specifically for nonprofits and the entire social good community.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

ListConsentCategories ([Optional]boolean include_inactive)

List consent categories

ListConsentChannels ()

List consent channels

CreateConstituentConsent (CommPrefApi.ConstituentConsentAdd body)

Create a constituent consent record

ListConsentSources ([Optional]boolean include_inactive)

List consent sources

ListConstituentConsents (string constituent_id, [Optional]boolean most_recent_only)

List constituent consent records

ListConstituentSolicitCodes (string constituent_id)

List constituent solicit codes

CreateConstituentSolicitCode (CommPrefApi.ConstituentSolicitCodeAdd body)

Create a constituent solicit code

EditConstituentSolicitCode (string constituent_solicit_code_id, CommPrefApi.ConstituentSolicitCodeEdit body)

Update a constituent solicit code

ListSolicitCodes ()

List solicit codes

ListActions ([Optional]string list_id, [Optional]string computed_status, [Optional]string status_code, [Optional]integer limit, [Optional]integer offset, [advanced][Optional]string date_added, [advanced][Optional]string last_modified)

List actions

CreateAction (ConstituentApi.ActionAdd body)

Create a constituent action

GetAction (string action_id)

Get a constituent action

EditAction (string action_id, ConstituentApi.ActionEdit body)

Update a constituent action

ListActionAttachments (string action_id)

List action attachments

ListActionCustomFields (string action_id)

List action custom fields

CreateActionAttachment (ConstituentApi.ActionAttachmentAdd body)

Create an action attachment

EditActionAttachment (string attachment_id, ConstituentApi.ActionAttachmentEdit body)

Update an action attachment

CreateActionCustomField (ConstituentApi.ActionCustomFieldAdd body)

Create an action custom field

EditActionCustomField (string custom_field_id, ConstituentApi.ActionCustomFieldEdit body)

Update an action custom field

ListActionCustomFieldCategoryDetails ()

List custom field categories

CreateConstituentAddress (ConstituentApi.AddressAdd body)

Create a constituent address

EditConstituentAddress (string address_id, ConstituentApi.AddressEdit body)

Update a constituent address

CreateConstituentAlias (ConstituentApi.AliasAdd body)

Create a constituent alias

EditConstituentAlias (string alias_id, ConstituentApi.AliasEdit body)

Update a constituent alias

CreateConstituentCode (ConstituentApi.ConstituentCodeAdd body)

Create a constituent code

EditConstituentCode (string constituent_code_id, ConstituentApi.ConstituentCodeEdit body)

Update a constituent code

ListConstituents ([Optional]string list_id, [Optional]integer limit, [Optional]integer offset, [advanced][Optional]string constituent_code, [advanced][Optional]string constituent_id, [advanced][Optional]string custom_field_category, [advanced][Optional]string fundraiser_status, [advanced][Optional]boolean include_deceased, [advanced][Optional]boolean include_inactive, [advanced][Optional]string postal_code, [advanced][Optional]string date_added, [advanced][Optional]string last_modified, [advanced][Optional]string sort)

List constituents

GetConstituent (string constituent_id)

Get a constituent

EditConstituent (string constituent_id, ConstituentApi.ConstituentEdit body)

Update a constituent

ListConstituentActions (string constituent_id)

List constituent actions

ListConstituentAddresses (string constituent_id, [Optional]boolean include_inactive)

List constituent addresses

ListConstituentAliases (string constituent_id)

List constituent aliases

ListConstituentAttachments (string constituent_id)

List constituent attachments

ListConstituentCodes (string constituent_id)

List constituent codes

ListConstituentCustomFields (string constituent_id)

List constituent custom fields

ListConstituentEducations (string constituent_id)

List constituent educations

ListConstituentEmailAddresses (string constituent_id, [Optional]boolean include_inactive)

List constituent email addresses

ListConstituentFundraiserAssignments (string constituent_id, [Optional]boolean include_inactive)

List constituent fundraiser assignments

ListConstituentNotes (string constituent_id)

List constituent notes

ListConstituentOnlinePresences (string constituent_id, [Optional]boolean include_inactive)

List constituent online presences

ListConstituentPhones (string constituent_id, [Optional]boolean include_inactive)

List constituent phones

GetConstituentProfilePicture (string constituent_id)

Get a constituent profile picture

EditConstituentProfilePicture (string constituent_id, ConstituentApi.ProfilePictureEdit body)

Update a constituent profile picture

ListConstituentRatings (string constituent_id, [advanced][Optional]boolean include_inactive, [advanced][Optional]boolean most_recent_only)

List constituent ratings

ListConstituentRelationships (string constituent_id, [Optional]integer limit, [Optional]integer offset)

List constituent relationships

CreateConstituentAttachment (ConstituentApi.ConstituentAttachmentAdd body)

Create a constituent attachment

EditConstituentAttachment (string attachment_id, ConstituentApi.ConstituentAttachmentEdit body)

Update a constituent attachment

CreateConstituentCustomField (ConstituentApi.ConstituentCustomFieldAdd body)

Create a constituent custom field

EditConstituentCustomField (string custom_field_id, ConstituentApi.ConstituentCustomFieldEdit body)

Update a constituent custom field

ListConstituentCustomFieldCategoryDetails ()

List custom field categories

SearchConstituent (string search_text, [advanced][Optional]string fundraiser_status, [advanced][Optional]boolean include_inactive, [advanced][Optional]string search_field, [advanced][Optional]boolean strict_search, [advanced][Optional]integer limit, [advanced][Optional]integer offset)

Search for a constituent

ListCountries ()

List country definitions

CreateDocument (ConstituentApi.NewDocumentInfo body)

Create a document location

CreateConstituentEducation (ConstituentApi.EducationAdd body)

Create a constituent education

EditConstituentEducation (string education_id, ConstituentApi.EducationEdit body)

Update a constituent education

CreateConstituentEmailAddress (ConstituentApi.EmailAddressAdd body)

Create a constituent email address

EditConstituentEmailAddress (string email_address_id, ConstituentApi.EmailAddressEdit body)

Update a constituent email address

ListNameFormatConfigurations ()

List name format configurations

CreateConstituentNote (ConstituentApi.NoteAdd body)

Create a constituent note

EditConstituentNote (string note_id, ConstituentApi.NoteEdit body)

Update a constituent note

CreateConstituentOnlinePresence (ConstituentApi.OnlinePresenceAdd body)

Create a constituent online presence

EditConstituentOnlinePresence (string online_presence_id, ConstituentApi.OnlinePresenceEdit body)

Update a constituent online presence

CreateConstituentPhone (ConstituentApi.PhoneAdd body)

Create a constituent phone

EditConstituentPhone (string phone_id, ConstituentApi.PhoneEdit body)

Update a constituent phone

CreateConstituentRating (ConstituentApi.RatingAdd body)

Create a constituent rating

ListRatingCategories ([Optional]boolean include_inactive, [Optional]string source_name)

List rating categories

ListRatingSources ([Optional]boolean include_inactive)

List rating sources

EditConstituentRelationship (string relationship_id, ConstituentApi.RelationshipEdit body)

Update a constituent relationship

CreateIndividualConstituent (ConstituentApi.Virtual.IndividualAdd body)

Create an individual constituent

CreateIndividualRelationship (ConstituentApi.Virtual.IndividualRelationshipAdd body)

Create an individual relationship

CreateOrganizationConstituent (ConstituentApi.Virtual.OrganizationAdd body)

Create an organization constituent

CreateOrganizationRelationship (ConstituentApi.Virtual.OrganizationRelationshipAdd body)

Create an organization relationship

ListEventCategories ()

List event categories

ListEvents ([Optional]string category, [Optional]string start_date_from, [Optional]string start_date_to, [Optional]boolean include_inactive, [Optional]integer limit, [Optional]integer offset, [advanced][Optional]string event_id, [advanced][Optional]string name, [advanced][Optional]string date_added, [advanced][Optional]string last_modified)

List events

CreateEvent (EventApi.CreateEvent body)

Create an event

GetEvent (string event_id)

Get an event

EditEvent (string event_id, EventApi.EditEvent body)

Update an event

ListEventFees (string event_id)

List event fees

CreateEventFee (string event_id, EventApi.CreateEventFee body)

Create an event fee

ListEventParticipantOptions (string event_id)

List event participant options

CreateEventParticipantOption (string event_id, EventApi.CreateEventParticipantOption body)

Create an event participant option

ListEventParticipants (string event_id, [Optional]string rsvp_status, [Optional]string invitation_status, [Optional]string participation_level, [Optional]boolean attended_filter, [Optional]boolean fees_paid_filter, [Optional]integer limit, [Optional]integer offset, [advanced][Optional]boolean is_constituent_filter, [advanced][Optional]boolean email_eligible_filter, [advanced][Optional]boolean phone_call_eligible_filter, [advanced][Optional]string name, [advanced][Optional]string date_added, [advanced][Optional]string last_modified)

List event participants

CreateParticipant (string event_id, EventApi.CreateParticipant body)

Create a participant

EditParticipantOption (string option_id, EventApi.EditParticipantOption body)

Update a participant option

GetParticipant (string participant_id)

Get a participant

EditParticipant (string participant_id, EventApi.EditParticipant body)

Update a participant

ListParticipantFeePayments (string participant_id, [Optional]integer limit, [Optional]integer offset)

List participant fee payments

CreateParticipantFeePayment (string participant_id, EventApi.CreateParticipantFeePayment body)

Create a participant fee payment

ListParticipantFees (string participant_id, [Optional]integer limit, [Optional]integer offset)

List participant fees

CreateParticipantFee (string participant_id, EventApi.CreateParticipantFee body)

Create a participant fee

ListParticipantOptions (string participant_id)

List participant options

CreateParticipantOption (string participant_id, EventApi.CreateParticipantOption body)

Create a participant option

ListParticipationLevels ()

List participation levels

ListAppeals ([Optional]integer limit, [Optional]integer offset, [advanced][Optional]boolean include_inactive, [advanced][Optional]string date_added, [advanced][Optional]string last_modified)

List appeals

GetAppeal (string appeal_id)

Get an appeal

ListAppealAttachments (string appeal_id)

List appeal attachments

ListAppealCustomFields (string appeal_id)

List appeal custom fields

CreateAppealAttachment (FundraisingApi.AppealAttachmentAdd body)

Create an appeal attachment

EditAppealAttachment (string attachment_id, FundraisingApi.AppealAttachmentEdit body)

Update an appeal attachment

CreateAppealCustomField (FundraisingApi.AppealCustomFieldAdd body)

Create an appeal custom field

EditAppealCustomField (string custom_field_id, FundraisingApi.AppealCustomFieldEdit body)

Update an appeal custom field

ListAppealCustomFieldCategories ()

List appeal custom field categories

ListCampaigns ([Optional]integer limit, [Optional]integer offset, [advanced][Optional]boolean include_inactive, [advanced][Optional]string date_added, [advanced][Optional]string last_modified)

List campaigns

GetCampaign (string campaign_id)

Get a campaign

ListCampaignAttachments (string campaign_id)

List campaign attachments

ListCampaignCustomFields (string campaign_id)

List campaign custom fields

CreateCampaignAttachment (FundraisingApi.CampaignAttachmentAdd body)

Create a campaign attachment

EditCampaignAttachment (string attachment_id, FundraisingApi.CampaignAttachmentEdit body)

Update a campaign attachment

CreateCampaignCustomField (FundraisingApi.CampaignCustomFieldAdd body)

Create a campaign custom field

EditCampaignCustomField (string custom_field_id, FundraisingApi.CampaignCustomFieldEdit body)

Update a campaign custom field

ListCampaignCustomFieldCategories ()

List campaign custom field categories

ListFunds ([Optional]integer limit, [Optional]integer offset, [advanced][Optional]boolean include_inactive, [advanced][Optional]string date_added, [advanced][Optional]string last_modified)

List funds

GetFund (string fund_id)

Get a fund

ListFundAttachments (string fund_id)

List fund attachments

ListFundCustomFields (string fund_id)

List fund custom fields

CreateFundAttachment (FundraisingApi.FundAttachmentAdd body)

Create a fund attachment

EditFundAttachment (string attachment_id, FundraisingApi.FundAttachmentEdit body)

Update a fund attachment

CreateFundCustomField (FundraisingApi.FundCustomFieldAdd body)

Create a fund custom field

EditFundCustomField (string custom_field_id, FundraisingApi.FundCustomFieldEdit body)

Update a fund custom field

ListFundCustomFieldCategories ()

List fund custom field categories

ListPackages ([Optional]string appeal_id, [Optional]integer limit, [Optional]integer offset, [advanced][Optional]boolean include_inactive, [advanced][Optional]string date_added, [advanced][Optional]string last_modified)

List packages

GetPackage (string package_id)

Get a package

EditGiftAcknowledgement (string acknowledgement_id, GiftApi.AcknowledgementEdit body)

Update gift acknowledgement details

EditGiftReceipt (string receipt_id, GiftApi.ReceiptEdit body)

Update gift receipt details

ListGifts ([Optional]string list_id, [Optional]string gift_type, [Optional]string constituent_id, [Optional]string campaign_id, [Optional]string fund_id, [Optional]string appeal_id, [Optional]integer limit, [Optional]integer offset, [advanced][Optional]string start_gift_date, [advanced][Optional]string end_gift_date, [advanced][Optional]number start_gift_amount, [advanced][Optional]number end_gift_amount, [advanced][Optional]string post_status, [advanced][Optional]string receipt_status, [advanced][Optional]string acknowledgement_status, [advanced][Optional]string date_added, [advanced][Optional]string last_modified)

List gifts

CreateGift (GiftApi.GiftAdd body)

Create a gift

GetGift (string gift_id)

Get a gift

ListGiftAttachments (string gift_id)

List gift attachments

ListGiftCustomFields (string gift_id)

List gift custom fields

CreateGiftAttachment (GiftApi.GiftAttachmentAdd body)

Create a gift attachment

EditGiftAttachment (string attachment_id, GiftApi.GiftAttachmentEdit body)

Update a gift attachment

CreateGiftCustomField (GiftApi.GiftCustomFieldAdd body)

Create a gift custom field

EditGiftCustomField (string custom_field_id, GiftApi.GiftCustomFieldEdit body)

Update a gift custom field

ListGiftCustomFieldCategories ()

List custom field categories

ListLists (string list_type)

List lists

ListOpportunities ([Optional]string list_id, [Optional]string constituent_id, [Optional]integer limit, [Optional]integer offset, [advanced][Optional]boolean include_inactive, [advanced][Optional]string date_added, [advanced][Optional]string last_modified)

List opportunities

CreateOpportunity (OpportunityApi.OpportunityAdd body)

Create an opportunity

GetOpportunity (string opportunity_id)

Get an opportunity

EditOpportunity (string opportunity_id, OpportunityApi.OpportunityEdit body)

Update an opportunity

ListOpportunityAttachments (string opportunity_id)

List opportunity attachments

ListOpportunityCustomFields (string opportunity_id)

List opportunity custom fields

CreateOpportunityAttachment (OpportunityApi.OpportunityAttachmentAdd body)

Create an opportunity attachment

EditOpportunityAttachment (string attachment_id, OpportunityApi.OpportunityAttachmentEdit body)

Update an opportunity attachment

CreateOpportunityCustomField (OpportunityApi.OpportunityCustomFieldAdd body)

Create an opportunity custom field

EditOpportunityCustomField (string custom_field_id, OpportunityApi.OpportunityCustomFieldEdit body)

Update an opportunity custom field

ListOpportunityCustomFieldCategories ()

List custom field categories

GetDynamicValues (string api, string route)

Get dynamic values

GetCustomFieldCodeTableDynamicValues (string api, string custom_field_type, string category_name)

Get custom field code table dynamic values

GetParticipantOptionListDynamicValues (string event_id, string event_participant_option_id)

Get participant option list dynamic values

GetCustomFieldDynamicProperties (string api, string custom_field_type, string category)

Get custom field dynamic properties

GetParticipantOptionDynamicProperties (string event_id, string event_participant_option_id)

Get participant option dynamic properties

GetRatingDynamicProperties (string source_name, string category)

Get rating category dynamic properties

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

CommPrefApi.ConsentCategory

 

CommPrefApi.ConsentCategoryCollection

 

CommPrefApi.ConsentChannel

 

CommPrefApi.ConsentChannelCollection

 

CommPrefApi.ConsentSource

 

CommPrefApi.ConsentSourceCollection

 

CommPrefApi.ConstituentConsentAdd

 

CommPrefApi.ConstituentConsentRead

 

CommPrefApi.ConstituentConsentReadCollection

 

CommPrefApi.ConstituentSolicitCodeAdd

 

CommPrefApi.ConstituentSolicitCodeEdit

 

CommPrefApi.ConstituentSolicitCodeRead

 

CommPrefApi.ConstituentSolicitCodeReadCollection

 

CommPrefApi.CreatedConstituentConsent

 

CommPrefApi.CreatedConstituentSolicitCode

 

CommPrefApi.SolicitCode

 

CommPrefApi.SolicitCodeCollection

 

ConstituentApi.ActionAdd

 

ConstituentApi.ActionAttachmentAdd

 

ConstituentApi.ActionAttachmentEdit

 

ConstituentApi.ActionAttachmentRead

 

ConstituentApi.ActionCustomFieldAdd

 

ConstituentApi.ActionCustomFieldEdit

 

ConstituentApi.ActionCustomFieldRead

 

ConstituentApi.ActionEdit

 

ConstituentApi.ActionRead

 

ConstituentApi.AddressAdd

 

ConstituentApi.AddressEdit

 

ConstituentApi.AddressRead

 

ConstituentApi.AliasAdd

 

ConstituentApi.AliasEdit

 

ConstituentApi.AliasRead

 

ConstituentApi.ApiCollectionOfActionAttachmentRead

 

ConstituentApi.ApiCollectionOfActionCustomFieldRead

 

ConstituentApi.ApiCollectionOfActionRead

 

ConstituentApi.ApiCollectionOfAddressRead

 

ConstituentApi.ApiCollectionOfAliasRead

 

ConstituentApi.ApiCollectionOfConstituentAttachmentRead

 

ConstituentApi.ApiCollectionOfConstituentCodeRead

 

ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

 

ConstituentApi.ApiCollectionOfConstituentRead

 

ConstituentApi.ApiCollectionOfCountryRead

 

ConstituentApi.ApiCollectionOfCustomFieldCategoryRead

 

ConstituentApi.ApiCollectionOfEducationRead

 

ConstituentApi.ApiCollectionOfEmailAddressRead

 

ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

 

ConstituentApi.ApiCollectionOfNameFormatConfigurationRead

 

ConstituentApi.ApiCollectionOfNoteRead

 

ConstituentApi.ApiCollectionOfOnlinePresenceRead

 

ConstituentApi.ApiCollectionOfPhoneRead

 

ConstituentApi.ApiCollectionOfRatingCategoryRead

 

ConstituentApi.ApiCollectionOfRatingRead

 

ConstituentApi.ApiCollectionOfRatingSourceRead

 

ConstituentApi.ApiCollectionOfRelationshipRead

 

ConstituentApi.ApiCollectionOfSearchResultRead

 

ConstituentApi.ConstituentAttachmentAdd

 

ConstituentApi.ConstituentAttachmentEdit

 

ConstituentApi.ConstituentAttachmentRead

 

ConstituentApi.ConstituentCodeAdd

 

ConstituentApi.ConstituentCodeEdit

 

ConstituentApi.ConstituentCodeRead

 

ConstituentApi.ConstituentCustomFieldAdd

 

ConstituentApi.ConstituentCustomFieldEdit

 

ConstituentApi.ConstituentCustomFieldRead

 

ConstituentApi.ConstituentEdit

 

ConstituentApi.ConstituentRead

 

ConstituentApi.CountryRead

 

ConstituentApi.CreatedAction

 

ConstituentApi.CreatedActionAttachment

 

ConstituentApi.CreatedActionCustomField

 

ConstituentApi.CreatedConstituentAddress

 

ConstituentApi.CreatedConstituentAlias

 

ConstituentApi.CreatedConstituentAttachment

 

ConstituentApi.CreatedConstituentCode

 

ConstituentApi.CreatedConstituentCustomField

 

ConstituentApi.CreatedConstituentEducation

 

ConstituentApi.CreatedConstituentEmailAddress

 

ConstituentApi.CreatedConstituentNote

 

ConstituentApi.CreatedConstituentOnlinePresence

 

ConstituentApi.CreatedConstituentPhone

 

ConstituentApi.CreatedConstituentRating

 

ConstituentApi.CreatedIndividualConstituent

 

ConstituentApi.CreatedIndividualRelationship

 

ConstituentApi.CreatedOrganizationConstituent

 

ConstituentApi.CreatedOrganizationRelationship

 

ConstituentApi.CustomFieldCategoryRead

 

ConstituentApi.EducationAdd

 

ConstituentApi.EducationEdit

 

ConstituentApi.EducationRead

 

ConstituentApi.EmailAddressAdd

 

ConstituentApi.EmailAddressEdit

 

ConstituentApi.EmailAddressRead

 

ConstituentApi.FileDefinition

 

ConstituentApi.FundraiserAssignmentRead

 

ConstituentApi.Header

 

ConstituentApi.NameFormatConfigurationRead

 

ConstituentApi.NewDocumentInfo

 

ConstituentApi.NoteAdd

 

ConstituentApi.NoteEdit

 

ConstituentApi.NoteRead

 

ConstituentApi.OnlinePresenceAdd

 

ConstituentApi.OnlinePresenceEdit

 

ConstituentApi.OnlinePresenceRead

 

ConstituentApi.PhoneAdd

 

ConstituentApi.PhoneEdit

 

ConstituentApi.PhoneRead

 

ConstituentApi.ProfilePictureEdit

 

ConstituentApi.ProfilePictureRead

 

ConstituentApi.RatingAdd

 

ConstituentApi.RatingCategoryRead

 

ConstituentApi.RatingRead

 

ConstituentApi.RatingSourceRead

 

ConstituentApi.RelationshipEdit

 

ConstituentApi.RelationshipRead

 

ConstituentApi.SearchResultRead

 

ConstituentApi.Virtual.IndividualAdd

 

ConstituentApi.Virtual.IndividualRelationshipAdd

 

ConstituentApi.Virtual.OrganizationAdd

 

ConstituentApi.Virtual.OrganizationRelationshipAdd

 

EventApi.AdministrativeArea

administrative area

EventApi.ApiCollectionOfEventCategory

 

EventApi.ApiCollectionOfEventFee

 

EventApi.ApiCollectionOfEventListEntry

 

EventApi.ApiCollectionOfEventParticipantOption

 

EventApi.ApiCollectionOfParticipantFee

 

EventApi.ApiCollectionOfParticipantFeePayment

 

EventApi.ApiCollectionOfParticipantListEntry

 

EventApi.ApiCollectionOfParticipantOption

 

EventApi.ApiCollectionOfParticipationLevel

 

EventApi.Country

country

EventApi.CreatedEvent

 

EventApi.CreatedEventFee

 

EventApi.CreatedEventParticipantOption

 

EventApi.CreatedParticipant

 

EventApi.CreatedParticipantFee

 

EventApi.CreatedParticipantFeePayment

 

EventApi.CreatedParticipantOption

 

EventApi.CreateEvent

 

EventApi.CreateEventFee

 

EventApi.CreateEventParticipantOption

 

EventApi.CreateParticipant

 

EventApi.CreateParticipantFee

 

EventApi.CreateParticipantFeePayment

 

EventApi.CreateParticipantOption

 

EventApi.CreateParticipantOptionListOption

List options

EventApi.EditEvent

 

EventApi.EditParticipant

 

EventApi.EditParticipantOption

 

EventApi.Event

 

EventApi.EventCategory

Category

EventApi.EventFee

Event fee

EventApi.EventListEntry

 

EventApi.EventParticipantOption

Event participant option

EventApi.EventParticipantOptionListOption

 

EventApi.Locality

locality

EventApi.Location

Location

EventApi.Membership

 

EventApi.MembershipCategory

Membership category

EventApi.Participant

 

EventApi.ParticipantFee

Participant fee

EventApi.ParticipantFeePayment

Participant fee payment

EventApi.ParticipantListEntry

 

EventApi.ParticipantListParticipantSummary

 

EventApi.ParticipantOption

Participant option

EventApi.ParticipationLevel

Participation level

EventApi.SubAdministrativeArea

sub-administrative area

FundraisingApi.ApiCollectionOfAppealAttachmentRead

 

FundraisingApi.ApiCollectionOfAppealCustomFieldRead

 

FundraisingApi.ApiCollectionOfAppealRead

 

FundraisingApi.ApiCollectionOfCampaignAttachmentRead

 

FundraisingApi.ApiCollectionOfCampaignCustomFieldRead

 

FundraisingApi.ApiCollectionOfCampaignRead

 

FundraisingApi.ApiCollectionOfCustomFieldCategoryRead

 

FundraisingApi.ApiCollectionOfFundAttachmentRead

 

FundraisingApi.ApiCollectionOfFundCustomFieldRead

 

FundraisingApi.ApiCollectionOfFundRead

 

FundraisingApi.ApiCollectionOfPackageRead

 

FundraisingApi.AppealAttachmentAdd

 

FundraisingApi.AppealAttachmentEdit

 

FundraisingApi.AppealAttachmentRead

 

FundraisingApi.AppealCustomFieldAdd

 

FundraisingApi.AppealCustomFieldEdit

 

FundraisingApi.AppealCustomFieldRead

 

FundraisingApi.AppealRead

 

FundraisingApi.CampaignAttachmentAdd

 

FundraisingApi.CampaignAttachmentEdit

 

FundraisingApi.CampaignAttachmentRead

 

FundraisingApi.CampaignCustomFieldAdd

 

FundraisingApi.CampaignCustomFieldEdit

 

FundraisingApi.CampaignCustomFieldRead

 

FundraisingApi.CampaignRead

 

FundraisingApi.CreatedAppealAttachment

 

FundraisingApi.CreatedAppealCustomField

 

FundraisingApi.CreatedCampaignAttachment

 

FundraisingApi.CreatedCampaignCustomField

 

FundraisingApi.CreatedFundAttachment

 

FundraisingApi.CreatedFundCustomField

 

FundraisingApi.CustomFieldCategoryRead

 

FundraisingApi.FundAttachmentAdd

 

FundraisingApi.FundAttachmentEdit

 

FundraisingApi.FundAttachmentRead

 

FundraisingApi.FundCustomFieldAdd

 

FundraisingApi.FundCustomFieldEdit

 

FundraisingApi.FundCustomFieldRead

 

FundraisingApi.FundRead

 

FundraisingApi.PackageRead

 

GiftApi.AcknowledgementEdit

 

GiftApi.AcknowledgementRead

 

GiftApi.ApiCollectionOfCustomFieldCategoryRead

 

GiftApi.ApiCollectionOfGiftAttachmentRead

 

GiftApi.ApiCollectionOfGiftCustomFieldRead

 

GiftApi.ApiCollectionOfGiftRead

 

GiftApi.CreatedGift

 

GiftApi.CreatedGiftAttachment

 

GiftApi.CreatedGiftCustomField

 

GiftApi.CustomFieldCategoryRead

 

GiftApi.GiftAdd

 

GiftApi.GiftAttachmentAdd

 

GiftApi.GiftAttachmentEdit

 

GiftApi.GiftAttachmentRead

 

GiftApi.GiftCustomFieldAdd

 

GiftApi.GiftCustomFieldEdit

 

GiftApi.GiftCustomFieldRead

 

GiftApi.GiftFundraiserRead

 

GiftApi.GiftRead

 

GiftApi.GiftSplitAdd

 

GiftApi.GiftSplitRead

 

GiftApi.PaymentRead

 

GiftApi.ReceiptEdit

 

GiftApi.ReceiptRead

 

GiftApi.SoftCreditRead

 

ListApi.ApiCollectionOfList

 

ListApi.ApiList

 

OpportunityApi.ApiCollectionOfCustomFieldCategoryRead

 

OpportunityApi.ApiCollectionOfOpportunityAttachmentRead

 

OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead

 

OpportunityApi.ApiCollectionOfOpportunityRead

 

OpportunityApi.CreatedOpportunity

 

OpportunityApi.CreatedOpportunityAttachment

 

OpportunityApi.CreatedOpportunityCustomField

 

OpportunityApi.CustomFieldCategoryRead

 

OpportunityApi.Fundraiser

 

OpportunityApi.OpportunityAdd

 

OpportunityApi.OpportunityAttachmentAdd

 

OpportunityApi.OpportunityAttachmentEdit

 

OpportunityApi.OpportunityAttachmentRead

 

OpportunityApi.OpportunityCustomFieldAdd

 

OpportunityApi.OpportunityCustomFieldEdit

 

OpportunityApi.OpportunityCustomFieldRead

 

OpportunityApi.OpportunityEdit

 

OpportunityApi.OpportunityRead

 

PowerAutomateUIApi.DynamicProperties

 

PowerAutomateUIApi.DynamicValue

 

PowerAutomateUIApi.DynamicValuesCollection

 

 

Actions:

ListConsentCategories

Summary: List consent categories

Description: Lists the available consent categories.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConsentCategories ([Optional]boolean include_inactive)

 

Parameters:

Name

Type

Summary

Required

Related Action

include_inactive

boolean

(Include inactive?)

Include inactive categories?

False

 

Returns:

          Type:CommPrefApi.ConsentCategoryCollection

          Description: Consent categories

 

ListConsentChannels

Summary: List consent channels

Description: Lists the available consent channels.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConsentChannels ()

 

Returns:

          Type:CommPrefApi.ConsentChannelCollection

          Description: Consent channels

 

CreateConstituentConsent

Summary: Create a constituent consent record

Description: Creates a new constituent consent record.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateConstituentConsent (CommPrefApi.ConstituentConsentAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CommPrefApi.ConstituentConsentAdd

 

Represents the consent entity to add to the specified constituent.

True

 

Returns:

          Type:CommPrefApi.CreatedConstituentConsent

          Description: Created constituent consent

 

ListConsentSources

Summary: List consent sources

Description: Lists the available consent sources.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConsentSources ([Optional]boolean include_inactive)

 

Parameters:

Name

Type

Summary

Required

Related Action

include_inactive

boolean

(Include inactive?)

Include inactive sources?

False

 

Returns:

          Type:CommPrefApi.ConsentSourceCollection

          Description: Consent sources

 

ListConstituentConsents

Summary: List constituent consent records

Description: Lists the consent records for a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConstituentConsents (string constituent_id, [Optional]boolean most_recent_only)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent.

True

most_recent_only

boolean

(Most recent only?)

Include only the most recent consent records for each channel category combination in the response?

False

 

Returns:

          Type:CommPrefApi.ConstituentConsentReadCollection

          Description: Consent records

 

ListConstituentSolicitCodes

Summary: List constituent solicit codes

Description: Lists the solicit codes for a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConstituentSolicitCodes (string constituent_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent.

True

 

Returns:

          Type:CommPrefApi.ConstituentSolicitCodeReadCollection

          Description: Solicit codes

 

CreateConstituentSolicitCode

Summary: Create a constituent solicit code

Description: Creates a new constituent solicit code.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateConstituentSolicitCode (CommPrefApi.ConstituentSolicitCodeAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CommPrefApi.ConstituentSolicitCodeAdd

 

Solicit codes provide guidance on how to contact constituents. These rules describe instructions and restrictions about when to reach out to constituents and how to tailor communications to honor their requests.

True

 

Returns:

          Type:CommPrefApi.CreatedConstituentSolicitCode

          Description: Created constituent solicit code

 

EditConstituentSolicitCode

Summary: Update a constituent solicit code

Description: Updates a constituent solicit code.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditConstituentSolicitCode (string constituent_solicit_code_id, CommPrefApi.ConstituentSolicitCodeEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_solicit_code_id

string

(Solicit code ID)

The system record ID of the solicit code to update.

True

body

CommPrefApi.ConstituentSolicitCodeEdit

 

Solicit codes provide guidance on how to contact constituents. These rules describe instructions and restrictions about when to reach out to constituents and how to tailor communications to honor their requests.

True

 

Returns:

 

ListSolicitCodes

Summary: List solicit codes

Description: Lists the available solicit codes.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListSolicitCodes ()

 

Returns:

          Type:CommPrefApi.SolicitCodeCollection

          Description: Solicit codes

 

ListActions

Summary: List actions

Description: Returns a list of actions.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListActions ([Optional]string list_id, [Optional]string computed_status, [Optional]string status_code, [Optional]integer limit, [Optional]integer offset, [advanced][Optional]string date_added, [advanced][Optional]string last_modified)

 

Parameters:

Name

Type

Summary

Required

Related Action

list_id

string

(List)

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.

False

ListLists

computed_status

string

(Computed status)

Represents a filter for results based on the computed action status. Available values are Open, Completed, or PastDue.

False

status_code

string

(Status)

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

False

limit

integer(int32)

(Limit)

Represents the number of records to return. The default is 500. The maximum is 5000.

False

offset

integer(int32)

(Offset)

Represents the number of records to skip. For use with pagination.

False

date_added

string(date-time)

(Added on or after)

Filter the results to actions created on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

last_modified

string(date-time)

(Modified on or after)

Filter the results to actions modified on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

 

Returns:

          Type:ConstituentApi.ApiCollectionOfActionRead

          Description: Actions

 

CreateAction

Summary: Create a constituent action

Description: Creates a new constituent action.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateAction (ConstituentApi.ActionAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConstituentApi.ActionAdd

 

Actions track the interactions and tasks that are required to secure gifts and cultivate relationships with constituents.

True

 

Returns:

          Type:ConstituentApi.CreatedAction

          Description: Created action

 

GetAction

Summary: Get a constituent action

Description: Returns information about a constituent action.

 

Syntax:

BlackbaudRaisersEdgeNXT.GetAction (string action_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

action_id

string

(Action ID)

The system record ID of the action to get.

True

 

Returns:

          Type:ConstituentApi.ActionRead

          Description: Action

 

EditAction

Summary: Update a constituent action

Description: Updates a constituent action.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditAction (string action_id, ConstituentApi.ActionEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

action_id

string

(Action ID)

The system record ID of the action to update.

True

body

ConstituentApi.ActionEdit

 

Actions track the interactions and tasks that are required to secure gifts and cultivate relationships with constituents.

True

 

Returns:

 

ListActionAttachments

Summary: List action attachments

Description: Lists the attachments for an action.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListActionAttachments (string action_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

action_id

string

(Action ID)

The system record ID of the action.

True

 

Returns:

          Type:ConstituentApi.ApiCollectionOfActionAttachmentRead

          Description: Attachments

 

ListActionCustomFields

Summary: List action custom fields

Description: Lists the custom fields for an action.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListActionCustomFields (string action_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

action_id

string

(Action ID)

The system record ID of the action.

True

 

Returns:

          Type:ConstituentApi.ApiCollectionOfActionCustomFieldRead

          Description: Custom fields

 

CreateActionAttachment

Summary: Create an action attachment

Description: Creates a new action attachment.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateActionAttachment (ConstituentApi.ActionAttachmentAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConstituentApi.ActionAttachmentAdd

 

Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

True

 

Returns:

          Type:ConstituentApi.CreatedActionAttachment

          Description: Created action attachment

 

EditActionAttachment

Summary: Update an action attachment

Description: Updates an action attachment.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditActionAttachment (string attachment_id, ConstituentApi.ActionAttachmentEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

attachment_id

string

(Attachment ID)

The system record ID of the attachment to update.

True

body

ConstituentApi.ActionAttachmentEdit

 

Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

True

 

Returns:

 

CreateActionCustomField

Summary: Create an action custom field

Description: Creates a new action custom field.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateActionCustomField (ConstituentApi.ActionCustomFieldAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConstituentApi.ActionCustomFieldAdd

 

While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

True

 

Returns:

          Type:ConstituentApi.CreatedActionCustomField

          Description: Created action custom field

 

EditActionCustomField

Summary: Update an action custom field

Description: Updates an action custom field.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditActionCustomField (string custom_field_id, ConstituentApi.ActionCustomFieldEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

custom_field_id

string

(Custom field ID)

The system record ID of the custom field to update.

True

body

ConstituentApi.ActionCustomFieldEdit

 

While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

True

 

Returns:

 

ListActionCustomFieldCategoryDetails

Summary: List custom field categories

Description: Lists the action custom field category details.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListActionCustomFieldCategoryDetails ()

 

Returns:

          Type:ConstituentApi.ApiCollectionOfCustomFieldCategoryRead

          Description: Custom field categories

 

CreateConstituentAddress

Summary: Create a constituent address

Description: Creates a new constituent address.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateConstituentAddress (ConstituentApi.AddressAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConstituentApi.AddressAdd

 

Addresses store information about constituent residences and other addresses along with information about where or whether to send mail.

True

 

Returns:

          Type:ConstituentApi.CreatedConstituentAddress

          Description: Created constituent address

 

EditConstituentAddress

Summary: Update a constituent address

Description: Updates a constituent address.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditConstituentAddress (string address_id, ConstituentApi.AddressEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

address_id

string

(Address ID)

The system record ID of the address to update.

True

body

ConstituentApi.AddressEdit

 

Addresses store information about constituent residences and other addresses along with information about where or whether to send mail.

True

 

Returns:

 

CreateConstituentAlias

Summary: Create a constituent alias

Description: Creates a new constituent alias.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateConstituentAlias (ConstituentApi.AliasAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConstituentApi.AliasAdd

 

Aliases provide secondary identification for individuals or organizations. For example, aliases can be stage names or acronyms.

True

 

Returns:

          Type:ConstituentApi.CreatedConstituentAlias

          Description: Created constituent alias

 

EditConstituentAlias

Summary: Update a constituent alias

Description: Updates an constituent alias.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditConstituentAlias (string alias_id, ConstituentApi.AliasEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

alias_id

string

(Alias ID)

The system record ID of the alias to update.

True

body

ConstituentApi.AliasEdit

 

Aliases provide secondary identification for individuals or organizations. For example, aliases can be stage names or acronyms.

True

 

Returns:

 

CreateConstituentCode

Summary: Create a constituent code

Description: Creates a new constituent code.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateConstituentCode (ConstituentApi.ConstituentCodeAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConstituentApi.ConstituentCodeAdd

 

Constituent codes define the high-level affiliations between constituents and your organization — such as Board member, Vendor, and Volunteer — to provide context for why constituents are in the database.

True

 

Returns:

          Type:ConstituentApi.CreatedConstituentCode

          Description: Created constituent code

 

EditConstituentCode

Summary: Update a constituent code

Description: Updates a constituent code.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditConstituentCode (string constituent_code_id, ConstituentApi.ConstituentCodeEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_code_id

string

(Constituent code ID)

The system record ID of the constituent code to update.

True

body

ConstituentApi.ConstituentCodeEdit

 

Constituent codes define the high-level affiliations between constituents and your organization — such as Board member, Vendor, and Volunteer — to provide context for why constituents are in the database.

True

 

Returns:

 

ListConstituents

Summary: List constituents

Description: Returns a list of constituents.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConstituents ([Optional]string list_id, [Optional]integer limit, [Optional]integer offset, [advanced][Optional]string constituent_code, [advanced][Optional]string constituent_id, [advanced][Optional]string custom_field_category, [advanced][Optional]string fundraiser_status, [advanced][Optional]boolean include_deceased, [advanced][Optional]boolean include_inactive, [advanced][Optional]string postal_code, [advanced][Optional]string date_added, [advanced][Optional]string last_modified, [advanced][Optional]string sort)

 

Parameters:

Name

Type

Summary

Required

Related Action

list_id

string

(List)

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.

False

ListLists

limit

integer(int32)

(Limit)

Represents the number of records to return. The default is 500. The maximum is 5000.

False

offset

integer(int32)

(Offset)

Represents the number of records to skip. For use with pagination.

False

constituent_code

string

(Constituent code)

Represents a constituent code to filter the list. For example, "Board Member" returns only constituents with a Board Member constituent code.

False

constituent_id

string

(Constituent ID)

Represents a comma-separated list of constituent identifiers to filter the results. For example, "280,1232" returns only constituent 280 or constituent 1232.

False

custom_field_category

string

(Custom field category)

Represents a custom field category to filter the results. For example, "Anniversary" returns only constituents with an active Anniversary custom field.

False

fundraiser_status

string

(Fundraiser status)

Represents a comma-separated list of fundraiser statuses to filter the results. For example, "Active,None" returns only constituents whose fundraiser status is Active or None.  Valid values for this filter are Active, Inactive, and None.

False

include_deceased

boolean

(Include deceased?)

Include deceased constituents in the response?

False

include_inactive

boolean

(Include inactive?)

Include inactive constituents in the response?

False

postal_code

string

(Postal code)

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.

False

date_added

string(date-time)

(Added on or after)

Filter the results to constituents created on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

last_modified

string(date-time)

(Modified on or after)

Filter the results to constituents modified on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

sort

string

(Sorted by)

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.

False

 

Returns:

          Type:ConstituentApi.ApiCollectionOfConstituentRead

          Description: Constituents

 

GetConstituent

Summary: Get a constituent

Description: Returns information about a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.GetConstituent (string constituent_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent to get.

True

 

Returns:

          Type:ConstituentApi.ConstituentRead

          Description: Constituent

 

EditConstituent

Summary: Update a constituent

Description: Updates a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditConstituent (string constituent_id, ConstituentApi.ConstituentEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent to update.

True

body

ConstituentApi.ConstituentEdit

 

Constituents are the individuals and organizations who support your organization by contributing time, money, and resources. The constituent entity stores information about donors, prospects, volunteers, general supporters, and more.

True

 

Returns:

 

ListConstituentActions

Summary: List constituent actions

Description: Lists the actions for a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConstituentActions (string constituent_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent.

True

 

Returns:

          Type:ConstituentApi.ApiCollectionOfActionRead

          Description: Actions

 

ListConstituentAddresses

Summary: List constituent addresses

Description: Lists the addresses for a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConstituentAddresses (string constituent_id, [Optional]boolean include_inactive)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent.

True

include_inactive

boolean

(Include inactive?)

Include inactive addresses?

False

 

Returns:

          Type:ConstituentApi.ApiCollectionOfAddressRead

          Description: Addresses

 

ListConstituentAliases

Summary: List constituent aliases

Description: Lists the aliases for a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConstituentAliases (string constituent_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent.

True

 

Returns:

          Type:ConstituentApi.ApiCollectionOfAliasRead

          Description: Aliases

 

ListConstituentAttachments

Summary: List constituent attachments

Description: Lists the attachments for a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConstituentAttachments (string constituent_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent.

True

 

Returns:

          Type:ConstituentApi.ApiCollectionOfConstituentAttachmentRead

          Description: Attachments

 

ListConstituentCodes

Summary: List constituent codes

Description: Lists the constituent codes for a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConstituentCodes (string constituent_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent.

True

 

Returns:

          Type:ConstituentApi.ApiCollectionOfConstituentCodeRead

          Description: Constituent codes

 

ListConstituentCustomFields

Summary: List constituent custom fields

Description: Lists the custom fields for a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConstituentCustomFields (string constituent_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent.

True

 

Returns:

          Type:ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

          Description: Custom fields

 

ListConstituentEducations

Summary: List constituent educations

Description: Lists the education records for a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConstituentEducations (string constituent_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent.

True

 

Returns:

          Type:ConstituentApi.ApiCollectionOfEducationRead

          Description: Educations

 

ListConstituentEmailAddresses

Summary: List constituent email addresses

Description: Lists the email addresses for a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConstituentEmailAddresses (string constituent_id, [Optional]boolean include_inactive)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent.

True

include_inactive

boolean

(Include inactive?)

Include inactive email addresses?

False

 

Returns:

          Type:ConstituentApi.ApiCollectionOfEmailAddressRead

          Description: Email addresses

 

ListConstituentFundraiserAssignments

Summary: List constituent fundraiser assignments

Description: Lists the fundraiser assignments for a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConstituentFundraiserAssignments (string constituent_id, [Optional]boolean include_inactive)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent.

True

include_inactive

boolean

(Include inactive?)

Include inactive fundraiser assignments?

False

 

Returns:

          Type:ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

          Description: Fundraiser assignments

 

ListConstituentNotes

Summary: List constituent notes

Description: Lists the notes for a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConstituentNotes (string constituent_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent.

True

 

Returns:

          Type:ConstituentApi.ApiCollectionOfNoteRead

          Description: Notes

 

ListConstituentOnlinePresences

Summary: List constituent online presences

Description: Lists the online presences for a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConstituentOnlinePresences (string constituent_id, [Optional]boolean include_inactive)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent.

True

include_inactive

boolean

(Include inactive?)

Include inactive online presences?

False

 

Returns:

          Type:ConstituentApi.ApiCollectionOfOnlinePresenceRead

          Description: Online presences

 

ListConstituentPhones

Summary: List constituent phones

Description: Lists the phones for a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConstituentPhones (string constituent_id, [Optional]boolean include_inactive)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent.

True

include_inactive

boolean

(Include inactive?)

Include inactive phones?

False

 

Returns:

          Type:ConstituentApi.ApiCollectionOfPhoneRead

          Description: Phones

 

GetConstituentProfilePicture

Summary: Get a constituent profile picture

Description: Returns the current profile picture for a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.GetConstituentProfilePicture (string constituent_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent for whom the profile picture is to be retrieved.

True

 

Returns:

          Type:ConstituentApi.ProfilePictureRead

          Description: Profile picture

 

EditConstituentProfilePicture

Summary: Update a constituent profile picture

Description: Updates the current profile picture for a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditConstituentProfilePicture (string constituent_id, ConstituentApi.ProfilePictureEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent whose profile picture is to be updated.

True

body

ConstituentApi.ProfilePictureEdit

 

Profile pictures are photos or images such as selfies or company logos that help identify constituents and personalize relationships. Profile pictures can be PNG, BMP, or JPG image files uploaded via the web view.

True

 

Returns:

 

ListConstituentRatings

Summary: List constituent ratings

Description: Returns the list of ratings for a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConstituentRatings (string constituent_id, [advanced][Optional]boolean include_inactive, [advanced][Optional]boolean most_recent_only)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent

True

include_inactive

boolean

(Include inactive?)

Include inactive ratings?

False

most_recent_only

boolean

(Only most recent?)

Include only the most recent ratings?

False

 

Returns:

          Type:ConstituentApi.ApiCollectionOfRatingRead

          Description: Ratings

 

ListConstituentRelationships

Summary: List constituent relationships

Description: Lists the relationships for a constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConstituentRelationships (string constituent_id, [Optional]integer limit, [Optional]integer offset)

 

Parameters:

Name

Type

Summary

Required

Related Action

constituent_id

string

(Constituent ID)

The system record ID of the constituent.

True

limit

integer(int32)

(Limit)

Represents the number of records to return. The default is 500. There is no maximum.

False

offset

integer(int32)

(Offset)

Represents the number of records to skip. For use with pagination.

False

 

Returns:

          Type:ConstituentApi.ApiCollectionOfRelationshipRead

          Description: Relationships

 

CreateConstituentAttachment

Summary: Create a constituent attachment

Description: Creates a new constituent attachment.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateConstituentAttachment (ConstituentApi.ConstituentAttachmentAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConstituentApi.ConstituentAttachmentAdd

 

Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

True

 

Returns:

          Type:ConstituentApi.CreatedConstituentAttachment

          Description: Created constituent attachment

 

EditConstituentAttachment

Summary: Update a constituent attachment

Description: Updates a constituent attachment.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditConstituentAttachment (string attachment_id, ConstituentApi.ConstituentAttachmentEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

attachment_id

string

(Attachment ID)

The system record ID of the attachment to update.

True

body

ConstituentApi.ConstituentAttachmentEdit

 

Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

True

 

Returns:

 

CreateConstituentCustomField

Summary: Create a constituent custom field

Description: Creates a new constituent custom field.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateConstituentCustomField (ConstituentApi.ConstituentCustomFieldAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConstituentApi.ConstituentCustomFieldAdd

 

While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

True

 

Returns:

          Type:ConstituentApi.CreatedConstituentCustomField

          Description: Created constituent custom field

 

EditConstituentCustomField

Summary: Update a constituent custom field

Description: Updates a constituent custom field.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditConstituentCustomField (string custom_field_id, ConstituentApi.ConstituentCustomFieldEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

custom_field_id

string

(Custom field ID)

The system record ID of the custom field to update.

True

body

ConstituentApi.ConstituentCustomFieldEdit

 

While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

True

 

Returns:

 

ListConstituentCustomFieldCategoryDetails

Summary: List custom field categories

Description: Lists the constituent custom field category details.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListConstituentCustomFieldCategoryDetails ()

 

Returns:

          Type:ConstituentApi.ApiCollectionOfCustomFieldCategoryRead

          Description: Custom field categories

 

SearchConstituent

Summary: Search for a constituent

Description: 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.

 

Syntax:

BlackbaudRaisersEdgeNXT.SearchConstituent (string search_text, [advanced][Optional]string fundraiser_status, [advanced][Optional]boolean include_inactive, [advanced][Optional]string search_field, [advanced][Optional]boolean strict_search, [advanced][Optional]integer limit, [advanced][Optional]integer offset)

 

Parameters:

Name

Type

Summary

Required

Related Action

search_text

string

(Search text)

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.

True

fundraiser_status

string

(Fundraiser statuses)

Represents a comma-separated list of fundraiser statuses to filter the results. For example, "Active,None" returns only constituents whose fundraiser status is Active or None.  Valid values for this filter are Active, Inactive, and None.

False

include_inactive

boolean

(Include inactive?)

Include inactive constituents in the response?

False

search_field

string

(Search field)Values: [lookup_id]

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.

False

strict_search

boolean

(Use strict search?)

Exclude constituents whose names sound like the search text but are spelled differently?

False

limit

integer(int32)

(Limit)

Represents the number of records to return. The default is 500. The maximum is 5000.

False

offset

integer(int32)

(Offset)

Represents the number of records to skip. For use with pagination.

False

 

Returns:

          Type:ConstituentApi.ApiCollectionOfSearchResultRead

          Description: Search results

 

ListCountries

Summary: List country definitions

Description: Lists the country definitions.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListCountries ()

 

Returns:

          Type:ConstituentApi.ApiCollectionOfCountryRead

          Description: Countries

 

CreateDocument

Summary: Create a document location

Description: 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.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateDocument (ConstituentApi.NewDocumentInfo body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConstituentApi.NewDocumentInfo

 

Cultivation activities often result in physical collateral such as images, PDFs, or Word files. The New Document entity allows you to upload these files to maintain a holistic view of target constituents.

True

 

Returns:

          Type:ConstituentApi.FileDefinition

          Description: File definition

 

CreateConstituentEducation

Summary: Create a constituent education

Description: Creates a new constituent education.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateConstituentEducation (ConstituentApi.EducationAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConstituentApi.EducationAdd

 

A constituent's education history provides important insight into who they are and often helps determine which causes to which the constituent will invest time and money.

True

 

Returns:

          Type:ConstituentApi.CreatedConstituentEducation

          Description: Created constituent education

 

EditConstituentEducation

Summary: Update a constituent education

Description: Updates a constituent education.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditConstituentEducation (string education_id, ConstituentApi.EducationEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

education_id

string

(Education ID)

The system record ID of the education record to update.

True

body

ConstituentApi.EducationEdit

 

A constituent's education history provides important insight into who they are and often helps determine which causes to which the constituent will invest time and money.

True

 

Returns:

 

CreateConstituentEmailAddress

Summary: Create a constituent email address

Description: Creates a new constituent email address.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateConstituentEmailAddress (ConstituentApi.EmailAddressAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConstituentApi.EmailAddressAdd

 

Email addresses store information about constituent email accounts and where to send email correspondences for individuals and organizations.

True

 

Returns:

          Type:ConstituentApi.CreatedConstituentEmailAddress

          Description: Created constituent email address

 

EditConstituentEmailAddress

Summary: Update a constituent email address

Description: Updates a constituent email address.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditConstituentEmailAddress (string email_address_id, ConstituentApi.EmailAddressEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

email_address_id

string

(Email address ID)

The system record ID of the email address to update.

True

body

ConstituentApi.EmailAddressEdit

 

Email addresses store information about constituent email accounts and where to send email correspondences for individuals and organizations.

True

 

Returns:

 

ListNameFormatConfigurations

Summary: List name format configurations

Description: List the name format configurations.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListNameFormatConfigurations ()

 

Returns:

          Type:ConstituentApi.ApiCollectionOfNameFormatConfigurationRead

          Description: Name format configurations

 

CreateConstituentNote

Summary: Create a constituent note

Description: Creates a new constituent note.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateConstituentNote (ConstituentApi.NoteAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConstituentApi.NoteAdd

 

Notes track helpful or important details about constituents, gifts, or actions, such as specific interests and special instructions for donations. Notes connect you with donors at a more personal level as you cultivate relationships and track lessons learned for more effective fundraising.

True

 

Returns:

          Type:ConstituentApi.CreatedConstituentNote

          Description: Created constituent note

 

EditConstituentNote

Summary: Update a constituent note

Description: Updates a constituent note.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditConstituentNote (string note_id, ConstituentApi.NoteEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

note_id

string

(Note ID)

The system record ID of the note to update.

True

body

ConstituentApi.NoteEdit

 

Notes track helpful or important details about constituents, gifts, or actions, such as specific interests and special instructions for donations. Notes connect you with donors at a more personal level as you cultivate relationships and track lessons learned for more effective fundraising.

True

 

Returns:

 

CreateConstituentOnlinePresence

Summary: Create a constituent online presence

Description: Creates a new constituent online presence.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateConstituentOnlinePresence (ConstituentApi.OnlinePresenceAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConstituentApi.OnlinePresenceAdd

 

Online presence entities store a constituent's social media accounts, websites, and other means of reaching out or gaining more information about the constituent.

True

 

Returns:

          Type:ConstituentApi.CreatedConstituentOnlinePresence

          Description: Created constituent online presence

 

EditConstituentOnlinePresence

Summary: Update a constituent online presence

Description: Updates a constituent online presence.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditConstituentOnlinePresence (string online_presence_id, ConstituentApi.OnlinePresenceEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

online_presence_id

string

(Online presence ID)

The  system record ID of the online presence to update.

True

body

ConstituentApi.OnlinePresenceEdit

 

Online presence entities store a constituent's social media accounts, websites, and other means of reaching out or gaining more information about the constituent.

True

 

Returns:

 

CreateConstituentPhone

Summary: Create a constituent phone

Description: Creates a new constituent phone.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateConstituentPhone (ConstituentApi.PhoneAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConstituentApi.PhoneAdd

 

Phones store information about constituent phone numbers and where to call individuals and organizations.

True

 

Returns:

          Type:ConstituentApi.CreatedConstituentPhone

          Description: Created constituent phone

 

EditConstituentPhone

Summary: Update a constituent phone

Description: Updates a constituent phone.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditConstituentPhone (string phone_id, ConstituentApi.PhoneEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

phone_id

string

(Phone ID)

The system record ID of the phone to update.

True

body

ConstituentApi.PhoneEdit

 

Phones store information about constituent phone numbers and where to call individuals and organizations.

True

 

Returns:

 

CreateConstituentRating

Summary: Create a constituent rating

Description: Creates a new constituent rating.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateConstituentRating (ConstituentApi.RatingAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConstituentApi.RatingAdd

 

Ratings indicate the estimated wealth of constituents and their capacity to give. Ratings information such as overall wealth ratings, suggested ask amounts, and total identified assets can help to determine where to focus efforts, whether to pursue prospects or major gifts, and how much to ask from donors.

True

 

Returns:

          Type:ConstituentApi.CreatedConstituentRating

          Description: Created constituent rating

 

ListRatingCategories

Summary: List rating categories

Description: Lists the rating categories.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListRatingCategories ([Optional]boolean include_inactive, [Optional]string source_name)

 

Parameters:

Name

Type

Summary

Required

Related Action

include_inactive

boolean

(Include inactive?)

Include inactive categories?

False

source_name

string

(Source name)

The source to filter the categories. To return all categories, do not include source_name. To return all categories that do not have a source, include source_name in the request URL with an empty value.

False

 

Returns:

          Type:ConstituentApi.ApiCollectionOfRatingCategoryRead

          Description: Rating categories

 

ListRatingSources

Summary: List rating sources

Description: Lists the country definitions.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListRatingSources ([Optional]boolean include_inactive)

 

Parameters:

Name

Type

Summary

Required

Related Action

include_inactive

boolean

(Include inactive?)

Include inactive sources?

False

 

Returns:

          Type:ConstituentApi.ApiCollectionOfRatingSourceRead

          Description: Rating sources

 

EditConstituentRelationship

Summary: Update a constituent relationship

Description: 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.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditConstituentRelationship (string relationship_id, ConstituentApi.RelationshipEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

relationship_id

string

(Relationship ID)

The system record ID of the relationship to update.

True

body

ConstituentApi.RelationshipEdit

 

Relationships describe connections between constituents and other individuals and organizations such as family, friends, and employers. Tracking constituent relationships can enhance fundraising efforts and interactions.

True

 

Returns:

 

CreateIndividualConstituent

Summary: Create an individual constituent

Description: Creates a new individual constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateIndividualConstituent (ConstituentApi.Virtual.IndividualAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConstituentApi.Virtual.IndividualAdd

 

Constituents are the individuals and organizations who support your organization by contributing time, money, and resources. The constituent entity stores information about donors, prospects, volunteers, general supporters, and more.

True

 

Returns:

          Type:ConstituentApi.CreatedIndividualConstituent

          Description: Created individual constituent

 

CreateIndividualRelationship

Summary: Create an individual relationship

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

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateIndividualRelationship (ConstituentApi.Virtual.IndividualRelationshipAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConstituentApi.Virtual.IndividualRelationshipAdd

 

Relationships describe connections between constituents and other individuals such as family, friends, and employers. Tracking constituent relationships can enhance fundraising efforts and interactions.

True

 

Returns:

          Type:ConstituentApi.CreatedIndividualRelationship

          Description: Created individual relationship

 

CreateOrganizationConstituent

Summary: Create an organization constituent

Description: Creates a new organization constituent.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateOrganizationConstituent (ConstituentApi.Virtual.OrganizationAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConstituentApi.Virtual.OrganizationAdd

 

Constituents are the individuals and organizations who support your organization by contributing time, money, and resources. The constituent entity stores information about donors, prospects, volunteers, general supporters, and more.

True

 

Returns:

          Type:ConstituentApi.CreatedOrganizationConstituent

          Description: Created organization constituent

 

CreateOrganizationRelationship

Summary: Create an organization relationship

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

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateOrganizationRelationship (ConstituentApi.Virtual.OrganizationRelationshipAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConstituentApi.Virtual.OrganizationRelationshipAdd

 

Relationships describe connections between constituents and other individuals and organizations such as family, friends, and employers. Tracking constituent relationships can enhance fundraising efforts and interactions.

True

 

Returns:

          Type:ConstituentApi.CreatedOrganizationRelationship

          Description: Created organization relationship

 

ListEventCategories

Summary: List event categories

Description: Lists the event categories.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListEventCategories ()

 

Returns:

          Type:EventApi.ApiCollectionOfEventCategory

          Description: Categories

 

ListEvents

Summary: List events

Description: Returns a list of events.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListEvents ([Optional]string category, [Optional]string start_date_from, [Optional]string start_date_to, [Optional]boolean include_inactive, [Optional]integer limit, [Optional]integer offset, [advanced][Optional]string event_id, [advanced][Optional]string name, [advanced][Optional]string date_added, [advanced][Optional]string last_modified)

 

Parameters:

Name

Type

Summary

Required

Related Action

category

string

(Category)

Filter based on event category.

False

ListEventCategories

start_date_from

string(date)

(Start date from)

Filter the results to events with start date on or after the specified date (ex: '2020-09-18').

False

start_date_to

string(date)

(Start date to)

Filter the results to events with start date on or before the specified date (ex: '2020-09-18').

False

include_inactive

boolean

(Include inactive?)

Include inactive events?

False

limit

integer(int32)

(Limit)

Represents the number of records to return. The default is 500. The maximum is 10000.

False

offset

integer(int32)

(Offset)

Represents the number of records to skip. For use with pagination.

False

event_id

string

(Event ID)

Filter the events that match the specified system record ID.

False

name

string

(Name)

Filter for events that match the specified name.

False

date_added

string(date-time)

(Added on or after)

Filter the results to events created on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

last_modified

string(date-time)

(Modified on or after)

Filter the results to events modified on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

 

Returns:

          Type:EventApi.ApiCollectionOfEventListEntry

          Description: Events

 

CreateEvent

Summary: Create an event

Description: Creates a new event.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateEvent (EventApi.CreateEvent body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

EventApi.CreateEvent

 

Events are planned occasions that help organizations raise awareness for their missions, engage constituents, and encourage donations.

True

 

Returns:

          Type:EventApi.CreatedEvent

          Description: Created event

 

GetEvent

Summary: Get an event

Description: Returns information about an event.

 

Syntax:

BlackbaudRaisersEdgeNXT.GetEvent (string event_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

event_id

string

(Event ID)

The system record ID of the event to get.

True

 

Returns:

          Type:EventApi.Event

          Description: Event

 

EditEvent

Summary: Update an event

Description: Updates the details about an event.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditEvent (string event_id, EventApi.EditEvent body)

 

Parameters:

Name

Type

Summary

Required

Related Action

event_id

string

(Event ID)

The system record ID of the event to update.

True

body

EventApi.EditEvent

 

Events are planned occasions that help organizations raise awareness for their missions, engage constituents, and encourage donations.

True

 

Returns:

 

ListEventFees

Summary: List event fees

Description: Lists the fees for an event.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListEventFees (string event_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

event_id

string

(Event ID)

The system record ID of the event.

True

 

Returns:

          Type:EventApi.ApiCollectionOfEventFee

          Description: Fees

 

CreateEventFee

Summary: Create an event fee

Description: Creates a new fee for an event.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateEventFee (string event_id, EventApi.CreateEventFee body)

 

Parameters:

Name

Type

Summary

Required

Related Action

event_id

string

(Event ID)

The system record ID of the event.

True

body

EventApi.CreateEventFee

 

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

True

 

Returns:

          Type:EventApi.CreatedEventFee

          Description: Created event fee

 

ListEventParticipantOptions

Summary: List event participant options

Description: Lists the participant options for an event.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListEventParticipantOptions (string event_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

event_id

string

(Event ID)

The ID of the event.

True

 

Returns:

          Type:EventApi.ApiCollectionOfEventParticipantOption

          Description: Event participant options

 

CreateEventParticipantOption

Summary: Create an event participant option

Description: Creates a new participant option for an event.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateEventParticipantOption (string event_id, EventApi.CreateEventParticipantOption body)

 

Parameters:

Name

Type

Summary

Required

Related Action

event_id

string

(Event ID)

The ID of the event.

True

body

EventApi.CreateEventParticipantOption

 

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

True

 

Returns:

          Type:EventApi.CreatedEventParticipantOption

          Description: Created event participant option

 

ListEventParticipants

Summary: List event participants

Description: Lists the participants for an event.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListEventParticipants (string event_id, [Optional]string rsvp_status, [Optional]string invitation_status, [Optional]string participation_level, [Optional]boolean attended_filter, [Optional]boolean fees_paid_filter, [Optional]integer limit, [Optional]integer offset, [advanced][Optional]boolean is_constituent_filter, [advanced][Optional]boolean email_eligible_filter, [advanced][Optional]boolean phone_call_eligible_filter, [advanced][Optional]string name, [advanced][Optional]string date_added, [advanced][Optional]string last_modified)

 

Parameters:

Name

Type

Summary

Required

Related Action

event_id

string

(Event ID)

The system record ID of the event.

True

rsvp_status

string

(RSVP status)Values: [NoResponse, Attending, Declined, Interested, Canceled, Waitlisted, NotApplicable]

Filter participants based on RSVP status.

False

invitation_status

string

(Invitation status)Values: [NotApplicable, NotInvited, Invited]

Filter participants based on invitation status.

False

participation_level

string

(Participation level)

Filter participants based on level of involvement.

False

ListParticipationLevels

attended_filter

boolean

(Attended?)

Filter for including or excluding participants marked as attended.

False

fees_paid_filter

boolean

(Fees paid?)

Filter for including or excluding participants that have paid their fees.

False

limit

integer(int32)

(Limit)

Represents the number of records to return. The default is 500. The maximum is 10000.

False

offset

integer(int32)

(Offset)

Represents the number of records to skip. For use with pagination.

False

is_constituent_filter

boolean

(Is a constituent?)

Filter for including or excluding participants who are constituents.

False

email_eligible_filter

boolean

(Has an eligible email?)

Filter for including or excluding participants based on whether they have a primary email address that's not marked Do not email?

False

phone_call_eligible_filter

boolean

(Has an eligible phone?)

Filter for including or excluding participants based on whether they have a primary phone number that's not marked Do not call.

False

name

string

(Name)

Filter for participants that match the specified name.

False

date_added

string(date-time)

(Added on or after)

Filter the results to participants created on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

last_modified

string(date-time)

(Modified on or after)

Filter the results to participants modified on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

 

Returns:

          Type:EventApi.ApiCollectionOfParticipantListEntry

          Description: Participants

 

CreateParticipant

Summary: Create a participant

Description: Creates a new participant for an event.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateParticipant (string event_id, EventApi.CreateParticipant body)

 

Parameters:

Name

Type

Summary

Required

Related Action

event_id

string

(Event ID)

The system record ID of the event.

True

body

EventApi.CreateParticipant

 

Participants are individuals or organizations who engage with the organization through an event.  They can include constituents who receive invitations or register for the event.

True

 

Returns:

          Type:EventApi.CreatedParticipant

          Description: Created participant

 

EditParticipantOption

Summary: Update a participant option

Description: Updates the details about a participant option.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditParticipantOption (string option_id, EventApi.EditParticipantOption body)

 

Parameters:

Name

Type

Summary

Required

Related Action

option_id

string

(Participant option ID)

The system record ID of the participant option to update.

True

body

EventApi.EditParticipantOption

 

A participant option

True

 

Returns:

 

GetParticipant

Summary: Get a participant

Description: Returns information about a specific event participant.

 

Syntax:

BlackbaudRaisersEdgeNXT.GetParticipant (string participant_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

participant_id

string

(Participant ID)

The system record ID of the participant.

True

 

Returns:

          Type:EventApi.Participant

          Description: Participant

 

EditParticipant

Summary: Update a participant

Description: Updates the details about a participant.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditParticipant (string participant_id, EventApi.EditParticipant body)

 

Parameters:

Name

Type

Summary

Required

Related Action

participant_id

string

(Participant ID)

The system record ID of the participant to update.

True

body

EventApi.EditParticipant

 

Participants are individuals or organizations who engage with the organization through an event.  They can include constituents who receive invitations or register for the event.

True

 

Returns:

 

ListParticipantFeePayments

Summary: List participant fee payments

Description: Lists the fee payments for a participant.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListParticipantFeePayments (string participant_id, [Optional]integer limit, [Optional]integer offset)

 

Parameters:

Name

Type

Summary

Required

Related Action

participant_id

string

(Participant ID)

The system record ID of the participant.

True

limit

integer(int32)

(Limit)

Represents the number of records to return. The default is 500. The maximum is 10000.

False

offset

integer(int32)

(Offset)

Represents the number of records to skip. For use with pagination. The default is 0.

False

 

Returns:

          Type:EventApi.ApiCollectionOfParticipantFeePayment

          Description: Fee payments

 

CreateParticipantFeePayment

Summary: Create a participant fee payment

Description: Creates a new fee payment for a participant.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateParticipantFeePayment (string participant_id, EventApi.CreateParticipantFeePayment body)

 

Parameters:

Name

Type

Summary

Required

Related Action

participant_id

string

(Participant ID)

The system record ID of the participant.

True

body

EventApi.CreateParticipantFeePayment

 

Participant fee payments are payments toward the participant's fees.

True

 

Returns:

          Type:EventApi.CreatedParticipantFeePayment

          Description: Created participant fee payment

 

ListParticipantFees

Summary: List participant fees

Description: Lists the fees for a participant.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListParticipantFees (string participant_id, [Optional]integer limit, [Optional]integer offset)

 

Parameters:

Name

Type

Summary

Required

Related Action

participant_id

string

(Participant ID)

The system record ID of the participant.

True

limit

integer(int32)

(Limit)

Represents the number of records to return. The default is 500. The maximum is 10000.

False

offset

integer(int32)

(Offset)

Represents the number of records to skip. For use with pagination. The default is 0.

False

 

Returns:

          Type:EventApi.ApiCollectionOfParticipantFee

          Description: Fees

 

CreateParticipantFee

Summary: Create a participant fee

Description: Creates a new fee for a participant.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateParticipantFee (string participant_id, EventApi.CreateParticipantFee body)

 

Parameters:

Name

Type

Summary

Required

Related Action

participant_id

string

(Participant ID)

The system record ID of the participant.

True

body

EventApi.CreateParticipantFee

 

Participant fees are how much an individual or organization pays to participate in or attend the event.

True

 

Returns:

          Type:EventApi.CreatedParticipantFee

          Description: Created participant fee

 

ListParticipantOptions

Summary: List participant options

Description: Lists the participant options for a participant.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListParticipantOptions (string participant_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

participant_id

string

(Participant ID)

The system record ID of the participant.

True

 

Returns:

          Type:EventApi.ApiCollectionOfParticipantOption

          Description: Participant options

 

CreateParticipantOption

Summary: Create a participant option

Description: Creates a new participant option for a participant.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateParticipantOption (string participant_id, EventApi.CreateParticipantOption body)

 

Parameters:

Name

Type

Summary

Required

Related Action

participant_id

string

(Participant ID)

The ID of the participant.

True

body

EventApi.CreateParticipantOption

 

Participant options are the responses to an event participant option.

True

 

Returns:

          Type:EventApi.CreatedParticipantOption

          Description: Created participant option

 

ListParticipationLevels

Summary: List participation levels

Description: Lists the participation levels.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListParticipationLevels ()

 

Returns:

          Type:EventApi.ApiCollectionOfParticipationLevel

          Description: Participation levels

 

ListAppeals

Summary: List appeals

Description: Returns a list of appeals.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListAppeals ([Optional]integer limit, [Optional]integer offset, [advanced][Optional]boolean include_inactive, [advanced][Optional]string date_added, [advanced][Optional]string last_modified)

 

Parameters:

Name

Type

Summary

Required

Related Action

limit

integer(int32)

(Limit)

Represents the number of records to return. The default is 500. The maximum is 5000.

False

offset

integer(int32)

(Offset)

Represents the number of records to skip. For use with pagination.

False

include_inactive

boolean

(Include inactive?)

Include inactive appeals?

False

date_added

string(date-time)

(Added on or after)

Filter the results to appeals created on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

last_modified

string(date-time)

(Modified on or after)

Filter the results to appeals modified on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

 

Returns:

          Type:FundraisingApi.ApiCollectionOfAppealRead

          Description: Appeals

 

GetAppeal

Summary: Get an appeal

Description: Returns information about an appeal.

 

Syntax:

BlackbaudRaisersEdgeNXT.GetAppeal (string appeal_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

appeal_id

string

(Appeal ID)

The system record ID of the appeal to get.

True

 

Returns:

          Type:FundraisingApi.AppealRead

          Description: Appeal

 

ListAppealAttachments

Summary: List appeal attachments

Description: Lists the attachments for an appeal.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListAppealAttachments (string appeal_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

appeal_id

string

(Appeal ID)

The system record ID of the appeal.

True

 

Returns:

          Type:FundraisingApi.ApiCollectionOfAppealAttachmentRead

          Description: Attachments

 

ListAppealCustomFields

Summary: List appeal custom fields

Description: Lists the custom fields for an appeal.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListAppealCustomFields (string appeal_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

appeal_id

string

(Appeal ID)

The system record ID of the appeal.

True

 

Returns:

          Type:FundraisingApi.ApiCollectionOfAppealCustomFieldRead

          Description: Custom fields

 

CreateAppealAttachment

Summary: Create an appeal attachment

Description: Creates a new appeal attachment.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateAppealAttachment (FundraisingApi.AppealAttachmentAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

FundraisingApi.AppealAttachmentAdd

 

Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

True

 

Returns:

          Type:FundraisingApi.CreatedAppealAttachment

          Description: Created appeal attachment

 

EditAppealAttachment

Summary: Update an appeal attachment

Description: Updates an appeal attachment.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditAppealAttachment (string attachment_id, FundraisingApi.AppealAttachmentEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

attachment_id

string

(Attachment ID)

The system record ID of the attachment to update.

True

body

FundraisingApi.AppealAttachmentEdit

 

Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

True

 

Returns:

 

CreateAppealCustomField

Summary: Create an appeal custom field

Description: Creates a new appeal custom field.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateAppealCustomField (FundraisingApi.AppealCustomFieldAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

FundraisingApi.AppealCustomFieldAdd

 

While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

True

 

Returns:

          Type:FundraisingApi.CreatedAppealCustomField

          Description: Created appeal custom field

 

EditAppealCustomField

Summary: Update an appeal custom field

Description: Updates an appeal custom field.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditAppealCustomField (string custom_field_id, FundraisingApi.AppealCustomFieldEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

custom_field_id

string

(Custom field ID)

The system record ID of the custom field to update.

True

body

FundraisingApi.AppealCustomFieldEdit

 

While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

True

 

Returns:

 

ListAppealCustomFieldCategories

Summary: List appeal custom field categories

Description: Lists the appeal custom field categories.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListAppealCustomFieldCategories ()

 

Returns:

          Type:FundraisingApi.ApiCollectionOfCustomFieldCategoryRead

          Description: Custom field categories

 

ListCampaigns

Summary: List campaigns

Description: Returns a list of campaigns.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListCampaigns ([Optional]integer limit, [Optional]integer offset, [advanced][Optional]boolean include_inactive, [advanced][Optional]string date_added, [advanced][Optional]string last_modified)

 

Parameters:

Name

Type

Summary

Required

Related Action

limit

integer(int32)

(Limit)

Represents the number of records to return. The default is 500. The maximum is 5000.

False

offset

integer(int32)

(Offset)

Represents the number of records to skip. For use with pagination.

False

include_inactive

boolean

(Include inactive?)

Include inactive campaigns?

False

date_added

string(date-time)

(Added on or after)

Filter the results to campaigns created on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

last_modified

string(date-time)

(Modified on or after)

Filter the results to campaigns modified on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

 

Returns:

          Type:FundraisingApi.ApiCollectionOfCampaignRead

          Description: Campaigns

 

GetCampaign

Summary: Get a campaign

Description: Returns information about a campaign.

 

Syntax:

BlackbaudRaisersEdgeNXT.GetCampaign (string campaign_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

campaign_id

string

(Campaign ID)

The system record ID of the campaign to get.

True

 

Returns:

          Type:FundraisingApi.CampaignRead

          Description: Campaign

 

ListCampaignAttachments

Summary: List campaign attachments

Description: Lists the attachments for an campaign.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListCampaignAttachments (string campaign_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

campaign_id

string

(Campaign ID)

The system record ID of the campaign.

True

 

Returns:

          Type:FundraisingApi.ApiCollectionOfCampaignAttachmentRead

          Description: Attachments

 

ListCampaignCustomFields

Summary: List campaign custom fields

Description: Lists the custom fields for a campaign.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListCampaignCustomFields (string campaign_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

campaign_id

string

(Campaign ID)

The system record ID of the campaign.

True

 

Returns:

          Type:FundraisingApi.ApiCollectionOfCampaignCustomFieldRead

          Description: Custom fields

 

CreateCampaignAttachment

Summary: Create a campaign attachment

Description: Creates a new campaign attachment.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateCampaignAttachment (FundraisingApi.CampaignAttachmentAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

FundraisingApi.CampaignAttachmentAdd

 

Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

True

 

Returns:

          Type:FundraisingApi.CreatedCampaignAttachment

          Description: Created campaign attachment

 

EditCampaignAttachment

Summary: Update a campaign attachment

Description: Updates a campaign attachment.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditCampaignAttachment (string attachment_id, FundraisingApi.CampaignAttachmentEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

attachment_id

string

(Attachment ID)

The system record ID of the attachment to update.

True

body

FundraisingApi.CampaignAttachmentEdit

 

Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

True

 

Returns:

 

CreateCampaignCustomField

Summary: Create a campaign custom field

Description: Creates a new campaign custom field.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateCampaignCustomField (FundraisingApi.CampaignCustomFieldAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

FundraisingApi.CampaignCustomFieldAdd

 

While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

True

 

Returns:

          Type:FundraisingApi.CreatedCampaignCustomField

          Description: Created campaign custom field

 

EditCampaignCustomField

Summary: Update a campaign custom field

Description: Updates a campaign custom field.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditCampaignCustomField (string custom_field_id, FundraisingApi.CampaignCustomFieldEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

custom_field_id

string

(Custom field ID)

The system record ID of the custom field to update.

True

body

FundraisingApi.CampaignCustomFieldEdit

 

While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

True

 

Returns:

 

ListCampaignCustomFieldCategories

Summary: List campaign custom field categories

Description: Lists the campaign custom field categories.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListCampaignCustomFieldCategories ()

 

Returns:

          Type:FundraisingApi.ApiCollectionOfCustomFieldCategoryRead

          Description: Custom field categories

 

ListFunds

Summary: List funds

Description: Returns a list of funds.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListFunds ([Optional]integer limit, [Optional]integer offset, [advanced][Optional]boolean include_inactive, [advanced][Optional]string date_added, [advanced][Optional]string last_modified)

 

Parameters:

Name

Type

Summary

Required

Related Action

limit

integer(int32)

(Limit)

Represents the number of records to return. The default is 500. The maximum is 5000.

False

offset

integer(int32)

(Offset)

Represents the number of records to skip. For use with pagination.

False

include_inactive

boolean

(Include inactive?)

Include inactive funds?

False

date_added

string(date-time)

(Added on or after)

Filter the results to funds created on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

last_modified

string(date-time)

(Modified on or after)

Filter the results to funds modified on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

 

Returns:

          Type:FundraisingApi.ApiCollectionOfFundRead

          Description: Funds

 

GetFund

Summary: Get a fund

Description: Returns information about a fund.

 

Syntax:

BlackbaudRaisersEdgeNXT.GetFund (string fund_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

fund_id

string

(Fund ID)

The system record ID of the fund to get.

True

 

Returns:

          Type:FundraisingApi.FundRead

          Description: Fund

 

ListFundAttachments

Summary: List fund attachments

Description: Lists the attachments for a fund.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListFundAttachments (string fund_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

fund_id

string

(Fund ID)

The system record ID of the fund.

True

 

Returns:

          Type:FundraisingApi.ApiCollectionOfFundAttachmentRead

          Description: Attachments

 

ListFundCustomFields

Summary: List fund custom fields

Description: Lists the custom fields for a fund.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListFundCustomFields (string fund_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

fund_id

string

(Fund ID)

The system record ID of the fund.

True

 

Returns:

          Type:FundraisingApi.ApiCollectionOfFundCustomFieldRead

          Description: Custom fields

 

CreateFundAttachment

Summary: Create a fund attachment

Description: Creates a new fund attachment.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateFundAttachment (FundraisingApi.FundAttachmentAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

FundraisingApi.FundAttachmentAdd

 

Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

True

 

Returns:

          Type:FundraisingApi.CreatedFundAttachment

          Description: Created fund attachment

 

EditFundAttachment

Summary: Update a fund attachment

Description: Updates a fund attachment.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditFundAttachment (string attachment_id, FundraisingApi.FundAttachmentEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

attachment_id

string

(Attachment ID)

The system record ID of the attachment to update.

True

body

FundraisingApi.FundAttachmentEdit

 

Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

True

 

Returns:

 

CreateFundCustomField

Summary: Create a fund custom field

Description: Creates a new fund custom field.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateFundCustomField (FundraisingApi.FundCustomFieldAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

FundraisingApi.FundCustomFieldAdd

 

While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

True

 

Returns:

          Type:FundraisingApi.CreatedFundCustomField

          Description: Created fund custom field

 

EditFundCustomField

Summary: Update a fund custom field

Description: Updates a fund custom field.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditFundCustomField (string custom_field_id, FundraisingApi.FundCustomFieldEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

custom_field_id

string

(Custom field ID)

The system record ID of the custom field to update.

True

body

FundraisingApi.FundCustomFieldEdit

 

While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

True

 

Returns:

 

ListFundCustomFieldCategories

Summary: List fund custom field categories

Description: Lists the fund custom field categories.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListFundCustomFieldCategories ()

 

Returns:

          Type:FundraisingApi.ApiCollectionOfCustomFieldCategoryRead

          Description: Custom field categories

 

ListPackages

Summary: List packages

Description: Returns a list of packages.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListPackages ([Optional]string appeal_id, [Optional]integer limit, [Optional]integer offset, [advanced][Optional]boolean include_inactive, [advanced][Optional]string date_added, [advanced][Optional]string last_modified)

 

Parameters:

Name

Type

Summary

Required

Related Action

appeal_id

string

(Appeal ID)

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.

False

limit

integer(int32)

(Limit)

Represents the number of records to return. The default is 500. The maximum is 5000.

False

offset

integer(int32)

(Offset)

Represents the number of records to skip. For use with pagination.

False

include_inactive

boolean

(Include inactive?)

Include inactive packages?

False

date_added

string(date-time)

(Added on or after)

Filter the results to packages created on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

last_modified

string(date-time)

(Modified on or after)

Filter the results to packages modified on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

 

Returns:

          Type:FundraisingApi.ApiCollectionOfPackageRead

          Description: Packages

 

GetPackage

Summary: Get a package

Description: Returns information about a package.

 

Syntax:

BlackbaudRaisersEdgeNXT.GetPackage (string package_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

package_id

string

(Package ID)

The system record ID of the package to get.

True

 

Returns:

          Type:FundraisingApi.PackageRead

          Description: Package

 

EditGiftAcknowledgement

Summary: Update gift acknowledgement details

Description: Updates the acknowledgement details for a gift.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditGiftAcknowledgement (string acknowledgement_id, GiftApi.AcknowledgementEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

acknowledgement_id

string

(Acknowledgement ID)

The system record ID of the gift acknowledgement to update. It uses the parent gift's ID as its value.

True

body

GiftApi.AcknowledgementEdit

 

Acknowledgement letters foster relationships with donors and show appreciation for their contributions. It is important to keep track of the acknowledgement status of gifts to ensure that each one gets a well-deserved thank you.

True

 

Returns:

 

EditGiftReceipt

Summary: Update gift receipt details

Description: Updates the receipt details for a gift.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditGiftReceipt (string receipt_id, GiftApi.ReceiptEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

receipt_id

string

(Receipt ID)

The system record ID of the gift receipt to update. It uses the parent gift's ID as its value.

True

body

GiftApi.ReceiptEdit

 

An object that represents the gift receipt to edit. To help donors track their giving for tax purposes, your organization should provide gift receipts.

True

 

Returns:

 

ListGifts

Summary: List gifts

Description: Returns a list of gifts.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListGifts ([Optional]string list_id, [Optional]string gift_type, [Optional]string constituent_id, [Optional]string campaign_id, [Optional]string fund_id, [Optional]string appeal_id, [Optional]integer limit, [Optional]integer offset, [advanced][Optional]string start_gift_date, [advanced][Optional]string end_gift_date, [advanced][Optional]number start_gift_amount, [advanced][Optional]number end_gift_amount, [advanced][Optional]string post_status, [advanced][Optional]string receipt_status, [advanced][Optional]string acknowledgement_status, [advanced][Optional]string date_added, [advanced][Optional]string last_modified)

 

Parameters:

Name

Type

Summary

Required

Related Action

list_id

string

(List)

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.

False

ListLists

gift_type

string

(Type)

Represents a comma-separated list of gift types to filter the results. For example, "MatchingGiftPledge,RecurringGift" returns only gifts of type MatchingGiftPledge or RecurringGift.

False

constituent_id

string

(Constituent ID)

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.

False

campaign_id

string

(Campaign ID)

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.

False

fund_id

string

(Fund ID)

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.

False

appeal_id

string

(Appeal ID)

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.

False

limit

integer(int32)

(Limit)

Represents the number of records to return. The default is 500. The maximum is 5000.

False

offset

integer(int32)

(Offset)

Represents the number of records to skip. For use with pagination.

False

start_gift_date

string(date-time)

(Start gift date)

Represents a filter for gifts with a gift date on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

end_gift_date

string(date-time)

(End gift date)

Represents a filter for gifts with a gift date on or before the specified date (ex: '2020-09-18T04:13:56Z').

False

start_gift_amount

number(double)

(Start gift amount)

Represents a filter for gifts with an amount greater than or equal to the specified amount.

False

end_gift_amount

number(double)

(End gift amount)

Represents a filter for gifts with an amount less than or equal to the specified amount.

False

post_status

string

(Post status)

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.

False

receipt_status

string

(Receipt status)

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.

False

acknowledgement_status

string

(Acknowledgement status)

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.

False

date_added

string(date-time)

(Added on or after)

Filter the results to gifts created on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

last_modified

string(date-time)

(Modified on or after)

Filter the results to gifts modified on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

 

Returns:

          Type:GiftApi.ApiCollectionOfGiftRead

          Description: Gifts

 

CreateGift

Summary: Create a gift

Description: Creates a new gift.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateGift (GiftApi.GiftAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

GiftApi.GiftAdd

 

Gifts are the primary goal of fundraising efforts. They come in many forms and have a lot of information associated with them to ensure that they are properly allocated and acknowledged.

True

 

Returns:

          Type:GiftApi.CreatedGift

          Description: Created gift

 

GetGift

Summary: Get a gift

Description: Returns information about a gift.

 

Syntax:

BlackbaudRaisersEdgeNXT.GetGift (string gift_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

gift_id

string

(Gift ID)

The system record ID of the gift to get.

True

 

Returns:

          Type:GiftApi.GiftRead

          Description: Gift

 

ListGiftAttachments

Summary: List gift attachments

Description: Lists the attachments for a gift.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListGiftAttachments (string gift_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

gift_id

string

(Gift ID)

The system record ID of the gift.

True

 

Returns:

          Type:GiftApi.ApiCollectionOfGiftAttachmentRead

          Description: Attachments

 

ListGiftCustomFields

Summary: List gift custom fields

Description: Lists the custom fields for a gift.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListGiftCustomFields (string gift_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

gift_id

string

(Gift ID)

The system record ID of the gift.

True

 

Returns:

          Type:GiftApi.ApiCollectionOfGiftCustomFieldRead

          Description: Custom fields

 

CreateGiftAttachment

Summary: Create a gift attachment

Description: Creates a new gift attachment.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateGiftAttachment (GiftApi.GiftAttachmentAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

GiftApi.GiftAttachmentAdd

 

Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

True

 

Returns:

          Type:GiftApi.CreatedGiftAttachment

          Description: Created gift attachment

 

EditGiftAttachment

Summary: Update a gift attachment

Description: Updates a gift attachment.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditGiftAttachment (string attachment_id, GiftApi.GiftAttachmentEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

attachment_id

string

(Attachment ID)

The system record ID of the attachment to update.

True

body

GiftApi.GiftAttachmentEdit

 

Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

True

 

Returns:

 

CreateGiftCustomField

Summary: Create a gift custom field

Description: Creates a new gift custom field.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateGiftCustomField (GiftApi.GiftCustomFieldAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

GiftApi.GiftCustomFieldAdd

 

While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

True

 

Returns:

          Type:GiftApi.CreatedGiftCustomField

          Description: Created gift custom field

 

EditGiftCustomField

Summary: Update a gift custom field

Description: Updates a gift custom field.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditGiftCustomField (string custom_field_id, GiftApi.GiftCustomFieldEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

custom_field_id

string

(Custom field ID)

The system record ID of the custom field to update.

True

body

GiftApi.GiftCustomFieldEdit

 

While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

True

 

Returns:

 

ListGiftCustomFieldCategories

Summary: List custom field categories

Description: Lists the gift custom field categories.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListGiftCustomFieldCategories ()

 

Returns:

          Type:GiftApi.ApiCollectionOfCustomFieldCategoryRead

          Description: Custom field categories

 

ListLists

Summary: List lists

Description: Get a list of lists.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListLists (string list_type)

 

Parameters:

Name

Type

Summary

Required

Related Action

list_type

string

(List type)Values: [Constituent, Gift, Action, Opportunity]

The type of list to return.

True

 

Returns:

          Type:ListApi.ApiCollectionOfList

          Description: Lists

 

ListOpportunities

Summary: List opportunities

Description: Returns a list of opportunities.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListOpportunities ([Optional]string list_id, [Optional]string constituent_id, [Optional]integer limit, [Optional]integer offset, [advanced][Optional]boolean include_inactive, [advanced][Optional]string date_added, [advanced][Optional]string last_modified)

 

Parameters:

Name

Type

Summary

Required

Related Action

list_id

string

(List)

Defines a list identifier used to filter the set of opportunities to those included in the specified list. If this value is set, other specified filters will be ignored.

False

ListLists

constituent_id

string

(Constituent ID)

Represents a comma-separated list of constituent identifiers to filter the results. For example, "280,1232" returns only opportunities from constituent 280 or constituent 1232.

False

limit

integer(int32)

(Limit)

Represents the number of records to return. The default is 500. The maximum is 5000.

False

offset

integer(int32)

(Offset)

Represents the number of records to skip. For use with pagination.

False

include_inactive

boolean

(Include inactive?)

Include inactive opportunities?

False

date_added

string(date-time)

(Added on or after)

Filter the results to opportunities created on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

last_modified

string(date-time)

(Modified on or after)

Filter the results to opportunities modified on or after the specified date (ex: '2020-09-18T04:13:56Z').

False

 

Returns:

          Type:OpportunityApi.ApiCollectionOfOpportunityRead

          Description: Opportunities

 

CreateOpportunity

Summary: Create an opportunity

Description: Creates a new opportunity.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateOpportunity (OpportunityApi.OpportunityAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

OpportunityApi.OpportunityAdd

 

Opportunities help you plan and track efforts to build relationships with prospects and secure major gifts. They can manage information about fundraising activities and the effectiveness of your efforts.

True

 

Returns:

          Type:OpportunityApi.CreatedOpportunity

          Description: Created opportunity

 

GetOpportunity

Summary: Get an opportunity

Description: Returns information about an opportunity.  Note: This endpoint returns the status property with a latency of about 10 minutes.

 

Syntax:

BlackbaudRaisersEdgeNXT.GetOpportunity (string opportunity_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

opportunity_id

string

(Opportunity ID)

The system record ID of the opportunity to get.

True

 

Returns:

          Type:OpportunityApi.OpportunityRead

          Description: Opportunity

 

EditOpportunity

Summary: Update an opportunity

Description: Updates an opportunity.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditOpportunity (string opportunity_id, OpportunityApi.OpportunityEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

opportunity_id

string

(Opportunity ID)

The system record ID of the opportunity to update.

True

body

OpportunityApi.OpportunityEdit

 

Opportunities help you plan and track efforts to build relationships with prospects and secure major gifts. They can manage information about fundraising activities and the effectiveness of your efforts.

True

 

Returns:

 

ListOpportunityAttachments

Summary: List opportunity attachments

Description: Lists the attachments for an opportunity.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListOpportunityAttachments (string opportunity_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

opportunity_id

string

(Opportunity ID)

The system record ID of the opportunity.

True

 

Returns:

          Type:OpportunityApi.ApiCollectionOfOpportunityAttachmentRead

          Description: Attachments

 

ListOpportunityCustomFields

Summary: List opportunity custom fields

Description: Lists the custom fields for an opportunity.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListOpportunityCustomFields (string opportunity_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

opportunity_id

string

(Opportunity ID)

The system record ID of the opportunity.

True

 

Returns:

          Type:OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead

          Description: Custom fields

 

CreateOpportunityAttachment

Summary: Create an opportunity attachment

Description: Creates a new opportunity attachment.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateOpportunityAttachment (OpportunityApi.OpportunityAttachmentAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

OpportunityApi.OpportunityAttachmentAdd

 

Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

True

 

Returns:

          Type:OpportunityApi.CreatedOpportunityAttachment

          Description: Created opportunity attachment

 

EditOpportunityAttachment

Summary: Update an opportunity attachment

Description: Updates an opportunity attachment.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditOpportunityAttachment (string attachment_id, OpportunityApi.OpportunityAttachmentEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

attachment_id

string

(Attachment ID)

The system record ID of the attachment to update.

True

body

OpportunityApi.OpportunityAttachmentEdit

 

Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

True

 

Returns:

 

CreateOpportunityCustomField

Summary: Create an opportunity custom field

Description: Creates a new opportunity custom field.

 

Syntax:

BlackbaudRaisersEdgeNXT.CreateOpportunityCustomField (OpportunityApi.OpportunityCustomFieldAdd body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

OpportunityApi.OpportunityCustomFieldAdd

 

While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

True

 

Returns:

          Type:OpportunityApi.CreatedOpportunityCustomField

          Description: Created opportunity attachment

 

EditOpportunityCustomField

Summary: Update an opportunity custom field

Description: Updates an opportunity custom field.

 

Syntax:

BlackbaudRaisersEdgeNXT.EditOpportunityCustomField (string custom_field_id, OpportunityApi.OpportunityCustomFieldEdit body)

 

Parameters:

Name

Type

Summary

Required

Related Action

custom_field_id

string

(Custom field ID)

The system record ID of the custom field to update.

True

body

OpportunityApi.OpportunityCustomFieldEdit

 

While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

True

 

Returns:

 

ListOpportunityCustomFieldCategories

Summary: List custom field categories

Description: Lists the opportunity custom field categories.

 

Syntax:

BlackbaudRaisersEdgeNXT.ListOpportunityCustomFieldCategories ()

 

Returns:

          Type:OpportunityApi.ApiCollectionOfCustomFieldCategoryRead

          Description: Custom field categories

 

GetDynamicValues

Summary: Get dynamic values

Description: List dynamic values.

 

Syntax:

BlackbaudRaisersEdgeNXT.GetDynamicValues (string api, string route)

 

Parameters:

Name

Type

Summary

Required

Related Action

api

string

Values: [constituent, gift, fundraising, opportunity]

The underlying SKY API containing the route that will be used to populate the dynamic values list.

True

route

string

 

The route within the specified SKY API to call to produce the values for the dynamic list.

True

 

Returns:

          Type:PowerAutomateUIApi.DynamicValuesCollection

          Description: A collection of objects for use with dynamic values.

 

GetCustomFieldCodeTableDynamicValues

Summary: Get custom field code table dynamic values

Description: List custom field code table dynamic values.

 

Syntax:

BlackbaudRaisersEdgeNXT.GetCustomFieldCodeTableDynamicValues (string api, string custom_field_type, string category_name)

 

Parameters:

Name

Type

Summary

Required

Related Action

api

string

Values: [constituent, gift, fundraising, opportunity]

The underlying SKY API containing the route that will be used to populate the dynamic values list.

True

custom_field_type

string

Values: [actions, constituents, appeals, campaigns, funds, gifts, opportunities]

The type of entity that owns the custom field.

True

category_name

string

 

The custom field category.

True

 

Returns:

          Type:PowerAutomateUIApi.DynamicValuesCollection

          Description: A collection of objects for use with dynamic values.

 

GetParticipantOptionListDynamicValues

Summary: Get participant option list dynamic values

Description: List participant option list dynamic values.

 

Syntax:

BlackbaudRaisersEdgeNXT.GetParticipantOptionListDynamicValues (string event_id, string event_participant_option_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

event_id

string

 

The event identifier.

True

event_participant_option_id

string

 

The event participant option identifier.

True

 

Returns:

          Type:PowerAutomateUIApi.DynamicValuesCollection

          Description: A collection of objects for use with dynamic values.

 

GetCustomFieldDynamicProperties

Summary: Get custom field dynamic properties

Description: List custom field dynamic properties.

 

Syntax:

BlackbaudRaisersEdgeNXT.GetCustomFieldDynamicProperties (string api, string custom_field_type, string category)

 

Parameters:

Name

Type

Summary

Required

Related Action

api

string

Values: [constituent, gift, fundraising, opportunity]

The underlying SKY API containing the endpoint that will be used to fetch the custom field category definition.

True

custom_field_type

string

Values: [actions, constituents, appeals, campaigns, funds, gifts, opportunities]

The type of entity that owns the custom field.

True

category

string

 

The custom field category.

True

 

Returns:

          Type:PowerAutomateUIApi.DynamicProperties

          Description: Defines some (but potentially not all) dynamic OpenApi metadata properties needed for a custom field.

 

GetParticipantOptionDynamicProperties

Summary: Get participant option dynamic properties

Description: List participant option dynamic properties.

 

Syntax:

BlackbaudRaisersEdgeNXT.GetParticipantOptionDynamicProperties (string event_id, string event_participant_option_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

event_id

string

 

The event identifier.

True

event_participant_option_id

string

 

The event participant option identifier.

True

 

Returns:

          Type:PowerAutomateUIApi.DynamicProperties

          Description: Defines some (but potentially not all) dynamic OpenApi metadata properties needed for a custom field.

 

GetRatingDynamicProperties

Summary: Get rating category dynamic properties

Description: List rating category dynamic properties.

 

Syntax:

BlackbaudRaisersEdgeNXT.GetRatingDynamicProperties (string source_name, string category)

 

Parameters:

Name

Type

Summary

Required

Related Action

source_name

string

 

The rating source.

True

category

string

 

The custom field category.

True

 

Returns:

          Type:PowerAutomateUIApi.DynamicProperties

          Description: Defines some (but potentially not all) dynamic OpenApi metadata properties needed for a custom field.

 


 

CommPrefApi.ConsentCategory

Summary:

Description: Consent category

 

          Properties:

Name

Type

Summary

description

string

Description

The name of the consent category.

inactive

boolean

Inactive?

Is the consent category inactive?

sequence

integer(int32)

Sequence

The placement of the category in the order of category table values, if defined.


 

CommPrefApi.ConsentCategoryCollection

Summary:

Description: Consent categories

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

The number of consent categories in the list.

value

array of (CommPrefApi.ConsentCategory)

 

The set of consent categories included in the response.


 

CommPrefApi.ConsentChannel

Summary:

Description: Consent channel

 

          Properties:

Name

Type

Summary

description

string

Description

The name of the consent channel.


 

CommPrefApi.ConsentChannelCollection

Summary:

Description: Consent channels

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

The number of consent channels in the list.

value

array of (CommPrefApi.ConsentChannel)

 

The set of consent channels included in the response.


 

CommPrefApi.ConsentSource

Summary:

Description: Consent source

 

          Properties:

Name

Type

Summary

description

string

Description

The name of the consent source.

inactive

boolean

Inactive?

Is the consent source inactive?

sequence

integer(int32)

Sequence

The placement of the source in the order of source table values, if defined.


 

CommPrefApi.ConsentSourceCollection

Summary:

Description: Consent sources

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

The number of consent sources in the list.

value

array of (CommPrefApi.ConsentSource)

 

The set of consent sources included in the response.


 

CommPrefApi.ConstituentConsentAdd

Summary:

Description: Represents the consent entity to add to the specified constituent.

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the consent record.

channel

string

Channel

The channel that the consent response applies to.

category

string

Category

The category that the consent response applies to.

source

string

Source

The source of the consent response from the constituent.

constituent_consent_response

string

Response

How the constituent responded to consent for the specified channel/category.  Values: [OptIn, OptOut, NoResponse]

consent_date

string(date-time)

Date

The date the consent response was received (ex: '2020-09-18T04:13:56Z').

consent_statement

string

Consent statement

The statement the constituent responded to when providing consent.

privacy_notice

string

Privacy notice

The privacy notice provided to the constituent.


 

CommPrefApi.ConstituentConsentRead

Summary:

Description: Represents a consent entity for a constituent.

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the consent record.

channel

string

Channel

The channel that the consent response applies to.

category

string

Category

The category that the consent response applies to.

source

string

Source

The source of the consent response from the constituent.

constituent_consent_response

string

Response

How the constituent responded to consent for the specified channel/category.  Values: [OptIn, OptOut, NoResponse]

consent_date

string(date-time)

Date

The date the consent response was received.

consent_statement

string

Consent statement

The statement the constituent responded to when providing consent.

privacy_notice

string

Privacy notice

The privacy notice provided to the constituent.

date_added

string(date-time)

Date added

The date the consent response was added.

user_name

string

Added by

The user that added the consent response.


 

CommPrefApi.ConstituentConsentReadCollection

Summary:

Description: Consent records

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

The number of consent records in the list.

value

array of (CommPrefApi.ConstituentConsentRead)

 

The set of consent records included in the response.


 

CommPrefApi.ConstituentSolicitCodeAdd

Summary:

Description: Solicit codes provide guidance on how to contact constituents. These rules describe instructions and restrictions about when to reach out to constituents and how to tailor communications to honor their requests.

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the solicit code.

solicit_code

string

Solicit code

Communication instructions and/or restrictions for a constituent.

start_date

string(date)

Start date

The start date of the solicit code (ex: '2005-09-18').

end_date

string(date)

End date

The end date of the solicit code (ex: '2005-09-18').


 

CommPrefApi.ConstituentSolicitCodeEdit

Summary:

Description: Solicit codes provide guidance on how to contact constituents. These rules describe instructions and restrictions about when to reach out to constituents and how to tailor communications to honor their requests.

 

          Properties:

Name

Type

Summary

solicit_code

string

Solicit code

Communication instructions and/or restrictions for a constituent.

start_date

string(date)

Start date

The start date of the solicit code (ex: '2005-09-18').

end_date

string(date)

End date

The end date of the solicit code (ex: '2005-09-18').


 

CommPrefApi.ConstituentSolicitCodeRead

Summary:

Description: Solicit code

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the constituent solicit code.

solicit_code

string

Solicit code

Communication instructions and/or restrictions for a constituent.

start_date

string(date)

Start date

The start date of the solicit code (ex: '2005-09-18').

end_date

string(date)

End date

The end date of the solicit code (ex: '2005-09-18').


 

CommPrefApi.ConstituentSolicitCodeReadCollection

Summary:

Description: Solicit codes

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

The number of constituent solicit codes in the list.

value

array of (CommPrefApi.ConstituentSolicitCodeRead)

 

The set of constituent solicit codes included in the response.


 

CommPrefApi.CreatedConstituentConsent

Summary:

Description: Created constituent consent

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created consent record.


 

CommPrefApi.CreatedConstituentSolicitCode

Summary:

Description: Created constituent solicit code

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created constituent solicit code.


 

CommPrefApi.SolicitCode

Summary:

Description: Solicit code

 

          Properties:

Name

Type

Summary

description

string

Description

The name of the solicit code.


 

CommPrefApi.SolicitCodeCollection

Summary:

Description: Solicit codes

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

The number of solicit codes in the list.

value

array of (CommPrefApi.SolicitCode)

 

The set of solicit codes included in the response.


 

ConstituentApi.ActionAdd

Summary:

Description: Actions track the interactions and tasks that are required to secure gifts and cultivate relationships with constituents.

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the action.

category

string

Category

The channel or intent of the constituent interaction.  Values: [Phone Call, Meeting, Mailing, Email, Task/Other]

completed

boolean

Completed?

Is the action completed? If the system is configured to use custom action statuses, this value is based on the action status value.

completed_date

string(date-time)

Completed on

The date when the action was completed (ex: '2020-09-18T04:13:56Z').

date

string(date-time)

Date

The action date (ex: '2020-09-18T04:13:56Z').

description

string

Note

The detailed explanation that elaborates on the action summary.

direction

string

Direction

The direction of the action.  Values: [Inbound, Outbound]

fundraisers

array of (string)

Fundraiser(s)

The set of system record IDs for the fundraisers associated with the action.

location

string

Location

The location of the action.

opportunity_id

string

Opportunity ID

The system record ID of the opportunity associated with the action.

outcome

string

Outcome

The outcome of the action.  Values: [Successful, Unsuccessful]

priority

string

Priority

The priority of the action.  Values: [Normal, High, Low]

start_time

string

Start time

The start time of the action. Uses 24-hour time in the HH:mm format.

end_time

string

End time

The end time of the action. Uses 24-hour time in the HH:mm format.

status

string

Status

The action status.

summary

string

Summary

The short description of the action that appears at the top of the record. Character limit: 255.

type

string

Type

Additional description of the action to complement the category.


 

ConstituentApi.ActionAttachmentAdd

Summary:

Description: Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

 

          Properties:

Name

Type

Summary

parent_id

string

Action ID

The system record ID of the action associated with the attachment.

type

string

Type

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.  Values: [Link, Physical]

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment (ex: '2020-09-18T04:13:56Z'). This field defaults to the current date and time if not supplied.

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.

file_name

string

File name

The name of the file. Character limit: 36. For physical attachments only.

file_id

string

File ID

The identifier of the file. Character limit: 36. For physical attachments only.

thumbnail_id

string

Thumbnail ID

The identifier of the thumbnail. Character limit: 36. For physical attachments only.


 

ConstituentApi.ActionAttachmentEdit

Summary:

Description: Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment (ex: '2020-09-18T04:13:56Z').

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.


 

ConstituentApi.ActionAttachmentRead

Summary:

Description: Attachment

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the attachment.

parent_id

string

Action ID

The system record ID of the action associated with the attachment.

type

string

Type

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.  Values: [Link, Physical]

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment.

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.

file_name

string

File name

The name of the file. Character limit: 36. For physical attachments only.

file_id

string

File ID

The identifier of the file. Character limit: 36. For physical attachments only.

thumbnail_id

string

Thumbnail ID

The identifier of the thumbnail. Character limit: 36. For physical attachments only.

thumbnail_url

string

Thumbnail URL

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

string

Content type

The content type. For physical attachments only.

file_size

integer(int64)

File size

The file size in bytes. For physical attachments only.


 

ConstituentApi.ActionCustomFieldAdd

Summary:

Description: While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

 

          Properties:

Name

Type

Summary

parent_id

string

Action ID

The system record ID of the action associated with the custom field.

category

string

Category

The custom field category.

value

Value

 

 

date

string(date)

Date

The date on the custom field (ex: '2005-09-18').

comment

string

Comment

The comment on the custom field. Character limit: 50.

 

Value

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

ConstituentApi.ActionCustomFieldEdit

Summary:

Description: While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

 

          Properties:

Name

Type

Summary

category

string

Category

The custom field category (required if updating the custom field value).

value

Value

 

 

date

string(date)

Date

The date on the custom field (ex: '2005-09-18').

comment

string

Comment

The comment on the custom field. Character limit: 50.

 

Value

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

ConstituentApi.ActionCustomFieldRead

Summary:

Description: Custom field

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the custom field.

parent_id

string

Action ID

The system record ID of the action associated with the custom field.

category

string

Category

The custom field category.

type

string

Type

The type of data that the custom field represents.  Values: [Text, Number, Date, Currency, Boolean, CodeTableEntry, ConstituentId, FuzzyDate]

value

Value

Value

The value of the custom field.

date

string(date)

Date

The date on the custom field.

comment

string

Comment

The comment on the custom field. Character limit: 50.

date_added

string(date-time)

Date added

The date when the custom field was created.

date_modified

string(date-time)

Date modified

The date when the custom field was last modified.

 

Value

Summary: Value

Description: The value of the custom field.

 

          Properties:

Name

Type

Summary

 


 

ConstituentApi.ActionEdit

Summary:

Description: Actions track the interactions and tasks that are required to secure gifts and cultivate relationships with constituents.

 

          Properties:

Name

Type

Summary

category

string

Category

The channel or intent of the constituent interaction.  Values: [Phone Call, Meeting, Mailing, Email, Task/Other]

completed

boolean

Completed?

Is the action completed? If the system is configured to use custom action statuses, this value is based on the action status value.

completed_date

string(date-time)

Completed on

The date when the action was completed (ex: '2020-09-18T04:13:56Z').

date

string(date-time)

Date

The action date (ex: '2020-09-18T04:13:56Z').

description

string

Note

The detailed explanation that elaborates on the action summary.

direction

string

Direction

The direction of the action.  Values: [Inbound, Outbound]

fundraisers

array of (string)

Fundraiser(s)

The set of system record IDs for the fundraisers associated with the action.

location

string

Location

The location of the action.

opportunity_id

string

Opportunity ID

The system record ID of the opportunity associated with the action.

outcome

string

Outcome

The outcome of the action.  Values: [Successful, Unsuccessful]

priority

string

Priority

The priority of the action.  Values: [Normal, High, Low]

start_time

string

Start time

The start time of the action. Uses 24-hour time in the HH:mm format.

end_time

string

End time

The end time of the action. Uses 24-hour time in the HH:mm format.

status

string

Status

The action status.

summary

string

Summary

The short description of the action that appears at the top of the record. Character limit: 255.

type

string

Type

Additional description of the action to complement the category.


 

ConstituentApi.ActionRead

Summary:

Description: Action

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the action.

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the action.

category

string

Category

The channel or intent of the constituent interaction.

completed

boolean

Completed?

Is the action completed? If the system is configured to use custom action statuses, this value is based on the action status value.

completed_date

string(date-time)

Completed on

The date when the action was completed.

date

string(date-time)

Date

The action date.

description

string

Note

The detailed explanation that elaborates on the action summary.

direction

string

Direction

The direction of the action.  Values: [Inbound, Outbound]

fundraisers

array of (string)

Fundraiser(s)

The set of system record IDs for the fundraisers associated with the action.

location

string

Location

The location of the action.

opportunity_id

string

Opportunity ID

The system record ID of the opportunity associated with the action.

outcome

string

Outcome

The outcome of the action.  Values: [Successful, Unsuccessful]

priority

string

Priority

The priority of the action.  Values: [Normal, High, Low]

start_time

string

Start time

The start time of the action. Uses 24-hour time in the HH:mm format.

end_time

string

End time

The end time of the action. Uses 24-hour time in the HH:mm format.

status

string

Status

The action status.

status_code

string

Status code

The action status code. This property is only returned when the system is configured to use custom action statuses.

computed_status

string

Computed status

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.  Values: [Open, Completed, PastDue]

summary

string

Summary

The short description of the action that appears at the top of the record. Character limit: 255.

type

string

Type

Additional description of the action to complement the category.

date_added

string(date-time)

Date added

The date when the action was created.

date_modified

string(date-time)

Date modified

The date when the action was last modified.


 

ConstituentApi.AddressAdd

Summary:

Description: Addresses store information about constituent residences and other addresses along with information about where or whether to send mail.

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the address.

type

string

Address type

The address type.

country

string

Country

The country of the address (can be the ID, name, or abbreviation).

address_lines

string

Address lines

The address lines.

city

string

City

The city of the address (do not use in combination with the Suburb field).

state

string

State

The state of the address.

postal_code

string

Postal code

The postal code of the address.

suburb

string

Suburb

The suburb of the address (do not use in combination with the City field).

county

string

County

The county of the address.

information_source

string

Information source

The information source for the address.

region

string

Region

The region for the address.

cart

string

CART

The carrier route (CART) for the address.

lot

string

LOT

The line of travel (LOT) for the address.

dpc

string

DPC

The delivery point code (DPC) for the address.

start

string(date)

Valid from

The date when the constituent began residing at this address (ex: '2005-09-18').

end

string(date)

Valid to

The date when the constituent ceased to reside at this address (ex: '2005-09-18').

preferred

boolean

Primary?

Is this the constituent's preferred address?

do_not_mail

boolean

Do not mail?

Can the constituent be contacted at this address?

seasonal_start

Seasonal_start

Seasonal start

The time of year that the constituent begins residing at this address.

seasonal_end

Seasonal_end

Seasonal end

The time of the year ceases to reside at this address.

 

Seasonal_start

Summary: Seasonal start

Description: The time of year that the constituent begins residing at this address.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Seasonal_end

Summary: Seasonal end

Description: The time of the year ceases to reside at this address.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

ConstituentApi.AddressEdit

Summary:

Description: Addresses store information about constituent residences and other addresses along with information about where or whether to send mail.

 

          Properties:

Name

Type

Summary

type

string

Address type

The address type.

country

string

Country

The country of the address (can be the ID, name, or abbreviation).

address_lines

string

Address lines

The address lines.

city

string

City

The city of the address (do not use in combination with the Suburb field).

state

string

State

The state of the address.

postal_code

string

Postal code

The postal code of the address.

suburb

string

Suburb

The suburb of the address (do not use in combination with the City field).

county

string

County

The county of the address.

information_source

string

Information source

The information source for the address.

region

string

Region

The region for the address.

cart

string

CART

The carrier route (CART) for the address.

lot

string

LOT

The line of travel (LOT) for the address.

dpc

string

DPC

The delivery point code (DPC) for the address.

start

string(date)

Valid from

The date when the constituent began residing at this address (ex: '2005-09-18').

end

string(date)

Valid to

The date when the constituent ceased to reside at this address (ex: '2005-09-18').

preferred

boolean

Primary?

Is this the constituent's preferred address?

do_not_mail

boolean

Do not mail?

Can the constituent be contacted at this address?

seasonal_start

Seasonal_start

Seasonal start

The time of year that the constituent begins residing at this address.

seasonal_end

Seasonal_end

Seasonal end

The time of the year ceases to reside at this address.

 

Seasonal_start

Summary: Seasonal start

Description: The time of year that the constituent begins residing at this address.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Seasonal_end

Summary: Seasonal end

Description: The time of the year ceases to reside at this address.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

ConstituentApi.AddressRead

Summary:

Description: Address

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the address.

type

string

Type

The address type.

country

string

Country

The country of the address (can be the ID, name, or abbreviation).

address_lines

string

Address lines

The address lines.

city

string

City

The city of the address (do not use in combination with the Suburb field).

state

string

State

The state of the address.

postal_code

string

Postal code

The postal code of the address.

suburb

string

Suburb

The suburb of the address (do not use in combination with the City field).

county

string

County

The county of the address.

formatted_address

string

Formatted address

The formatted address in the configured format of the country.

information_source

string

Information source

The information source for the address.

region

string

Region

The region for the address.

cart

string

CART

The carrier route (CART) for the address.

lot

string

LOT

The line of travel (LOT) for the address.

dpc

string

DPC

The delivery point code (DPC) for the address.

start

string(date-time)

Valid from

The date when the constituent began residing at this address.

end

string(date-time)

Valid to

The date when the constituent ceased to reside at this address.

preferred

boolean

Primary?

Is this the constituent's preferred address?

inactive

boolean

Inactive?

Is the address inactive (meaning, the current date is before any end date)?

do_not_mail

boolean

Do not mail?

Can the constituent be contacted at this address?

seasonal_start

Seasonal_start

Seasonal start

The time of year that the constituent begins residing at this address.

seasonal_end

Seasonal_end

Seasonal end

The time of the year ceases to reside at this address.

date_added

string(date-time)

Date added

The date when the address was created.

date_modified

string(date-time)

Date modified

The date when the address was last modified.

 

Seasonal_start

Summary: Seasonal start

Description: The time of year that the constituent begins residing at this address.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Seasonal_end

Summary: Seasonal end

Description: The time of the year ceases to reside at this address.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

ConstituentApi.AliasAdd

Summary:

Description: Aliases provide secondary identification for individuals or organizations. For example, aliases can be stage names or acronyms.

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the alias.

name

string

Alias

The name to use as the constituent's alias. Character limit: 100.

type

string

Type

The alias type.


 

ConstituentApi.AliasEdit

Summary:

Description: Aliases provide secondary identification for individuals or organizations. For example, aliases can be stage names or acronyms.

 

          Properties:

Name

Type

Summary

name

string

Alias

The name to use as the constituent's alias. Character limit: 100.

type

string

Type

The alias type.


 

ConstituentApi.AliasRead

Summary:

Description: Alias

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the alias.

name

string

Alias

The name to use as the constituent's alias.

type

string

Type

The alias type.


 

ConstituentApi.ApiCollectionOfActionAttachmentRead

Summary:

Description: Attachments

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

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

Summary:

Description: Custom fields

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

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

Summary:

Description: Actions

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (ConstituentApi.ActionRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

ConstituentApi.ApiCollectionOfAddressRead

Summary:

Description: Addresses

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (ConstituentApi.AddressRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

ConstituentApi.ApiCollectionOfAliasRead

Summary:

Description: Aliases

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (ConstituentApi.AliasRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

ConstituentApi.ApiCollectionOfConstituentAttachmentRead

Summary:

Description: Attachments

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

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

Summary:

Description: Constituent codes

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

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

Summary:

Description: Custom fields

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

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

Summary:

Description: Constituents

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (ConstituentApi.ConstituentRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

ConstituentApi.ApiCollectionOfCountryRead

Summary:

Description: Countries

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (ConstituentApi.CountryRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

ConstituentApi.ApiCollectionOfCustomFieldCategoryRead

Summary:

Description: Custom field categories

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (ConstituentApi.CustomFieldCategoryRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

ConstituentApi.ApiCollectionOfEducationRead

Summary:

Description: Educations

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

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

Summary:

Description: Email addresses

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

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

Summary:

Description: Fundraiser assignments

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (ConstituentApi.FundraiserAssignmentRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

ConstituentApi.ApiCollectionOfNameFormatConfigurationRead

Summary:

Description: Name format configurations

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (ConstituentApi.NameFormatConfigurationRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

ConstituentApi.ApiCollectionOfNoteRead

Summary:

Description: Notes

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

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

Summary:

Description: Online presences

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

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

Summary:

Description: Phones

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (ConstituentApi.PhoneRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

ConstituentApi.ApiCollectionOfRatingCategoryRead

Summary:

Description: Rating categories

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (ConstituentApi.RatingCategoryRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

ConstituentApi.ApiCollectionOfRatingRead

Summary:

Description: Ratings

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (ConstituentApi.RatingRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

ConstituentApi.ApiCollectionOfRatingSourceRead

Summary:

Description: Rating sources

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (ConstituentApi.RatingSourceRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

ConstituentApi.ApiCollectionOfRelationshipRead

Summary:

Description: Relationships

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

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

Summary:

Description: Search results

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (ConstituentApi.SearchResultRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

ConstituentApi.ConstituentAttachmentAdd

Summary:

Description: Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

 

          Properties:

Name

Type

Summary

parent_id

string

Constituent ID

The system record ID of the constituent associated with the attachment.

type

string

Type

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.  Values: [Link, Physical]

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment (ex: '2020-09-18T04:13:56Z'). This field defaults to the current date and time if not supplied.

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.

file_name

string

File name

The name of the file. Character limit: 36. For physical attachments only.

file_id

string

File ID

The identifier of the file. Character limit: 36. For physical attachments only.

thumbnail_id

string

Thumbnail ID

The identifier of the thumbnail. Character limit: 36. For physical attachments only.


 

ConstituentApi.ConstituentAttachmentEdit

Summary:

Description: Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment (ex: '2020-09-18T04:13:56Z').

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.


 

ConstituentApi.ConstituentAttachmentRead

Summary:

Description: Attachment

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the attachment.

parent_id

string

Constituent ID

The system record ID of the constituent associated with the attachment.

type

string

Type

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.  Values: [Link, Physical]

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment.

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.

file_name

string

File name

The name of the file. Character limit: 36. For physical attachments only.

file_id

string

File ID

The identifier of the file. Character limit: 36. For physical attachments only.

thumbnail_id

string

Thumbnail ID

The identifier of the thumbnail. Character limit: 36. For physical attachments only.

thumbnail_url

string

Thumbnail URL

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

string

Content type

The content type. For physical attachments only.

file_size

integer(int64)

File size

The file size in bytes. For physical attachments only.


 

ConstituentApi.ConstituentCodeAdd

Summary:

Description: Constituent codes define the high-level affiliations between constituents and your organization — such as Board member, Vendor, and Volunteer — to provide context for why constituents are in the database.

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the constituent code.

description

string

Constituent code

The constituent code.

start

Start

Start

The start date of the constituent code.

end

End

End

The end date of the constituent code.

sequence

integer(int32)

Sequence

The numeric sequence associated with the constituent code.

 

Start

Summary: Start

Description: The start date of the constituent code.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

End

Summary: End

Description: The end date of the constituent code.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

ConstituentApi.ConstituentCodeEdit

Summary:

Description: Constituent codes define the high-level affiliations between constituents and your organization — such as Board member, Vendor, and Volunteer — to provide context for why constituents are in the database.

 

          Properties:

Name

Type

Summary

start

Start

Start

The start date of the constituent code.

end

End

End

The end date of the constituent code.

sequence

integer(int32)

Sequence

The numeric sequence associated with the constituent code.

 

Start

Summary: Start

Description: The start date of the constituent code.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

End

Summary: End

Description: The end date of the constituent code.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

ConstituentApi.ConstituentCodeRead

Summary:

Description: Constituent code

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the constituent code.

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the constituent code.

description

string

Constituent code

The constituent code.

start

Start

Start

The start date of the constituent code.

end

End

End

The end date of the constituent code.

inactive

boolean

Inactive?

Is the constituent code inactive?

sequence

integer(int32)

Sequence

The numeric sequence associated with the constituent code.

date_added

string(date-time)

Date added

The date when the constituent code was created.

date_modified

string(date-time)

Date modified

The date when the constituent code was last modified.

 

Start

Summary: Start

Description: The start date of the constituent code.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

End

Summary: End

Description: The end date of the constituent code.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

ConstituentApi.ConstituentCustomFieldAdd

Summary:

Description: While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

 

          Properties:

Name

Type

Summary

parent_id

string

Constituent ID

The system record ID of the constituent associated with the custom field.

category

string

Category

The custom field category.

value

Value

 

 

date

string(date)

Date

The date on the custom field (ex: '2005-09-18').

comment

string

Comment

The comment on the custom field. Character limit: 50.

 

Value

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

ConstituentApi.ConstituentCustomFieldEdit

Summary:

Description: While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

 

          Properties:

Name

Type

Summary

category

string

Category

The custom field category (required if updating the custom field value).

value

Value

 

 

date

string(date)

Date

The date on the custom field (ex: '2005-09-18').

comment

string

Comment

The comment on the custom field. Character limit: 50.

 

Value

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

ConstituentApi.ConstituentCustomFieldRead

Summary:

Description: Custom field

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the custom field.

parent_id

string

Constituent ID

The system record ID of the constituent associated with the custom field.

category

string

Category

The custom field category.

type

string

Type

The type of data that the custom field represents.  Values: [Text, Number, Date, Currency, Boolean, CodeTableEntry, ConstituentId, FuzzyDate]

value

Value

Value

The value of the custom field.

date

string(date)

Date

The date on the custom field.

comment

string

Comment

The comment on the custom field. Character limit: 50.

date_added

string(date-time)

Date added

The date when the custom field was created.

date_modified

string(date-time)

Date modified

The date when the custom field was last modified.

 

Value

Summary: Value

Description: The value of the custom field.

 

          Properties:

Name

Type

Summary

 


 

ConstituentApi.ConstituentEdit

Summary:

Description: Constituents are the individuals and organizations who support your organization by contributing time, money, and resources. The constituent entity stores information about donors, prospects, volunteers, general supporters, and more.

 

          Properties:

Name

Type

Summary

title

string

Title

The constituent's primary title (for individuals only).

first

string

First name

The constituent's first name (for individuals only). Character limit: 50.

last

string

Last name

The constituent's last name (for individuals only). Character limit: 100.

name

string

Organization name

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

string

Suffix

The constituent's primary suffix (for individuals only).

preferred_name

string

Preferred name

The constituent's preferred name (for individuals only). Character limit: 50.

lookup_id

string

Lookup ID

The user-defined identifier for the constituent.

gender

string

Gender

The constituent's gender (for individuals only).

middle

string

Middle name

The constituent's middle name (for individuals only). Character limit: 50.

former_name

string

Former name

The constituent's former name (for individuals only). Character limit: 100.

title_2

string

Title 2

The constituent's secondary title (for individuals only).

suffix_2

string

Suffix 2

The constituent's secondary suffix (for individuals only).

marital_status

string

Marital status

The constituent's marital status (for individuals only).

gives_anonymously

boolean

Gives anonymously?

Does the constituent give anonymously?

inactive

boolean

Inactive?

Is the constituent inactive?

birthdate

Birthdate

Birthdate

The constituent's birthdate (for individuals only).

birthplace

string

Birthplace

The birthplace of the constituent (for individuals only).

ethnicity

string

Ethnicity

The ethnicity of the constituent (for individuals only).

income

string

Income

The income for the constituent (for individuals only).

religion

string

Religion

The religion of the constituent (for individuals only).

industry

string

Industry

The industry of the constituent (for organizations only).

num_employees

integer(int32)

Number of employees

The number of employees at the organization.

matches_gifts

boolean

Matches gifts?

Does the organization match gifts?

matching_gift_factor

number(double)

Matching gift factor

The matching gift factor (for organizations only).

matching_gift_per_gift_min

Matching_gift_per_gift_min

 

 

matching_gift_per_gift_max

Matching_gift_per_gift_max

 

 

matching_gift_total_min

Matching_gift_total_min

 

 

matching_gift_total_max

Matching_gift_total_max

 

 

matching_gift_notes

string

Matching gift notes

The matching gift notes for the constituent (for organizations only).

deceased

boolean

Deceased?

Is the constituent deceased (for individuals only)?

deceased_date

Deceased_date

Deceased date

The date when the constituent died (for individuals only).

 

Birthdate

Summary: Birthdate

Description: The constituent's birthdate (for individuals only).

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Matching_gift_per_gift_min

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

number(double)

Min match per gift

The minimum match amount per gift for the constituent (for organizations only).

 

Matching_gift_per_gift_max

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

number(double)

Max match per gift

The maximum match amount per gift for the constituent (for organizations only).

 

Matching_gift_total_min

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

number(double)

Min match per constit

The minimum match total for the constituent (for organizations only).

 

Matching_gift_total_max

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

number(double)

Max match per constit

The maximum match total for the constituent (for organizations only).

 

Deceased_date

Summary: Deceased date

Description: The date when the constituent died (for individuals only).

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

ConstituentApi.ConstituentRead

Summary:

Description: Constituent

 

          Properties:

Name

Type

Summary

id

string

ID

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

string

Type

The type of constituent.  Values: [Individual, Organization]

title

string

Title

The constituent's primary title (for individuals only).

first

string

First name

The constituent's first name (for individuals only).

last

string

Last name

The constituent's last name (for individuals only).

name

string

Name

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

string

Preferred name

The constituent's preferred name (for individuals only).

suffix

string

Suffix

The constituent's primary suffix (for individuals only).

lookup_id

string

Lookup ID

The user-defined identifier for the constituent.

email

Email

Primary email

The constituent's primary email address, or the constituent's first active email address if no active email address is marked as primary.

phone

Phone

Primary phone

The constituent's primary phone, or the constituent's first active phone if no active phone is marked as primary.

online_presence

Online_presence

Primary online presence

The constituent's primary online presence, or the constituent's first active online presence if no active online presence is marked as primary.

address

Address

Preferred address

The constituent's preferred address.

gender

string

Gender

The constituent's gender (for individuals only).

middle

string

Middle name

The constituent's middle name (for individuals only).

former_name

string

Former name

The constituent's former name (for individuals only).

title_2

string

Title 2

The constituent's secondary title (for individuals only).

suffix_2

string

Suffix 2

The constituent's secondary suffix (for individuals only).

marital_status

string

Marital staus

The constituent's marital status (for individuals only).

gives_anonymously

boolean

Gives anonymously?

Does the constituent give anonymously?

inactive

boolean

Inactive?

Is the constituent inactive?

birthdate

Birthdate

Birthdate

The constituent's birthdate (for individuals only).

birthplace

string

Birthplace

The birthplace of the constituent (for individuals only).

ethnicity

string

Ethnicity

The ethnicity of the constituent (for individuals only).

income

string

Income

The income for the constituent (for individuals only).

religion

string

Religion

The religion of the constituent (for individuals only).

industry

string

Industry

The industry of the constituent (for organizations only).

num_employees

integer(int32)

Number of employees

The number of employees at the organization.

matches_gifts

boolean

Matches gifts?

Does the organization match gifts?

matching_gift_factor

number(double)

Matching gift factor

The matching gift factor (for organizations only).

matching_gift_per_gift_min

Matching_gift_per_gift_min

 

 

matching_gift_per_gift_max

Matching_gift_per_gift_max

 

 

matching_gift_total_min

Matching_gift_total_min

 

 

matching_gift_total_max

Matching_gift_total_max

 

 

matching_gift_notes

string

Matching gift notes

The matching gift notes for the constituent (for organizations only).

age

integer(int32)

Age

The constituent's age, as calculated based on the birthdate property (for individuals only).

deceased

boolean

Deceased?

Is the constituent deceased (for individuals only)?

deceased_date

Deceased_date

Deceased date

The date when the constituent died (for individuals only).

fundraiser_status

string

Fundraiser status

Indicates whether the constituent is a fundraiser (for individuals only).  Values: [Active, Inactive, None]

spouse

Spouse

Spouse

The constituent's spouse (for individuals only).

date_added

string(date-time)

Date added

The date when the constituent was created.

date_modified

string(date-time)

Date modified

The date when the constituent was last modified.

 

Email

Summary: Primary email

Description: The constituent's primary email address, or the constituent's first active email address if no active email address is marked as primary.

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the email address.

type

string

type

The type of email address.

address

string

address

The email address.

do_not_email

boolean

do not email?

Can the constituent be contacted at this email address?

inactive

boolean

inactive?

Is this email address inactive?

date_added

string(date-time)

date added

The date when the email address was created.

date_modified

string(date-time)

date modified

The date when the email address was last modified.

 

Phone

Summary: Primary phone

Description: The constituent's primary phone, or the constituent's first active phone if no active phone is marked as primary.

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the phone.

type

string

type

The phone type.

number

string

number

The phone number.

do_not_call

boolean

do not call?

Can the constituent be contacted at this number?

inactive

boolean

inactive?

Is this phone number inactive?

date_added

string(date-time)

date added

The date when the phone was created.

date_modified

string(date-time)

date modified

The date when the phone was last modified.

 

Online_presence

Summary: Primary online presence

Description: The constituent's primary online presence, or the constituent's first active online presence if no active online presence is marked as primary.

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the online presence.

type

string

type

The online presence type.

address

string

link

The web address for the online presence.

inactive

boolean

inactive?

Is this online presence inactive?

date_added

string(date-time)

date added

The date when the online presence was created.

date_modified

string(date-time)

date modified

The date when the online presence was last modified.

 

Address

Summary: Preferred address

Description: The constituent's preferred address.

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the address.

type

string

type

The address type.

country

string

country

The country of the address (can be the ID, name, or abbreviation).

address_lines

string

lines

The address lines.

city

string

city

The city of the address (do not use in combination with the Suburb field).

state

string

state

The state of the address.

postal_code

string

postal code

The postal code of the address.

suburb

string

suburb

The suburb of the address (do not use in combination with the City field).

county

string

county

The county of the address.

formatted_address

string

formatted

The formatted address in the configured format of the country.

start

string(date-time)

valid from

The date when the constituent began residing at this address.

end

string(date-time)

valid to

The date when the constituent ceased to reside at this address.

inactive

boolean

inactive?

Is the address inactive (meaning, the current date is before any end date)?

do_not_mail

boolean

do not mail?

Can the constituent be contacted at this address?

seasonal_start

Seasonal_start

seasonal start

The time of year that the constituent begins residing at this address.

seasonal_end

Seasonal_end

seasonal end

The time of the year ceases to reside at this address.

date_added

string(date-time)

date added

The date when the address was created.

date_modified

string(date-time)

date modified

The date when the address was last modified.

 

Seasonal_start

Summary: seasonal start

Description: The time of year that the constituent begins residing at this address.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Seasonal_end

Summary: seasonal end

Description: The time of the year ceases to reside at this address.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Birthdate

Summary: Birthdate

Description: The constituent's birthdate (for individuals only).

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Matching_gift_per_gift_min

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

number(double)

Min match per gift

The minimum match amount per gift for the constituent (for organizations only).

 

Matching_gift_per_gift_max

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

number(double)

Max match per gift

The maximum match amount per gift for the constituent (for organizations only).

 

Matching_gift_total_min

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

number(double)

Min match per constit

The minimum match total for the constituent (for organizations only).

 

Matching_gift_total_max

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

number(double)

Max match per constit

The maximum match total for the constituent (for organizations only).

 

Deceased_date

Summary: Deceased date

Description: The date when the constituent died (for individuals only).

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Spouse

Summary: Spouse

Description: The constituent's spouse (for individuals only).

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the spouse.

first

string

first name

The spouse's first name.

last

string

last name

The spouse's last name.

is_head_of_household

boolean

is head of household?

Is the spouse the head of the household?

 


 

ConstituentApi.CountryRead

Summary:

Description: Country

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the country.

abbreviation

string

Abbreviation

The user-defined abbreviation for the country.

name

string

Name

The country name.


 

ConstituentApi.CreatedAction

Summary:

Description: Created action

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created action.


 

ConstituentApi.CreatedActionAttachment

Summary:

Description: Created action attachment

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created action attachment.


 

ConstituentApi.CreatedActionCustomField

Summary:

Description: Created action custom field

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created action custom field.


 

ConstituentApi.CreatedConstituentAddress

Summary:

Description: Created constituent address

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created constituent address.


 

ConstituentApi.CreatedConstituentAlias

Summary:

Description: Created constituent alias

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created constituent alias.


 

ConstituentApi.CreatedConstituentAttachment

Summary:

Description: Created constituent attachment

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created constituent attachment.


 

ConstituentApi.CreatedConstituentCode

Summary:

Description: Created constituent code

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created constituent code.


 

ConstituentApi.CreatedConstituentCustomField

Summary:

Description: Created constituent custom field

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created constituent custom field.


 

ConstituentApi.CreatedConstituentEducation

Summary:

Description: Created constituent education

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created constituent education.


 

ConstituentApi.CreatedConstituentEmailAddress

Summary:

Description: Created constituent email address

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created constituent email address.


 

ConstituentApi.CreatedConstituentNote

Summary:

Description: Created constituent note

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created constituent note.


 

ConstituentApi.CreatedConstituentOnlinePresence

Summary:

Description: Created constituent online presence

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created constituent online presence.


 

ConstituentApi.CreatedConstituentPhone

Summary:

Description: Created constituent phone

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created constituent phone.


 

ConstituentApi.CreatedConstituentRating

Summary:

Description: Created constituent rating

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created constituent rating.


 

ConstituentApi.CreatedIndividualConstituent

Summary:

Description: Created individual constituent

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created individual constituent.


 

ConstituentApi.CreatedIndividualRelationship

Summary:

Description: Created individual relationship

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created individual relationship.


 

ConstituentApi.CreatedOrganizationConstituent

Summary:

Description: Created organization constituent

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created organization constituent.


 

ConstituentApi.CreatedOrganizationRelationship

Summary:

Description: Created organization relationship

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created organization relationship.


 

ConstituentApi.CustomFieldCategoryRead

Summary:

Description: Custom field category

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the custom field category.

type

string

Type

The type of data that custom fields with this category represent.  Values: [Text, Number, Date, Currency, Boolean, CodeTableEntry, ConstituentId, FuzzyDate]


 

ConstituentApi.EducationAdd

Summary:

Description: A constituent's education history provides important insight into who they are and often helps determine which causes to which the constituent will invest time and money.

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the education.

school

string

School

The school/establishment name.

type

string

Type

The type of education.

class_of

string

Class of

The year the constituent graduated.

status

string

Status

The status of the education.

date_entered

Date_entered

Date entered

The first date of attendance.

date_left

Date_left

Date left

The last date of attendance.

date_graduated

Date_graduated

Date graduated

The graduation date.

degree

string

Degree

The degree received.

gpa

number(double)

GPA

The grade point average.

subject_of_study

string

Subject of study

The subject of study.

primary

boolean

Primary?

Is this the constituent's primary school association?

majors

array of (string)

Majors

The major courses of study.

minors

array of (string)

Minors

The minor courses of study.

campus

string

Campus

The campus.  Character limit: 50.

social_organization

string

Social organization

The social organization. Character limit: 50.

known_name

string

Known name

The known name. Character limit: 50.

class_of_degree

string

Class of degree

The class of degree (only applicable for UK versions).

department

string

Department

The name of the education department (only applicable for UK versions).

faculty

string

Faculty

The name of the faculty (only applicable for UK versions).

registration_number

string

Registration number

The registration number (only applicable for UK versions). Character limit: 50.

 

Date_entered

Summary: Date entered

Description: The first date of attendance.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Date_left

Summary: Date left

Description: The last date of attendance.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Date_graduated

Summary: Date graduated

Description: The graduation date.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

ConstituentApi.EducationEdit

Summary:

Description: A constituent's education history provides important insight into who they are and often helps determine which causes to which the constituent will invest time and money.

 

          Properties:

Name

Type

Summary

school

string

School

The school/establishment name.

type

string

Type

The type of education.

class_of

string

Class of

The year the constituent graduated.

status

string

Status

The status of the education.

date_entered

Date_entered

Date entered

The first date of attendance.

date_left

Date_left

Date left

The last date of attendance.

date_graduated

Date_graduated

Date graduated

The graduation date.

degree

string

Degree

The degree received.

gpa

number(double)

GPA

The grade point average.

subject_of_study

string

Subject of study

The subject of study.

primary

boolean

Primary?

Is this the constituent's primary school association?

majors

array of (string)

Majors

The major courses of study.

minors

array of (string)

Minors

The minor courses of study.

campus

string

Campus

The campus.  Character limit: 50.

social_organization

string

Social organization

The social organization. Character limit: 50.

known_name

string

Known name

The known name. Character limit: 50.

class_of_degree

string

Class of degree

The class of degree.

department

string

Department

The name of the education department.

faculty

string

Faculty

The name of the faculty.

registration_number

string

Registration number

The registration number. Character limit: 50.

 

Date_entered

Summary: Date entered

Description: The first date of attendance.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Date_left

Summary: Date left

Description: The last date of attendance.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Date_graduated

Summary: Date graduated

Description: The graduation date.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

ConstituentApi.EducationRead

Summary:

Description: Education

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the education.

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the education.

school

string

School

The school/establishment name.

type

string

Type

The type of education.

class_of

string

Class of

The year the constituent graduated.

status

string

Status

The status of the education.

date_entered

Date_entered

Date entered

The first date of attendance.

date_left

Date_left

Date left

The last date of attendance.

date_graduated

Date_graduated

Date graduated

The graduation date.

degree

string

Degree

The degree received.

gpa

number(double)

GPA

The grade point average.

majors

array of (string)

Majors

The major courses of study.

minors

array of (string)

Minors

The minor courses of study.

primary

boolean

Is primary education?

Is this the constituent's primary school association?

campus

string

Campus

The campus.

social_organization

string

Social organization

The social organization.

known_name

string

Known name

The known name.

class_of_degree

string

Class of degree

The class of degree.

department

string

Department

The name of the education department.

faculty

string

Faculty

The name of the faculty.

registration_number

string

Registration number

The registration number.

subject_of_study

string

Subject of study

The subject of study.

date_added

string(date-time)

Date added

The date when the education was created.

date_modified

string(date-time)

Date modified

The date when the education was last modified.

 

Date_entered

Summary: Date entered

Description: The first date of attendance.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Date_left

Summary: Date left

Description: The last date of attendance.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Date_graduated

Summary: Date graduated

Description: The graduation date.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

ConstituentApi.EmailAddressAdd

Summary:

Description: Email addresses store information about constituent email accounts and where to send email correspondences for individuals and organizations.

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the email address.

type

string

Email type

The type of email address.

address

string

Email address

The email address.

primary

boolean

Primary?

Is this the constituent's primary email address?

do_not_email

boolean

Do not email?

Can the constituent be contacted at this email address?

inactive

boolean

Inactive?

Is this email address inactive?


 

ConstituentApi.EmailAddressEdit

Summary:

Description: Email addresses store information about constituent email accounts and where to send email correspondences for individuals and organizations.

 

          Properties:

Name

Type

Summary

type

string

Email type

The type of email address.

address

string

Email address

The email address.

primary

boolean

Primary?

Is this the constituent's primary email address?

do_not_email

boolean

Do not email?

Can the constituent be contacted at this email address?

inactive

boolean

Inactive?

Is this email address inactive?


 

ConstituentApi.EmailAddressRead

Summary:

Description: Email address

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the email address.

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the email address.

type

string

Email type

The type of email address.

address

string

Email address

The email address.

primary

boolean

Primary?

Is this the constituent's primary email address?

do_not_email

boolean

Do not email?

Can the constituent be contacted at this email address?

inactive

boolean

Inactive?

Is this email address inactive?

date_added

string(date-time)

Date added

The date when the email address was created.

date_modified

string(date-time)

Date modified

The date when the email address was last modified.


 

ConstituentApi.FileDefinition

Summary:

Description: File definition

 

          Properties:

Name

Type

Summary

file_id

string

File ID

The identifier of the file.

file_upload_request

File_upload_request

File upload

The metadata for the request for uploading the file.

thumbnail_id

string

Thumbnail ID

The identifier of the thumbnail.

thumbnail_upload_request

Thumbnail_upload_request

Thumbnail upload

The metadata for the request for uploading the thumbnail.

 

File_upload_request

Summary: File upload

Description: The metadata for the request for uploading the file.

 

          Properties:

Name

Type

Summary

url

string

URL

The URL to use for the upload request.

method

string

method

The HTTP method to use with the upload request.

headers

array of (ConstituentApi.Header)

headers

The headers to supply when making the request.

 

Thumbnail_upload_request

Summary: Thumbnail upload

Description: The metadata for the request for uploading the thumbnail.

 

          Properties:

Name

Type

Summary

url

string

URL

The URL to use for the upload request.

method

string

method

The HTTP method to use with the upload request.

headers

array of (ConstituentApi.Header)

headers

The headers to supply when making the request.

 


 

ConstituentApi.FundraiserAssignmentRead

Summary:

Description: Fundraiser assignment

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the fundraiser assignment.

constituent_id

string

Constituent ID

The system record ID of the constituent assigned to the fundraiser.

fundraiser_id

string

Fundraiser ID

The system record ID of the fundraiser.

type

string

Type

The type of fundraiser.

amount

Amount

Amount

The goal amount for the fundraiser to solicit from the assigned constituent.

campaign_id

string

Campaign ID

The system record ID of the campaign to apply resulting gifts to.

fund_id

string

Fund ID

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

string

Appeal ID

The system record ID of the appeal the fundraiser should use to request gifts.

start

string(date-time)

Start date

The fundraiser assignment start date.

end

string(date-time)

End date

The fundraiser assignment end date.

 

Amount

Summary: Amount

Description: The goal amount for the fundraiser to solicit from the assigned constituent.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 


 

ConstituentApi.Header

Summary:

Description: Request header used for uploading the physical attachment.

 

          Properties:

Name

Type

Summary

name

string

name

The name for the header.

value

string

value

The value for the header.


 

ConstituentApi.NameFormatConfigurationRead

Summary:

Description: Name format configuration

 

          Properties:

Name

Type

Summary

id

string

ID

The name format configuration identifier.

format

string

Format

The name format.


 

ConstituentApi.NewDocumentInfo

Summary:

Description: Cultivation activities often result in physical collateral such as images, PDFs, or Word files. The New Document entity allows you to upload these files to maintain a holistic view of target constituents.

 

          Properties:

Name

Type

Summary

file_name

string

File name

The file name of the document to be uploaded.

upload_thumbnail

boolean

Include thumbnail?

Include a thumbnail document location?


 

ConstituentApi.NoteAdd

Summary:

Description: Notes track helpful or important details about constituents, gifts, or actions, such as specific interests and special instructions for donations. Notes connect you with donors at a more personal level as you cultivate relationships and track lessons learned for more effective fundraising.

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the note.

type

string

Type

The note type.

date

Date

Date

The note date.

summary

string

Summary

The note summary. Character limit: 50.

text

string

Note

The note text.

 

Date

Summary: Date

Description: The note date.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

ConstituentApi.NoteEdit

Summary:

Description: Notes track helpful or important details about constituents, gifts, or actions, such as specific interests and special instructions for donations. Notes connect you with donors at a more personal level as you cultivate relationships and track lessons learned for more effective fundraising.

 

          Properties:

Name

Type

Summary

type

string

Type

The note type.

date

Date

Date

The note date.

summary

string

Summary

The note summary. Character limit: 50.

text

string

Note

The note text.

 

Date

Summary: Date

Description: The note date.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

ConstituentApi.NoteRead

Summary:

Description: Note

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the note.

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the note.

type

string

Type

The note type.

date

Date

Date

The note date.

summary

string

Summary

The note summary.

text

string

Note

The note text.

date_added

string(date-time)

Date added

The date when the note was created.

date_modified

string(date-time)

Date modified

The date when the note was last modified.

 

Date

Summary: Date

Description: The note date.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

ConstituentApi.OnlinePresenceAdd

Summary:

Description: Online presence entities store a constituent's social media accounts, websites, and other means of reaching out or gaining more information about the constituent.

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the online presence.

type

string

Type

The online presence type.

address

string

Link

The web address for the online presence.

primary

boolean

Primary?

Is this the constituent's primary online presence?

inactive

boolean

Inactive?

Is this online presence inactive?


 

ConstituentApi.OnlinePresenceEdit

Summary:

Description: Online presence entities store a constituent's social media accounts, websites, and other means of reaching out or gaining more information about the constituent.

 

          Properties:

Name

Type

Summary

type

string

Type

The online presence type.

address

string

Link

The web address for the online presence.

primary

boolean

Primary?

Is this the constituent's primary online presence?

inactive

boolean

Inactive?

Is this online presence inactive?


 

ConstituentApi.OnlinePresenceRead

Summary:

Description: Online presence

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the online presence.

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the online presence.

type

string

Type

The online presence type.

address

string

Link

The web address for the online presence.

primary

boolean

Primary?

Is this the constituent's primary online presence?

inactive

boolean

Inactive?

Is this online presence inactive?

date_added

string(date-time)

Date added

The date when the online presence was created.

date_modified

string(date-time)

Date modified

The date when the online presence was last modified.


 

ConstituentApi.PhoneAdd

Summary:

Description: Phones store information about constituent phone numbers and where to call individuals and organizations.

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the phone.

type

string

Type

The phone type.

number

string

Number

The phone number.

primary

boolean

Primary?

Is this the constituent's primary phone?

do_not_call

boolean

Do not call?

Can the constituent be contacted at this number?

inactive

boolean

Inactive?

Is this phone number inactive?


 

ConstituentApi.PhoneEdit

Summary:

Description: Phones store information about constituent phone numbers and where to call individuals and organizations.

 

          Properties:

Name

Type

Summary

type

string

Type

The phone type.

number

string

Number

The phone number.

primary

boolean

Primary?

Is this the constituent's primary phone?

do_not_call

boolean

Do not call?

Can the constituent be contacted at this number?

inactive

boolean

Inactive?

Is this phone number inactive?


 

ConstituentApi.PhoneRead

Summary:

Description: Phone

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the phone.

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the phone.

type

string

Type

The phone type.

number

string

Number

The phone number.

primary

boolean

Primary?

Is this the constituent's primary phone?

do_not_call

boolean

Do not call?

Can the constituent be contacted at this number?

inactive

boolean

Inactive?

Is this phone number inactive?

date_added

string(date-time)

Date added

The date when the phone was created.

date_modified

string(date-time)

Date modified

The date when the phone was last modified.


 

ConstituentApi.ProfilePictureEdit

Summary:

Description: Profile pictures are photos or images such as selfies or company logos that help identify constituents and personalize relationships. Profile pictures can be PNG, BMP, or JPG image files uploaded via the web view.

 

          Properties:

Name

Type

Summary

file_name

string

File name

The name of the file.

document_id

string(uuid)

Document ID

The document identifier.

thumbnail_id

string(uuid)

Thumbnail ID

The thumbnail document identifier.


 

ConstituentApi.ProfilePictureRead

Summary:

Description: Profile picture

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the profile picture.

url

string

URL

The URL for the profile picture. The URL contains a time-bound signature that limits access to 60 minutes.

thumbnail_url

string

Thumbnail URL

The URL for a thumbnail of the profile picture. Contains a time-bound signature that limits access to 60 minutes.


 

ConstituentApi.RatingAdd

Summary:

Description: Ratings indicate the estimated wealth of constituents and their capacity to give. Ratings information such as overall wealth ratings, suggested ask amounts, and total identified assets can help to determine where to focus efforts, whether to pursue prospects or major gifts, and how much to ask from donors.

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the rating.

source

string

Source

The source of the new rating.

category

string

Category

The category of the rating.

date

string(date-time)

Date

The date of the rating (ex: '2020-09-18T04:13:56Z').

value

Value

 

 

comment

string

Comments

A comment about the rating. Character limit: 255.

 

Value

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

ConstituentApi.RatingCategoryRead

Summary:

Description: Rating category

 

          Properties:

Name

Type

Summary

inactive

boolean

Inactive?

Is the category inactive?

name

string

Name

The name of the rating category.

source_name

string

Source

The source of the category.

type

string

Type

Gets or sets the type of the rating category.  Values: [Text, Number, DateTime, Currency, Boolean, CodeTable, Unknown]


 

ConstituentApi.RatingRead

Summary:

Description: Rating

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the rating.

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the rating.

source

string

Source

The source of the new rating.

category

string

Category

The category of the rating.

date

string(date-time)

Date

The date of the rating.

value

Value

Description

The value of the rating.

comment

string

Comments

A comment about the rating.

inactive

boolean

Inactive?

Is the rating inactive?

type

string

Type

This computed field indicates the type of data that the rating represents based on the category property.  Values: [Text, Number, DateTime, Currency, Boolean, CodeTable, Unknown]

 

Value

Summary: Description

Description: The value of the rating.

 

          Properties:

Name

Type

Summary

 


 

ConstituentApi.RatingSourceRead

Summary:

Description: Rating source

 

          Properties:

Name

Type

Summary

inactive

boolean

Inactive?

Is the rating source inactive?

name

string

Name

The name of the rating source.


 

ConstituentApi.RelationshipEdit

Summary:

Description: Relationships describe connections between constituents and other individuals and organizations such as family, friends, and employers. Tracking constituent relationships can enhance fundraising efforts and interactions.

 

          Properties:

Name

Type

Summary

type

string

Type

The type of relation that the relationship represents.

reciprocal_type

string

Reciprocal type

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.

start

Start

Start

The start date for the relationship.

end

End

End

The end date for the relationship.

is_spouse

boolean

Is spouse?

Is the related individual the constituent's spouse (only applies to relationships between individuals)?

is_constituent_head_of_household

boolean

Is constituent head of household?

Is the constituent the head of the household?

is_spouse_head_of_household

boolean

Is spouse head of household?

Is the spouse the head of the household?

comment

string

Notes

Additional notes about the relationship.

is_organization_contact

boolean

Is contact?

Does the constituent represent this organization as a contact (only applies to relationships between organizations and individuals)?

is_primary_business

boolean

Is primary business?

Is this the constituent's primary business (only applies to relationships between organizations and individuals)?

organization_contact_type

string

Contact type

Provides context for interactions with the related individual who represents the organization as a contact. Only applies to relationships between organizations and individuals.

position

string

Position

The individual's position in the organization. Only applies to relationships between organizations and individuals. Character limit: 50.

 

Start

Summary: Start

Description: The start date for the relationship.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

End

Summary: End

Description: The end date for the relationship.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

ConstituentApi.RelationshipRead

Summary:

Description: Relationship

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the relationship.

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the relationship.

relation_id

string

Relation ID

The system record ID of the related individual or organization.

reciprocal_relationship_id

string

Reciprocal relationship ID

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

string

Name

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

string

Type

The type of relation that the relationship represents.

reciprocal_type

string

Reciprocal type

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.

start

Start

Start

The start date for the relationship.

end

End

End

The end date for the relationship.

is_spouse

boolean

Is spouse?

Is the related individual the constituent's spouse (only applies to relationships between individuals)?

is_constituent_head_of_household

boolean

Is constituent head of household?

Is the constituent the head of the household?

is_spouse_head_of_household

boolean

Is spouse head of household?

Is the spouse the head of the household?

comment

string

Notes

The comment on the relationship.

is_organization_contact

boolean

Is contact?

Does the constituent represent this organization as a contact (only applies to relationships between organizations and individuals)?

is_primary_business

boolean

Is primary business?

Is this the constituent's primary business (only applies to relationships between organizations and individuals)?

organization_contact_type

string

Contact type

Provides context for interactions with the related individual who represents the organization as a contact. Only applies to relationships between organizations and individuals.

position

string

Position

The individual's position in the organization. Only applies to relationships between organizations and individuals.

date_added

string(date-time)

Date added

The date when the relationship was created.

date_modified

string(date-time)

Date modified

The date when the relationship was last modified.

 

Start

Summary: Start

Description: The start date for the relationship.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

End

Summary: End

Description: The end date for the relationship.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

ConstituentApi.SearchResultRead

Summary:

Description: Search result

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the constituent.

name

string

Name

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

string

Address

The constituent's preferred address.

deceased

boolean

Deceased?

Is the constituent is deceased?

email

string

Email

The constituent's email address.

fundraiser_status

string

Fundraiser status

The constituent's fundraiser status. For individuals, this computed field indicates the whether the constituent is Active, Inactive, or None.  For organizations, this value will always be None.

inactive

boolean

Inactive?

Is the constituent inactive?

lookup_id

string

Lookup ID

The user-defined identifier for the constituent.


 

ConstituentApi.Virtual.IndividualAdd

Summary:

Description: Constituents are the individuals and organizations who support your organization by contributing time, money, and resources. The constituent entity stores information about donors, prospects, volunteers, general supporters, and more.

 

          Properties:

Name

Type

Summary

type

string

Type

The type of constituent.  Values: [Individual]

title

string

Title

The constituent's primary title.

first

string

First name

The constituent's first name. Character limit: 50.

last

string

Last name

The constituent's last name. Character limit: 100.

suffix

string

Suffix

The constituent's primary suffix.

lookup_id

string

Lookup ID

The user-defined identifier for the constituent.

address

Address

Address

The constituent's preferred address.

phone

Phone

Phone

The constituent's phone.

email

Email

Email

The constituent's email address.

online_presence

Online_presence

Online presence

The constituent's online presence.

preferred_name

string

Preferred name

The constituent's preferred name. Character limit: 50.

middle

string

Middle name

The constituent's middle name. Character limit: 50.

former_name

string

Former name

The constituent's former name. Character limit: 100.

title_2

string

Title 2

The constituent's secondary title.

suffix_2

string

Suffix 2

The constituent's secondary suffix.

gender

string

Gender

The constituent's gender.

marital_status

string

Marital status

The constituent's marital status.

gives_anonymously

boolean

Gives anonymously?

Does the constituent give anonymously?

birthdate

Birthdate

Birthdate

The constituent's birthdate.

birthplace

string

Birthplace

The birthplace of the constituent.

ethnicity

string

Ethnicity

The ethnicity of the constituent.

income

string

Income

The income for the constituent.

religion

string

Religion

The religion of the constituent.

primary_addressee

Primary_addressee

 

 

primary_salutation

Primary_salutation

 

 

 

Address

Summary: Address

Description: The constituent's preferred address.

 

          Properties:

Name

Type

Summary

type

string

type

The address type.

country

string

country

The country of the address (can be the ID, name, or abbreviation).

address_lines

string

lines

The address lines. Character limit: 150.

city

string

city

The city of the address (do not use in combination with the Suburb field).

state

string

state

The state of the address.

postal_code

string

postal code

The postal code of the address. Character limit: 12.

suburb

string

suburb

The suburb of the address (do not use in combination with the City field).

county

string

county

The county of the address.

start

string(date)

start

The date when the constituent began residing at this address (ex: '2005-09-18').

end

string(date)

end

The date when the constituent ceased to reside at this address  (ex: '2005-09-18').

 

Phone

Summary: Phone

Description: The constituent's phone.

 

          Properties:

Name

Type

Summary

type

string

type

The phone type.

number

string

number

The phone number.

primary

boolean

is primary?

Is this the constituent's primary phone number?

 

Email

Summary: Email

Description: The constituent's email address.

 

          Properties:

Name

Type

Summary

type

string

type

The type of email address.

address

string

address

The email address.

primary

boolean

is primary?

Is this the constituent's primary email address?

 

Online_presence

Summary: Online presence

Description: The constituent's online presence.

 

          Properties:

Name

Type

Summary

type

string

type

The online presence type.

address

string

address

The web address for the online presence.

primary

boolean

is primary?

Is this the constituent's primary online presence?

 

Birthdate

Summary: Birthdate

Description: The constituent's birthdate.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Primary_addressee

Summary:

Description:

 

          Properties:

Name

Type

Summary

custom_format

boolean

Custom addressee?

Is the primary addressee a custom format?

configuration_id

string

Addressee format

Primary addressee configuration (required unless a custom format is used).

formatted_name

string

Addressee custom name

Primary addressee formatted name (required when a custom format is used). Character limit: 255.

 

Primary_salutation

Summary:

Description:

 

          Properties:

Name

Type

Summary

custom_format

boolean

Custom salutation?

Is the primary salutation a custom format?

configuration_id

string

Salutation format

Primary salutation configuration (required unless a custom format is used).

formatted_name

string

Salutation custom name

Primary salutation formatted name (required when a custom format is used). Character limit: 255.

 


 

ConstituentApi.Virtual.IndividualRelationshipAdd

Summary:

Description: Relationships describe connections between constituents and other individuals such as family, friends, and employers. Tracking constituent relationships can enhance fundraising efforts and interactions.

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the relationship.

relation_id

string

Relation ID

The system record ID of the related individual.

type

string

Type

The type of relation that the relationship represents.

reciprocal_type

string

Reciprocal type

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.

start

Start

Start

The start date for the relationship.

end

End

End

The end date for the relationship.

is_spouse

boolean

Is spouse?

Is the related individual the constituent's spouse?

is_constituent_head_of_household

boolean

Is constituent head of household?

Is the constituent the head of the household?

is_spouse_head_of_household

boolean

Is spouse head of household?

Is the spouse the head of the household?

comment

string

Notes

Additional notes about the relationship.

 

Start

Summary: Start

Description: The start date for the relationship.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

End

Summary: End

Description: The end date for the relationship.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

ConstituentApi.Virtual.OrganizationAdd

Summary:

Description: Constituents are the individuals and organizations who support your organization by contributing time, money, and resources. The constituent entity stores information about donors, prospects, volunteers, general supporters, and more.

 

          Properties:

Name

Type

Summary

type

string

Type

The type of constituent.  Values: [Organization]

name

string

Name

The organization name. Character limit: 100.

lookup_id

string

Lookup ID

The user-defined identifier for the constituent.

address

Address

Address

The constituent's preferred address.

phone

Phone

Phone

The constituent's phone.

email

Email

Email

The constituent's email address.

online_presence

Online_presence

Online presence

The constituent's online presence.

gives_anonymously

boolean

Gives anonymously?

Does the constituent give anonymously?

industry

string

Industry

The industry of the constituent.

num_employees

integer(int32)

Number of employees

The number of employees at the organization.

matches_gifts

boolean

Matches gifts?

Does the organization match gifts?

matching_gift_factor

number(double)

Matching gift factor

The matching gift factor.

matching_gift_per_gift_min

Matching_gift_per_gift_min

 

 

matching_gift_per_gift_max

Matching_gift_per_gift_max

 

 

matching_gift_total_min

Matching_gift_total_min

 

 

matching_gift_total_max

Matching_gift_total_max

 

 

matching_gift_notes

string

Matching gift notes

The matching gift notes for the constituent.

 

Address

Summary: Address

Description: The constituent's preferred address.

 

          Properties:

Name

Type

Summary

type

string

type

The address type.

country

string

country

The country of the address (can be the ID, name, or abbreviation).

address_lines

string

lines

The address lines. Character limit: 150.

city

string

city

The city of the address (do not use in combination with the Suburb field).

state

string

state

The state of the address.

postal_code

string

postal code

The postal code of the address. Character limit: 12.

suburb

string

suburb

The suburb of the address (do not use in combination with the City field).

county

string

county

The county of the address.

start

string(date)

start

The date when the constituent began residing at this address (ex: '2005-09-18').

end

string(date)

end

The date when the constituent ceased to reside at this address (ex: '2005-09-18').

 

Phone

Summary: Phone

Description: The constituent's phone.

 

          Properties:

Name

Type

Summary

type

string

type

The phone type.

number

string

number

The phone number.

primary

boolean

is primary?

Is this the constituent's primary phone number?

 

Email

Summary: Email

Description: The constituent's email address.

 

          Properties:

Name

Type

Summary

type

string

type

The type of email address.

address

string

address

The email address.

primary

boolean

is primary?

Is this the constituent's primary email address?

 

Online_presence

Summary: Online presence

Description: The constituent's online presence.

 

          Properties:

Name

Type

Summary

type

string

type

The online presence type.

address

string

address

The web address for the online presence.

primary

boolean

is primary?

Is this the constituent's primary online presence?

 

Matching_gift_per_gift_min

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

number(double)

Min match per gift

The minimum match amount per gift for the constituent.

 

Matching_gift_per_gift_max

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

number(double)

Max match per gift

The maximum match amount per gift for the constituent.

 

Matching_gift_total_min

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

number(double)

Min match per constit

The minimum match total for the constituent.

 

Matching_gift_total_max

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

number(double)

Max match per constit

The maximum match total for the constituent.

 


 

ConstituentApi.Virtual.OrganizationRelationshipAdd

Summary:

Description: Relationships describe connections between constituents and other individuals and organizations such as family, friends, and employers. Tracking constituent relationships can enhance fundraising efforts and interactions.

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the relationship.

relation_id

string

Relation ID

The system record ID of the related organization.

type

string

Type

The type of relation that the relationship represents.

reciprocal_type

string

Reciprocal type

Describes the constituent's relationship to the related organization.

start

Start

Start

The start date for the relationship.

end

End

End

The end date for the relationship.

is_organization_contact

boolean

Is contact?

Does the constituent represent this organization as a contact?

organization_contact_type

string

Contact type

Provides context for interactions with the related individual who represents the organization as a contact.

position

string

Position

The individual's position in the organization. Character limit: 50.

is_primary_business

boolean

Is primary business?

Is this the constituent's primary business?

comment

string

Notes

Additional notes about the relationship.

 

Start

Summary: Start

Description: The start date for the relationship.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

End

Summary: End

Description: The end date for the relationship.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

EventApi.AdministrativeArea

Summary: administrative area

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

 

          Properties:

Name

Type

Summary

id

string

ID

The record ID of the administrative area.

name

string

name

The name of the administrative area.

short_description

string

short description

The short description of the administrative area.


 

EventApi.ApiCollectionOfEventCategory

Summary:

Description: Categories

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (EventApi.EventCategory)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

EventApi.ApiCollectionOfEventFee

Summary:

Description: Fees

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (EventApi.EventFee)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

EventApi.ApiCollectionOfEventListEntry

Summary:

Description: Events

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (EventApi.EventListEntry)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

EventApi.ApiCollectionOfEventParticipantOption

Summary:

Description: Event participant options

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (EventApi.EventParticipantOption)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

EventApi.ApiCollectionOfParticipantFee

Summary:

Description: Fees

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (EventApi.ParticipantFee)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

EventApi.ApiCollectionOfParticipantFeePayment

Summary:

Description: Fee payments

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (EventApi.ParticipantFeePayment)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

EventApi.ApiCollectionOfParticipantListEntry

Summary:

Description: Participants

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (EventApi.ParticipantListEntry)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

EventApi.ApiCollectionOfParticipantOption

Summary:

Description: Participant options

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (EventApi.ParticipantOption)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

EventApi.ApiCollectionOfParticipationLevel

Summary:

Description: Participation levels

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (EventApi.ParticipationLevel)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

EventApi.Country

Summary: country

Description: Defines the data model used for an address' country.

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the country record.

display_name

string

display name

The display name of the country.

iso_alpha2_code

string

ISO code

The ISO 3166-1 alpha-2 code for the country.


 

EventApi.CreatedEvent

Summary:

Description: Created event

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created event.


 

EventApi.CreatedEventFee

Summary:

Description: Created event fee

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created event fee.


 

EventApi.CreatedEventParticipantOption

Summary:

Description: Created event participant option

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created event participant option.


 

EventApi.CreatedParticipant

Summary:

Description: Created participant

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created participant.


 

EventApi.CreatedParticipantFee

Summary:

Description: Created participant fee

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created participant fee.


 

EventApi.CreatedParticipantFeePayment

Summary:

Description: Created participant fee payment

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created participant fee payment.


 

EventApi.CreatedParticipantOption

Summary:

Description: Created participant option

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created participant option.


 

EventApi.CreateEvent

Summary:

Description: Events are planned occasions that help organizations raise awareness for their missions, engage constituents, and encourage donations.

 

          Properties:

Name

Type

Summary

name

string

Event name

The name of the event.

description

string

Description

The description of the event.

category

Category

 

The event category

start_date

string(date)

Start date

The start date of the event (ex: '2020-09-18').

start_time

string

Start time

The start time of the event (ex: '07:30').

end_date

string(date)

End date

The end date of the event (ex: '2020-09-18').

end_time

string

End time

The end time of the event (ex: '07:30)'.

lookup_id

string

Lookup ID

The lookup ID of the event.

capacity

integer(int32)

Capacity

The number of people that can attend the event.

goal

number(double)

Goal

The monetary goal of the event.

campaign_id

string

Campaign ID

The system record ID of the campaign associated with the event.

fund_id

string

Fund ID

The system record ID of the fund associated with the event.

inactive

boolean

Inactive?

Is the event active?

 

Category

Summary:

Description: The event category

 

          Properties:

Name

Type

Summary

name

string

Category

The category name.

 


 

EventApi.CreateEventFee

Summary:

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

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the fee.

cost

number(double)

Fee amount

The amount of money associated with the fee.

contribution_amount

number(double)

Contribution amount

The amount of the fee that's a donation above the costs of the event.


 

EventApi.CreateEventParticipantOption

Summary:

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

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the event participant option.

input_type

string

Input type

The types of values participants can use to provide responses.  Values: [Boolean, String, List]

multi_select

boolean

Allow multi-select?

Allow more than one value for lists?

list_options

array of (EventApi.CreateParticipantOptionListOption)

 

The available options for the list.


 

EventApi.CreateParticipant

Summary:

Description: Participants are individuals or organizations who engage with the organization through an event.  They can include constituents who receive invitations or register for the event.

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The constituent ID of the participant.

host_id

string

Host ID

The ID of the host's participant record.

rsvp_status

string

RSVP status

The status of the participant's engagement with the event.  Values: [NoResponse, Attending, Declined, Interested, Canceled, Waitlisted, NotApplicable]

attended

boolean

Attended?

Did the participant attend the event?

invitation_status

string

Invitation status

The status of the invitation to the participant.  Values: [NotApplicable, NotInvited, Invited]

rsvp_date

Rsvp_date

RSVP date

The date of the RSVP.

invitation_date

Invitation_date

Invitation date

The date of the invitation.

participation_level

Participation_level

 

The participation level

 

Rsvp_date

Summary: RSVP date

Description: The date of the RSVP.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Invitation_date

Summary: Invitation date

Description: The date of the invitation.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Participation_level

Summary:

Description: The participation level

 

          Properties:

Name

Type

Summary

name

string

Participation level

The name of the participation level.

 


 

EventApi.CreateParticipantFee

Summary:

Description: Participant fees are how much an individual or organization pays to participate in or attend the event.

 

          Properties:

Name

Type

Summary

event_id

string

Event ID

The system record ID of the event.

event_fee_id

string

Fee

The event fee.

quantity

integer(int32)

Quantity

The quantity purchased.

fee_amount

number(double)

Fee amount

The amount of money associated with the fee.

contribution_amount

number(double)

Contribution amount

The amount of the fee that's a donation above the costs of the event. This is the amount that typically appears on receipts.

date

Date

Date

The date of the participant fee.

 

Date

Summary: Date

Description: The date of the participant fee.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

EventApi.CreateParticipantFeePayment

Summary:

Description: Participant fee payments are payments toward the participant's fees.

 

          Properties:

Name

Type

Summary

gift_id

string

Gift ID

The systetm record ID of the gift to which the participant fee is linked.

applied_amount

number(double)

Applied amount

The amount of the payment that applies toward the participant fees.


 

EventApi.CreateParticipantOption

Summary:

Description: Participant options are the responses to an event participant option.

 

          Properties:

Name

Type

Summary

event_id

string

Event ID

The system record ID of the event.

event_participant_option_id

string

Option

The event participant option.

option_value

Option_value

 

 

 

Option_value

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

EventApi.CreateParticipantOptionListOption

Summary: List options

Description: List options for event participant options are the values participants can select when they provide responses.

 

          Properties:

Name

Type

Summary

name

string

name

The name of the list option.

sequence

integer(int32)

sequence

The 0-based sequence used for ordering.


 

EventApi.EditEvent

Summary:

Description: Events are planned occasions that help organizations raise awareness for their missions, engage constituents, and encourage donations.

 

          Properties:

Name

Type

Summary

name

string

Event name

The name of the event.

description

string

Description

The description of the event.

category

Category

 

The event category

start_date

string(date)

Start date

The start date of the event (ex: '2020-09-18').

start_time

string

Start time

The start time of the event (ex: '07:30').

end_date

string(date)

End date

The end date of the event (ex: '2020-09-18').

end_time

string

End time

The end time of the event (ex: '07:30').

lookup_id

string

Lookup ID

The lookup ID of the event.

capacity

integer(int32)

Capacity

The number of people that can attend the event.

goal

number(double)

Goal

The monetary goal of the event.

campaign_id

string

Campaign ID

The system record ID of the campaign associated with the event.

fund_id

string

Fund ID

The system record ID of the fund associated with the event.

inactive

boolean

Inactive?

Is the event active?

 

Category

Summary:

Description: The event category

 

          Properties:

Name

Type

Summary

name

string

Category

The category name.

 


 

EventApi.EditParticipant

Summary:

Description: Participants are individuals or organizations who engage with the organization through an event.  They can include constituents who receive invitations or register for the event.

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The constituent ID of the participant.

host_id

string

Host ID

The ID of the host's participant record.

rsvp_status

string

RSVP status

The status of the participant's engagement with the event.  Values: [NoResponse, Attending, Declined, Interested, Canceled, Waitlisted, NotApplicable]

attended

boolean

Attended?

Did the participant attend the event?

invitation_status

string

Invitation status

The status of the invitation to the participant.  Values: [NotApplicable, NotInvited, Invited]

rsvp_date

Rsvp_date

RSVP date

The date of the RSVP.

invitation_date

Invitation_date

Invitation date

The date of the invitation.

participation_level

Participation_level

 

The participation level

 

Rsvp_date

Summary: RSVP date

Description: The date of the RSVP.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Invitation_date

Summary: Invitation date

Description: The date of the invitation.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Participation_level

Summary:

Description: The participation level

 

          Properties:

Name

Type

Summary

name

string

Participation level

The name of the participation level.

 


 

EventApi.EditParticipantOption

Summary:

Description: A participant option

 

          Properties:

Name

Type

Summary

option_value

string

Value

The participant's response to the option.


 

EventApi.Event

Summary:

Description: Event

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the event.  This is not the same as the user-definable event identifier, which is stored in the lookup_id.

name

string

Name

The name of the event.

description

string

Description

The description of the event.

start_date

string(date)

Start date

The start date of the event.

start_time

string

Start time

The start time of the event.

end_date

string(date)

End date

The end date of the event.

end_time

string

End time

The end time of the event.

category

EventApi.EventCategory

Category

Event category is the custom categorization for the event.

lookup_id

string

Lookup ID

The lookup ID of the event.

location

EventApi.Location

Location

Defines the data model used for a location.

capacity

integer(int32)

Capacity

The number of people that can attend the event.

goal

number(double)

Goal

The monetary goal of the event.

campaign_id

string

Campaign ID

The system record ID of the campaign associated with the event.

fund_id

string

Fund ID

The system record ID of the fund associated with the event.

inactive

boolean

Inactive?

Is the event inactive?

date_added

string(date-time)

Date added

The date when the event was created.

date_modified

string(date-time)

Date modified

The date when the event was last modified.


 

EventApi.EventCategory

Summary: Category

Description: Event category is the custom categorization for the event.

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the event category.

name

string

name

The name of the event category.

inactive

boolean

inactive?

Is this category inactive?


 

EventApi.EventFee

Summary: Event fee

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

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the event fee.

name

string

name

The name of the event fee.

cost

number(double)

amount

The fee's cost.

contribution_amount

number(double)

contribution amount

The tax deductible amount for this fee.

number_sold

integer(int32)

number sold

The number of fees sold.


 

EventApi.EventListEntry

Summary:

Description: Event

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the event.

name

string

Name

The name of the event.

start_date

string(date)

Start date

The start date of the event.

start_time

string

Start time

The start time of the event.

end_date

string(date)

End date

The end date of the event.

end_time

string

End time

The end time of the event.

category

EventApi.EventCategory

Category

Event category is the custom categorization for the event.

lookup_id

string

Lookup ID

The lookup ID of the event.

capacity

integer(int32)

Capacity

The number of people that can attend the event.

attending_count

integer(int32)

Attending

The number of event participants who plan to attend.

attended_count

integer(int32)

Attended

The number of event attendees.

invited_count

integer(int32)

Invited

The number of event invitees.

revenue

number(double)

Revenue

The realized revenue of the event.

goal

number(double)

Goal

The monetary goal of the event.

percent_of_goal

integer(int32)

Percent of goal

The realized revenue as a percentage of the goal revenue.

inactive

boolean

Inactive?

Is the event inactive?

date_added

string(date-time)

Date added

The date when the event was created.

date_modified

string(date-time)

Date modified

The date when the event was last modified.


 

EventApi.EventParticipantOption

Summary: Event participant option

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

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the event participant option.

name

string

name

The name of the event participant option.

input_type

string

input type

The type of the event participant option.  Values: [Boolean, String, List]

multi_select

boolean

allow multi-select?

Allow more than one value for lists?

list_options

array of (EventApi.EventParticipantOptionListOption)

 

The available list options.

added_by_user

string

added by user

The ID of the user that added the option.

updated_by_user

string

modified by user

The ID of the user who modified the option.

added_by_service

string

added by service

The name of the service that added this option.

updated_by_service

string

modified by service

The name of the service that modified this option.

date_added

string(date-time)

date added

The date when the option was created.

date_updated

string(date-time)

date modified

The date when the option was last modified.

version

integer(int32)

version

The version number of the option.


 

EventApi.EventParticipantOptionListOption

Summary:

Description: A event participant option list option

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the list option

name

string

name

The name of the list option

sequence

integer(int32)

sequence

The sequence used to order the list options


 

EventApi.Locality

Summary: locality

Description: Defines the data model used for an address' locality.

 

          Properties:

Name

Type

Summary

id

string

ID

The record ID of the locality record.

name

string

name

The name of the locality.


 

EventApi.Location

Summary: Location

Description: Defines the data model used for a location.

 

          Properties:

Name

Type

Summary

name

string

name

The name of the location.

address_lines

string

address lines

The location's address lines.

postal_code

string

postal code

The location's postal code.

locality

EventApi.Locality

locality

Defines the data model used for an address' locality.

administrative_area

EventApi.AdministrativeArea

administrative area

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

sub_administrative_area

EventApi.SubAdministrativeArea

sub-administrative area

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

country

EventApi.Country

country

Defines the data model used for an address' country.

formatted_address

string

formatted address

The location's formatted address


 

EventApi.Membership

Summary:

Description: Membership information for the participant.

 

          Properties:

Name

Type

Summary

category

EventApi.MembershipCategory

Membership category

The individual's membership category.


 

EventApi.MembershipCategory

Summary: Membership category

Description: The individual's membership category.

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the membership category.

name

string

name

The name of the membership category.


 

EventApi.Participant

Summary:

Description: Participant

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the participant.

constituent_id

string

Constituent ID

The constituent ID of the participant.

event_id

string

Event ID

The system record ID of the event being attended.

host_id

string

Host ID

The ID of the host's participant record.

rsvp_status

string

RSVP status

The status of the participant's engagement with the event.  Values: [NoResponse, Attending, Declined, Interested, Canceled, Waitlisted, NotApplicable]

attended

boolean

Attended?

Did the participant attend the event?

invitation_status

string

Invitation status

The status of the invitation to the participant.  Values: [NotApplicable, NotInvited, Invited]

rsvp_date

Rsvp_date

RSVP date

The date of the RSVP.

invitation_date

Invitation_date

Invitation date

The date of the invitation.

participation_level

EventApi.ParticipationLevel

Participation level

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

date_added

string(date-time)

Date added

The date when the participant was created.

date_modified

string(date-time)

Date modified

The date when the participant was last modified.

 

Rsvp_date

Summary: RSVP date

Description: The date of the RSVP.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Invitation_date

Summary: Invitation date

Description: The date of the invitation.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

EventApi.ParticipantFee

Summary: Participant fee

Description: Defines a data model for a participant fee

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the participant fee.

participant_id

string

participant ID

The ID of the record that the participant fee is linked to.

quantity

integer(int32)

quantity

The quantity purchased.

fee_amount

number(double)

fee amount

The amount of the participant fee.

tax_receiptable_amount

number(double)

contribution amount

The tax deductible amount for this fee.

date

Date

Date

The date of the participant fee.

event_fee

EventApi.EventFee

Event fee

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

 

Date

Summary: Date

Description: The date of the participant fee.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

EventApi.ParticipantFeePayment

Summary: Participant fee payment

Description: Defines a data model for a participant fee payment

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the participant fee payment.

participant_id

string

participant ID

The system record ID of the participant to which the participant fee is linked.

gift_id

string

gift ID

The system record ID of the gift to which the participant fee is linked.

applied_amount

number(double)

applied amount

The applied amount of the participant fee payment.


 

EventApi.ParticipantListEntry

Summary:

Description: Participant

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the participant.

contact_id

string

Contact ID

The ID of the contact attending the event.

rsvp_status

string

RSVP status

The status of the participant's engagement with the event.  Values: [NoResponse, Attending, Declined, Interested, Canceled, Waitlisted, NotApplicable]

attended

boolean

Attended?

Did the participant attend the event?

invitation_status

string

Invitation status

The status of the invitation to the participant.  Values: [NotApplicable, NotInvited, Invited]

rsvp_date

Rsvp_date

RSVP date

The date of the RSVP.

participation_level

EventApi.ParticipationLevel

Participation level

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

title

string

Title

The participant's title.

first_name

string

First name

The participant's first name.

last_name

string

Last name

The participant's last name.

name

string

Name

The participant's full name.

preferred_name

string

Preferred name

The participant's preferred name.

suffix

string

Suffix

The participant's suffix.

lookup_id

string

Lookup ID

The LookupId of the participant.

email

string

Email

The participant's email address.

do_not_email

boolean

Do not email?

Can the participant be contacted at this email address?

phone

string

Phone

The participant's phone number.

do_not_call

boolean

Do not call?

Can the participant be contacted at this number?

middle_name

string

Middle name

The participant's middle name.

former_name

string

Former name

The participant's former name.

is_constituent

boolean

Is a constituent?

Is the participant a constituent?

class_of

string

Class of

The participant's graduating class.

total_registration_fees

number(double)

Total registration fees

The sum of the participant's fee amounts.

total_paid

number(double)

Total paid

The sum of the participant's paid gifts with a type of Registration Fees.

seat

string

Seat

The seat assignment for the participant.

name_tag

string

Name tag

The name tag for the participant

date_added

string(date-time)

Date added

The date when the participant was created.

date_modified

string(date-time)

Date modified

The date when the participant was last modified.

host

Host

Host

The participant's basic summary information.

guests

array of (EventApi.ParticipantListParticipantSummary)

 

The guests of the participant.

memberships

array of (EventApi.Membership)

 

The membership information for the participant.

 

Rsvp_date

Summary: RSVP date

Description: The date of the RSVP.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Host

Summary: Host

Description: The participant's basic summary information.

 

          Properties:

Name

Type

Summary

contact_id

string

contact ID

The ID of the contact attending the event.

participant_id

string

participant ID

The ID of the participant.

name

string

name

The participant's full name.

 


 

EventApi.ParticipantListParticipantSummary

Summary:

Description: The participant's basic summary information.

 

          Properties:

Name

Type

Summary

contact_id

string

contact ID

The ID of the contact attending the event.

participant_id

string

participant ID

The ID of the participant.

name

string

name

The participant's full name.


 

EventApi.ParticipantOption

Summary: Participant option

Description: The participant option associated with a given participant

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the participant option.

participant_id

string

participant ID

The system record ID of the participant.

event_id

string

event ID

The system record ID of the event.

event_participant_option_id

string

event participant option ID

The system record ID of the event participant option.

option_value

string

value

The participant's response to the option.

added_by_user

string

added by user

The ID of the user that added the participant option.

updated_by_user

string

modified by user

The ID of the user who modified the participant option.

added_by_service

string

added by service

The name of the service that added this participant option.

updated_by_service

string

modified by service

The name of the service that modified this participant option.

date_added

string(date-time)

date added

The date when the participant option was created.

date_updated

string(date-time)

date modified

The date when the participant option was last modified.


 

EventApi.ParticipationLevel

Summary: Participation level

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

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the participation level.

name

string

name

The name of the participation level.

is_inactive

boolean

inactive?

Is the participation level inactive?


 

EventApi.SubAdministrativeArea

Summary: sub-administrative area

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

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the sub-administrative area.

name

string

name

The name of the sub-administrative area.


 

FundraisingApi.ApiCollectionOfAppealAttachmentRead

Summary:

Description: Attachments

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

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

Summary:

Description: Custom fields

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

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

Summary:

Description: Appeals

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

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

Summary:

Description: Attachments

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

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

Summary:

Description: Custom fields

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

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

Summary:

Description: Campaigns

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (FundraisingApi.CampaignRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

FundraisingApi.ApiCollectionOfCustomFieldCategoryRead

Summary:

Description: Custom field categories

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (FundraisingApi.CustomFieldCategoryRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

FundraisingApi.ApiCollectionOfFundAttachmentRead

Summary:

Description: Attachments

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

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

Summary:

Description: Custom fields

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

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

Summary:

Description: Funds

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (FundraisingApi.FundRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

FundraisingApi.ApiCollectionOfPackageRead

Summary:

Description: Packages

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (FundraisingApi.PackageRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

FundraisingApi.AppealAttachmentAdd

Summary:

Description: Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

 

          Properties:

Name

Type

Summary

parent_id

string

Appeal ID

The system record ID of the appeal associated with the attachment.

type

string

Type

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.  Values: [Link, Physical]

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment (ex: '2020-09-18T04:13:56Z'). This field defaults to the current date and time if not supplied.

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.

file_name

string

File name

The name of the file. Character limit: 36. For physical attachments only.

file_id

string

File ID

The identifier of the file. Character limit: 36. For physical attachments only.

thumbnail_id

string

Thumbnail ID

The identifier of the thumbnail. Character limit: 36. For physical attachments only.


 

FundraisingApi.AppealAttachmentEdit

Summary:

Description: Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment (ex: '2020-09-18T04:13:56Z').

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.


 

FundraisingApi.AppealAttachmentRead

Summary:

Description: Attachment

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the attachment.

parent_id

string

Appeal ID

The system record ID of the appeal associated with the attachment.

type

string

Type

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.  Values: [Link, Physical]

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment.

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.

file_name

string

File name

The name of the file. Character limit: 36. For physical attachments only.

file_id

string

File ID

The identifier of the file. Character limit: 36. For physical attachments only.

thumbnail_id

string

Thumbnail ID

The identifier of the thumbnail. Character limit: 36. For physical attachments only.

thumbnail_url

string

Thumbnail URL

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

string

Content type

The content type. For physical attachments only.

file_size

integer(int64)

File size

The file size in bytes. For physical attachments only.


 

FundraisingApi.AppealCustomFieldAdd

Summary:

Description: While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

 

          Properties:

Name

Type

Summary

parent_id

string

Appeal ID

The system record ID of the appeal associated with the custom field.

category

string

Category

The custom field category.

value

Value

 

 

date

string(date)

Date

The date on the custom field (ex: '2005-09-18').

comment

string

Comment

The comment on the custom field. Character limit: 50.

 

Value

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

FundraisingApi.AppealCustomFieldEdit

Summary:

Description: While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

 

          Properties:

Name

Type

Summary

category

string

Category

The custom field category (required if updating the custom field value).

value

Value

 

 

date

string(date)

Date

The date on the custom field (ex: '2005-09-18').

comment

string

Comment

The comment on the custom field. Character limit: 50.

 

Value

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

FundraisingApi.AppealCustomFieldRead

Summary:

Description: Custom field

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the custom field.

parent_id

string

Appeal ID

The system record ID of the appeal associated with the custom field.

category

string

Category

The custom field category.

type

string

Type

The type of data that the custom field represents.  Values: [Text, Number, Date, Currency, Boolean, CodeTableEntry, ConstituentId, FuzzyDate]

value

Value

Value

The value of the custom field.

date

string(date)

Date

The date on the custom field.

comment

string

Comment

The comment on the custom field. Character limit: 50.

date_added

string(date-time)

Date added

The date when the custom field was created.

date_modified

string(date-time)

Date modified

The date when the custom field was last modified.

 

Value

Summary: Value

Description: The value of the custom field.

 

          Properties:

Name

Type

Summary

 


 

FundraisingApi.AppealRead

Summary:

Description: Appeal

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the appeal.

category

string

Category

The category of the appeal.

date_added

string(date-time)

Date added

The date when the appeal was created.

date_modified

string(date-time)

Date modified

The date when the appeal was last modified.

description

string

Description

The display name of the appeal.

end_date

string(date-time)

End date

The end date of the appeal.

goal

Goal

Goal

The monetary goal associated with the appeal.

inactive

boolean

Inactive?

Is the appeal active (meaning, the current date is after any start date and before any end date)?

lookup_id

string

Lookup ID

The user-defined identifier for the appeal.

start_date

string(date-time)

Start date

The start date of the appeal.

 

Goal

Summary: Goal

Description: The monetary goal associated with the appeal.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 


 

FundraisingApi.CampaignAttachmentAdd

Summary:

Description: Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

 

          Properties:

Name

Type

Summary

parent_id

string

Campaign ID

The system record ID of the campaign associated with the attachment.

type

string

Type

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.  Values: [Link, Physical]

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment (ex: '2020-09-18T04:13:56Z'). This field defaults to the current date and time if not supplied.

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.

file_name

string

File name

The name of the file. Character limit: 36. For physical attachments only.

file_id

string

File ID

The identifier of the file. Character limit: 36. For physical attachments only.

thumbnail_id

string

Thumbnail ID

The identifier of the thumbnail. Character limit: 36. For physical attachments only.


 

FundraisingApi.CampaignAttachmentEdit

Summary:

Description: Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment (ex: '2020-09-18T04:13:56Z').

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.


 

FundraisingApi.CampaignAttachmentRead

Summary:

Description: Attachment

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the attachment.

parent_id

string

Campaign ID

The system record ID of the campaign associated with the attachment.

type

string

Type

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.  Values: [Link, Physical]

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment.

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.

file_name

string

File name

The name of the file. Character limit: 36. For physical attachments only.

file_id

string

File ID

The identifier of the file. Character limit: 36. For physical attachments only.

thumbnail_id

string

Thumbnail ID

The identifier of the thumbnail. Character limit: 36. For physical attachments only.

thumbnail_url

string

Thumbnail URL

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

string

Content type

The content type. For physical attachments only.

file_size

integer(int64)

File size

The file size in bytes. For physical attachments only.


 

FundraisingApi.CampaignCustomFieldAdd

Summary:

Description: While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

 

          Properties:

Name

Type

Summary

parent_id

string

Campaign ID

The system record ID of the campaign associated with the custom field.

category

string

Category

The custom field category.

value

Value

 

 

date

string(date)

Date

The date on the custom field (ex: '2005-09-18').

comment

string

Comment

The comment on the custom field. Character limit: 50.

 

Value

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

FundraisingApi.CampaignCustomFieldEdit

Summary:

Description: While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

 

          Properties:

Name

Type

Summary

category

string

Category

The custom field category (required if updating the custom field value).

value

Value

 

 

date

string(date)

Date

The date on the custom field (ex: '2005-09-18').

comment

string

Comment

The comment on the custom field. Character limit: 50.

 

Value

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

FundraisingApi.CampaignCustomFieldRead

Summary:

Description: Custom field

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the custom field.

parent_id

string

Campaign ID

The system record ID of the campaign associated with the custom field.

category

string

Category

The custom field category.

type

string

Type

The type of data that the custom field represents.  Values: [Text, Number, Date, Currency, Boolean, CodeTableEntry, ConstituentId, FuzzyDate]

value

Value

Value

The value of the custom field.

date

string(date)

Date

The date on the custom field.

comment

string

Comment

The comment on the custom field. Character limit: 50.

date_added

string(date-time)

Date added

The date when the custom field was created.

date_modified

string(date-time)

Date modified

The date when the custom field was last modified.

 

Value

Summary: Value

Description: The value of the custom field.

 

          Properties:

Name

Type

Summary

 


 

FundraisingApi.CampaignRead

Summary:

Description: Campaign

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the campaign.

category

string

Category

The category of the campaign.

date_added

string(date-time)

Date added

The date when the campaign was created.

date_modified

string(date-time)

Date modified

The date when the campaign was last modified.

description

string

Description

The display name of the campaign.

end_date

string(date-time)

End date

The end date of the campaign.

goal

Goal

Goal

The monetary goal associated with the campaign.

inactive

boolean

Inactive?

Is the campaign inactive (meaning, the current date is after any start date and before any end date)?

lookup_id

string

Lookup ID

The user-defined identifier for the campaign.

start_date

string(date-time)

Start date

The start date of the campaign.

 

Goal

Summary: Goal

Description: The monetary goal associated with the campaign.

 

          Properties:

Name

Type

Summary

value

number(double)

 

The monetary value.

 


 

FundraisingApi.CreatedAppealAttachment

Summary:

Description: Created appeal attachment

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created appeal attachment.


 

FundraisingApi.CreatedAppealCustomField

Summary:

Description: Created appeal custom field

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created appeal custom field.


 

FundraisingApi.CreatedCampaignAttachment

Summary:

Description: Created campaign attachment

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created campaign attachment.


 

FundraisingApi.CreatedCampaignCustomField

Summary:

Description: Created campaign custom field

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created campaign custom field.


 

FundraisingApi.CreatedFundAttachment

Summary:

Description: Created fund attachment

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created fund attachment.


 

FundraisingApi.CreatedFundCustomField

Summary:

Description: Created fund custom field

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created fund custom field.


 

FundraisingApi.CustomFieldCategoryRead

Summary:

Description: The system includes many different types of custom fields. Custom field categories store the metadata to appropriately match how you use a given custom field with an available type.

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the custom field category.

type

string

Type

The type of data that custom fields with this category represent.  Values: [Text, Number, Date, Currency, Boolean, CodeTableEntry, ConstituentId, FuzzyDate]


 

FundraisingApi.FundAttachmentAdd

Summary:

Description: Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

 

          Properties:

Name

Type

Summary

parent_id

string

Fund ID

The system record ID of the fund associated with the attachment.

type

string

Type

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.  Values: [Link, Physical]

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment (ex: '2020-09-18T04:13:56Z'). This field defaults to the current date and time if not supplied.

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.

file_name

string

File name

The name of the file. Character limit: 36. For physical attachments only.

file_id

string

File ID

The identifier of the file. Character limit: 36. For physical attachments only.

thumbnail_id

string

Thumbnail ID

The identifier of the thumbnail. Character limit: 36. For physical attachments only.


 

FundraisingApi.FundAttachmentEdit

Summary:

Description: Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment (ex: '2020-09-18T04:13:56Z').

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.


 

FundraisingApi.FundAttachmentRead

Summary:

Description: Attachment

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the attachment.

parent_id

string

Fund ID

The system record ID of the fund associated with the attachment.

type

string

Type

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.  Values: [Link, Physical]

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment.

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.

file_name

string

File name

The name of the file. Character limit: 36. For physical attachments only.

file_id

string

File ID

The identifier of the file. Character limit: 36. For physical attachments only.

thumbnail_id

string

Thumbnail ID

The identifier of the thumbnail. Character limit: 36. For physical attachments only.

thumbnail_url

string

Thumbnail URL

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

string

Content type

The content type. For physical attachments only.

file_size

integer(int64)

File size

The file size in bytes. For physical attachments only.


 

FundraisingApi.FundCustomFieldAdd

Summary:

Description: While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

 

          Properties:

Name

Type

Summary

parent_id

string

Fund ID

The system record ID of the fund associated with the custom field.

category

string

Category

The custom field category.

value

Value

 

 

date

string(date)

Date

The date on the custom field (ex: '2005-09-18').

comment

string

Comment

The comment on the custom field. Character limit: 50.

 

Value

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

FundraisingApi.FundCustomFieldEdit

Summary:

Description: While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

 

          Properties:

Name

Type

Summary

category

string

Category

The custom field category (required if updating the custom field value).

value

Value

 

 

date

string(date)

Date

The date on the custom field (ex: '2005-09-18').

comment

string

Comment

The comment on the custom field. Character limit: 50.

 

Value

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

FundraisingApi.FundCustomFieldRead

Summary:

Description: Custom field

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the custom field.

parent_id

string

Fund ID

The system record ID of the fund associated with the custom field.

category

string

Category

The custom field category.

type

string

Type

The type of data that the custom field represents.  Values: [Text, Number, Date, Currency, Boolean, CodeTableEntry, ConstituentId, FuzzyDate]

value

Value

Value

The value of the custom field.

date

string(date)

Date

The date on the custom field.

comment

string

Comment

The comment on the custom field. Character limit: 50.

date_added

string(date-time)

Date added

The date when the custom field was created.

date_modified

string(date-time)

Date modified

The date when the custom field was last modified.

 

Value

Summary: Value

Description: The value of the custom field.

 

          Properties:

Name

Type

Summary

 


 

FundraisingApi.FundRead

Summary:

Description: Fund

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the fund.

category

string

Category

The category of the fund.

date_added

string(date-time)

Date added

The date when the fund was created.

date_modified

string(date-time)

Date modified

The date when the fund was last modified.

description

string

Description

The display name of the fund.

end_date

string(date-time)

End date

The end date of the fund.

goal

Goal

Goal

The monetary goal associated with the fund.

inactive

boolean

Inactive?

Is the fund inactive (meaning, the current date is after any start date and before any end date)?

lookup_id

string

Lookup ID

The user-defined identifier for the fund.

start_date

string(date-time)

Start date

The start date of the fund.

type

string

Type

The type of the fund.

 

Goal

Summary: Goal

Description: The monetary goal associated with the fund.

 

          Properties:

Name

Type

Summary

value

number(double)

 

The monetary value.

 


 

FundraisingApi.PackageRead

Summary:

Description: Package

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the package.

appeal_id

string

Appeal ID

The system record ID of the appeal associated with this package.

category

string

Category

The category of the package.

date_added

string(date-time)

Date added

The date when the package was created.

date_modified

string(date-time)

Date modified

The date when the package was last modified.

default_gift_amount

Default_gift_amount

Default gift amount

The default amount for gifts associated with this package.

description

string

Description

The display name of the package.

end

string(date-time)

End date

The end date of the package.

goal

Goal

Goal

The monetary goal associated with the package.

inactive

boolean

Inactive?

Is the package inactive (meaning, the current date is after any start date and before any end date)?

lookup_id

string

Lookup ID

The user-defined identifier for the package.

notes

string

Notes

The notes on the package.

recipient_count

integer(int32)

Recipient count

The number of recipients of the package.

start

string(date-time)

Start date

The start date of the package.

 

Default_gift_amount

Summary: Default gift amount

Description: The default amount for gifts associated with this package.

 

          Properties:

Name

Type

Summary

value

number(double)

 

The monetary value.

 

Goal

Summary: Goal

Description: The monetary goal associated with the package.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 


 

GiftApi.AcknowledgementEdit

Summary:

Description: Acknowledgement letters foster relationships with donors and show appreciation for their contributions. It is important to keep track of the acknowledgement status of gifts to ensure that each one gets a well-deserved thank you.

 

          Properties:

Name

Type

Summary

status

string

Status

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.  Values: [Acknowledged, NeedsAcknowledgement, DoNotAcknowledge]

date

string(date-time)

Date

The date associated with the acknowledgement (ex: '2020-09-18T04:13:56Z').

letter

string

Letter

The letter associated with the acknowledgement.


 

GiftApi.AcknowledgementRead

Summary:

Description: Acknowledgement

 

          Properties:

Name

Type

Summary

date

string(date-time)

date

The date associated with the acknowledgement.

letter

string

letter

The letter associated with the acknowledgement.

status

string

status

The status of the acknowledgement. Available values are: ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT, and DONOTACKNOWLEDGE.


 

GiftApi.ApiCollectionOfCustomFieldCategoryRead

Summary:

Description: Custom field categories

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (GiftApi.CustomFieldCategoryRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

GiftApi.ApiCollectionOfGiftAttachmentRead

Summary:

Description: Attachments

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

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

Summary:

Description: Custom fields

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

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

Summary:

Description: Gifts

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (GiftApi.GiftRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

GiftApi.CreatedGift

Summary:

Description: Created gift

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created gift.


 

GiftApi.CreatedGiftAttachment

Summary:

Description: Created gift attachment

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created gift attachment.


 

GiftApi.CreatedGiftCustomField

Summary:

Description: Created gift custom field

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created gift custom field.


 

GiftApi.CustomFieldCategoryRead

Summary:

Description: Custom field category

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the custom field category.

type

string

Type

The type of data that custom fields with this category represent.  Values: [Text, Number, Date, Currency, Boolean, CodeTableEntry, ConstituentId, FuzzyDate]


 

GiftApi.GiftAdd

Summary:

Description: Gifts are the primary goal of fundraising efforts. They come in many forms and have a lot of information associated with them to ensure that they are properly allocated and acknowledged.

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the gift.

amount

Amount

 

 

date

string(date)

Date

The gift date (ex: '2020-09-18').

type

string

Type

The gift type.  Values: [Donation, Other, GiftInKind]

gift_splits

array of (GiftApi.GiftSplitAdd)

Splits

The set of gift splits associated with the gift.

payments

Payments

 

The payment details.

is_anonymous

boolean

Is anonymous?

Is the gift anonymous? If no value is provided, the default anonymity of the donor will be used.

subtype

string

Subtype

The subtype of the gift.

reference

string

Comment

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

string

Lookup ID

The user-defined identifier for the gift.

default_fundraiser_credits

boolean

Use fundraiser credits?

Use the default fundraiser credits?

default_soft_credits

boolean

Use soft credits?

Use the default soft credits?

constituency

string

Constituency

The constituency of the gift.

batch_prefix

string

Batch prefix

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

string

Batch number

The batch number. Character limit: 50 (including the batch prefix).

post_status

string

Post status

The post status of the gift.  Values: [Posted, NotPosted, DoNotPost]

post_date

string(date)

Post date

The date the gift was posted (ex: '2020-09-18').

origin

string

Origin

The origin of the gift. When provided, it must parse to a valid JSON object with one string field called "name". Additional fields may be added as desired.

receipts

Receipts

 

The receipt details.

 

Amount

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

number(double)

Amount

The monetary amount of the gift.

 

Payments

Summary:

Description: The payment details.

 

          Properties:

Name

Type

Summary

payment_method

string

Payment method

The payment method.  Values: [Cash, CreditCard, PersonalCheck, DirectDebit, Other, PayPal, Venmo]

check_number

string

Check number

The check number (only applicable when payment method is "PersonalCheck").

check_date

Check_date

Check date

The check date (only applicable when payment method is "PersonalCheck").

reference

string

Reference

The payment reference (only applicable when payment method is "Other").

reference_date

Reference_date

Reference date

The payment reference date (only applicable when payment method is "Other").

 

Check_date

Summary: Check date

Description: The check date (only applicable when payment method is "PersonalCheck").

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Reference_date

Summary: Reference date

Description: The payment reference date (only applicable when payment method is "Other").

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Receipts

Summary:

Description: The receipt details.

 

          Properties:

Name

Type

Summary

status

string

Receipt status

The receipt status of the gift.  Values: [Receipted, NeedsReceipt, DoNotReceipt]

amount

Amount

 

 

date

string(date)

Receipt date

The date that the gift was receipted (ex: '2020-09-18').

 

Amount

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

number(double)

Receipt amount

The monetary amount of the receipt for the gift.

 


 

GiftApi.GiftAttachmentAdd

Summary:

Description: Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

 

          Properties:

Name

Type

Summary

parent_id

string

Gift ID

The system record ID of the gift associated with the attachment.

type

string

Type

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.  Values: [Link, Physical]

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment (ex: '2020-09-18T04:13:56Z'). This field defaults to the current date and time if not supplied.

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.

file_name

string

File name

The name of the file. Character limit: 36. For physical attachments only.

file_id

string

File ID

The identifier of the file. Character limit: 36. For physical attachments only.

thumbnail_id

string

Thumbnail ID

The identifier of the thumbnail. Character limit: 36. For physical attachments only.


 

GiftApi.GiftAttachmentEdit

Summary:

Description: Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment (ex: '2020-09-18T04:13:56Z').

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.


 

GiftApi.GiftAttachmentRead

Summary:

Description: Attachment

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the attachment.

parent_id

string

Gift ID

The system record ID of the gift associated with the attachment.

type

string

Type

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.  Values: [Link, Physical]

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment.

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.

file_name

string

File name

The name of the file. Character limit: 36. For physical attachments only.

file_id

string

File ID

The identifier of the file. Character limit: 36. For physical attachments only.

thumbnail_id

string

Thumbnail ID

The identifier of the thumbnail. Character limit: 36. For physical attachments only.

thumbnail_url

string

Thumbnail URL

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

string

Content type

The content type. For physical attachments only.

file_size

integer(int64)

File size

The file size in bytes. For physical attachments only.


 

GiftApi.GiftCustomFieldAdd

Summary:

Description: While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

 

          Properties:

Name

Type

Summary

parent_id

string

Gift ID

The system record ID of the gift associated with the custom field.

category

string

Category

The custom field category.

value

Value

 

 

date

string(date)

Date

The date on the custom field (ex: '2005-09-18').

comment

string

Comment

The comment on the custom field. Character limit: 50.

 

Value

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

GiftApi.GiftCustomFieldEdit

Summary:

Description: While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

 

          Properties:

Name

Type

Summary

category

string

Category

The custom field category (required if updating the custom field value).

value

Value

 

 

date

string(date)

Date

The date on the custom field (ex: '2005-09-18').

comment

string

Comment

The comment on the custom field. Character limit: 50.

 

Value

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

GiftApi.GiftCustomFieldRead

Summary:

Description: Custom field

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the custom field.

parent_id

string

Gift ID

The system record ID of the gift associated with the custom field.

category

string

Category

The custom field category.

type

string

Type

The type of data that the custom field represents.  Values: [Text, Number, Date, Currency, Boolean, CodeTableEntry, ConstituentId, FuzzyDate]

value

Value

Value

The value of the custom field.

date

string(date)

Date

The date on the custom field.

comment

string

Comment

The comment on the custom field. Character limit: 50.

date_added

string(date-time)

Date added

The date when the custom field was created.

date_modified

string(date-time)

Date modified

The date when the custom field was last modified.

 

Value

Summary: Value

Description: The value of the custom field.

 

          Properties:

Name

Type

Summary

 


 

GiftApi.GiftFundraiserRead

Summary:

Description: Gift fundraiser

 

          Properties:

Name

Type

Summary

amount

Amount

amount

The amount credited to the fundraiser for the gift.

constituent_id

string

fundraiser ID

The constituent system record ID for the fundraiser associated with the gift.

 

Amount

Summary: amount

Description: The amount credited to the fundraiser for the gift.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 


 

GiftApi.GiftRead

Summary:

Description: Gift

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the gift.

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the gift.

type

string

Type

The gift type.

subtype

string

Subtype

The subtype of the gift.

date

string(date-time)

Date

The gift date.

amount

Amount

Amount

The monetary amount of the gift.

balance

Balance

Balance

The balance remaining on the gift.

batch_number

string

Batch number

The batch number associated with this gift.

gift_status

string

Status

The status of the gift.

is_anonymous

boolean

Anonymous?

Is the gift anonymous?

constituency

string

Constituency

The constituency of the gift.

lookup_id

string

Lookup ID

The user-defined identifier for the gift.

origin

string

Origin

The origin of the gift.

post_status

string

Post status

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

string(date-time)

Post date

The date that the gift was posted to general ledger.

reference

string

Reference

Notes to track special details about a gift such as the motivation behind it or a detailed description of a gift-in-kind.

recurring_gift_status_date

Recurring_gift_status_date

Recurring gift date

The date that the gift status was last modified.

recurring_gift_schedule

Recurring_gift_schedule

Recurring gift schedule

The recurring gift schedule.

gift_aid_amount

Gift_aid_amount

Gift aid amount

This computed field calculates the total qualified amount of tax reclaimed from Gift Aid across all gift_splits for this gift. For the UK only.

gift_aid_qualification_status

string

Gift aid qualification status

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

string

Gift code

The gift code value associated with the gift.

gift_splits

array of (GiftApi.GiftSplitRead)

Gift splits

The set of gift splits associated with the gift.

fundraisers

array of (GiftApi.GiftFundraiserRead)

Fundraisers

The set of fundraisers who receive credit for the gift.

soft_credits

array of (GiftApi.SoftCreditRead)

Soft credits

The set of soft credits associated with the gift.

receipts

array of (GiftApi.ReceiptRead)

Receipts

The set of receipts associated with the gift.

acknowledgements

array of (GiftApi.AcknowledgementRead)

Acknowledgements

The set of acknowledgements associated with the gift.

payments

array of (GiftApi.PaymentRead)

Payments

The payments on the gift.

linked_gifts

array of (string)

Linked gifts

The identifiers of other gifts that are linked to this gift.

date_added

string(date-time)

Date added

The date when the gift was created.

date_modified

string(date-time)

Date modified

The date when the gift was last modified.

 

Amount

Summary: Amount

Description: The monetary amount of the gift.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 

Balance

Summary: Balance

Description: The balance remaining on the gift.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 

Recurring_gift_status_date

Summary: Recurring gift date

Description: The date that the gift status was last modified.

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Recurring_gift_schedule

Summary: Recurring gift schedule

Description: The recurring gift schedule.

 

          Properties:

Name

Type

Summary

frequency

string

frequency

Installment frequency of the recurring gift to view. Available values are WEEKLY, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONTHLY, QUARTERLY, ANNUALLY.

start_date

string(date-time)

start

Date the recurring gift should start.

end_date

string(date-time)

end

Date the recurring gift should end.

 

Gift_aid_amount

Summary: Gift aid amount

Description: This computed field calculates the total qualified amount of tax reclaimed from Gift Aid across all gift_splits for this gift. For the UK only.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 


 

GiftApi.GiftSplitAdd

Summary:

Description: Split

 

          Properties:

Name

Type

Summary

campaign_id

string

campaign ID

The system record ID of the campaign associated with the gift split.

fund_id

string

fund ID

The system record ID of the fund associated with the gift split.

appeal_id

string

appeal ID

The system record ID of the appeal associated with the gift split.

package_id

string

package ID

The system record ID of the package associated with the gift split.

amount

Amount

 

 

 

Amount

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

number(double)

amount

The monetary amount of the gift split.

 


 

GiftApi.GiftSplitRead

Summary:

Description: Gift split

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the gift split.

amount

Amount

amount

The amount of the gift split.

appeal_id

string

appeal ID

The system record ID of the appeal associated with the gift split.

campaign_id

string

campaign ID

The system record ID of the campaign associated with the gift split.

fund_id

string

fund ID

The system record ID of the fund associated with the gift split.

gift_aid_amount

Gift_aid_amount

gift aid amount

The amount of tax reclaimed from gift aid for this gift split. For the UK only.

gift_aid_qualification_status

string

gift aid qualification status

The gift aid qualification status of the gift split. Available values are: Qualified, and NotQualified. For the UK only.

package_id

string

package ID

The system record ID of the package associated with the gift split.

 

Amount

Summary: amount

Description: The amount of the gift split.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 

Gift_aid_amount

Summary: gift aid amount

Description: The amount of tax reclaimed from gift aid for this gift split. For the UK only.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 


 

GiftApi.PaymentRead

Summary:

Description: Payment

 

          Properties:

Name

Type

Summary

account_token

string

account token

The tokenized account information (ex: credit card) from the external payment provider. Only applies to payment methods of "CreditCard" and "DirectDebit".

bbps_configuration_id

string

BBPS configuration ID

The BBPS configuration ID. Only applies to payment methods of "CreditCard" and "DirectDebit".

bbps_transaction_id

string

BBPS transaction ID

The BBPS transaction ID. Only applies to payment methods of "CreditCard" and "DirectDebit".

check_date

Check_date

check date

The check date. Only applies to payment method of "PersonalCheck".

check_number

string

check number

The check number. Only applies to payment method of "PersonalCheck".

checkout_transaction_id

string

checkout transaction ID

The checkout transaction ID. Only applies to payment methods of "CreditCard" and "DirectDebit".

payment_method

string

payment method

The payment method. Available values are listed below.

reference

string

reference

The reference. Only applies to payment method of "Other".

reference_date

Reference_date

reference date

The reference date. Only applies to payment method of "Other".

 

Check_date

Summary: check date

Description: The check date. Only applies to payment method of "PersonalCheck".

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 

Reference_date

Summary: reference date

Description: The reference date. Only applies to payment method of "Other".

 

          Properties:

Name

Type

Summary

d

integer(int32)

day

The day in the fuzzy date.

m

integer(int32)

month

The month in the fuzzy date.

y

integer(int32)

year

The year in the fuzzy date.

 


 

GiftApi.ReceiptEdit

Summary:

Description: An object that represents the gift receipt to edit. To help donors track their giving for tax purposes, your organization should provide gift receipts.

 

          Properties:

Name

Type

Summary

status

string

Status

The receipt status of the gift.  When status is set to NeedsReceipt or DoNotReceipt, receipt date should be null.  Values: [Receipted, NeedsReceipt, DoNotReceipt]

amount

Amount

Amount

The amount of the receipt.

date

string(date-time)

Date

The date on the receipt (ex: '2020-09-18T04:13:56Z').

number

integer(int32)

Number

The number of the receipt.

 

Amount

Summary: Amount

Description: The amount of the receipt.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 


 

GiftApi.ReceiptRead

Summary:

Description: Receipt

 

          Properties:

Name

Type

Summary

amount

Amount

amount

The amount of the receipt.

date

string(date-time)

date

The date on the receipt.

number

integer(int32)

number

The number of the receipt.

status

string

status

The status of the receipt. Available values are: RECEIPTED, NEEDSRECEIPT, and DONOTRECEIPT.

 

Amount

Summary: amount

Description: The amount of the receipt.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 


 

GiftApi.SoftCreditRead

Summary:

Description: Soft credit

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the soft credit.

amount

Amount

amount

The amount of the soft credit.

constituent_id

string

constituent ID

The system record ID of the constituent associated with the soft credit.

gift_id

string

gift ID

The system record ID of the gift associated with the soft credit.

 

Amount

Summary: amount

Description: The amount of the soft credit.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 


 

ListApi.ApiCollectionOfList

Summary:

Description: Lists

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

The total number of lists in the set.

value

array of (ListApi.ApiList)

 

The set of items included in the response.


 

ListApi.ApiList

Summary:

Description: List

 

          Properties:

Name

Type

Summary

id

string

 

The system record ID for the list.

name

string

 

The name of the list.


 

OpportunityApi.ApiCollectionOfCustomFieldCategoryRead

Summary:

Description: Custom field categories

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (OpportunityApi.CustomFieldCategoryRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

OpportunityApi.ApiCollectionOfOpportunityAttachmentRead

Summary:

Description: Attachments

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (OpportunityApi.OpportunityAttachmentRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead

Summary:

Description: Custom fields

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (OpportunityApi.OpportunityCustomFieldRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

OpportunityApi.ApiCollectionOfOpportunityRead

Summary:

Description: Opportunities

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

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

array of (OpportunityApi.OpportunityRead)

 

The set of items included in the response. This may be a subset of the items in the collection.


 

OpportunityApi.CreatedOpportunity

Summary:

Description: Created opportunity

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created opportunity.


 

OpportunityApi.CreatedOpportunityAttachment

Summary:

Description: Created opportunity attachment

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created opportunity attachment.


 

OpportunityApi.CreatedOpportunityCustomField

Summary:

Description: Created opportunity attachment

 

          Properties:

Name

Type

Summary

id

string

ID

The ID of the newly created opportunity attachment.


 

OpportunityApi.CustomFieldCategoryRead

Summary:

Description: Custom field category

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the custom field category.

type

string

Type

The type of data that custom fields with this category represent.  Values: [Text, Number, Date, Currency, Boolean, CodeTableEntry, ConstituentId, FuzzyDate]


 

OpportunityApi.Fundraiser

Summary:

Description: Fundraiser

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the fundraiser.

credit_amount

Credit_amount

Credit amount

The amount credited to the fundraiser for the opportunity.

 

Credit_amount

Summary: Credit amount

Description: The amount credited to the fundraiser for the opportunity.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 


 

OpportunityApi.OpportunityAdd

Summary:

Description: Opportunities help you plan and track efforts to build relationships with prospects and secure major gifts. They can manage information about fundraising activities and the effectiveness of your efforts.

 

          Properties:

Name

Type

Summary

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the opportunity.

purpose

string

Purpose

The intended use for any money raised as a result of the opportunity.

name

string

Name

The name that identifies the opportunity throughout the program, such as in lists or on constituent records. Character limit: 255.

status

string

Status

The status that indicates where the opportunity is in the solicitation process.

deadline

string(date-time)

Deadline

The goal date for the opportunity to result in a gift (ex: '2020-09-18T04:13:56Z').

ask_date

string(date-time)

Ask date

The date when the solicitation was made (ex: '2020-09-18T04:13:56Z').

ask_amount

Ask_amount

Ask amount

The monetary amount solicited from the prospect for the opportunity.

expected_date

string(date-time)

Expected date

The date when the prospect is expected to give in response to the opportunity (ex: '2020-09-18T04:13:56Z').

expected_amount

Expected_amount

Expected amount

The monetary amount that is realistically expected to result from the opportunity.

funded_date

string(date-time)

Funded date

The date when the prospect gave in response to the opportunity (ex: '2020-09-18T04:13:56Z').

funded_amount

Funded_amount

Funded amount

The monetary amount that the prospect gave in response to the opportunity.

campaign_id

string

Campaign ID

The system record ID of the campaign associated with the opportunity. The campaign sets the overall objectives for raising money.

fund_id

string

Fund ID

The system record ID of the fund associated with the opportunity. The fund designates the specific financial purpose of a gift and identifies the financial account for that gift.

fundraisers

array of (OpportunityApi.Fundraiser)

Fundraiser(s)

The set of system record IDs for the fundraisers assigned to the opportunity.

inactive

boolean

Inactive?

Is the opportunity inactive?

 

Ask_amount

Summary: Ask amount

Description: The monetary amount solicited from the prospect for the opportunity.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 

Expected_amount

Summary: Expected amount

Description: The monetary amount that is realistically expected to result from the opportunity.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 

Funded_amount

Summary: Funded amount

Description: The monetary amount that the prospect gave in response to the opportunity.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 


 

OpportunityApi.OpportunityAttachmentAdd

Summary:

Description: Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

 

          Properties:

Name

Type

Summary

parent_id

string

Opportunity ID

The system record ID of the opportunity associated with the attachment.

type

string

Type

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.  Values: [Link, Physical]

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment (ex: '2020-09-18T04:13:56Z'). This field defaults to the current date and time if not supplied.

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.

file_name

string

File name

The name of the file. Character limit: 36. For physical attachments only.

file_id

string

File ID

The identifier of the file. Character limit: 36. For physical attachments only.

thumbnail_id

string

Thumbnail ID

The identifier of the thumbnail. Character limit: 36. For physical attachments only.


 

OpportunityApi.OpportunityAttachmentEdit

Summary:

Description: Many cultivation activities collect related collateral, such as correspondence and prospect research. Attachments can save this data on the appropriate record to maintain a complete view of those activities.

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment (ex: '2020-09-18T04:13:56Z').

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.


 

OpportunityApi.OpportunityAttachmentRead

Summary:

Description: Attachment

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the attachment.

parent_id

string

Opportunity ID

The system record ID of the opportunity associated with the attachment.

type

string

Type

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.  Values: [Link, Physical]

name

string

Name

The name of the attachment. Character limit: 150.

date

string(date-time)

Date

The date of the attachment.

url

string

URL

The URL for the attachment. This is required for link attachments and not applicable for physical attachments.

file_name

string

File name

The name of the file. Character limit: 36. For physical attachments only.

file_id

string

File ID

The identifier of the file. Character limit: 36. For physical attachments only.

thumbnail_id

string

Thumbnail ID

The identifier of the thumbnail. Character limit: 36. For physical attachments only.

thumbnail_url

string

Thumbnail URL

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

string

Content type

The content type. For physical attachments only.

file_size

integer(int64)

File size

The file size in bytes. For physical attachments only.


 

OpportunityApi.OpportunityCustomFieldAdd

Summary:

Description: While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

 

          Properties:

Name

Type

Summary

parent_id

string

Opportunity ID

The system record ID of the opportunity associated with the custom field.

category

string

Category

The custom field category.

value

Value

 

 

date

string(date)

Date

The date on the custom field (ex: '2005-09-18').

comment

string

Comment

The comment on the custom field. Character limit: 50.

 

Value

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

OpportunityApi.OpportunityCustomFieldEdit

Summary:

Description: While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.

 

          Properties:

Name

Type

Summary

category

string

Category

The custom field category (required if updating the custom field value).

value

Value

 

 

date

string(date)

Date

The date on the custom field (ex: '2005-09-18').

comment

string

Comment

The comment on the custom field. Character limit: 50.

 

Value

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

OpportunityApi.OpportunityCustomFieldRead

Summary:

Description: Custom field

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the custom field.

parent_id

string

Opportunity ID

The system record ID of the opportunity associated with the custom field.

category

string

Category

The custom field category.

type

string

Type

The type of data that the custom field represents.  Values: [Text, Number, Date, Currency, Boolean, CodeTableEntry, ConstituentId, FuzzyDate]

value

Value

Value

The value of the custom field.

date

string(date)

Date

The date on the custom field.

comment

string

Comment

The comment on the custom field. Character limit: 50.

date_added

string(date-time)

Date added

The date when the custom field was created.

date_modified

string(date-time)

Date modified

The date when the custom field was last modified.

 

Value

Summary: Value

Description: The value of the custom field.

 

          Properties:

Name

Type

Summary

 


 

OpportunityApi.OpportunityEdit

Summary:

Description: Opportunities help you plan and track efforts to build relationships with prospects and secure major gifts. They can manage information about fundraising activities and the effectiveness of your efforts.

 

          Properties:

Name

Type

Summary

purpose

string

Purpose

The intended use for any money raised as a result of the opportunity.

name

string

Name

The name that identifies the opportunity throughout the program, such as in lists or on constituent records. Character limit: 255.

status

string

Status

The status that indicates where the opportunity is in the solicitation process.

deadline

string(date-time)

Deadline

The goal date for the opportunity to result in a gift (ex: '2020-09-18T04:13:56Z').

ask_date

string(date-time)

Ask date

The date when the solicitation was made (ex: '2020-09-18T04:13:56Z').

ask_amount

Ask_amount

Ask amount

The monetary amount solicited from the prospect for the opportunity.

expected_date

string(date-time)

Expected date

The date when the prospect is expected to give in response to the opportunity (ex: '2020-09-18T04:13:56Z').

expected_amount

Expected_amount

Expected amount

The monetary amount that is realistically expected to result from the opportunity.

funded_date

string(date-time)

Funded date

The date when the prospect gave in response to the opportunity (ex: '2020-09-18T04:13:56Z').

funded_amount

Funded_amount

Funded amount

The monetary amount that the prospect gave in response to the opportunity.

campaign_id

string

Campaign ID

The system record ID of the campaign associated with the opportunity. The campaign sets the overall objectives for raising money.

fund_id

string

Fund ID

The system record ID of the fund associated with the opportunity. The fund designates the specific financial purpose of a gift and identifies the financial account for that gift.

fundraisers

array of (OpportunityApi.Fundraiser)

Fundraiser(s)

The set of system record IDs for the fundraisers assigned to the opportunity.

inactive

boolean

Inactive?

Is the opportunity inactive?

 

Ask_amount

Summary: Ask amount

Description: The monetary amount solicited from the prospect for the opportunity.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 

Expected_amount

Summary: Expected amount

Description: The monetary amount that is realistically expected to result from the opportunity.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 

Funded_amount

Summary: Funded amount

Description: The monetary amount that the prospect gave in response to the opportunity.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 


 

OpportunityApi.OpportunityRead

Summary:

Description: Opportunity

 

          Properties:

Name

Type

Summary

id

string

ID

The system record ID of the opportunity.

constituent_id

string

Constituent ID

The system record ID of the constituent associated with the opportunity.

purpose

string

Purpose

The intended use for any money raised as a result of the opportunity.

name

string

Name

The name that identifies the opportunity throughout the program, such as in lists or on constituent records. Character limit: 255.

status

string

Status

The status that indicates where the opportunity is in the solicitation process.

deadline

string(date-time)

Deadline

The goal date for the opportunity to result in a gift.

ask_date

string(date-time)

Ask date

The date when the solicitation was made.

ask_amount

Ask_amount

Ask amount

The monetary amount solicited from the prospect for the opportunity.

expected_date

string(date-time)

Expected date

The date when the prospect is expected to give in response to the opportunity.

expected_amount

Expected_amount

Expected amount

The monetary amount that is realistically expected to result from the opportunity.

funded_date

string(date-time)

Funded date

The date when the prospect gave in response to the opportunity.

funded_amount

Funded_amount

Funded amount

The monetary amount that the prospect gave in response to the opportunity.

campaign_id

string

Campaign ID

The system record ID of the campaign associated with the opportunity. The campaign sets the overall objectives for raising money.

fund_id

string

Fund ID

The system record ID of the fund associated with the opportunity. The fund designates the specific financial purpose of a gift and identifies the financial account for that gift.

fundraisers

array of (OpportunityApi.Fundraiser)

Fundraiser(s)

The set of system record IDs for the fundraisers assigned to the opportunity.

inactive

boolean

Inactive?

Is the opportunity inactive?

linked_gifts

array of (string)

 

The system record IDs of the gifts related to the opportunity.

date_added

string(date-time)

Date added

The date when the opportunity was created.

date_modified

string(date-time)

Date modified

The date when the opportunity was last modified.

 

Ask_amount

Summary: Ask amount

Description: The monetary amount solicited from the prospect for the opportunity.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 

Expected_amount

Summary: Expected amount

Description: The monetary amount that is realistically expected to result from the opportunity.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 

Funded_amount

Summary: Funded amount

Description: The monetary amount that the prospect gave in response to the opportunity.

 

          Properties:

Name

Type

Summary

value

number(double)

value

The monetary value.

 


 

PowerAutomateUIApi.DynamicProperties

Summary:

Description: Defines some (but potentially not all) dynamic OpenApi metadata properties needed for a custom field.

 

          Properties:

Name

Type

Summary

items

Items

 

The OpenApi properties for the custom field value.

 

Items

Summary:

Description: The OpenApi properties for the custom field value.

 

          Properties:

Name

Type

Summary

type

string

 

The OpenApi type.

format

string

 

The OpenApi format.

description

string

 

The OpenApi description.

 


 

PowerAutomateUIApi.DynamicValue

Summary:

Description: A single dynamic value item

 

          Properties:

Name

Type

Summary

id

string

 

The dynamic value item identifier.

item

string

 

The dynamic value item.


 

PowerAutomateUIApi.DynamicValuesCollection

Summary:

Description: A collection of objects for use with dynamic values.

 

          Properties:

Name

Type

Summary

count

integer(int32)

 

The number of items in the list.

value

array of (PowerAutomateUIApi.DynamicValue)

 

The set of objects for use with dynamic values.