Constituent

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

POST

Document

Creates a document upload location and unique document identifier for physical attachments.

Maximum file size is 100MB.

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 document to upload.

{
  "file_name": "businesscard.jpg",
  "upload_thumbnail": true
}
{
  "description": "Cultivation activities often result in physical collateral such as images, PDFs, or Word files. The New Document entity allows you to upload these files to maintain a holistic view of target constituents.",
  "type": "object",
  "properties": {
    "file_name": {
      "description": "The file name. For physical attachments only.",
      "type": "string"
    },
    "upload_thumbnail": {
      "description": "Indicates that a thumbnail needs to be created.",
      "type": "boolean"
    }
  },
  "x-display-name": "New document info",
  "x-display-id": "NewDocumentInfo"
}

Response 200 OK

Returned when the operation successfully posts a document. The response body contains the properties of the posted document.

{
  "file_id": "e8ce3494-d961-4eef-9938-acf0a2d9a831",
  "file_upload_request": {
    "headers": [
      {
        "name": "x-ms-blob-type",
        "value": "BlockBlob"
      },
      {
        "name": "x-ms-version",
        "value": "2015-12-11"
      }
    ],
    "method": "PUT",
    "url": "http://prodsarnxdocmn002blkbrdo.blob.core.windows.net/blackbauddocumentsvc/tenants/a486g1de-73f5-4a81-a4b1-ff353509fbde/documents/4DF6B36A-3058-4FA9-ACA5-4BCD08E67ACF/businesscard.jpg?sv=2015-05-17&sr=b&sig=HI0UTKNjiCVB6AtGHBVuCdhgnETbRPYegwb7%2FQyjI%2FU%3D&se=2015-10-15T18%3A25%3A30Z&sp=rw"
  },
  "thumbnail_id": "5b181d20-9b5f-44ab-8e63-46d14424dfe5",
  "thumbnail_upload_request": {
    "headers": [
      {
        "name": "x-ms-blob-type",
        "value": "BlockBlob"
      },
      {
        "name": "x-ms-version",
        "value": "2015-12-11"
      }
    ],
    "method": "PUT",
    "url": "http://prodsarnxdocmn002blkbrdo.blob.core.windows.net/blackbauddocumentsvc/tenants/a486g1de-73f5-4a81-a4b1-ff353509fbde/documents/4DF6B36A-3058-4FA9-ACA5-4BCD08E67ACF/thumbnail_businesscard.jpg?sv=2015-05-17&sr=b&sig=HI0UTKNjiCVB6AtGHBVuCdhgnETbRPYegwb7%2FQyjI%2FU%3D&se=2015-10-15T18%3A25%3A30Z&sp=rw"
  }
}
{
  "description": "Contains metadata for uploading a document and unique document identifier for physical attachments.",
  "type": "object",
  "properties": {
    "file_id": {
      "description": "The identifier of the file.",
      "type": "string"
    },
    "file_upload_request": {
      "description": "The metadata for the request for uploading the file.",
      "type": "object",
      "properties": {
        "headers": {
          "description": "The headers to supply when making the request.",
          "type": "array",
          "items": {
            "description": "Request header used for uploading the physical attachment.",
            "type": "object",
            "properties": {
              "name": {
                "description": "The name for the header.",
                "type": "string"
              },
              "value": {
                "description": "The value for the header.",
                "type": "string"
              }
            }
          }
        },
        "method": {
          "description": "The http method to use for the request.",
          "type": "string"
        },
        "url": {
          "description": "The url to use for the request.",
          "type": "string"
        }
      },
      "x-display-name": "Request meta data",
      "x-display-id": "RequestMetaData"
    },
    "thumbnail_id": {
      "description": "The identifier of the thumbnail.",
      "type": "string"
    },
    "thumbnail_upload_request": {
      "description": "The metadata for the request for uploading the thumbnail.",
      "type": "object",
      "properties": {
        "headers": {
          "description": "The headers to supply when making the request.",
          "type": "array",
          "items": {
            "description": "Request header used for uploading the physical attachment.",
            "type": "object",
            "properties": {
              "name": {
                "description": "The name for the header.",
                "type": "string"
              },
              "value": {
                "description": "The value for the header.",
                "type": "string"
              }
            }
          }
        },
        "method": {
          "description": "The http method to use for the request.",
          "type": "string"
        },
        "url": {
          "description": "The url to use for the request.",
          "type": "string"
        }
      },
      "x-display-name": "Request meta data",
      "x-display-id": "RequestMetaData"
    }
  },
  "x-display-name": "File definition",
  "x-display-id": "FileDefinition"
}

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 upload the document.

Code samples

@ECHO OFF

curl -v -X POST "https://api.sky.blackbaud.com/constituent/v1/documents"
-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/documents?" + 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/documents");


            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/documents?" + $.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/documents";
    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/documents');
$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/documents?%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/documents?%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/documents')

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!