Constituent

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

POST Action

Creates a constituent action.

Try it

Request URL

Request headers

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

An object that represents the action to create.

constituent_idProperty is requiredstringThe constituent identifier.
categoryProperty is requiredstringThe channel or intent of the constituent interaction. Available values are Phone Call, Meeting, Mailing, Email, and Task/Other.
dateProperty is requireddateTimeThe action date. Uses ISO-8601 format: 2015-09-18T16:25:00.
start_timestringThe start time of the action. Uses 24-hour time in the HH:mm format. For example, 17:30 represents 5:30 p.m.
end_timestringThe end time of the action. Uses 24-hour time in the HH:mm format. For example, 17:30 represents 5:30 p.m.
locationstringThe location of the action. Available values are the entries in the Action Locations table.
prioritystringThe priority of the action. Available values are Normal, High, and Low. The default is Normal.
directionstringThe direction of the action. Available values are Inbound and Outbound.
typestringAdditional description of the action to complement the category. Available values are the entries in the Actions table.
summarystringThe short description of the action that appears at the top of the record.
descriptionstringThe detailed explanation that elaborates on the action summary.
completedbooleanIndicates whether the action is complete. If the system is configured to use custom action statuses, this value is based on the action status value. This property defaults to false if no value is provided.
completed_datedateTimeThe date when the action was completed. Uses ISO-8601 format: 2015-09-18T16:25:00.
outcomestringThe outcome of the action. Available values are Successful and Unsuccessful.
statusstringThe action status. If the system is configured to use custom action statuses, available values are the entries in the Action Status table. If not, this field computes the status based on the completed and date properties: If an action is not completed and has a current or future date, the status is Open; if an action is not completed and has a past date, the status is Past due; and if an action is completed, the status is Completed.
fundraisersarray of stringsThe set of constituent IDs for the fundraisers associated with the action.
opportunity_idstringThe identifier of the opportunity associated with the action.

{
  "constituent_id": "280",
  "category": "Meeting",
  "type": "Dinner Meeting",
  "date": "2015-08-26T00:00:00",
  "start_time": "18:30",
  "end_time": "21:30",
  "location": "Rafferty's",
  "priority": "Normal",
  "direction": "Outbound",
  "summary": "Sushi dinner celebration",
  "description": "Had dinner with Dr. Hernandez at Rafferty's",
  "completed": true,
  "completed_date": "2015-08-26T00:00:00",
  "outcome": "Successful",
  "status": "Closed",
  "fundraisers": [
    "252"
  ],
  "opportunity_id": "23"
}
{
  "description": "Defines the shape of a constituent action record",
  "required": [
    "constituent_id"
  ],
  "type": "object",
  "properties": {
    "id": {
      "description": "The action identifier.",
      "type": "string"
    },
    "constituent_id": {
      "description": "The constituent identifier.",
      "type": "string"
    },
    "category": {
      "description": "The channel or intent of the constituent interaction. Available values are <i>Phone Call</i>, <i>Meeting</i>, <i>Mailing</i>, <i>Email</i>, and <i>Task/Other</i>.",
      "type": "string"
    },
    "type": {
      "description": "Additional description of the action to complement the category. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/574f4bc7d7dcde0740edb969\"><b>Actions</b></a> table.",
      "type": "string"
    },
    "date": {
      "format": "date-time",
      "description": "The action date. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
      "type": "string"
    },
    "start_time": {
      "description": "The start time of the action. Uses 24-hour time in the <i>HH:mm</i> format. For example, 17:30 represents 5:30 p.m.",
      "type": "string"
    },
    "end_time": {
      "description": "The end time of the action. Uses 24-hour time in the <i>HH:mm</i> format. For example, 17:30 represents 5:30 p.m.",
      "type": "string"
    },
    "location": {
      "description": "The location of the action. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/59a0a959a9db950e686f09ce\"><b>Action Locations</b></a> table.",
      "type": "string"
    },
    "priority": {
      "description": "The priority of the action. Available values are <i>Normal</i>, <i>High</i>, and <i>Low</i>. The default is <i>Normal</i>.",
      "enum": [
        "Normal",
        "High",
        "Low"
      ],
      "type": "string"
    },
    "direction": {
      "description": "The direction of the action. Available values are <i>Inbound</i> and <i>Outbound</i>.",
      "enum": [
        "Inbound",
        "Outbound"
      ],
      "type": "string"
    },
    "summary": {
      "description": "The short description of the action that appears at the top of the record.",
      "type": "string"
    },
    "description": {
      "description": "The detailed explanation that elaborates on the action summary.",
      "type": "string"
    },
    "completed": {
      "description": "Indicates whether the action is complete. If the system is configured to use custom action statuses, this value is based on the action status value. This property defaults to <i>false</i> if no value is provided.",
      "type": "boolean"
    },
    "completed_date": {
      "format": "date-time",
      "description": "The date when the action was completed. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
      "type": "string"
    },
    "outcome": {
      "description": "The outcome of the action. Available values are <i>Successful</i> and <i>Unsuccessful</i>.",
      "enum": [
        "Successful",
        "Unsuccessful"
      ],
      "type": "string"
    },
    "status": {
      "description": "The action status. If the system is configured to use custom action statuses, available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/574f4bc7d7dcde0740edb96a\"><b>Action Status</b></a> table. If not, this field computes the status based on the <code>completed</code> and <code>date</code> properties: If an action is not completed and has a current or future date, the status is Open; if an action is not completed and has a past date, the status is Past due; and if an action is completed, the status is Completed.",
      "type": "string"
    },
    "fundraisers": {
      "description": "The set of constituent IDs for the fundraisers associated with the action.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "opportunity_id": {
      "description": "The identifier for the opportunity associated with the action.",
      "type": "string"
    },
    "date_added": {
      "format": "date-time",
      "description": "The date when the action was created. Includes an offset from UTC in <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43-04:00</i>.",
      "type": "string"
    },
    "date_modified": {
      "format": "date-time",
      "description": "The date when the action was last modified. Includes an offset from UTC in <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43-04:00</i>.",
      "type": "string"
    }
  },
  "example": {
    "constituent_id": "280",
    "category": "Meeting",
    "type": "Dinner Meeting",
    "date": "2015-08-26T00:00:00",
    "start_time": "18:30",
    "end_time": "21:30",
    "location": "Rafferty's",
    "priority": "Normal",
    "direction": "Outbound",
    "summary": "Sushi dinner celebration",
    "description": "Had dinner with Dr. Hernandez at Rafferty's",
    "completed": true,
    "completed_date": "2015-08-26T00:00:00",
    "outcome": "Successful",
    "status": "Closed",
    "fundraisers": [
      "252"
    ],
    "opportunity_id": "23"
  },
  "x-hidden": true
}

Response 200

Returned when the operation successfully creates an action. The response body contains the ID of the new action.

{
  "id": "1281"
}
{
  "description": "Represents a Post Response object",
  "type": "object",
  "properties": {
    "id": {
      "description": "The newly created Id",
      "type": "string"
    }
  },
  "x-hidden": true
}

Response 400

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

Response 403

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

Response 404

Returned when the specified constituent is not found.

Code samples

@ECHO OFF

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

            HttpResponseMessage response;

            // 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 >");
               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/actions");


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

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