> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Bloomerang

> How to set up the Bloomerang connector, plus the actions that are available.

![Bloomerang](https://stackone-logos.com/api/bloomerang/filled/svg)

Betav2.0.0[See changelog](https://docs.stackone.com/connectors/bloomerang/changelog.md)

[104 actions](#actions) · 2 auth methods

CRM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/bloomerang/guides/connector-profile/api-key.md)
>
> Uses a private API key for server-to-server access. Generate from your Bloomerang user settings as an Administrator.

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/bloomerang/guides/connector-profile/oauth-2-0.md)
>
> Delegated access on behalf of a signed-in Bloomerang user, scoped to Standard, StandardEditFinancialData, or OrgAdmin pe...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/bloomerang/guides/link-account/api-key.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/bloomerang/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

Standard

StandardEditFinancialData

No scopes found

104 actions

ActionDescriptionRequired scopes

List Constituents`bloomerang_list_constituents`

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

`Standard`

Get Constituent`bloomerang_get_constituent`

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

`Standard`

Create Constituent (Merge)`bloomerang_create_constituent`

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

`Standard`

Update Constituent`bloomerang_update_constituent`

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

`Standard`

Delete Constituent`bloomerang_delete_constituent`

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

`Standard`

Search Constituents`bloomerang_search_constituents`

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

`Standard`

Get Constituent Relationships`bloomerang_get_constituent_relationships`

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

`Standard`

Get Constituent Timeline`bloomerang_get_constituent_timeline`

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

`Standard`

Find Duplicate Constituents`bloomerang_find_duplicate_constituents`

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

`Standard`

Update Constituent Communication Settings`bloomerang_update_constituent_communication_settings`

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

`Standard`

List Transactions`bloomerang_list_transactions`

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

`StandardEditFinancialData`

Get Transaction`bloomerang_get_transaction`

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

`StandardEditFinancialData`

Create Transaction`bloomerang_create_transaction`

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

`StandardEditFinancialData`

Update Transaction`bloomerang_update_transaction`

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

`StandardEditFinancialData`

Delete Transaction`bloomerang_delete_transaction`

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

`StandardEditFinancialData`

List Designations`bloomerang_list_designations`

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

`StandardEditFinancialData`

Get Designation`bloomerang_get_designation`

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

`StandardEditFinancialData`

List Interactions`bloomerang_list_interactions`

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

`Standard`

Get Interaction`bloomerang_get_interaction`

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

`Standard`

Create Interaction`bloomerang_create_interaction`

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

`Standard`

Update Interaction`bloomerang_update_interaction`

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

`Standard`

Delete Interaction`bloomerang_delete_interaction`

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

`Standard`

List Tasks`bloomerang_list_tasks`

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

`Standard`

Get Task`bloomerang_get_task`

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

`Standard`

Create Task`bloomerang_create_task`

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

`Standard`

Update Task`bloomerang_update_task`

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

`Standard`

Delete Task`bloomerang_delete_task`

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

`Standard`

Complete Task`bloomerang_complete_task`

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

`Standard`

List Campaigns`bloomerang_list_campaigns`

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

`Standard`

Get Campaign`bloomerang_get_campaign`

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

`Standard`

Create Campaign`bloomerang_create_campaign`

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

`Standard`

Update Campaign`bloomerang_update_campaign`

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

`Standard`

Refresh Campaign Summaries`bloomerang_refresh_campaign_summaries`

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

`Standard`

List Appeals`bloomerang_list_appeals`

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

`Standard`

Get Appeal`bloomerang_get_appeal`

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

`Standard`

Create Appeal`bloomerang_create_appeal`

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

`Standard`

Update Appeal`bloomerang_update_appeal`

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

`Standard`

List Funds`bloomerang_list_funds`

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

`Standard`

Get Fund`bloomerang_get_fund`

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

`Standard`

Create Fund`bloomerang_create_fund`

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

`Standard`

Update Fund`bloomerang_update_fund`

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

`Standard`

Get Pledge Installments`bloomerang_get_pledge_installments`

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

`StandardEditFinancialData`

Generate Pledge Installments`bloomerang_generate_pledge_installments`

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

`StandardEditFinancialData`

Get Pledge Payments`bloomerang_get_pledge_payments`

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

`StandardEditFinancialData`

Get Pledge Payment Failures`bloomerang_get_pledge_payment_failures`

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

`StandardEditFinancialData`

Write Off Pledge`bloomerang_write_off_pledge`

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

`StandardEditFinancialData`

List Households`bloomerang_list_households`

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

`Standard`

Get Household`bloomerang_get_household`

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

`Standard`

Create Household`bloomerang_create_household`

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

`Standard`

Update Household`bloomerang_update_household`

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

`Standard`

Delete Household`bloomerang_delete_household`

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

`Standard`

List Notes`bloomerang_list_notes`

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

`Standard`

Get Note`bloomerang_get_note`

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

`Standard`

Create Note`bloomerang_create_note`

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

`Standard`

Update Note`bloomerang_update_note`

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

`Standard`

Delete Note`bloomerang_delete_note`

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

`Standard`

List Addresses`bloomerang_list_addresses`

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

`Standard`

Get Address`bloomerang_get_address`

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

`Standard`

Create Address`bloomerang_create_address`

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

`Standard`

Update Address`bloomerang_update_address`

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

`Standard`

Delete Address`bloomerang_delete_address`

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

`Standard`

List Email Addresses`bloomerang_list_emails`

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

`Standard`

Get Email Address`bloomerang_get_email`

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

`Standard`

Create Email Address`bloomerang_create_email`

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

`Standard`

Update Email Address`bloomerang_update_email`

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

`Standard`

Delete Email Address`bloomerang_delete_email`

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

`Standard`

List Phone Numbers`bloomerang_list_phones`

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

`Standard`

Get Phone Number`bloomerang_get_phone`

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

`Standard`

Create Phone Number`bloomerang_create_phone`

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

`Standard`

Update Phone Number`bloomerang_update_phone`

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

`Standard`

Delete Phone Number`bloomerang_delete_phone`

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

`Standard`

List Refunds`bloomerang_list_refunds`

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

`StandardEditFinancialData`

Get Refund`bloomerang_get_refund`

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

`StandardEditFinancialData`

Create Refund`bloomerang_create_refund`

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

`StandardEditFinancialData`

Update Refund`bloomerang_update_refund`

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

`StandardEditFinancialData`

Delete Refund`bloomerang_delete_refund`

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

`StandardEditFinancialData`

Get Relationship`bloomerang_get_relationship`

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

`Standard`

Create Relationship`bloomerang_create_relationship`

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

`Standard`

Update Relationship`bloomerang_update_relationship`

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

`Standard`

Delete Relationship`bloomerang_delete_relationship`

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

`Standard`

List Relationship Roles`bloomerang_list_relationship_roles`

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

`Standard`

Get Relationship Role`bloomerang_get_relationship_role`

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

`Standard`

List Soft Credits`bloomerang_list_soft_credits`

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

`Standard`

Get Soft Credit`bloomerang_get_soft_credit`

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

`Standard`

Create Soft Credit`bloomerang_create_soft_credit`

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

`Standard`

Update Soft Credit`bloomerang_update_soft_credit`

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

`Standard`

Delete Soft Credit`bloomerang_delete_soft_credit`

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

`Standard`

List Tributes`bloomerang_list_tributes`

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

`Standard`

Get Tribute`bloomerang_get_tribute`

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

`Standard`

Create Tribute`bloomerang_create_tribute`

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

`Standard`

Update Tribute`bloomerang_update_tribute`

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

`Standard`

Search Tributes`bloomerang_search_tributes`

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

`Standard`

List Custom Field Categories`bloomerang_list_custom_field_categories`

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

`Standard`

List Custom Fields`bloomerang_list_custom_fields`

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

`Standard`

List Custom Values`bloomerang_list_custom_values`

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

`Standard`

List Custom Values By Field`bloomerang_list_custom_values_by_field`

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

`Standard`

List Email Interests`bloomerang_list_email_interests`

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

`Standard`

Get Email Interest`bloomerang_get_email_interest`

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

`Standard`

List Wallet Items`bloomerang_list_wallet_items`

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

`StandardEditFinancialData`

Get Wallet Item`bloomerang_get_wallet_item`

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

`StandardEditFinancialData`

Create Wallet Item`bloomerang_create_wallet_item`

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

`StandardEditFinancialData`

Delete Wallet Item`bloomerang_delete_wallet_item`

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

`StandardEditFinancialData`

List Processors`bloomerang_list_processors`

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

`StandardEditFinancialData`

Get Processor`bloomerang_get_processor`

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

`StandardEditFinancialData`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.