Skip to main content
Bloomerang logo

​
Overview

Add Bloomerang to any ModuleX agent or workflow. Nonprofit donor management and fundraising CRM platform integration against the Bloomerang REST API (api.bloomerang.co/v2).
Categories: CRM · Nonprofit · Fundraising · Auth: API Key · Actions: 3

​
Authentication

​
API Key Authentication

Authenticate using your Bloomerang API key
1

Step 1

Log in to your Bloomerang account
2

Step 2

Navigate to Settings > API Keys
3

Step 3

Create a new API key or copy your existing one
4

Step 4

Paste the API key below

​
Required Credentials

FieldDescriptionRequiredFormat
Bloomerang API KeyYour Bloomerang API keyYes-

​
Available Actions

​
Parameters

​
type
string
required
Constituent type. Valid values: Individual, Organization
​
first_name
string
First name of the constituent (used when type is Individual)
​
last_name
string
Last name of the constituent (used when type is Individual)
​
full_name
string
Organization name (used when type is Organization)
​
status
string
Status of the constituent. Valid values: Active, Inactive, Deceased
​
middle_name
string
Middle name of the constituent
​
prefix
string
Prefix/title. Valid values: Mr., Mrs., Ms., Mx., Dr., Rev., etc.
​
suffix
string
Suffix. Valid values: Jr., Sr., II, III, IV, V, Ph.D., M.D., Esq., etc.
​
job_title
string
Job title of the constituent
​
gender
string
Gender. Valid values: Male, Female, Other
​
birthdate
string
Birth date of the constituent (ISO format YYYY-MM-DD)
​
employer
string
Employer of the constituent
​
website
string
Website URL of the constituent
​
facebook_id
string
Facebook page URL of the constituent
​
twitter_id
string
Twitter/X handle of the constituent
​
linked_in_id
string
LinkedIn page URL of the constituent
​
preferred_communication_channel
string
Preferred communication channel. Valid values: Email, Phone, Text Message, Mail

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "first_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "First Name"
    },
    "last_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Last Name"
    },
    "full_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Full Name"
    },
    "type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Type"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateConstituentOutput",
  "type": "object"
}

​
Parameters

​
constituent_id
string
required
ID of the constituent (donor)
​
date
string
required
Date of the donation (ISO format YYYY-MM-DD)
​
amount
string
required
Donation amount as a numeric string
​
fund_id
string
required
ID of the fund for the donation
​
payment_method
string
required
Payment method. Valid values: None, Cash, Check, CreditCard, Eft, InKind, ApplePay, GooglePay, PayPal, Venmo
​
campaign_id
string
ID of the campaign for the donation
​
appeal_id
string
ID of the appeal for the donation
​
note
string
Note for the donation

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "amount": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Amount"
    },
    "date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Date"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateDonationOutput",
  "type": "object"
}

​
Parameters

​
constituent_id
string
required
ID of the constituent
​
date
string
required
Date of the interaction (ISO format YYYY-MM-DD)
​
subject
string
required
Subject of the interaction
​
channel
string
required
Channel of the interaction. Valid values: Email, InPerson, Mail, MassEmail, Other, Phone, SocialMedia, TextMessage, VideoCall, Webinar, Website
​
purpose
string
required
Purpose of the interaction. Valid values: Acknowledgement, ImpactCultivation, Newsletter, Receipt, Solicitation, SpecialEvent, VolunteerActivity, PledgeReminder, Welcome, Other
​
note
string
Note for the interaction
​
is_inbound
boolean
Whether the interaction was initiated by the constituent

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "subject": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Subject"
    },
    "channel": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Channel"
    }
  },
  "required": [
    "success"
  ],
  "title": "AddInteractionOutput",
  "type": "object"
}

​
Limits & Quotas

  • No publicly documented rate limits for the Bloomerang REST API v2.
  • Error model: non-2xx responses and timeouts are caught and returned as success=False + error rather than raising.

Clay

Dropcontact

Google Contacts