Gift
This API manages gift information and related entities such as gift splits, gift fundraisers, and soft credits.
PATCH
Gift
Edits a gift. Posted gifts cannot be modified, except to change recurring gift status.
Try itRequest URL
Request parameters
Parameter | Required | Type | Description |
---|---|---|---|
gift_id | Property is required | string | The immutable system record ID of the gift to edit. |
Request headers
Header | Required | Type | Description |
---|---|---|---|
If-Match | Property is required | string | ETag of the Entity. The value should match the current ETag header value from the gift GET request or it should be * for an unconditional update. |
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 properties of the gift to edit.
{
"constituency": "Parent",
"date": "2019-08-10T11:14:03Z",
"gift_code": "TestGiftCode",
"gift_status": "Held",
"is_anonymous": false,
"lookup_id": "testlookupid2",
"marketing_details": {
"finder_number": 136,
"mailing_id": 1548,
"marketing_source_code": "Radio"
},
"recurring_gift_status_date": {
"y": "2019",
"m": "4",
"d": "17"
},
"reference": "reference2",
"subtype": "Computers"
}
{
"description": "An object that represents the gift to edit.\r\nGifts are the primary goal of fundraising efforts. They come in many forms and have a lot of information associated with them to ensure that they are properly allocated and acknowledged.",
"type": "object",
"properties": {
"lookup_id": {
"description": "The user-defined identifier for the gift. Character limit: 50.",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"date": {
"format": "date-time",
"description": "The gift date. Includes an offset from UTC in <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
},
"is_anonymous": {
"description": "Indicates whether the gift is anonymous.\r\nIf no value is provided, the default anonymity of the donor will be used.",
"type": "boolean"
},
"reference": {
"description": "Notes to track special details about a gift such as the motivation behind it or a detailed description of a gift-in-kind. Character limit: 255.",
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"gift_status": {
"description": "The status of the gift. Available values are <i>Active</i>, <i>Held</i>, <i>Terminated</i>, <i>Completed</i>, and <i>Cancelled.</i>\r\nThe status can only be changed for gifts of type pledge and recurring gift.\r\nThe status cannot be changed from Terminated, Completed, or Cancelled to Active or Held.",
"type": "string"
},
"recurring_gift_status_date": {
"description": "The date associated with the gift status. Type is a FuzzyDate.",
"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"
},
"gift_code": {
"description": "The gift code of the gift.",
"type": "string"
},
"subtype": {
"description": "The subtype of the gift. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/58bdd5edd7dcde06046081d6/operations/ListGiftSubtypes\"><b>Gift Subtypes</b></a> table.",
"type": "string"
},
"constituency": {
"description": "The constituency of the gift.",
"type": "string"
},
"marketing_details": {
"description": "The marketing details of the gift.",
"type": "object",
"properties": {
"finder_number": {
"format": "int32",
"description": "Gets or sets the gift's finder number. The finder number cannot be negative.",
"type": "integer"
},
"mailing_id": {
"description": "Gets or sets the gift's mailing identifier.",
"type": "string"
},
"marketing_source_code": {
"description": "Gets or sets the gift's marketing source code. Character limit: 255.",
"type": "string"
}
},
"x-hidden": true,
"x-display-name": "Edit gift marketing details",
"x-display-id": "EditGiftMarketingDetails",
"x-additional-info": "<a name=\"GiftTypes\"></a>\r\n<p> </p>\r\n<p>\r\n Available values for the <b>type</b> of a <b>gift</b>:\r\n</p>\r\n\r\n<div class=\"table-responsive\">\r\n <table class=\"table table-striped table-hover\">\r\n <thead>\r\n <tr>\r\n <th class=\"col-xs-3\"><strong>Type</strong></th>\r\n <th class=\"col-xs-9\"><strong>Description</strong></th>\r\n </tr>\r\n </thead>\r\n <tbody>\r\n <tr>\r\n <td>Amendment</td>\r\n <td>An amendment.</td>\r\n </tr>\r\n <tr>\r\n <td>Donation</td>\r\n <td>A donation.</td>\r\n </tr>\r\n <tr>\r\n <td>GiftInKind</td>\r\n <td>A gift-in-kind.</td>\r\n </tr>\r\n <tr>\r\n <td>GeneralLedgerReversal</td>\r\n <td>A general ledger reversal.</td>\r\n </tr>\r\n <tr>\r\n <td>MatchingGiftPledge</td>\r\n <td>A matching gift pledge.</td>\r\n </tr>\r\n <tr>\r\n <td>MatchingGiftPayment</td>\r\n <td>A matching gift payment.</td>\r\n </tr>\r\n <tr>\r\n <td>MatchingGiftWriteOff</td>\r\n <td>A matching gift write-off.</td>\r\n </tr>\r\n <tr>\r\n <td>PlannedGift</td>\r\n <td>A planned gift.</td>\r\n </tr>\r\n <tr>\r\n <td>Pledge</td>\r\n <td>A pledge.</td>\r\n </tr>\r\n <tr>\r\n <td>PledgePayment</td>\r\n <td>A pledge payment.</td>\r\n </tr>\r\n <tr>\r\n <td>PledgeWriteOff</td>\r\n <td>A pledge write off.</td>\r\n </tr>\r\n <tr>\r\n <td>RecurringGift</td>\r\n <td>A recurring gift.</td>\r\n </tr>\r\n <tr>\r\n <td>RecurringGiftPayment</td>\r\n <td>A recurring gift payment.</td>\r\n </tr>\r\n <tr>\r\n <td>Stock</td>\r\n <td>A stock.</td>\r\n </tr>\r\n <tr>\r\n <td>SoldStock</td>\r\n <td>A sold stock.</td>\r\n </tr>\r\n <tr>\r\n <td>Other</td>\r\n <td>Another type of gift.</td>\r\n </tr>\r\n </tbody>\r\n </table>\r\n</div>"
}
},
"x-hidden": true,
"x-display-name": "Edit gift",
"x-display-id": "EditGift"
}
Response 200 OK
OK
{}
{
"type": "object"
}
Response 400 Bad Request
Returned when the specified gift ID in the URL or the specified request body is not in the appropriate format.
Response 403 Forbidden
Returned when the user does not have permission to edit the gift.
Response 404 Not Found
Returned when the specified gift is not found.
Code samples
@ECHO OFF
curl -v -X PATCH "https://api.sky.blackbaud.com/gift/v1/gifts/{gift_id}"
-H "If-Match: {if-match}"
-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.IfMatch.Add(EntityTagHeaderValue.Parse("{if-match}"));
client.DefaultRequestHeaders.Add("Bb-Api-Subscription-Key", "{subscription key}");
client.DefaultRequestHeaders.Add("Authorization", "Bearer {access token}");
var uri = "https://api.sky.blackbaud.com/gift/v1/gifts/{gift_id}?" + 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 request = new HttpRequestMessage(new HttpMethod("PATCH"), uri);
request.Content = content;
var response = await client.SendAsync(request);
}
}
}
}
// // 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/gift/v1/gifts/{gift_id}");
URI uri = builder.build();
HttpPatch request = new HttpPatch(uri);
request.setHeader("If-Match", "{if-match}");
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/gift/v1/gifts/{gift_id}?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("If-Match","{if-match}");
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Bb-Api-Subscription-Key","{subscription key}");
xhrObj.setRequestHeader("Authorization","Bearer {access token}");
},
type: "PATCH",
// 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/gift/v1/gifts/{gift_id}";
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:@"PATCH"];
// Request headers
[_request setValue:@"{if-match}" forHTTPHeaderField:@"If-Match"];
[_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/gift/v1/gifts/{gift_id}');
$url = $request->getUrl();
$headers = array(
// Request headers
'If-Match' => '{if-match}',
'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_PATCH);
// 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
'If-Match': '{if-match}',
'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("PATCH", "/gift/v1/gifts/{gift_id}?%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
'If-Match': '{if-match}',
'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("PATCH", "/gift/v1/gifts/{gift_id}?%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/gift/v1/gifts/{gift_id}')
request = Net::HTTP::Patch.new(uri.request_uri)
# Request headers
request['If-Match'] = '{if-match}'
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