Bloomerang.js

Bloomerang.useKey(publicKey)

This function uses the public key to submit the form to the correct organization. Get the public key by clicking Settings > Integrations > API Keys v1.0 and copying the Public API Key.

Bloomerang.useProcessor(id, type, publicKey, isTestMode, bluePayTPS, restrictBPCredit)

Tells Bloomerang which processor to post the credit card or EFT information to. Use this function only if the form uses BluePay and supports EFT. Otherwise, Spreedly handles credit card processing.

Bloomerang.useDonationId(id)

Tells Bloomerang which donation form you are using.

Bloomerang.Account.individual()

Sets the account type of the constituent to Individual (a person, not an organization).

Bloomerang.Account.organization()

Sets the account type of the constituent to Organization (not an individual).

Bloomerang.Account.organizationName(name)

Sets the full name of the organization. Also calls Bloomerang.Account.organization() to set the type of the account to Organization.

Bloomerang.Account.firstName(name)

Sets the constituent’s first name. This does not set the account type to Individual. If the account is already set to Organization, first call Bloomerang.Account.individual().

Bloomerang.Account.middleName(name)

Sets the constituent’s middle name. This does not set the account type to Individual. If the account is already set to Organization, first call Bloomerang.Account.individual().

Bloomerang.Account.lastName(name)

Sets the constituent’s last name. This does not set the account type to Individual. If the account is already set to Organization, first call Bloomerang.Account.individual().

Bloomerang.Account.prefix(value)

Sets the constituent’s name prefix. This does not set the account type to Individual. If the account is already set to Organization, first call Bloomerang.Account.individual().

Bloomerang.Account.suffix(value)

Sets the constituent’s name suffix. This does not set the account type to Individual. If the account is already set to Organization, first call Bloomerang.Account.individual().

Bloomerang.Account.informalName(name)

Sets the constituent’s informal name. This does not set the account type to Individual. If the account is already set to Organization, first call Bloomerang.Account.individual().

If this is not called, the informal name defaults to the constituent’s first name.

Bloomerang.Account.formalName(name)

Sets the constituent’s formal name. This does not set the account type to Individual. If the account is already set to Organization, first call “a href=”https://bloomerang.com/api/bloomerang-js/#bloomerang-account-individual”> Bloomerang.Account.individual().

If this is not called, the informal name defaults to prefix lastName. If no prefix is specified, it defaults to firstName lastName.

Bloomerang.Account.envelopeName(name)

Sets the constituent’s envelope name. This is the name that should be printed on mailing labels. This does not set the account type to Individual. If the account is already set to Organization, first call Bloomerang.Account.individual().

If this is not called, the envelope name defaults to prefix firstName lastName suffix.

Bloomerang.Account.recognitionName(name)

Sets the constituent’s recognition name. This does not set the account type to Individual. If the account is already set to Organization, first call Bloomerang.Account.individual().

If this is not called, the recognition name defaults to prefix firstName middleName lastName suffix.

Bloomerang.Account.jobTitle(title)

Sets the constituent’s job title.

Bloomerang.Account.employer(name)

Sets the name of the constituent’s employer.

Sets the constituent’s website.

Bloomerang.Account.facebook(id)

Sets the constituent’s Facebook account.

Bloomerang.Account.twitter(id)

Set the constituent’s Twitter account.

Bloomerang.Account.linkedInId(id)

Sets the constituent’s LinkedIn account.

Bloomerang.Account.gender(value)

Sets the constituent’s gender.

Bloomerang.Account.birthdate(date)

Sets the constituent’s date of birth.

Bloomerang.Account.homePhone(number,ext)

Sets the constituent’s primary phone number, with a type of Home. Shortcut for Bloomerang.Account.setPhone(Home). You can only set one phone number on a constituent via forms.

When the phone number is submitted, it is added as a new phone number and marked as primary. If the constituent already has that phone number, it is marked as primary.

Sets the constituent’s primary phone number, with a type of Work. Shortcut for Bloomerang.Account.setPhone(Work). You can only set one phone number on a constituent via forms.

When the phone number is submitted, it is added as a new phone number and marked as primary. If the constituent already has that phone number, it is marked as primary.

Bloomerang.Account.setPhone(type, number, ext)

Sets the constituent’s primary phone number and specifies the type. You can only set one phone number on a constituent via forms.

