Skip to main content
POST
Connect or reconnect Bloomerang with an API key

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated request fields for this operation.

connection_id
integer
required

Connection id. Validation: nullable, integer.

Required range: x >= 1
Example:

1

api_key
string | null
write-only

Active Bloomerang API Keys 2.0 credential; required when connection_id is absent or non-positive. Positive existing connection may reuse its stored key.

Required string length: 8 - 2048
Example:

"YOUR_BLOOMERANG_API_KEY"

Response

Operation result.

status
string
Example:

"success"

data
object

Safe connection receipt without API key or other credentials.

message
string

Operation receipt.

Example:

"Example"