Integrations

Save Bloomerang relationship setup

Atomically approves the next constituent-relationship mapping and mapped-constituents-only member policy, superseding its previous version. Saving setup does not create donor/relationship records. 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

relationship-mapping

Save Bloomerang relationship setup

curl --request POST \
  --url https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/relationship-mapping \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source_of_truth": "provider"
}
'

import requests

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

payload = { "source_of_truth": "provider" }
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'})
};

fetch('https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/relationship-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/relationship-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'
  ]),
  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/relationship-mapping"

	payload := strings.NewReader("{\n  \"source_of_truth\": \"provider\"\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/relationship-mapping")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source_of_truth\": \"provider\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/relationship-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}"

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"

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 relationship setup

curl --request POST \
  --url https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/relationship-mapping \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source_of_truth": "provider"
}
'

import requests

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

payload = { "source_of_truth": "provider" }
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'})
};

fetch('https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/relationship-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/relationship-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'
  ]),
  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/relationship-mapping"

	payload := strings.NewReader("{\n  \"source_of_truth\": \"provider\"\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/relationship-mapping")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source_of_truth\": \"provider\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/bloomerang/relationship-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}"

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."
}