When the phone number is submitted, it is added as a new phone number and marked as primary. If the constituent already has that phone number, it is marked as primary.

Bloomerang.Account.homeEmail(address)

Sets the constituent’s primary email address, with a type of Home. Shortcut for Bloomerang.Account.setEmail(“Home”, address). You can only set one email address on a constituent via forms.

When the email address is submitted, it is added as a new email address and marked as primary. If the constituent already has that email address, it is marked as primary.

Bloomerang.Account.workEmail(address)

Sets the constituent’s primary email address, with a type of Work. Shortcut for Bloomerang.Account.setEmail(“Work”, address) . You can only set one email address on a constituent via forms.

When the email address is submitted, it is added as a new email address and marked as primary. If the constituent already has that email address, it is marked as primary.

Bloomerang.Account.setEmail(type, address)

Sets the constituent’s primary email address and specifies the type. You can only set one email address on a constituent via forms.

When the email address is submitted, it is added as a new email address and marked as primary. If the constituent already has that email address, it is marked as primary.

Bloomerang.Account.homeAddress(street, city, state, zip, country)

Sets the constituent’s primary address, with a type of Home. Shortcut for < a href="https://bloomerang.com/api/bloomerang-js/#bloomerang-account-setaddress">Bloomearng.Account.setAddress(home). You can only set one address on a constituent via forms.

If the constituent already has an address, Bloomerang normalizes the submitted address. (“123 North 4th Street” becomes “123 N 4TH ST”.) Then it compares the normalized address with the existing addresses. If a match is found, the existing address is updated and marked as primary. If not, a new address is added and marked as primary.

If the country is not United States, Canada, or Bermuda, put the entire address in the street argument. Don’t use city, state, or zip.

Bloomerang.Account.workAddress(street, city, state, zip, country)

Sets the constituent’s primary address, with a type of Work. Shortcut for Bloomerang.Account.setAddress(Work). You can only set one address on a constituent via forms.

If the constituent already has an address, Bloomerang normalizes the submitted address. (“123 North 4th Street” becomes “123 N 4TH ST”.) Then it compares the normalized address with the existing addresses. If a match is found, the existing address is updated and marked as primary. If not, a new address is added and marked as primary.

If the country is not United States, Canada, or Bermuda, put the entire address in the street argument. Don’t use city, state, or zip.

Bloomerang.Account.setAddress(type, street, city, state, zip, country)

Sets the constituent’s primary address and specifies the type. You can only set one address on a constituent via forms.

If the constituent already has an address, Bloomerang normalizes the submitted address. (“123 North 4th Street” becomes “123 N 4TH ST”.) Then it compares the normalized address with the existing addresses. If a match is found, the existing address is updated and marked as primary. If not, a new address is added and marked as primary.

If the country is not United States, Canada, or Bermuda, put the entire address in the street argument. Don’t use city, state, or zip.

Bloomerang.Account.customFreeformField (field, value)

Sets a freeform custom field on the constituent account.

Bloomerang.Account.customPickField (fieldID, valueID1, ValueID2, …)

Sets a pick one or pick multiple custom field on the constituent account.

For a pick one field, only pass in one value’s ID. This value replaces an existing value for that field.

For a pick multiple field, you can pass in as many value IDs as there are defined values. Each value is a separate argument. Submitted values replace any existing values for that field.

Bloomerang.Account.clearCustomFields()

Clears all the custom field values on the account. Call this function to remove any selections left over from a previous submission attempt. Then update the custom fields with values from the form.

This does not delete any custom field values in the Bloomerang database.

Bloomerang.Donation.date(date)

Depreciated. Bloomerang automatically uses the date the donation was submitted.

Bloomerang.Donation.note(text)

Sets the Note field on the donation.

Bloomerang.Donation.amount(amount)

Sets the donation amount.

Bloomerang.Donation.nonDeductible(amount)

Sets the nondeductible part of the donation amount. (The tax-deductible part is amount minus nonDeductible.)

Bloomerang.Donation.fundID(id)

Sets the fund for the donation.

If the submitted fund does not exist in Bloomerang, the transaction defaults to the form’s first fund.

Bloomerang.Donation.campaign(name)

Sets the campaign for the donation. This overrides any campaign set in the Bloomerang form builder.

This function does not create campaigns in Bloomerang! You must first create the campaign in Bloomerang and then use the exact name on your form.

Bloomerang.Donation.appeal(name)

