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