Constituent
This API manages constituent information and related entities such as addresses, phones, emails, and notes.
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 constituent to create.
{
"birthdate": {
"d": 14,
"m": 3,
"y": 1963
},
"deceased": false,
"email": {
"address": "Kilgore_Trout64@gmail.com",
"do_not_email": false,
"inactive": false,
"primary": true,
"type": "Email"
},
"first": "Kilgore",
"former_name": "Josh Kilgore",
"gender": "Male",
"gives_anonymously": false,
"last": "Trout",
"marital_status": "Single",
"middle": "X",
"phone": {
"do_not_call": false,
"inactive": false,
"number": "843-537-3397",
"primary": true,
"type": "Home"
},
"preferred_name": "Junior",
"primary_addressee": {
"configuration_id": "28"
},
"primary_salutation": {
"custom_format": true,
"formatted_name": "Joshua Kilgore"
},
"suffix": ", Jr.",
"title": "Mr.",
"type": "Individual"
}{
"description": "Constituents are the individuals and organizations who support your organization by contributing time, money, and resources. The constituent entity stores information about donors, prospects, volunteers, general supporters, and more.",
"required": [
"type"
],
"type": "object",
"properties": {
"address": {
"description": "The constituent's preferred address.",
"required": [
"type"
],
"type": "object",
"properties": {
"address_lines": {
"description": "The address lines. Character limit: 150.",
"maxLength": 150,
"minLength": 0,
"type": "string"
},
"city": {
"description": "The city of the address. Character limit: 50.",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"country": {
"description": "The country of the address.",
"type": "string"
},
"county": {
"description": "The county of the address.",
"type": "string"
},
"do_not_mail": {
"description": "Indicates whether the constituent requests not to be contacted at this address.",
"type": "boolean"
},
"end": {
"format": "date-time",
"description": "The date when the constituent ceased to reside at this address. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
"type": "string",
"x-supports-datetime-offset": false
},
"postal_code": {
"description": "The postal code of the address. Character limit: 12.",
"maxLength": 12,
"minLength": 0,
"type": "string"
},
"seasonal_end": {
"description": "The time of the year ceases to reside at this address.",
"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"
},
"seasonal_start": {
"description": "The time of year that the constituent begins residing at this address.",
"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"
},
"start": {
"format": "date-time",
"description": "The date when the constituent began residing at this address. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
"type": "string",
"x-supports-datetime-offset": false
},
"state": {
"description": "The state of the address.",
"type": "string"
},
"suburb": {
"description": "The suburb of the address.",
"type": "string"
},
"type": {
"description": "The address type. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListAddressTypes\"><b>Address Types</b></a> table.",
"type": "string"
}
},
"x-hidden": true,
"x-display-name": "Create constituent address",
"x-display-id": "CreateConstituentAddress"
},
"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"
},
"email": {
"description": "The constituent's email address.",
"required": [
"address",
"type"
],
"type": "object",
"properties": {
"address": {
"description": "The email address.",
"type": "string"
},
"do_not_email": {
"description": "Indicates whether the constituent requests not to be contacted at this email address.",
"type": "boolean"
},
"inactive": {
"description": "Indicates whether the email address is inactive.",
"type": "boolean"
},
"primary": {
"description": "Indicates whether this is the constituent's primary email address.",
"type": "boolean"
},
"type": {
"description": "The type of email address. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListEmailAddressTypes\"><b>Phone Types</b></a> table.",
"type": "string"
}
},
"x-hidden": true,
"x-display-name": "Create constituent email address",
"x-display-id": "CreateConstituentEmailAddress"
},
"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"
},
"gives_anonymously": {
"description": "Indicates whether the constituent gives anonymously.",
"type": "boolean"
},
"inactive": {
"description": "Indicates whether the constituent is inactive.",
"type": "boolean"
},
"last": {
"description": "The constituent's last name. For individuals only (required). Character limit: 100.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"lookup_id": {
"description": "The user-defined identifier for the constituent.",
"type": "string"
},
"marital_status": {
"description": "The constituent's marital status. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListMaritalStatuses\"><b>Marital Status</b></a> table. For individuals only.",
"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"
},
"online_presence": {
"description": "The constituent's online presence.",
"required": [
"address",
"type"
],
"type": "object",
"properties": {
"address": {
"description": "The web address for the online presence.",
"type": "string"
},
"inactive": {
"description": "Indicates whether the online presence is inactive.",
"type": "boolean"
},
"primary": {
"description": "Indicates whether this is the constituent's primary online presence.",
"type": "boolean"
},
"type": {
"description": "The online presence type. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListOnlinePresenceTypes\"><b>Phone Types</b></a> table.",
"type": "string"
}
},
"x-hidden": true,
"x-display-name": "Create constituent online presence",
"x-display-id": "CreateConstituentOnlinePresence"
},
"phone": {
"description": "The constituent's phone.",
"required": [
"number",
"type"
],
"type": "object",
"properties": {
"do_not_call": {
"description": "Indicates whether the constituent requests not to be contacted at this number.",
"type": "boolean"
},
"inactive": {
"description": "Indicates whether the phone is inactive.",
"type": "boolean"
},
"number": {
"description": "The phone number.",
"type": "string"
},
"primary": {
"description": "Indicates whether this is the constituent's primary phone number.",
"type": "boolean"
},
"type": {
"description": "The phone type. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListPhoneTypes\"><b>Phone Types</b></a> table.",
"type": "string"
}
},
"x-hidden": true,
"x-display-name": "Create constituent phone",
"x-display-id": "CreateConstituentPhone"
},
"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"
},
"birthplace": {
"description": "The birthplace of the constituent. For individuals only.",
"type": "string"
},
"ethnicity": {
"description": "The ethnicity of the constituent. For individuals only.",
"type": "string"
},
"income": {
"description": "The income for the constituent. For individuals only.",
"type": "string"
},
"religion": {
"description": "The religion of the constituent. For individuals only.",
"type": "string"
},
"industry": {
"description": "The industry of the constituent. For organizations only.",
"type": "string"
},
"matches_gifts": {
"description": "Indicates if the constituent matches gifts. For organizations only.",
"type": "boolean"
},
"matching_gift_per_gift_min": {
"description": "The minimum matching gift per gift for the constituent. For organizations only.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"matching_gift_per_gift_max": {
"description": "The maximum matching gift per gift for the constituent. For organizations only.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"matching_gift_total_min": {
"description": "The minimum matching gift total for the constituent. For organizations only.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"matching_gift_total_max": {
"description": "The maximum matching gift total for the constituent. For organizations only.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"matching_gift_factor": {
"format": "double",
"description": "The matching gift factor for the constituent. For organizations only.",
"type": "number"
},
"matching_gift_notes": {
"description": "The matching gift notes for the constituent. For organizations only.",
"type": "string"
},
"num_employees": {
"format": "int32",
"description": "The number of employees for the constituent. For organizations only.",
"type": "integer"
},
"is_memorial": {
"description": "Indicates whether the constituent is for honor/memorial.",
"type": "boolean"
},
"is_solicitor": {
"description": "Indicates whether the constituent is a solicitor.",
"type": "boolean"
},
"no_valid_address": {
"description": "Indicates whether the constituent does not have a valid address.",
"type": "boolean"
},
"receipt_type": {
"description": "The receipt type of the constituent.",
"enum": [
"One receipt per gift",
"Consolidated receipts"
],
"type": "string"
},
"target": {
"description": "The target of the constituent.",
"type": "string"
},
"date_added": {
"format": "date-time",
"description": "Optional. The date the constituent was added. Useful when importing records from another system and the source system has a date added. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
"type": "string",
"x-supports-datetime-offset": true
},
"requests_no_email": {
"description": "Indicates whether the constituent requests no email.",
"type": "boolean"
},
"import_id": {
"description": "The import ID associated with the constituent. Maximum length is 20 characters.",
"maxLength": 20,
"minLength": 0,
"type": "string"
}
},
"x-hidden": true,
"x-display-name": "Create constituent",
"x-display-id": "CreateConstituent"
}Response 200 OK
Returned when the operation successfully creates a constituent. The response body contains the ID of the new constituent.
{
"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 specified request body is not in the appropriate format.
Response 403 Forbidden
Returned when the user does not have permission to create the constituent.
Code samples
@ECHO OFF
curl -v -X POST "https://api.sky.blackbaud.com/constituent/v1/constituents"
-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/constituents?" + 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/constituents");
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/constituents?" + $.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/constituents";
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/constituents');
$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/constituents?%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/constituents?%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/constituents')
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