Skip to main content
POST
Queue a manual Bloomerang import

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

connection_id
integer
required

Connection id in the current organization.

Body

application/json

Validated request fields for this operation.

object_types
string[] | null

Object types. Validation: nullable, array.

Supported values: donor, household, relationship, group, donation, soft_credit, refund, note, task, interaction. Unknown/empty normalized scope falls back to household, donor, relationship, donation, soft_credit and refund; groups are not automatic-sync scopes.

max_pages
integer | null

Max pages. Validation: nullable, integer, min:1, max:1000.

Required range: 1 <= x <= 1000
Example:

1

match_existing_by_email
boolean | null

Match existing by email. Validation: nullable, boolean.

Example:

true

constituent_ids
integer[] | null

Constituent ids. Validation: nullable, array, max:25.

Maximum array length: 25

Constituent ids item. Validation: integer, min:1.

Required range: x >= 1
use_cursors
boolean | null

Use cursors. Validation: nullable, boolean.

Example:

true

replay_from_baseline
boolean | null

Replay from baseline. Validation: nullable, boolean.

Example:

true

mapped_records_only
boolean | null

Mapped records only. Validation: nullable, boolean. Requires donor-only full scan with no constituent_ids filter and no cursor reads.

Example:

true

Include related objects. Validation: nullable, boolean. Defaults true; adds configured related soft-credit/acknowledgement types for donations.

Example:

true

Response

Operation result.

status
string
Example:

"success"

data
object
message
string

Operation receipt.

Example:

"Example"