Integrations

Save Bloomerang transaction setup

Saves donation direction, fallback, soft-credit and acknowledgement choices with the next approved transaction mapping. Enabling fallback requires an organization program and recipient belonging to it. Each supplied mapped_fields row requires a supported unique source path and non-empty label. Omitted fallback/soft-credit/acknowledgement booleans are false; disabling fallback clears its ids. Setup describes one payment with multiple designation allocations and requires existing donor/target links for future export; no payment/provider transaction is created here. Direction follows sync_direction_control: configurable uses requested/current/default direction, locked_bidirectional forces bidirectional, and unavailable preserves current/default direction. Defaults are bidirectional. Returned context/mapping shows effective flags; saving direction and activating ongoing sync are separate. Requires the integration platform global/configured client feature gate (normally integration_platform_foundation). Requires permission: one of access_account_settings.

POST

integrations

hub

connections

{connection_id}

bloomerang

donation-mapping

Save Bloomerang transaction setup

curl --request POST \
  --url https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/donation-mapping \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source_of_truth": "provider",
  "donation_fallback_enabled": true,
  "donation_fallback_program_id": 1,
  "donation_fallback_designation_id": 1,
  "donation_soft_credits_enabled": true,
  "donation_acknowledgements_enabled": true,
  "mapped_fields": [
    {
      "provider_path": "designation.fund.name",
      "field_label": "Bloomerang fund"
    }
  ]
}
'

import requests

url = "https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/donation-mapping"

payload = {
    "source_of_truth": "provider",
    "donation_fallback_enabled": True,
    "donation_fallback_program_id": 1,
    "donation_fallback_designation_id": 1,
    "donation_soft_credits_enabled": True,
    "donation_acknowledgements_enabled": True,
    "mapped_fields": [
        {
            "provider_path": "designation.fund.name",
            "field_label": "Bloomerang fund"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    source_of_truth: 'provider',
    donation_fallback_enabled: true,
    donation_fallback_program_id: 1,
    donation_fallback_designation_id: 1,
    donation_soft_credits_enabled: true,
    donation_acknowledgements_enabled: true,
    mapped_fields: [{provider_path: 'designation.fund.name', field_label: 'Bloomerang fund'}]
  })
};

