Communication Preference (Beta)

This API manages constituent communication preference information and related entities such as constituent consent.

GET

Constituent consent list

Returns a list of constituent consent records.

Try it

Request URL

Request parameters

Parameter Required Type Description
constituent_id Property is required string

The constituent's consent record.

most_recent_only boolean

Set this parameter to "true" to include only the most recent record for each channel category combination in the response.

limit integer

Set this parameter to return only the specified number of records in the response. Defaults to return all records.

skip integer

Set this parameter to skip the specified number of records in the response. Defaults to skip no records.

channels array

Set this parameter to return records of the specified channels. For example, "channels=Phone&channels=Email" returns consent records with either "Phone" or "Email" as the channel. Defaults to return consent records with any channel.

categories array

Set this parameter to return records of the specified categories. For example, "categories=Fundraising&categories=Newsletter" returns consent records with either "Fundraising" or "Newsletter" as the category. Defaults to return consent records with any category.

Request headers

Header Required Type Description
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, Implicit.

Response 200 OK

Returned when the operation succeeds. The response body contains a collection of consent records.

{
  "count": 3,
  "value": [
    {
      "id": "1",
      "channel": "Email",
      "category": "Fundraising",
      "source": "Web form",
      "consent_date": "2018-07-31T00:00:00",
      "constituent_consent_response": "OptIn",
      "privacy_notice": "Sample privacy notice",
      "consent_statement": "Sample consent statement",
      "date_added": "2018-07-30T20:39:00+00:00",
      "user_name": "Joe Bob"
    },
    {
      "id": "15",
      "channel": "Phone",
      "category": "Fundraising",
      "source": "Phone call inbound",
      "consent_date": "2018-06-22T00:00:00",
      "constituent_consent_response": "OptOut",
      "privacy_notice": "Sample privacy notice",
      "consent_statement": "Sample consent statement",
      "date_added": "2018-06-23T18:59:00+00:00",
      "user_name": "Joe Bob"
    },
    {
      "id": "121",
      "channel": "Email",
      "category": "Newsletter",
      "source": "Phone call outbound",
      "consent_date": "2018-05-03T00:00:00",
      "constituent_consent_response": "NoResponse",
      "privacy_notice": "Sample privacy notice",
      "consent_statement": "Sample consent statement",
      "date_added": "2018-05-02T11:56:00+00:00",
      "user_name": "Joe Bob"
    }
  ]
}
{
  "description": "A collection of consent records.",
  "type": "object",
  "properties": {
    "count": {
      "format": "int32",
      "description": "The number of consent records in the list.",
      "type": "integer",
      "readOnly": true
    },
    "value": {
      "description": "The set of consent records included in the response.",
      "type": "array",
      "items": {
        "description": "Represents a consent entity for a constituent.",
        "required": [
          "id",
          "channel",
          "consent_date",
          "constituent_consent_response"
        ],
        "type": "object",
        "properties": {
          "id": {
            "description": "The immutable system record ID of the consent record.",
            "type": "string"
          },
          "channel": {
            "description": "The channel that the consent response applies to.",
            "type": "string"
          },
          "category": {
            "description": "The category that the consent response applies to.",
            "type": "string"
          },
          "source": {
            "description": "The source of the consent response from the constituent.",
            "type": "string"
          },
          "consent_date": {
            "format": "date-time",
            "description": "The date the consent response was received.",
            "type": "string"
          },
          "constituent_consent_response": {
            "description": "How the constituent responded to consent for the specified channel/category. Available values are <i>OptIn</i>, <i>OptOut</i>, and <i>NoResponse</i>.",
            "enum": [
              "OptIn",
              "OptOut",
              "NoResponse"
            ],
            "type": "string"
          },
          "privacy_notice": {
            "description": "The privacy notice provided to the constituent.",
            "maxLength": 7999,
            "type": "string"
          },
          "consent_statement": {
            "description": "The statement the constituent responded to when providing consent.",
            "maxLength": 7999,
            "type": "string"
          },
          "date_added": {
            "format": "date-time",
            "description": "The date the consent response was added.",
            "type": "string"
          },
          "user_name": {
            "description": "The user that added the consent response.",
            "type": "string"
          }
        }
      }
    }
  }
}

