Constituent

This API manages constituent information and related entities such as addresses, phones, emails, and notes.

POST

Relationship

Creates a relationship for a constituent. If the relationship is with another constituent, a reciprocal relationship is created for that constituent. The identifier of the reciprocal relationship is in the reciprocal_relationship_id property.

Try it

Request URL

Request headers

Header Required Type Description
Content-Type string Media type of the body sent to the API.
Bb-Api-Subscription-Key Property is required string Subscription key which provides access to this API. Found in your Profile.
Authorization Property is required string OAuth 2.0 access token obtained from Blackbaud OAuth 2.0 Service. Supported grant types: Authorization code.

Request body

An object that represents the relationship to create.

{
  "comment": "Dr. Yang coaches basketball for the Y every year.",
  "constituent_id": "280",
  "end": {
    "d": 19,
    "m": 4,
    "y": 2011
  },
  "is_organization_contact": false,
  "is_primary_business": false,
  "is_spouse": false,
  "position": "Basketball Coach",
  "reciprocal_type": "Member",
  "relation_id": "461",
  "start": {
    "d": 9,
    "m": 6,
    "y": 1990
  },
  "type": "Club"
}
{
  "description": "Relationships describe connections between constituents and other individuals and organizations such as family, friends, and employers. Tracking constituent relationships can enhance fundraising efforts and interactions.",
  "required": [
    "constituent_id"
  ],
  "type": "object",
  "properties": {
    "comment": {
      "description": "The comment on the relationship.",
      "type": "string"
    },
    "constituent_id": {
      "description": "The immutable system record ID of the constituent associated with the relationship.",
      "type": "string"
    },
    "end": {
      "description": "The end date for the relationship.",
      "type": "object",
      "properties": {
        "d": {
          "format": "int32",
          "description": "The day in the fuzzy date.",
          "type": "integer"
        },
        "m": {
          "format": "int32",
          "description": "The month in the fuzzy date.",
          "type": "integer"
        },
        "y": {
          "format": "int32",
          "description": "The year in the fuzzy date.",
          "type": "integer"
        }
      },
      "x-display-name": "Fuzzy date",
      "x-display-id": "FuzzyDate"
    },
    "is_organization_contact": {
      "description": "Indicates whether the related individual represents the organization as a contact. Only applies to relationships between organizations and individuals.",
      "type": "boolean"
    },
    "is_primary_business": {
      "description": "Indicates whether the related organization is the individual's primary business. Only applies to relationships between organizations and individuals.",
      "type": "boolean"
    },
    "is_spouse": {
      "description": "Indicates whether the related constituent is the constituent's spouse. Only applies to relationships between individuals.",
      "type": "boolean"
    },
    "is_spouse_head_of_household": {
      "description": "Indicates whether the spouse constituent is the head household. Only applies to spousal relationships between individuals.",
      "type": "boolean"
    },
    "is_constituent_head_of_household": {
      "description": "Indicates whether the constituent is the head of household. Only applies to spousal relationships between individuals.",
      "type": "boolean"
    },
    "organization_contact_type": {
      "description": "Provides context for interactions with the related individual who represents the organization as a contact. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListOrganizationContactTypes\"><b>Contact Types</b></a> table. Only applies to relationships between organizations and individuals.",
      "type": "string"
    },
    "position": {
      "description": "The individual's position in the organization. Only applies to relationships between organizations and individuals. Character limit: 50.",
      "maxLength": 50,
      "minLength": 0,
      "type": "string"
    },
    "reciprocal_type": {
      "description": "Describes the constituent's relationship to the related constituent. For example, in a relationship between a male constituent and a female sibling, the reciprocal relationship type would be brother. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListRelationshipTypes\"><b>Relationships</b></a> table.",
      "type": "string"
    },
    "relation_id": {
      "description": "The immutable system record ID of the related individual or organization.",
      "type": "string"
    },
    "relation": {
      "description": "The non-constituent individual or organization relation",
      "required": [
        "type"
      ],
      "type": "object",
      "properties": {
        "birthdate": {
          "description": "The constituent's birthdate. For individuals only.",
          "type": "object",
          "properties": {
            "d": {
              "format": "int32",
              "description": "The day in the fuzzy date.",
              "type": "integer"
            },
            "m": {
              "format": "int32",
              "description": "The month in the fuzzy date.",
              "type": "integer"
            },
            "y": {
              "format": "int32",
              "description": "The year in the fuzzy date.",
              "type": "integer"
            }
          },
          "x-display-name": "Fuzzy date",
          "x-display-id": "FuzzyDate"
        },
        "deceased": {
          "description": "Indicates whether the constituent is deceased. For individuals only.",
          "type": "boolean"
        },
        "deceased_date": {
          "description": "The date when the constituent died. For individuals only.",
          "type": "object",
          "properties": {
            "d": {
              "format": "int32",
              "description": "The day in the fuzzy date.",
              "type": "integer"
            },
            "m": {
              "format": "int32",
              "description": "The month in the fuzzy date.",
              "type": "integer"
            },
            "y": {
              "format": "int32",
              "description": "The year in the fuzzy date.",
              "type": "integer"
            }
          },
          "x-display-name": "Fuzzy date",
          "x-display-id": "FuzzyDate"
        },
        "first": {
          "description": "The constituent's first name. For individuals only. Character limit: 50.",
          "maxLength": 50,
          "minLength": 0,
          "type": "string"
        },
        "former_name": {
          "description": "The constituent's former name. For individuals only. Character limit: 100.",
          "maxLength": 100,
          "minLength": 0,
          "type": "string"
        },
        "gender": {
          "description": "The constituent's gender. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListGenders\"><b>Gender</b></a> table. This property defaults to <i>Unknown</i> if no value is provided. For individuals only.",
          "type": "string"
        },
        "last": {
          "description": "The constituent's last name. For individuals only (required). Character limit: 100.",
          "maxLength": 100,
          "minLength": 0,
          "type": "string"
        },
        "middle": {
          "description": "The constituent's middle name. For individuals only. Character limit: 50.",
          "maxLength": 50,
          "minLength": 0,
          "type": "string"
        },
        "name": {
          "description": "If the constituent's <code>type</code> is <i>Individual</i>, this is a computed field that does not apply to add operations. If the <code>type</code> is <i>Organization</i>, this field is required and represents the organization's name. Character limit: 60.",
          "type": "string"
        },
        "preferred_name": {
          "description": "The constituent's preferred name. For individuals only. Character limit: 50.",
          "maxLength": 50,
          "minLength": 0,
          "type": "string"
        },
        "suffix": {
          "description": "The constituent's primary suffix. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListSuffixes\"><b>Suffixes</b></a> table. For individuals only.",
          "type": "string"
        },
        "suffix_2": {
          "description": "The constituent's secondary suffix. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListSuffixes\"><b>Suffixes</b></a> table. For individuals only.",
          "type": "string"
        },
        "title": {
          "description": "The constituent's primary title. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListTitles\"><b>Titles</b></a> table. For individuals only.",
          "type": "string"
        },
        "title_2": {
          "description": "The constituent's secondary title. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListTitles\"><b>Titles</b></a> table. For individuals only.",
          "type": "string"
        },
        "type": {
          "description": "The type of constituent. Available values are <i>Individual</i> and <i>Organization</i>.",
          "enum": [
            "Individual",
            "Organization"
          ],
          "type": "string"
        },
        "primary_addressee": {
          "description": "The constituent's primary addressee. For individuals only.",
          "type": "object",
          "properties": {
            "configuration_id": {
              "description": "The name format configuration identifier. Required when custom_format is false.",
              "type": "string"
            },
            "custom_format": {
              "description": "Whether the name format uses a custom format.",
              "type": "boolean"
            },
            "formatted_name": {
              "description": "The name format formatted name. Required when custom_format is true. Character limit: 255.",
              "maxLength": 255,
              "minLength": 0,
              "type": "string"
            }
          },
          "x-hidden": true,
          "x-display-name": "Edit primary name format",
          "x-display-id": "EditPrimaryNameFormat"
        },
        "primary_salutation": {
          "description": "The constituent's primary salutation. For individuals only.",
          "type": "object",
          "properties": {
            "configuration_id": {
              "description": "The name format configuration identifier. Required when custom_format is false.",
              "type": "string"
            },
            "custom_format": {
              "description": "Whether the name format uses a custom format.",
              "type": "boolean"
            },
            "formatted_name": {
              "description": "The name format formatted name. Required when custom_format is true. Character limit: 255.",
              "maxLength": 255,
              "minLength": 0,
              "type": "string"
            }
          },
          "x-hidden": true,
          "x-display-name": "Edit primary name format",
          "x-display-id": "EditPrimaryNameFormat"
        }
      },
      "x-hidden": true,
      "x-display-name": "Create non-constituent",
      "x-display-id": "CreateNon-Constituent"
    },
    "start": {
      "description": "The start date for the relationship.",
      "type": "object",
      "properties": {
        "d": {
          "format": "int32",
          "description": "The day in the fuzzy date.",
          "type": "integer"
        },
        "m": {
          "format": "int32",
          "description": "The month in the fuzzy date.",
          "type": "integer"
        },
        "y": {
          "format": "int32",
          "description": "The year in the fuzzy date.",
          "type": "integer"
        }
      },
      "x-display-name": "Fuzzy date",
      "x-display-id": "FuzzyDate"
    },
    "type": {
      "description": "The type of relation that the relationship represents. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListRelationshipTypes\"><b>Relationships</b></a> table.",
      "type": "string"
    },
    "do_not_reciprocate": {
      "description": "When set to true, indicates that a reciprocal relationship should not be created.",
      "type": "boolean"
    }
  },
  "x-hidden": true,
  "x-display-name": "Create relationship",
  "x-display-id": "CreateRelationship"
}