Sets the appeal for the donation. This overrides any appeal set in the Bloomerang form builder.

This function does not create appeals in Bloomerang! You must first create the appeal in Bloomerang and then use the exact name on your form.

Bloomerang.Donation.tribute(name)

Sets the tribute for the donation.

This function does not create tributes in Bloomerang! You must first create the tribute in Bloomerang and then use the exact name on your form.

Bloomerang.Donation.tributeType(name)

Sets the donation’s tribute type.

Bloomerang.Donation.customFreeformField(fieldID, value)

Sets a custom field on the donation. The constituent can type anything into this field.

Bloomerang.Donation.customPickField(fieldID, valueID1, valueID2, …)

Sets a custom field on the donation. The constituent can pick one or more values. This depends on how the field was created in Bloomerang.

This function replaces the field’s values on the JavaScript object.

Bloomerang.Donation.clearCustomFields()

Clears all the custom field values for the donation. Call this function to remove any selections left over from a previous submission attempt. Then update the custom fields with values from the form.

This does not delete any custom field values in the Bloomerang database.

Bloomerang.RecurringDonation.date(date)

Depreciated. Bloomerang automatically uses the date the recurring donation was submitted.

The start date of a recurring donation is set using Bloomerang.RecurringDonation.startDate.

Bloomerang.RecurringDonation.note(text)

Sets the Note field on the recurring donation.

Bloomerang.RecurringDonation.amount(amount)

Sets the amount of the recurring donation. The amount is charged at each interval specified by Bloomerang.RecurringDonation.frequency(value).

amount

required

The amount of recurring donation

Bloomerang.RecurringDonation.nonDeductible(amount)

Sets the nondeductible part of the recurring donation amount. (The tax-deductible part is amount minus nonDeductible.)

Bloomerang.RecurringDonation.fundID(id)

Sets the fund for the recurring donation.

If the submitted fund does not exist in Bloomerang, the transaction defaults to the form’s first fund.

Bloomerang.RecurringDonation.campaign(name)

Sets the campaign for the recurring donation. This overrides any campaign set in the Bloomerang form builder.

This function does not create campaigns in Bloomerang! You must first create the campaign in Bloomerang and then use the exact name on your form.

Bloomerang.RecurringDonation.appeal(name)

Sets the appeal for the recurring donation. This overrides any appeal set in the Bloomerang form builder.

This function does not create appeals in Bloomerang! You must first create the appeal in Bloomerang and then use the exact name on your form.

Bloomerang.RecurringDonation.tribute(name)

Sets the tribute that should be used for the current recurring donation.

This function does not create tributes in Bloomerang! You must first create the tribute in Bloomerang and then use the exact name on your form.

Bloomerang.RecurringDonation.tributeType(name)

Sets the recurring donation’s tribute type.

Bloomerang.RecurringDonation.frequency(value)

Sets how often the recurring donation should occur.

Bloomerang.RecurringDonation.weekly()

Sets the recurring donation to happen weekly. Shortcut for Bloomerang.RecurringDonation.frequency(“Weekly”).

Bloomerang.RecurringDonation.monthly()

Sets the recurring donation to happen monthly. Shortcut for Bloomerang.RecurringDonation.frequency(“Monthly”).

Bloomerang.RecurringDonation.quarterly()

Sets the recurring donation to happen quarterly. Shortcut for Bloomerang.RecurringDonation.frequency(“Quarterly”).

Bloomerang.RecurringDonation.yearly()

Sets the recurring donation to happen yearly. Shortcut for Bloomerang.RecurringDonation.frequency(“Yearly”).

Bloomerang.RecurringDonation.startDate(date)

Sets the date when the recurring donation should start processing payments. This is not the same as Bloomerang.RecurringDonation.date, which is when the form was submitted.
If the start date is the same as the current date, the first payment processes immediately. Otherwise, it occurs in the early morning of the start date (UTC time).
Time zones can set the start date earlier than the donation’s date. If this happens, Bloomerang changes the start date to match the donation’s date. The payment processes immediately.

Bloomerang.RecurringDonation.customFreeformField (fieldID, value)

Sets a custom field on the recurring donation. The constituent can type anything into this field.

Bloomerang.RecurringDonation.customPickField(fieldId, value1, value2, …)

Sets a custom field on the donation. The constituent can pick one or more values. This depends on how the field was created in Bloomerang.
This function replaces the field’s values on the JavaScript object.

