Actions

104 actions

Action

Description

List Constituents

Retrieves a paginated list of all constituents (donors, contacts, and organizations) from the Bloomerang CRM database vi...

Get Constituent

Retrieves a single constituent record by its unique numeric ID via GET /constituent/\{id}, returning the complete donor o...

Create Constituent (Merge)

Creates a new constituent or merges data into an existing duplicate record via POST /constituent/merge, using intelligen...

Update Constituent

Updates an existing constituent record by ID via PUT /constituent/\{id}, applying partial updates where only provided fie...

Delete Constituent

Permanently deletes a constituent record by ID via DELETE /constituent/\{id}, removing the donor or organization and all...

Search Constituents

Performs a text search across constituents and households via GET /constituents/search, matching against names and retur...

Get Constituent Relationships

Retrieves all relationships for a specific constituent via GET /constituent/\{id}/relationships, showing family, professi...

Get Constituent Timeline

Retrieves a chronological timeline of all activity for a constituent (or all household members if a Household ID is prov...

Find Duplicate Constituents

Searches for possible duplicate constituent records via POST /constituent/duplicates, requiring a name match plus at lea...

Update Constituent Communication Settings

Updates communication preferences and restrictions for a constituent via PUT /constituent/\{id}/updateCommunicationSettin...

List Transactions

Retrieves a paginated list of all donation transactions from the Bloomerang CRM via GET /transactions, with filters for...

Get Transaction

Retrieves a single transaction record by its unique numeric ID via GET /transaction/\{id}, returning the complete donatio...

Create Transaction

Creates a new donation transaction for a constituent via POST /transaction, recording the gift in the CRM database witho...

Update Transaction

Updates an existing transaction record by ID via PUT /transaction/\{id}, applying partial updates to donation details suc...

Delete Transaction

Permanently deletes a transaction record by ID via DELETE /transaction/\{id}, removing the donation and all associated de...

List Designations

Retrieves a paginated list of transaction designations via GET /transactions/designations, showing how donations are all...

Get Designation

Retrieves a single designation record by its unique numeric ID via GET /transactions/designation/\{id}, returning the com...

List Interactions

Retrieves a paginated list of donor interactions (touchpoints) from the Bloomerang CRM via GET /interactions, tracking a...

Get Interaction

Retrieves a single interaction record by its unique numeric ID via GET /interaction/\{id}, returning the complete communi...

Create Interaction

Creates a new interaction (communication touchpoint) for a constituent via POST /interaction, logging a donor engagement...

Update Interaction

Updates an existing interaction record by ID via PUT /interaction/\{id}, applying partial updates to communication detail...

Delete Interaction

Permanently deletes an interaction record by ID via DELETE /interaction/\{id}, removing the communication touchpoint from...

List Tasks

Retrieves a paginated list of tasks (scheduled follow-up actions) from the Bloomerang CRM via GET /tasks, with filters f...

Get Task

Retrieves a single task record by its unique numeric ID via GET /task/\{id}, returning the complete scheduled action deta...

Create Task

Creates a new task (scheduled follow-up action) via POST /task, assigning a stewardship activity to a user with a due da...

Update Task

Updates an existing task record by ID via PUT /task/\{id}, applying partial updates to scheduled action details such as d...

Delete Task

Permanently deletes a task record by ID via DELETE /task/\{id}, removing the scheduled follow-up action from the CRM.

Complete Task

Marks a task as completed via PUT /task/\{id}/complete, with an option to automatically create a corresponding interactio...

List Campaigns

Retrieves a paginated list of fundraising campaigns from the Bloomerang CRM via GET /campaigns, used to organize and tra...

Get Campaign

Retrieves a single campaign record by its unique numeric ID via GET /campaign/\{id}, returning the complete fundraising i...

Create Campaign

Creates a new fundraising campaign via POST /campaign, setting up an organizational unit for tracking donations and meas...

Update Campaign

Updates an existing campaign record by ID via PUT /campaign/\{id}, applying partial updates to campaign details such as n...

Refresh Campaign Summaries

Triggers a recalculation of all campaign goal summaries via GET /campaigns/refreshsummaries, updating progress metrics t...

List Appeals

Retrieves a paginated list of fundraising appeals from the Bloomerang CRM via GET /appeals, representing specific solici...

Get Appeal

Retrieves a single appeal record by its unique numeric ID via GET /appeal/\{id}, returning the complete solicitation meth...

Create Appeal

Creates a new fundraising appeal via POST /appeal, defining a solicitation method that can be referenced in transaction...

Update Appeal

Updates an existing appeal record by ID via PUT /appeal/\{id}, applying partial updates to the appeal name or active stat...

List Funds

Retrieves a paginated list of funds from the Bloomerang CRM via GET /funds, representing financial accounts or categorie...

Get Fund

Retrieves a single fund record by its unique numeric ID via GET /fund/\{id}, returning the complete financial account det...

Create Fund

Creates a new fund (financial account category) via POST /fund, defining a donation allocation target for use in transac...

Update Fund

Updates an existing fund record by ID via PUT /fund/\{id}, applying partial updates to fund properties such as name, acti...

Get Pledge Installments

Retrieves a paginated list of installment schedule entries for a specific pledge via GET /pledge/\{id}/installments, show\...

Generate Pledge Installments

Generates a preview installment schedule for a pledge via GET /pledge/generateInstallments without saving to the databas...

Get Pledge Payments

Retrieves a paginated list of successful payments made against a specific pledge via GET /pledge/\{id}/payments, showing...

Get Pledge Payment Failures

Retrieves a paginated list of failed payment attempts for a specific pledge via GET /pledge/\{id}/paymentFailures, showin...

Write Off Pledge

Writes off the remaining unpaid balance of a pledge via POST /pledge/\{id}/writeOff, marking the outstanding amount as un...

List Households

Retrieves a paginated list of households from the Bloomerang CRM via GET /households, representing family or organizatio...

Get Household

Retrieves a single household record by its unique numeric ID via GET /household/\{id}, returning the complete household g...

Create Household

Creates a new household grouping via POST /household, linking individual constituents into a family unit with a designat...

Update Household

Updates an existing household record by ID via PUT /household/\{id}, applying partial updates to membership, head designa...

Delete Household

Permanently deletes a household grouping by ID via DELETE /household/\{id}, removing the family unit but preserving all i...

List Notes

Retrieves a paginated list of notes from the Bloomerang CRM via GET /notes, representing free-text annotations attached...

Get Note

Retrieves a single note record by its unique numeric ID via GET /note/\{id}, returning the complete annotation including...

Create Note

Creates a new note (free-text annotation) for a constituent via POST /note, adding internal documentation to a donor's r...

Update Note

Updates an existing note record by ID via PUT /note/\{id}, applying partial updates to the content, date, or custom field...

Delete Note

Permanently deletes a note record by ID via DELETE /note/\{id}, removing the annotation from the constituent's timeline.

List Addresses

Retrieves a paginated list of physical mailing addresses from the Bloomerang CRM via GET /addresses, including primary a...

Get Address

Retrieves a single address record by its unique numeric ID via GET /addresses/\{id}, returning the complete mailing addre...

Create Address

Creates a new mailing address for a constituent via POST /address, adding a secondary address or the initial address rec...

Update Address

Updates an existing address record by ID via PUT /address/\{id}, applying partial updates to mailing address fields such...

Delete Address

Permanently deletes an address record by ID via DELETE /address/\{id}, removing the mailing address from the constituent'...

List Email Addresses

Retrieves a paginated list of email addresses from the Bloomerang CRM via GET /emails, including primary and secondary e...

Get Email Address

Retrieves a single email address record by its unique numeric ID via GET /email/\{id}, returning the complete email detai...

Create Email Address

Creates a new email address for a constituent via POST /email, adding a secondary email or the initial email record for...

Update Email Address

Updates an existing email address record by ID via PUT /email/\{id}, applying partial updates to the email type, value, o...

Delete Email Address

Permanently deletes an email address record by ID via DELETE /email/\{id}, removing the email from the constituent's cont...

List Phone Numbers

Retrieves a paginated list of phone numbers from the Bloomerang CRM via GET /phones, including primary and secondary pho...

Get Phone Number

Retrieves a single phone number record by its unique numeric ID via GET /phone/\{id}, returning the complete phone detail...

Create Phone Number

Creates a new phone number for a constituent via POST /phone, adding a secondary phone or the initial phone record for a...

Update Phone Number

Updates an existing phone number record by ID via PUT /phone/\{id}, applying partial updates to the phone type, number, e...

Delete Phone Number

Permanently deletes a phone number record by ID via DELETE /phone/\{id}, removing the phone from the constituent's contac...

List Refunds

Retrieves a paginated list of refund records from the Bloomerang CRM via GET /refunds, tracking returned or reversed don...

Get Refund

Retrieves a single refund record by its unique numeric ID via GET /refund/\{id}, returning the complete refund details in...

Create Refund

Creates a new refund record against an existing transaction via POST /refund, recording a partial or full return of a do...

Update Refund

Updates an existing refund record by ID via PUT /refund/\{id}, applying partial updates to the refund date, amount, or re...

Delete Refund

Permanently deletes a refund record by ID via DELETE /refund/\{id}, removing the refund entry and restoring the original...

Get Relationship

Retrieves a single relationship record by its unique numeric ID via GET /relationship/\{id}, returning the complete conne...

Create Relationship

Creates a new relationship between two non-household constituents via POST /relationship, defining a bidirectional conne...

Update Relationship

Updates an existing relationship record by ID via PUT /relationship/\{id}, applying partial updates to the role type, hea...

Delete Relationship

Permanently deletes a relationship record by ID via DELETE /relationship/\{id}, removing the bidirectional connection bet...

List Relationship Roles

Retrieves a paginated list of relationship role definitions from the Bloomerang CRM via GET /relationshiproles, providin...

Get Relationship Role

Retrieves a single relationship role definition by its unique numeric ID via GET /relationshiprole/\{id}, returning the r...

List Soft Credits

Retrieves a paginated list of soft credits from the Bloomerang CRM via GET /softcredits, representing donation recogniti...

Get Soft Credit

Retrieves a single soft credit record by its unique numeric ID via GET /softcredit/\{id}, returning the complete recognit...

Create Soft Credit

Creates a new soft credit via POST /softcredit, attributing donation recognition to a constituent who influenced a gift...

Update Soft Credit

Updates an existing soft credit record by ID via PUT /softcredit/\{id}, allowing modification of the recognized amount.

Delete Soft Credit

Permanently deletes a soft credit record by ID via DELETE /softcredit/\{id}, removing the donation recognition attributio...

List Tributes

Retrieves a paginated list of tributes from the Bloomerang CRM via GET /tributes, representing honorary or memorial dedi...

Get Tribute

Retrieves a single tribute record by its unique numeric ID via GET /tribute/\{id}, returning the complete honorary or mem...

Create Tribute

Creates a new tribute (honorary or memorial dedication) via POST /tribute, defining a person to be honored or memorializ...

Update Tribute

Updates an existing tribute record by ID via PUT /tribute/\{id}, applying partial updates to the tribute name, type, desc...

Search Tributes

Performs a text search across active tributes via GET /tributes/search, matching against tribute names with a minimum 3-...

List Custom Field Categories

Retrieves a list of custom field categories for a specific entity type via GET /customFieldCategories/\{type}, showing ho...

List Custom Fields

Retrieves a list of custom field definitions for a specific entity type via GET /customFields/\{type}, showing the availa...

List Custom Values

Retrieves all selectable option values for PickOne and PickMultiple custom fields of a given entity type via GET /custom...

List Custom Values By Field

Retrieves selectable option values for a specific custom field via GET /customValues/\{type}/\{fieldId}, narrowing results...

List Email Interests

Retrieves a paginated list of email interest categories from the Bloomerang CRM via GET /emailInterests, representing th...

Get Email Interest

Retrieves a single email interest category by its unique numeric ID via GET /emailInterest/\{id}, returning the subscript...

List Wallet Items

Retrieves a list of wallet items (stored payment methods) from the Bloomerang CRM via GET /walletitems, showing saved cr...

Get Wallet Item

Retrieves a single wallet item (stored payment method) by its unique numeric ID via GET /walletitem/\{id}, returning mask...

Create Wallet Item

Creates a new wallet item (stored payment method) for a constituent via POST /walletitem, securely tokenizing a credit c...

Delete Wallet Item

Permanently deletes a wallet item (stored payment method) by ID via DELETE /walletitem/\{id}, removing the saved credit c...

List Processors

Retrieves a list of payment processors configured in the Bloomerang account via GET /processors, showing the gateways th...

Get Processor

Retrieves a single payment processor by its unique numeric ID via GET /processor/\{id}, returning the complete gateway co...