Response 200 OK

Returned when the operation successfully creates a relationship. The response body contains the ID of the new relationship.

{
  "id": "1281"
}
{
  "description": "Defines the shape of a post response object.",
  "type": "object",
  "properties": {
    "id": {
      "description": "The newly created ID",
      "type": "string"
    }
  },
  "x-hidden": true
}

Response 400 Bad Request

Returned when the request body is not in the appropriate format.

Response 403 Forbidden

Returned when the user does not have permission to create the relationship.

Response 404 Not Found

Returned when the specified constituent is not found.

Code samples

@ECHO OFF

curl -v -X POST "https://api.sky.blackbaud.com/constituent/v1/relationships"
-H "Content-Type: application/json"
-H "Bb-Api-Subscription-Key: {subscription key}"
-H "Authorization: Bearer {access token}"
--data-ascii "{body}"

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }

        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Bb-Api-Subscription-Key", "{subscription key}");
            client.DefaultRequestHeaders.Add("Authorization", "Bearer {access token}");

            var uri = "https://api.sky.blackbaud.com/constituent/v1/relationships?" + queryString;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               var response = await client.PostAsync(uri, content);
            }

        }
    }
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.sky.blackbaud.com/constituent/v1/relationships");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Bb-Api-Subscription-Key", "{subscription key}");
            request.setHeader("Authorization", "Bearer {access token}");

            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity)); 
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/constituent/v1/relationships?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Bb-Api-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","Bearer {access token}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];

    NSString* path = @"https://api.sky.blackbaud.com/constituent/v1/relationships";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];

    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Bb-Api-Subscription-Key"];
    [_request setValue:@"Bearer {access token}" forHTTPHeaderField:@"Authorization"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];

    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);

        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }

        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }

        NSLog(@"%@", json);
        _connectionData = nil;
    }

    [pool drain];

    return 0;
}

<?php
// This sample uses the PEAR HTTP client from http://pear.php.net/package/HTTP_Request2
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.sky.blackbaud.com/constituent/v1/relationships');
$url = $request->getUrl();

$headers = array(
    // Request headers
   'Content-Type' => 'application/json',
   'Bb-Api-Subscription-Key' => '{subscription key}',
   'Authorization' => 'Bearer {access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Bb-Api-Subscription-Key': '{subscription key}',
    'Authorization': 'Bearer {access token}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("POST", "/constituent/v1/relationships?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Bb-Api-Subscription-Key': '{subscription key}',
    'Authorization': 'Bearer {access token}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("POST", "/constituent/v1/relationships?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.sky.blackbaud.com/constituent/v1/relationships')

request = Net::HTTP::Post.new(uri.request_uri)

# Request headers
request['Content-Type'] = 'application/json'
request['Bb-Api-Subscription-Key'] = '{subscription key}'
request['Authorization'] = 'Bearer {access token}'

# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body

Comments

Have a question? See a problem with our docs? Want to engage with the SKY Developer team? Please visit us on the SKY Developer Community!