Gift

This API manages gift information and related entities such as gift splits, gift fundraisers, and soft credits.

POST

Gift

Creates a gift. At this time, you can only post gifts with the "Donation", "RecurringGift", and "RecurringGiftPayment" type, and the payments can only use the "Cash," "CreditCard," "PersonalCheck," "DirectDebit," and "Other" payment methods with "RecurringGiftPayment" and "RecurringGift" types only allowing "CreditCard" and "DirectDebit" payment methods. When adding a recurring gift, a recurring_gift_schedule must be included. Additionally, an account token must be provided for each payments object on a recurring gift. When adding a recurring gift payment, a linked_gifts field must be included as an array of strings with the ID of the recurring gift to which the payment is linked. Additionally, either a bbps_transaction_id or checkout_transaction_id must be provided for each payments object on a recurring gift payment.

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

An object that represents the gift to create.

{
  "amount": {
    "value": 100
  },
  "constituent_id": "280",
  "date": "2017-10-03T00:00:00",
  "fundraisers": [
    {
      "amount": {
        "value": 100
      },
      "constituent_id": "252"
    }
  ],
  "gift_splits": [
    {
      "amount": {
        "value": 100
      },
      "appeal_id": "15",
      "campaign_id": "1",
      "fund_id": "41"
    }
  ],
  "gift_status": "Active",
  "is_anonymous": false,
  "lookup_id": "2225",
  "payments": [
    {
      "payment_method": "Cash"
    }
  ],
  "post_date": "2017-10-03T00:00:00",
  "post_status": "NotPosted",
  "reference": "newly added gift",
  "soft_credits": [
    {
      "amount": {
        "value": 100
      },
      "constituent_id": "187"
    }
  ],
  "subtype": "Annuity",
  "type": "Donation"
}
{
  "description": "Gifts 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.",
  "required": [
    "amount",
    "constituent_id",
    "gift_splits",
    "type",
    "payments"
  ],
  "type": "object",
  "properties": {
    "acknowledgements": {
      "description": "The set of acknowledgements associated with the gift.\r\nIf none are provided, an empty acknowledgement with a status of <i>NEEDSACKNOWLEDGEMENT</i> will be created alongside the gift.",
      "type": "array",
      "items": {
        "description": "Acknowledgement letters foster relationships with donors and show appreciation for their contributions. It is important to keep track of the acknowledgement status of gifts to ensure that each one gets a well-deserved thank you.",
        "type": "object",
        "properties": {
          "date": {
            "format": "date-time",
            "description": "The date associated with the acknowledgement. Uses <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
          },
          "letter": {
            "description": "The letter associated with the acknowledgement.",
            "type": "string"
          },
          "status": {
            "description": "The status of the acknowledgement. Available values are: <i>ACKNOWLEDGED</i>, <i>NEEDSACKNOWLEDGEMENT</i>, and <i>DONOTACKNOWLEDGE.</i>\r\nWhen <code>acknowledgement_status</code> is set to <i>DONOTACKNOWLEDGE</i>, <code>acknowledgement_letter</code> and <code>acknowledgement_date</code> should be null.\r\nWhen it is set to <i>NEEDSACKNOWLEDGEMENT</i>, <code>acknowledgement_date</code> should be null.\r\nIf no value is provided, a default value of <i>NEEDSACKNOWLEDGEMENT</i> will be used.",
            "type": "string"
          }
        },
        "x-display-name": "Acknowledgement",
        "x-display-id": "Acknowledgement_01"
      }
    },
    "amount": {
      "description": "The monetary amount of the gift.",
      "type": "object",
      "properties": {
        "value": {
          "format": "double",
          "description": "The monetary value.",
          "type": "number"
        }
      }
    },
    "batch_number": {
      "description": "Gets or sets the batch number. Character limit: 50 (including the batch prefix).",
      "maxLength": 50,
      "minLength": 0,
      "type": "string"
    },
    "batch_prefix": {
      "description": "Gets or sets the batch prefix. This must include at least one letter. It is required when BatchNumber has a value and defaults to \"API\" if no value is provided.",
      "type": "string"
    },
    "constituency": {
      "description": "The constituency of the gift.",
      "type": "string"
    },
    "constituent_id": {
      "description": "The immutable system record ID of the constituent associated with the gift.",
      "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
    },
    "default_fundraiser_credits": {
      "description": "Indicates whether to use default fundraiser credits.\r\nIf no value is provided, defaults will not be used.",
      "type": "boolean"
    },
    "default_soft_credits": {
      "description": "Indicates whether to use default soft credits.\r\nIf no value is provided, defaults will not be used.",
      "type": "boolean"
    },
    "fundraisers": {
      "description": "The set of fundraisers who receive credit for the gift.",
      "type": "array",
      "items": {
        "description": "Fundraiser constituents interact with other constituents and prospects on behalf of your organization to cultivate relationships and request donations. When a constituent makes a donation, the fundraiser can receive credit to track performance and foster fundraising accomplishments.",
        "required": [
          "amount",
          "constituent_id"
        ],
        "type": "object",
        "properties": {
          "amount": {
            "description": "The amount credited to the fundraiser for the gift.",
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "description": "The monetary value.",
                "type": "number"
              }
            }
          },
          "constituent_id": {
            "description": "The immutable constituent system record ID for the fundraiser associated with the gift.",
            "type": "string"
          }
        },
        "x-hidden": true,
        "x-display-name": "Create gift fundraiser",
        "x-display-id": "CreateGiftFundraiser"
      }
    },
    "gift_splits": {
      "description": "The set of gift splits associated with the gift.",
      "type": "array",
      "items": {
        "description": "Not all gifts serve a single purpose. Gift splits track donor wishes and allow you to divide gifts among multiple campaigns, funds, and appeals.",
        "required": [
          "amount",
          "fund_id"
        ],
        "type": "object",
        "properties": {
          "amount": {
            "description": "The amount of the gift split.",
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "description": "The monetary value.",
                "type": "number"
              }
            }
          },
          "appeal_id": {
            "description": "The immutable system record ID of the appeal associated with the gift split.",
            "type": "string"
          },
          "campaign_id": {
            "description": "The immutable system record ID of the campaign associated with the gift split.",
            "type": "string"
          },
          "fund_id": {
            "description": "The immutable system record ID of the fund associated with the gift split.",
            "type": "string"
          },
          "package_id": {
            "description": "The immutable system record ID of the package associated with the gift split.",
            "type": "string"
          }
        },
        "x-hidden": true,
        "x-display-name": "Create gift split",
        "x-display-id": "CreateGiftSplit"
      }
    },
    "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>",
      "type": "string"
    },
    "type": {
      "description": "The gift type. Available values <a href=\"#GiftTypes\">are listed below</a>, but at this time, you can only add gifts with the \"Donation\", \"RecurringGift\", and \"RecurringGiftPayment\" type.",
      "type": "string"
    },
    "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"
    },
    "linked_gifts": {
      "description": "Currently the linked recurring gift for recurring gift payments, but in the future will support multiple gifts that are linked to any commitment-type gift.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "lookup_id": {
      "description": "The user-defined identifier for the gift. Character limit: 50.",
      "maxLength": 50,
      "minLength": 0,
      "type": "string"
    },
    "origin": {
      "description": "The origin of the gift.\r\nWhen provided, it must parse to a valid JSON object with one string field called \"name\". Additional fields may be added as desired.",
      "type": "string"
    },
    "payments": {
      "description": "The payments on the gift.",
      "type": "array",
      "items": {
        "description": "Donors can use a variety of methods — such as Cash, Personal check, Credit card, and Direct debit — to pay for gifts.",
        "required": [
          "payment_method"
        ],
        "type": "object",
        "properties": {
          "account_token": {
            "description": "The account token. Must parse to a valid, non-empty GUID. Only applies to payment methods of \"CreditCard\" and \"DirectDebit\".",
            "type": "string"
          },
          "bbps_configuration_id": {
            "description": "The bbps configuration ID. Must parse to a valid, non-empty GUID. Only applies to payment methods of \"CreditCard\" and \"DirectDebit\".",
            "type": "string"
          },
          "bbps_transaction_id": {
            "description": "The bbps transaction ID. Must parse to a valid, non-empty GUID. Only applies to payment methods of \"CreditCard\" and \"DirectDebit\".",
            "type": "string"
          },
          "check_date": {
            "description": "The check date. Only applies to payment method of \"PersonalCheck\".",
            "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"
          },
          "check_number": {
            "description": "The check number. Only applies to payment method of \"PersonalCheck\". Character limit: 20.",
            "maxLength": 20,
            "minLength": 0,
            "type": "string"
          },
          "checkout_transaction_id": {
            "description": "The checkout transaction ID. Must parse to a valid, non-empty GUID. Only applies to payment methods of \"CreditCard\" and \"DirectDebit\".",
            "type": "string"
          },
          "charge_transaction": {
            "description": "Whether or not to charge the checkout transaction. Only applies when a \"CheckoutTransactionId\" is supplied.",
            "type": "boolean"
          },
          "payment_method": {
            "description": "The payment method. Available values <a href=\"#PaymentMethods\">are listed below</a>.",
            "type": "string"
          },
          "reason": {
            "description": "Optional. The Reason Code for this payment. Available values are \"Approved\", \"HardReject\", \"Held\", \"SoftReject\".",
            "type": "string"
          },
          "reference": {
            "description": "The reference. Only applies to payment method of \"Other\".",
            "type": "string"
          },
          "reference_date": {
            "description": "The reference date. Only applies to payment method of \"Other\".",
            "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"
          },
          "rejection_details": {
            "description": "The detail for why a payment was rejected. Generally comes from the gateway. This value will be ignored if reason is not set to \"HardReject\", \"Held\", or \"SoftReject\".",
            "type": "string"
          }
        },
        "x-hidden": true,
        "x-display-name": "Create payment",
        "x-display-id": "CreatePayment",
        "x-additional-info": "<a name=\"PaymentMethods\"></a>\r\n<p>&nbsp;</p>\r\n<p>\r\n    Available values for the <b>payment_method</b> of a <b>payment</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>Cash</td>\r\n                <td>Cash.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>PersonalCheck</td>\r\n                <td>A personal check.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>CreditCard</td>\r\n                <td>A credit card.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>StandingOrder</td>\r\n                <td>A standing order.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>DirectDebit</td>\r\n                <td>Direct debit.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>Voucher</td>\r\n                <td>A voucher.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>Other</td>\r\n                <td>Another method of payment.</td>\r\n            </tr>\r\n        </tbody>\r\n    </table>\r\n</div>"
      }
    },
    "post_date": {
      "format": "date-time",
      "description": "The date that the gift was posted to general ledger. 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
    },
    "post_status": {
      "description": "The general ledger post status of the gift. Available values are <i>Posted</i>, <i>NotPosted</i>, and <i>DoNotPost.</i>\r\nWhen <code>post_status</code> is set to <i>DoNotPost</i>, <code>post_date</code> should be null.\r\nWhen it is set to <i>NotPosted</i>, <code>post_date</code> is required but remains editable.\r\nWhen it is set to <i>Posted</i>, <code>post_date</code> is required and is no longer editable.\r\nIf no value is provided, a default value of <i>NotPosted</i> will be used.",
      "type": "string"
    },
    "receipts": {
      "description": "The set of receipts associated with the gift.\r\nIf none are provided, an empty receipt with a status of <i>NEEDSRECEIPT</i> will be added alongside the gift.",
      "type": "array",
      "items": {
        "description": "An object that represents the gift receipt to create.\r\nTo help donors track their giving for tax purposes, your organization should provide gift receipts.",
        "type": "object",
        "properties": {
          "amount": {
            "description": "The monetary amount of the receipt to associate with the gift.",
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "description": "The monetary value.",
                "type": "number"
              }
            }
          },
          "date": {
            "format": "date-time",
            "description": "The date that the gift was receipted. 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
          },
          "status": {
            "description": "The receipt status of the gift. Available values are <i>RECEIPTED</i>, <i>NEEDSRECEIPT</i>, and <i>DONOTRECEIPT.</i>\r\nWhen <code>receipt_status</code> is set to <i>DONOTRECEIPT</i>, <code>receipt_date</code> should be null.\r\nWhen it is set to <i>NEEDSRECEIPT</i>, <code>receipt_date</code> is required but remains editable.\r\nWhen it is set to <i>RECEIPTED</i>, <code>receipt_date</code> is required and is no longer editable.\r\nIf no value is provided, a default value of <i>NEEDSRECEIPT</i> will be used.",
            "type": "string"
          }
        },
        "x-hidden": true,
        "x-display-name": "Create gift receipt",
        "x-display-id": "CreateGiftReceipt"
      }
    },
    "recurring_gift_schedule": {
      "description": "The recurring gift schedule.",
      "required": [
        "frequency",
        "start_date"
      ],
      "type": "object",
      "properties": {
        "end_date": {
          "format": "date-time",
          "description": "Date the recurring gift should end. Uses <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
        },
        "frequency": {
          "description": "Installment frequency of the recurring gift to add. Available values are WEEKLY, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONTHLY, QUARTERLY, ANNUALLY.",
          "type": "string"
        },
        "start_date": {
          "format": "date-time",
          "description": "Date the recurring gift should start. Uses <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
        }
      },
      "x-hidden": true,
      "x-display-name": "Recurring gift schedule",
      "x-display-id": "RecurringGiftSchedule_01"
    },
    "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"
    },
    "soft_credits": {
      "description": "The set of soft credits associated with the gift.",
      "type": "array",
      "items": {
        "description": "Soft credits allow you to recognize and track the indirect contributions of constituents such as spouses who influence the gifts of other constituents.",
        "required": [
          "amount",
          "constituent_id"
        ],
        "type": "object",
        "properties": {
          "amount": {
            "description": "The amount of the soft credit.",
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "description": "The monetary value.",
                "type": "number"
              }
            }
          },
          "constituent_id": {
            "description": "The immutable system record ID of the constituent associated with the soft credit.",
            "type": "string"
          }
        },
        "x-hidden": true,
        "x-display-name": "Create soft credit",
        "x-display-id": "CreateSoftCredit"
      }
    },
    "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"
    }
  },
  "example": {
    "amount": {
      "value": 100
    },
    "constituent_id": "280",
    "date": "2017-10-03T00:00:00Z",
    "fundraisers": [
      {
        "amount": {
          "value": 100
        },
        "constituent_id": "252"
      }
    ],
    "gift_splits": [
      {
        "amount": {
          "value": 100
        },
        "appeal_id": "15",
        "campaign_id": "1",
        "fund_id": "41"
      }
    ],
    "gift_status": "Active",
    "is_anonymous": false,
    "lookup_id": "2225",
    "payments": [
      {
        "payment_method": "Cash"
      }
    ],
    "post_date": "2017-10-03T00:00:00Z",
    "post_status": "NotPosted",
    "reference": "newly added gift",
    "soft_credits": [
      {
        "amount": {
          "value": 100
        },
        "constituent_id": "187"
      }
    ],
    "subtype": "Annuity",
    "type": "Donation"
  },
  "x-hidden": true,
  "x-display-name": "Create gift",
  "x-display-id": "CreateGift",
  "x-additional-info": "<a name=\"GiftTypes\"></a>\r\n<p>&nbsp;</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>"
}

Response 200 OK

Returned when the operation successfully creates a gift. The response body contains the ID of the new gift.

{
  "id": "1281"
}
{
  "description": "Defines the shape of a post response object.",
  "type": "object",
  "properties": {
    "id": {
      "description": "The newly created ID",
      "type": "string"
    }
  },
  "x-hidden": true
}

Response 400 Bad Request

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

Response 403 Forbidden

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

Code samples

@ECHO OFF

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


            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/gift/v1/gifts?" + $.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/gift/v1/gifts";
    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/gift/v1/gifts');
$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", "/gift/v1/gifts?%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", "/gift/v1/gifts?%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')

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!