Bloomerang
App · 25 actions
Manage constituents and notes, and read fundraising campaigns, funds, gifts and interactions.
Actions
| Action | What it does |
|---|---|
| Create constituent | Create constituent. |
| Create note | Create note. |
| Delete constituent | Delete constituent. |
| Delete note | Delete note. |
| Get appeal | Get appeal. |
| Get campaign | Get campaign. |
| Get constituent | Get constituent. |
| Get current user | Get current user. |
| Get fund | Get fund. |
| Get household | Get household. |
| Get interaction | Get interaction. |
| Get note | Get note. |
| Get organization | Get organization. |
| Get transaction | Get transaction. |
| List appeals | List appeals. |
| List campaigns | List campaigns. |
| List constituents | List constituents. |
| List funds | List funds. |
| List households | List households. |
| List interactions | List interactions. |
| List notes | List notes. |
| List transactions | List transactions. |
| Search constituents | Search constituents. |
| Update constituent | Update constituent. |
| Update note | Update note. |
Create constituent
Create constituent.
Inputs
- Type
typetextRequired - Type.One of:
Individual,Organization. - Status
statustext - Status.One of:
Active,Inactive,Deceased. - First name
first_nametext - FirstName.
- Last name
last_nametext - LastName.
- Middle name
middle_nametext - MiddleName.
- Prefix
prefixtext - Must match a prefix in the Bloomerang CRM
- Suffix
suffixtext - Must match a suffix in the Bloomerang CRM
- Full name
full_nametext - FullName.
- Informal name
informal_nametext - InformalName.
- Formal name
formal_nametext - FormalName.
- Envelope name
envelope_nametext - EnvelopeName.
- Recognition name
recognition_nametext - RecognitionName.
- Job title
job_titletext - JobTitle.
- Employer
employertext - Employer.
- Website
websitetext - Website.
- Facebook ID
facebook_idtext - FacebookId.
- Twitter ID
twitter_idtext - TwitterId.
- Linked in ID
linked_in_idtext - LinkedInId.
- Gender
gendertext - Gender.One of:
Male,Female,Other. - Birthdate
birthdatedate - Birthdate.
- Profile picture type
profile_picture_typetext - ProfilePictureType.One of:
None,Custom,Twitter. - Primary address
primary_addressobject - Additional structured primary address. Use the documented fields.
- Secondary addresses
secondary_addresseslist - Non-primary addresses
- Primary email
primary_emailobject - Additional structured primary email. Use the documented fields.
- Secondary emails
secondary_emailslist - Non-primary email addresses
- Primary phone
primary_phoneobject - Additional structured primary phone. Use the documented fields.
- Secondary phones
secondary_phoneslist - Non-primary phones
- Full custom profile image
full_custom_profile_imagetext - The full picture File Attachment. Note that a Constituent can only have one Profile Picture; adding a new one will remove the old one.
- Cropped custom profile image
cropped_custom_profile_imagetext - The cropped picture File Attachment. Note that a Constituent can only have one Profile Picture; adding a new one will remove the old one.
- Custom values
custom_valueslist - CustomValues.
- Household ID
household_idnumber - The ID of the household this constituent is in (not to be confused with AccountNumber)
- Preferred communication channel
preferred_communication_channeltext - PreferredCommunicationChannel.One of:
Email,Phone,TextMessage,Mail. - Communication restrictions
communication_restrictionslist - CommunicationRestrictions.One or more of:
DoNotCall,DoNotMail,DoNotSolicit. - Email interest type
email_interest_typetext - EmailInterestType.One of:
All,Custom,OptedOut. - Custom email interest IDs
custom_email_interest_idslist - IDs for custom email interests if the email interest type is Custom
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"AccountNumber": 1,
"AddressIds": [],
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"Birthdate": "example",
"CommunicationRestrictions": [],
"CommunicationRestrictionsUpdateReason": "example",
"CroppedCustomProfileImageId": 1,
"CroppedCustomProfileImageUrl": "example",
"CustomEmailInterests": [],
"CustomValues": [],
"DonorSearchInfo": {
"AnnualFundLikelihood": "Low",
"BusinessExecutive": true,
"BusinessRevenues": 1,
"DateTimeScreenedUtc": "example",
"DemocraticContributionCount": 1,
"Foundations": "example",
"GenerosityScore": "Low",
"GenerosityScoreLabel": "example",
"Id": 1,
"IndependentContributionCount": 1,
"LargestGiftMax": 1,
"LargestGiftMin": 1,
"LargestGiftOrg": "example",
"MajorGiftLikelihood": "Low",
"NamesScreened": "example",
"Quality": "Low",
"RealEstateCount": 1,
"RepublicanContributionCount": 1,
"TotalGiftAmount": 1,
"WealthAskMax": 1,
"WealthAskMin": 1
},
"EmailIds": [],
"EmailInterestType": "All",
"EmailInterestsUpdateReason": "example",
"Employer": "example",
"EngagementScore": "Low",
"EngagementScoreLabel": "example",
"EnvelopeName": "example",
"FacebookId": "example",
"FirstName": "example",
"FormalName": "example",
"FullCustomProfileImageId": 1,
"FullCustomProfileImageUrl": "example",
"FullName": "example",
"Gender": "Male",
"HouseholdId": 1,
"Id": 1,
"InformalName": "example",
"IsFavorite": true,
"IsHeadOfHousehold": true,
"IsInHousehold": true,
"JobTitle": "example",
"LastName": "example",
"LinkedInId": "example",
"MiddleName": "example",
"PhoneIds": [],
"PreferredCommunicationChannel": "Email",
"Prefix": "example",
"PrimaryAddress": {
"AccountId": 1,
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"City": "example",
"Country": "example",
"CountryCode": "example",
"Id": 1,
"IsBad": true,
"IsPrimary": true,
"PostalCode": "example",
"State": "example",
"StateAbbreviation": "example",
"Street": "example",
"Type": "Home"
},
"PrimaryEmail": {
"AccountId": 1,
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"Id": 1,
"IsBad": true,
"IsPrimary": true,
"Type": "Home",
"Value": "example"
},
"PrimaryPhone": {
"AccountId": 1,
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"Extension": "example",
"Id": 1,
"IsPrimary": true,
"Number": "example",
"Type": "Home"
},
"ProfilePictureType": "None",
"RecognitionName": "example",
"Status": "Active",
"Suffix": "example",
"TwitterId": "example",
"Type": "Individual",
"Website": "example"
},
"has_more": false,
"next_cursor": null
}Create note
Create note.
Inputs
- Account ID
account_idnumberRequired - The ID of the constituent used in the API (not to be confused with accountNumber)
- Date
datedateRequired - Date.
- Note
notetextRequired - Note.
- Custom values
custom_valueslist - CustomValues.
- Attachments
attachmentslist - Attachments.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"AccountId": 1,
"AttachmentIds": [],
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"CustomValues": [],
"Date": "example",
"Id": 1,
"Note": "example"
},
"has_more": false,
"next_cursor": null
}Delete constituent
Delete constituent.
Inputs
- Id
idnumberRequired - The ID of the constituent to return.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"Deleted": true,
"Id": 1,
"Type": "example"
},
"has_more": false,
"next_cursor": null
}Delete note
Delete note.
Inputs
- Id
idnumberRequired - The ID of the note to return.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"Deleted": true,
"Id": 1,
"Type": "example"
},
"has_more": false,
"next_cursor": null
}Get appeal
Get appeal. Returns the full service response for the connected account.
Inputs
- Id
idnumberRequired - The ID of the appeal to return.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"Id": 1,
"IsActive": true,
"Name": "example",
"SortIndex": 1
},
"has_more": false,
"next_cursor": null
}Get campaign
Get campaign. Returns the full service response for the connected account.
Inputs
- Id
idnumberRequired - The ID of the campaign to return.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"EndDate": "example",
"Goal": 1,
"Id": 1,
"IsActive": true,
"Name": "example",
"Raised": 1,
"RaisedCalculationMode": "Legacy",
"SortIndex": 1,
"StartDate": "example"
},
"has_more": false,
"next_cursor": null
}Get constituent
Get constituent. Returns the full service response for the connected account.
Inputs
- Id
idnumberRequired - The ID of the constituent to return.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"AccountNumber": 1,
"AddressIds": [],
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"Birthdate": "example",
"CommunicationRestrictions": [],
"CommunicationRestrictionsUpdateReason": "example",
"CroppedCustomProfileImageId": 1,
"CroppedCustomProfileImageUrl": "example",
"CustomEmailInterests": [],
"CustomValues": [],
"DonorSearchInfo": {
"AnnualFundLikelihood": "Low",
"BusinessExecutive": true,
"BusinessRevenues": 1,
"DateTimeScreenedUtc": "example",
"DemocraticContributionCount": 1,
"Foundations": "example",
"GenerosityScore": "Low",
"GenerosityScoreLabel": "example",
"Id": 1,
"IndependentContributionCount": 1,
"LargestGiftMax": 1,
"LargestGiftMin": 1,
"LargestGiftOrg": "example",
"MajorGiftLikelihood": "Low",
"NamesScreened": "example",
"Quality": "Low",
"RealEstateCount": 1,
"RepublicanContributionCount": 1,
"TotalGiftAmount": 1,
"WealthAskMax": 1,
"WealthAskMin": 1
},
"EmailIds": [],
"EmailInterestType": "All",
"EmailInterestsUpdateReason": "example",
"Employer": "example",
"EngagementScore": "Low",
"EngagementScoreLabel": "example",
"EnvelopeName": "example",
"FacebookId": "example",
"FirstName": "example",
"FormalName": "example",
"FullCustomProfileImageId": 1,
"FullCustomProfileImageUrl": "example",
"FullName": "example",
"Gender": "Male",
"HouseholdId": 1,
"Id": 1,
"InformalName": "example",
"IsFavorite": true,
"IsHeadOfHousehold": true,
"IsInHousehold": true,
"JobTitle": "example",
"LastName": "example",
"LinkedInId": "example",
"Membership": [],
"MiddleName": "example",
"PhoneIds": [],
"PreferredCommunicationChannel": "Email",
"Prefix": "example",
"PrimaryAddress": {
"AccountId": 1,
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"City": "example",
"Country": "example",
"CountryCode": "example",
"Id": 1,
"IsBad": true,
"IsPrimary": true,
"PostalCode": "example",
"State": "example",
"StateAbbreviation": "example",
"Street": "example",
"Type": "Home"
},
"PrimaryEmail": {
"AccountId": 1,
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"Id": 1,
"IsBad": true,
"IsPrimary": true,
"Type": "Home",
"Value": "example"
},
"PrimaryPhone": {
"AccountId": 1,
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"Extension": "example",
"Id": 1,
"IsPrimary": true,
"Number": "example",
"Type": "Home"
},
"ProfilePictureType": "None",
"RecognitionName": "example",
"Status": "Active",
"Suffix": "example",
"TwitterId": "example",
"Type": "Individual",
"Website": "example"
},
"has_more": false,
"next_cursor": null
}Get current user
Get current user. Returns the full service response for the connected account.
Inputs
None.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"BccEmail": "example",
"Email": "example",
"Id": 1,
"IsActive": true,
"Name": "example",
"PendingEmail": "example",
"PermissionLevel": "Admin",
"Phone": "example",
"SendTaskEmails": true,
"UserName": "example",
"UserTimeZone": {
"Id": "example",
"Name": "example",
"UtcOffset": "example"
}
},
"has_more": false,
"next_cursor": null
}Get fund
Get fund. Returns the full service response for the connected account.
Inputs
- Id
idnumberRequired - The ID of the fund to return.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"DefaultQuickbooksAccountId": 1,
"GeneralLedgerClass": "example",
"Id": 1,
"IsActive": true,
"IsDefault": true,
"Name": "example",
"QuickbooksAccountIds": [],
"SortIndex": 1
},
"has_more": false,
"next_cursor": null
}Get household
Get household. Returns the full service response for the connected account.
Inputs
- Id
idnumberRequired - The ID of the household.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"AccountNumber": 1,
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"CommunicationRestrictions": [],
"EngagementScore": "Low",
"EnvelopeName": "example",
"FormalName": "example",
"FullName": "example",
"HeadId": 1,
"Id": 1,
"InformalName": "example",
"IsFavorite": true,
"MemberIds": [],
"RecognitionName": "example",
"SortName": "example",
"Status": "Active",
"Type": "Household"
},
"has_more": false,
"next_cursor": null
}Get interaction
Get interaction. Returns the full service response for the connected account.
Inputs
- Id
idnumberRequired - The ID of the interaction to return.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"AccountId": 1,
"AttachmentIds": [],
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"Channel": "Email",
"CustomValues": [],
"Date": "example",
"EmailAddress": "example",
"Id": 1,
"IsBcc": true,
"IsEngagementSurveyEmail": true,
"IsEngagementSurveyResponse": true,
"IsInbound": true,
"LetterAttachmentIds": [],
"Note": "example",
"Purpose": "Acknowledgement",
"Subject": "example",
"SurveyEmailInteractionId": 1,
"SurveyLapsedResponses": [],
"SurveyResponseInteractionId": 1,
"TweetId": "example"
},
"has_more": false,
"next_cursor": null
}Get note
Get note. Returns the full service response for the connected account.
Inputs
- Id
idnumberRequired - The ID of the note to return.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"AccountId": 1,
"AttachmentIds": [],
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"CustomValues": [],
"Date": "example",
"Id": 1,
"Note": "example"
},
"has_more": false,
"next_cursor": null
}Get organization
Get organization. Returns the full service response for the connected account.
Inputs
None.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"AccountingIntegration": "Aplos",
"BaseLicenseProvider": "Bloomerang",
"CurrentFiscalYearStartDate": "example",
"Flavor": "Customer",
"Id": "example",
"Name": "example"
},
"has_more": false,
"next_cursor": null
}Get transaction
Get transaction. Returns the full service response for the connected account.
Inputs
- Id
idnumberRequired - The ID of the transaction.
Outputs
dataobject- The transaction record returned by the API.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"AccountId": 1,
"Amount": 1,
"AttachmentIds": [],
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"CheckDate": "example",
"CheckNumber": "example",
"CreditCardExpMonth": 1,
"CreditCardExpYear": 1,
"CreditCardLastFourDigits": "example",
"CreditCardType": "Visa",
"Date": "example",
"Designations": [],
"EftAccountType": "Checking",
"EftLastFourDigits": "example",
"EftRoutingNumber": "example",
"FeeAmount": 1,
"Id": 1,
"InKindDescription": "example",
"InKindMarketValue": 1,
"InKindType": "Goods",
"IntegrationUrl": "example",
"IsRefunded": "Yes",
"Method": "None",
"NonDeductibleAmount": 1,
"RefundIds": [],
"TransactionNumber": 1
},
"has_more": false,
"next_cursor": null
}List appeals
List appeals. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Skip
skipnumber - The number of items to skip before starting to collect the result set.At least 0.
- Take
takenumber - The number of items to include in the result set.From 1 to 50.
- Last modified
last_modifieddate and time - Filters to appeals last modified after the specified date
- Id
idlist - Filters to appeals with the IDs in the list (pipe-separated)
- Is active
is_activetrue/false - Filters to either active or inactive appeals
- Search
searchtext - Filters to appeals with names that match any part of the search string
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"ResultCount": 1,
"Results": [],
"Start": 1,
"Total": 1,
"TotalFiltered": 1
},
"has_more": false,
"next_cursor": null
}List campaigns
List campaigns. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Skip
skipnumber - The number of items to skip before starting to collect the result set.At least 0.
- Take
takenumber - The number of items to include in the result set.From 1 to 50.
- Last modified
last_modifieddate and time - Filters to campaigns last modified after the specified date
- Id
idlist - Filters to campaigns with the IDs in the list (pipe-separated)
- Is active
is_activetrue/false - Filters to either active or inactive campaigns
- Search
searchtext - Filters to campaigns with names that match any part of the search string
- Has goal
has_goaltrue/false - Filters to campaigns that have either non-zero-dollar or zero-dollar goals
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"ResultCount": 1,
"Results": [],
"Start": 1,
"Total": 1,
"TotalFiltered": 1
},
"has_more": false,
"next_cursor": null
}List constituents
List constituents. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Skip
skipnumber - The number of items to skip before starting to collect the result set.At least 0.
- Take
takenumber - The number of items to include in the result set.From 1 to 50.
- Last modified
last_modifieddate and time - Filters to constituents last modified after the specified date
- Is favorite
is_favoritetrue/false - Filters constituents to only constituents the user has favorited.
- Type
typetext - Filters individuals and organizationsOne of:
Individual,Organization. - Id
idlist - Filters results based on the ID for the constituent.
- Order by
order_bytext - Sorts by Id, CreatedDate, or LastModifiedDate (default Id).One of:
Id,CreatedDate,LastModifiedDate. - Order direction
order_directiontext - Sorts the orderBy in ascending or descending order.One of:
Asc,Desc. - Custom field ID
custom_field_idnumber - The custom field ID to filter by
- Custom field value
custom_field_valuetext - The custom field value to filter by
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"ResultCount": 1,
"Results": [],
"Start": 1,
"Total": 1,
"TotalFiltered": 1
},
"has_more": false,
"next_cursor": null
}List funds
List funds. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Skip
skipnumber - The number of items to skip before starting to collect the result set.At least 0.
- Take
takenumber - The number of items to include in the result set.From 1 to 50.
- Id
idlist - Filters to funds with the IDs in the list (pipe-separated)
- Is active
is_activetrue/false - Filters to either active or inactive funds
- Is default
is_defaulttrue/false - Filters to either default or non-default funds
- Search
searchtext - Filters to funds with names that match any part of the search string
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"ResultCount": 1,
"Results": [],
"Start": 1,
"Total": 1,
"TotalFiltered": 1
},
"has_more": false,
"next_cursor": null
}List households
List households. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Skip
skipnumber - The number of items to skip before starting to collect the result set.At least 0.
- Take
takenumber - The number of items to include in the result set.From 1 to 50.
- Last modified
last_modifieddate and time - Filters to households last modified after the specified date
- Id
idlist - Filters results based on the ID for the household.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"ResultCount": 1,
"Results": [],
"Start": 1,
"Total": 1,
"TotalFiltered": 1
},
"has_more": false,
"next_cursor": null
}List interactions
List interactions. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Skip
skipnumber - The number of items to skip before starting to collect the result set.At least 0.
- Take
takenumber - The number of items to include in the result set.From 1 to 50.
- Channel
channellist - Filters results based on the interaction's channel.One or more of:
Email,MassEmail,Phone,TextMessage,Mail,InPerson,SocialMedia,Website,Twitter,Other,EngagementSurveyEmail,EngagementSurvey. - Purpose
purposelist - Filters results based on the interaction's purpose.One or more of:
Acknowledgement,ImpactCultivation,Newsletter,Receipt,Solicitation,SpecialEvent,VolunteerActivity,PledgeReminder,Welcome,BenevonPointOfEntry, and 5 more. - Constituent
constituentlist - Filters results based on the Constituent ID for the interaction.
- Id
idlist - Filters results based on the ID for the interaction.
- Order by
order_bytext - Sorts by Date, CreatedDate, or LastModifiedDate (default Date).One of:
CreatedDate,Date,LastModifiedDate. - Order direction
order_directiontext - Sorts the orderBy in ascending or descending order.One of:
Asc,Desc.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"ResultCount": 1,
"Results": [],
"Start": 1,
"Total": 1,
"TotalFiltered": 1
},
"has_more": false,
"next_cursor": null
}List notes
List notes. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Skip
skipnumber - The number of items to skip before starting to collect the result set.At least 0.
- Take
takenumber - The number of items to include in the result set.From 1 to 50.
- Constituent
constituentlist - Filters results based on the Constituent ID for the note.
- Id
idlist - Filters results based on the ID for the note.
- Order by
order_bytext - Sorts by Date, CreatedDate, or LastModifiedDate (default Date).One of:
CreatedDate,Date,LastModifiedDate. - Order direction
order_directiontext - Sorts the orderBy in ascending or descending order.One of:
Asc,Desc.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"ResultCount": 1,
"Results": [],
"Start": 1,
"Total": 1,
"TotalFiltered": 1
},
"has_more": false,
"next_cursor": null
}List transactions
List transactions. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Skip
skipnumber - The number of items to skip before starting to collect the result set.At least 0.
- Take
takenumber - The number of items to include in the result set.From 1 to 50.
- Last modified
last_modifieddate and time - Filters to transactions last modified after the specified date
- Transaction number
transaction_numberlist - Filters results based on the transaction's transactionNumber (called Payment Number in Bloomerang CRM Reporting).
- Account ID
account_idlist - Filters results based on the account ID for the transaction.
- Id
idlist - Filters results based on the transaction's ID.
- Type
typelist - Filters the results based on if the transaction has at least one of the given designation typesOne or more of:
Donation,Pledge,PledgePayment,RecurringDonation,RecurringDonationPayment. - Min amount
min_amountnumber - Filters results based on the transaction's amount (inclusive).
- Max amount
max_amountnumber - Filters results based on the transaction's amount (inclusive).
- Order by
order_bytext - Sorts by Amount, Date, CreatedDate, or LastModifiedDate (default Date).One of:
Amount,CreatedDate,Date,LastModifiedDate. - Order direction
order_directiontext - Sorts the orderBy in ascending or descending order (default descending).One of:
Asc,Desc. - Custom field ID
custom_field_idnumber - The custom field ID to filter by
- Custom field value
custom_field_valuetext - The custom field value to filter by
Outputs
dataobject- Transactions matching the query, including paging totals and every returned record.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"ResultCount": 1,
"Results": [],
"Start": 1,
"Total": 1,
"TotalFiltered": 1
},
"has_more": false,
"next_cursor": null
}Search constituents
Search constituents. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Skip
skipnumber - The number of items to skip before starting to collect the result set.At least 0.
- Take
takenumber - The number of items to include in the result set.From 1 to 50.
- Search
searchtext - The text to search
- Type
typetext - Filters individuals, organizations, and householdsOne of:
Individual,Organization,Household.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"ResultCount": 1,
"Results": [],
"Start": 1,
"Total": 1,
"TotalFiltered": 1
},
"has_more": false,
"next_cursor": null
}Update constituent
Update constituent. Empty fields keep their current values.
Inputs
- Id
idnumberRequired - The ID of the constituent to return.
- Type
typetext - Type.One of:
Individual,Organization. - Status
statustext - Status.One of:
Active,Inactive,Deceased. - First name
first_nametext - FirstName.
- Last name
last_nametext - LastName.
- Middle name
middle_nametext - MiddleName.
- Prefix
prefixtext - Must match a prefix in the Bloomerang CRM
- Suffix
suffixtext - Must match a suffix in the Bloomerang CRM
- Full name
full_nametext - FullName.
- Informal name
informal_nametext - InformalName.
- Formal name
formal_nametext - FormalName.
- Envelope name
envelope_nametext - EnvelopeName.
- Recognition name
recognition_nametext - RecognitionName.
- Job title
job_titletext - JobTitle.
- Employer
employertext - Employer.
- Website
websitetext - Website.
- Facebook ID
facebook_idtext - FacebookId.
- Twitter ID
twitter_idtext - TwitterId.
- Linked in ID
linked_in_idtext - LinkedInId.
- Gender
gendertext - Gender.One of:
Male,Female,Other. - Birthdate
birthdatedate - Birthdate.
- Profile picture type
profile_picture_typetext - ProfilePictureType.One of:
None,Custom,Twitter. - Primary address
primary_addressobject - Additional structured primary address. Use the documented fields.
- Secondary addresses
secondary_addresseslist - Non-primary addresses
- Primary email
primary_emailobject - Additional structured primary email. Use the documented fields.
- Secondary emails
secondary_emailslist - Non-primary email addresses
- Primary phone
primary_phoneobject - Additional structured primary phone. Use the documented fields.
- Secondary phones
secondary_phoneslist - Non-primary phones
- Full custom profile image
full_custom_profile_imagetext - The full picture File Attachment. Note that a Constituent can only have one Profile Picture; adding a new one will remove the old one.
- Cropped custom profile image
cropped_custom_profile_imagetext - The cropped picture File Attachment. Note that a Constituent can only have one Profile Picture; adding a new one will remove the old one.
- Custom values
custom_valueslist - CustomValues.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"AccountNumber": 1,
"AddressIds": [],
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"Birthdate": "example",
"CommunicationRestrictions": [],
"CommunicationRestrictionsUpdateReason": "example",
"CroppedCustomProfileImageId": 1,
"CroppedCustomProfileImageUrl": "example",
"CustomEmailInterests": [],
"CustomValues": [],
"DonorSearchInfo": {
"AnnualFundLikelihood": "Low",
"BusinessExecutive": true,
"BusinessRevenues": 1,
"DateTimeScreenedUtc": "example",
"DemocraticContributionCount": 1,
"Foundations": "example",
"GenerosityScore": "Low",
"GenerosityScoreLabel": "example",
"Id": 1,
"IndependentContributionCount": 1,
"LargestGiftMax": 1,
"LargestGiftMin": 1,
"LargestGiftOrg": "example",
"MajorGiftLikelihood": "Low",
"NamesScreened": "example",
"Quality": "Low",
"RealEstateCount": 1,
"RepublicanContributionCount": 1,
"TotalGiftAmount": 1,
"WealthAskMax": 1,
"WealthAskMin": 1
},
"EmailIds": [],
"EmailInterestType": "All",
"EmailInterestsUpdateReason": "example",
"Employer": "example",
"EngagementScore": "Low",
"EngagementScoreLabel": "example",
"EnvelopeName": "example",
"FacebookId": "example",
"FirstName": "example",
"FormalName": "example",
"FullCustomProfileImageId": 1,
"FullCustomProfileImageUrl": "example",
"FullName": "example",
"Gender": "Male",
"HouseholdId": 1,
"Id": 1,
"InformalName": "example",
"IsFavorite": true,
"IsHeadOfHousehold": true,
"IsInHousehold": true,
"JobTitle": "example",
"LastName": "example",
"LinkedInId": "example",
"MiddleName": "example",
"PhoneIds": [],
"PreferredCommunicationChannel": "Email",
"Prefix": "example",
"PrimaryAddress": {
"AccountId": 1,
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"City": "example",
"Country": "example",
"CountryCode": "example",
"Id": 1,
"IsBad": true,
"IsPrimary": true,
"PostalCode": "example",
"State": "example",
"StateAbbreviation": "example",
"Street": "example",
"Type": "Home"
},
"PrimaryEmail": {
"AccountId": 1,
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"Id": 1,
"IsBad": true,
"IsPrimary": true,
"Type": "Home",
"Value": "example"
},
"PrimaryPhone": {
"AccountId": 1,
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"Extension": "example",
"Id": 1,
"IsPrimary": true,
"Number": "example",
"Type": "Home"
},
"ProfilePictureType": "None",
"RecognitionName": "example",
"Status": "Active",
"Suffix": "example",
"TwitterId": "example",
"Type": "Individual",
"Website": "example"
},
"has_more": false,
"next_cursor": null
}Update note
Update note. Empty fields keep their current values.
Inputs
- Id
idnumberRequired - The ID of the note to return.
- Account ID
account_idnumber - The ID of the constituent used in the API (not to be confused with accountNumber)
- Date
datedate - Date.
- Note
notetext - Note.
- Custom values
custom_valueslist - CustomValues.
- Attachments
attachmentslist - Attachments.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"AccountId": 1,
"AttachmentIds": [],
"AuditTrail": {
"CreatedDate": "example",
"CreatedName": "example",
"LastModifiedDate": "example",
"LastModifiedName": "example"
},
"CustomValues": [],
"Date": "example",
"Id": 1,
"Note": "example"
},
"has_more": false,
"next_cursor": null
}