Communication Preference (Beta)

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

POST

Constituent consent

Creates a consent record for a constituent.

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, Implicit.

Request body

The constituent's consent record.

{
  "constituent_id": "280",
  "channel": "Email",
  "category": "Fundraising",
  "source": "Web form",
  "consent_date": "2018-07-30T23:04:52+00:00",
  "constituent_consent_response": "OptIn",
  "privacy_notice": "Sample privacy notice",
  "consent_statement": "Sample consent statement"
}
{
  "description": "Represents the consent entity to add to the specified constituent.",
  "required": [
    "constituent_id",
    "channel",
    "consent_date",
    "constituent_consent_response"
  ],
  "type": "object",
  "properties": {
    "constituent_id": {
      "description": "The immutable system record ID of the constituent associated with the consent record.",
      "type": "string"
    },
    "channel": {
      "description": "The channel that the consent response applies to. Available values can be obtained from the <a href=\"https://developer.sky.blackbaud.com/docs/services/communication-preference/operations/ListConsentChannels\">Consent Channels List</a>.",
      "type": "string"
    },
    "category": {
      "description": "The category that the consent response applies to. Available values can be obtained from the <a href=\"https://developer.sky.blackbaud.com/docs/services/communication-preference/operations/ListConsentCategories\">Consent Categories List</a>.",
      "type": "string"
    },
    "source": {
      "description": "The source of the consent response from the constituent. Available values can be obtained from the <a href=\"https://developer.sky.blackbaud.com/docs/services/communication-preference/operations/ListConsentSources\">Consent Sources List</a>.",
      "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"
    }
  },
  "example": {
    "constituent_id": "280",
    "channel": "Email",
    "category": "Fundraising",
    "source": "Web form",
    "consent_date": "2018-07-30T23:04:52Z",
    "constituent_consent_response": "OptIn",
    "privacy_notice": "Sample privacy notice",
    "consent_statement": "Sample consent statement"
  }
}

Response 200 OK

Returned when the operation succeeds. The response body contains the ID of the new consent record.

{
  "id": "4343"
}
{
  "description": "Response for creating a record.",
  "type": "object",
  "properties": {
    "id": {
      "description": "Id of the created record.",
      "type": "string"
    }
  }
}

Response 400 Bad Request

Returned when the request body 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 permission to create a consent record.

{
  "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 or when the provided channel, category, or source cannot be resolved.

{
  "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 POST "https://api.sky.blackbaud.com/commpref/v1/consent/consents"
-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/commpref/v1/consent/consents?" + 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/commpref/v1/consent/consents");


            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/commpref/v1/consent/consents?" + $.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/commpref/v1/consent/consents";
    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/commpref/v1/consent/consents');
$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", "/commpref/v1/consent/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
    '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", "/commpref/v1/consent/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/consent/consents')

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