Response 400 Bad Request

Returned when constituent_id is not in the appropriate format.

{
  "message": "The request body is not in the appropriate format.",
  "error_name": "BadRequest",
  "error_code": 400,
  "raw_message": "The request body is not in the appropriate format."
}
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "error_name": {
      "type": "string"
    },
    "error_code": {
      "format": "int32",
      "type": "integer"
    },
    "raw_message": {
      "type": "string"
    },
    "error_args": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

Response 403 Forbidden

Returned when the user does not have rights to view the constituent.

{
  "message": "The user does not have permission to create a record.",
  "error_name": "Forbidden",
  "error_code": 403,
  "raw_message": "The user does not have permission to create a record."
}
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "error_name": {
      "type": "string"
    },
    "error_code": {
      "format": "int32",
      "type": "integer"
    },
    "raw_message": {
      "type": "string"
    },
    "error_args": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

Response 404 Not Found

Returned when the specified constituent cannot be found.

{
  "message": "The requested record was not found.",
  "error_name": "NotFound",
  "error_code": 404,
  "raw_message": "The requested record was not found."
}
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "error_name": {
      "type": "string"
    },
    "error_code": {
      "format": "int32",
      "type": "integer"
    },
    "raw_message": {
      "type": "string"
    },
    "error_args": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.sky.blackbaud.com/commpref/v1/constituents/{constituent_id}/consents?most_recent_only={boolean}&limit={integer}&skip={integer}&channels={array}&categories={array}"
-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}");

            // Request parameters
            queryString["most_recent_only"] = "{boolean}";
            queryString["limit"] = "{integer}";
            queryString["skip"] = "{integer}";
            queryString["channels"] = "{array}";
            queryString["categories"] = "{array}";
            var uri = "https://api.sky.blackbaud.com/commpref/v1/constituents/{constituent_id}/consents?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}
// // 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/commpref/v1/constituents/{constituent_id}/consents");

            builder.setParameter("most_recent_only", "{boolean}");
            builder.setParameter("limit", "{integer}");
            builder.setParameter("skip", "{integer}");
            builder.setParameter("channels", "{array}");
            builder.setParameter("categories", "{array}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            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
            "most_recent_only": "{boolean}",
            "limit": "{integer}",
            "skip": "{integer}",
            "channels": "{array}",
            "categories": "{array}",
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/commpref/v1/constituents/{constituent_id}/consents?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Bb-Api-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","Bearer {access token}");
            },
            type: "GET",
            // 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/commpref/v1/constituents/{constituent_id}/consents";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"most_recent_only={boolean}",
                         @"limit={integer}",
                         @"skip={integer}",
                         @"channels={array}",
                         @"categories={array}",
                      ];

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

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_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/commpref/v1/constituents/{constituent_id}/consents');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'most_recent_only' => '{boolean}',
    'limit' => '{integer}',
    'skip' => '{integer}',
    'channels' => '{array}',
    'categories' => '{array}',
);

$url->setQueryVariables($parameters);

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

// 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
    'Bb-Api-Subscription-Key': '{subscription key}',
    'Authorization': 'Bearer {access token}',
}

params = urllib.urlencode({
    # Request parameters
    'most_recent_only': '{boolean}',
    'limit': '{integer}',
    'skip': '{integer}',
    'channels': '{array}',
    'categories': '{array}',
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/commpref/v1/constituents/{constituent_id}/consents?%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
    'Bb-Api-Subscription-Key': '{subscription key}',
    'Authorization': 'Bearer {access token}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'most_recent_only': '{boolean}',
    'limit': '{integer}',
    'skip': '{integer}',
    'channels': '{array}',
    'categories': '{array}',
})

try:
    conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/commpref/v1/constituents/{constituent_id}/consents?%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/commpref/v1/constituents/{constituent_id}/consents')

query = URI.encode_www_form({
    # Request parameters
    'most_recent_only' => '{boolean}',
    'limit' => '{integer}',
    'skip' => '{integer}',
    'channels' => '{array}',
    'categories' => '{array}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end
request = Net::HTTP::Get.new(uri.request_uri)

# Request headers
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 API team? Please visit us on the SKY API Community!