Bloomerang.RecurringDonation.clearCustomFields()

Clears all the custom fields for the donation. Call this function to remove any selections left over from a previous submission attempt. Then update the custom fields with values from the form.
This does not delete any custom field values in the Bloomerang database.

Sets the Spreedly token for processing a credit card. Spreedly is a service that reduces PCI compliance scope by securely handling credit card processing.Bloomerang recommends you use the Spreedly Express Payment Widget to obtain a Spreedly token.

Bloomerang.CreditCard.expirationMonth(month)

The month the credit card expires.

Bloomerang.CreditCard.expirationYear(year)

The year the credit card expires.

Bloomerang.InKind.marketValue(value)

The gift’s fair market value.

Blomerang.InKind.description(text)

Bloomerang.InKind.type(type)

Sets the type of gift (whether it was goods or services).

Bloomerang.InKind.goods()

Sets the gift type to Goods. Shortcut for Bloomerang.InKind.type(“Goods”).

Bloomerang.InKind.services()

Sets the gift type to Services. Shortcut for Bloomerang.InKind.type(“Services”).

Bloomerang.Check.number(number)

Sets the check number.

Bloomerang.Check.date(date)

Sets the date of the check

Bloomerang.Eft.type(type)

Sets the type of EFT account (checking or savings).

Bloomerang.Eft.checking()

Sets the EFT account type to Checking. Shortcut for Bloomerang.eft.type(“Checking”).

Bloomerang

Sets the EFT account type to Savings. Shortcut for Bloomerang.Eft.type(“Savings”)

Bloomerang.Eft.accountNumber(number)

Sets the account number that will be charged with the EFT.

Bloomerang.Eft.routingNumber(number)

Sets the bank’s nine-digit routing number.

Bloomerang.Interaction.date(date)

Sets the Date on the timeline that the new interaction should have

Bloomerang.Interaction.subject(subject)

Sets the Subject for the new interaction.

Bloomerang.Interaction.note(note)

Sets the Note for the new interaction.

Bloomerang.Interaction.channel(channel)

Sets the Channel for the new interaction

Bloomerang.interaction.purpose(purpose)

Sets the purpose for the new interaction.

Bloomerang.Interaction.inbound(inbound)

Sets the interaction as inbound (an inbound interaction is one initiated by the constituent)

Bloomerang.Interaction.customFreeformField(fieldId, value)

Sets a custom field on the interaction. The constituent can type anything into this field.

Bloomerang.Interaction.customPickField(fieldId, value1, value2, …)

Sets a custom field on the interaction. The constituent can pick one or more values. This depends on how the field was created in Bloomerang.
This function replaces the field’s values on the JavaScript object.

Bloomerang.Interaction.clearCustomFields()

Clears all the custom field values for the donation. Call this function to remove any selections left over from a previous submission attempt. Then update the custom fields with values from the form.

This does not delete any custom field values in the Bloomerang database.

Bloomerang.Api.donate()

Posts a one-time donation to Bloomerang. Set up all the data you want to post using the data functions before calling this function. Or set up the data as part of your Bloomerang.Api.OnSubmit handler.

Bloomerang.Api.recurringDonate()

Posts a recurring donation to Bloomerang. Set up all the data you want to post using the data functions before calling this function. Or set up the data as part of your Bloomerang.Api.OnSubmit handler.

Bloomerang.captchaResponse(response)

Google reCAPTCHA sends a Base64-encoded response to the form after client-side validation. Use this function to pass the CAPTCHA response from Google to Bloomerang.
For this function to work, CAPTCHA must be turned on in Bloomerang for the type of form you are using (transaction or interaction).

Bloomerang.continueFinancialSubmission(form)

This helper function checks that you are not submitting financial information more than once.
Call this immediately before submitting the form. If it returns true, the form has not been submitted. If it returns false, do not continue the submission. Another submission for the same form is already in progress.

Bloomerang.cancelFinancialSubmission(form)

A helper function to clear the restriction set by Bloomerang.continueFinancialSubmission().
Call this when you are finished processing the form. This might be after an error response or if you want the constituent to be able to submit the form again.

Bloomerang.Api.submitInteraction()

Posts a new Interaction to Bloomerang. Set up all the data you want to post using the data functions before calling this function. Or set up the data as part of your Bloomerang.Api.OnSubmit handler.