fetch('https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/donation-mapping', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/donation-mapping",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'source_of_truth' => 'provider',
    'donation_fallback_enabled' => true,
    'donation_fallback_program_id' => 1,
    'donation_fallback_designation_id' => 1,
    'donation_soft_credits_enabled' => true,
    'donation_acknowledgements_enabled' => true,
    'mapped_fields' => [
        [
                'provider_path' => 'designation.fund.name',
                'field_label' => 'Bloomerang fund'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/donation-mapping"

	payload := strings.NewReader("{\n  \"source_of_truth\": \"provider\",\n  \"donation_fallback_enabled\": true,\n  \"donation_fallback_program_id\": 1,\n  \"donation_fallback_designation_id\": 1,\n  \"donation_soft_credits_enabled\": true,\n  \"donation_acknowledgements_enabled\": true,\n  \"mapped_fields\": [\n    {\n      \"provider_path\": \"designation.fund.name\",\n      \"field_label\": \"Bloomerang fund\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/donation-mapping")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source_of_truth\": \"provider\",\n  \"donation_fallback_enabled\": true,\n  \"donation_fallback_program_id\": 1,\n  \"donation_fallback_designation_id\": 1,\n  \"donation_soft_credits_enabled\": true,\n  \"donation_acknowledgements_enabled\": true,\n  \"mapped_fields\": [\n    {\n      \"provider_path\": \"designation.fund.name\",\n      \"field_label\": \"Bloomerang fund\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/donation-mapping")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source_of_truth\": \"provider\",\n  \"donation_fallback_enabled\": true,\n  \"donation_fallback_program_id\": 1,\n  \"donation_fallback_designation_id\": 1,\n  \"donation_soft_credits_enabled\": true,\n  \"donation_acknowledgements_enabled\": true,\n  \"mapped_fields\": [\n    {\n      \"provider_path\": \"designation.fund.name\",\n      \"field_label\": \"Bloomerang fund\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "data": {
    "connection": {
      "id": 42,
      "target_context_json": {}
    },
    "mapping": {
      "id": 42,
      "connection_id": 42,
      "provider_key": "bloomerang",
      "hys_object_type": "Example",
      "provider_object_type": "Example",
      "mapping_version": 2,
      "status": "Example",
      "source_of_truth_json": {},
      "mapping_json": {},
      "defaults_json": {},
      "metadata_json": {},
      "approved_at": "2023-11-07T05:31:56Z"
    },
    "mappings": [
      {
        "id": 42,
        "connection_id": 42,
        "provider_key": "bloomerang",
        "hys_object_type": "Example",
        "provider_object_type": "Example",
        "mapping_version": 2,
        "status": "Example",
        "source_of_truth_json": {},
        "mapping_json": {},
        "defaults_json": {},
        "metadata_json": {},
        "approved_at": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "message": "Example"
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "message": "Not Found",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

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.

source_of_truth

enum<string> | null

Source of truth. Validation: nullable; allowed values: provider, hys, bidirectional.

Available options:

provider,

hys,

bidirectional,

null

Example:

"provider"

donation_fallback_enabled

boolean | null

Donation fallback enabled. Validation: nullable, boolean.

Example:

true

donation_fallback_program_id

integer | null

Donation fallback program id. Validation: nullable, integer.

Example:

1

donation_fallback_designation_id

integer | null

Donation fallback designation id. Validation: nullable, integer.

Example:

1

donation_soft_credits_enabled

boolean | null

Donation soft credits enabled. Validation: nullable, boolean.

Example:

true

donation_acknowledgements_enabled

boolean | null

Donation acknowledgements enabled. Validation: nullable, boolean.

Example:

true

mapped_fields

object[] | null

Mapped fields. Validation: nullable, array.

Show child attributes

Response

Operation result.

status

string

Example:

"success"

data

object

Group disable returns mapping=null. Interaction setup returns mapping as first newly approved version (or null), plus the complete mappings array. Other saves return mapping only.

Show child attributes

message

string

Operation receipt.

Example:

"Example"

Save Bloomerang transaction setup

curl --request POST \
  --url https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/donation-mapping \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source_of_truth": "provider",
  "donation_fallback_enabled": true,
  "donation_fallback_program_id": 1,
  "donation_fallback_designation_id": 1,
  "donation_soft_credits_enabled": true,
  "donation_acknowledgements_enabled": true,
  "mapped_fields": [
    {
      "provider_path": "designation.fund.name",
      "field_label": "Bloomerang fund"
    }
  ]
}
'

import requests

url = "https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/donation-mapping"

payload = {
    "source_of_truth": "provider",
    "donation_fallback_enabled": True,
    "donation_fallback_program_id": 1,
    "donation_fallback_designation_id": 1,
    "donation_soft_credits_enabled": True,
    "donation_acknowledgements_enabled": True,
    "mapped_fields": [
        {
            "provider_path": "designation.fund.name",
            "field_label": "Bloomerang fund"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    source_of_truth: 'provider',
    donation_fallback_enabled: true,
    donation_fallback_program_id: 1,
    donation_fallback_designation_id: 1,
    donation_soft_credits_enabled: true,
    donation_acknowledgements_enabled: true,
    mapped_fields: [{provider_path: 'designation.fund.name', field_label: 'Bloomerang fund'}]
  })
};

fetch('https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/donation-mapping', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/donation-mapping",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'source_of_truth' => 'provider',
    'donation_fallback_enabled' => true,
    'donation_fallback_program_id' => 1,
    'donation_fallback_designation_id' => 1,
    'donation_soft_credits_enabled' => true,
    'donation_acknowledgements_enabled' => true,
    'mapped_fields' => [
        [
                'provider_path' => 'designation.fund.name',
                'field_label' => 'Bloomerang fund'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/donation-mapping"

	payload := strings.NewReader("{\n  \"source_of_truth\": \"provider\",\n  \"donation_fallback_enabled\": true,\n  \"donation_fallback_program_id\": 1,\n  \"donation_fallback_designation_id\": 1,\n  \"donation_soft_credits_enabled\": true,\n  \"donation_acknowledgements_enabled\": true,\n  \"mapped_fields\": [\n    {\n      \"provider_path\": \"designation.fund.name\",\n      \"field_label\": \"Bloomerang fund\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/donation-mapping")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source_of_truth\": \"provider\",\n  \"donation_fallback_enabled\": true,\n  \"donation_fallback_program_id\": 1,\n  \"donation_fallback_designation_id\": 1,\n  \"donation_soft_credits_enabled\": true,\n  \"donation_acknowledgements_enabled\": true,\n  \"mapped_fields\": [\n    {\n      \"provider_path\": \"designation.fund.name\",\n      \"field_label\": \"Bloomerang fund\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/donation-mapping")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source_of_truth\": \"provider\",\n  \"donation_fallback_enabled\": true,\n  \"donation_fallback_program_id\": 1,\n  \"donation_fallback_designation_id\": 1,\n  \"donation_soft_credits_enabled\": true,\n  \"donation_acknowledgements_enabled\": true,\n  \"mapped_fields\": [\n    {\n      \"provider_path\": \"designation.fund.name\",\n      \"field_label\": \"Bloomerang fund\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "data": {
    "connection": {
      "id": 42,
      "target_context_json": {}
    },
    "mapping": {
      "id": 42,
      "connection_id": 42,
      "provider_key": "bloomerang",
      "hys_object_type": "Example",
      "provider_object_type": "Example",
      "mapping_version": 2,
      "status": "Example",
      "source_of_truth_json": {},
      "mapping_json": {},
      "defaults_json": {},
      "metadata_json": {},
      "approved_at": "2023-11-07T05:31:56Z"
    },
    "mappings": [
      {
        "id": 42,
        "connection_id": 42,
        "provider_key": "bloomerang",
        "hys_object_type": "Example",
        "provider_object_type": "Example",
        "mapping_version": 2,
        "status": "Example",
        "source_of_truth_json": {},
        "mapping_json": {},
        "defaults_json": {},
        "metadata_json": {},
        "approved_at": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "message": "Example"
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "message": "Not Found",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}