Opportunity
This API manages opportunity information and related entities such as opportunity fundraisers, opportunity attachments, and opportunity custom fields.
Request URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| opportunity_id | Property is required | string | The immutable system record ID of the opportunity to edit. |
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 properties of the opportunity to edit.
{
"ask_amount": {
"value": 10000
},
"ask_date": "2002-07-30T00:00:00",
"campaign_id": "6",
"deadline": "2005-05-15T00:00:00",
"expected_amount": {
"value": 10000
},
"expected_date": "2004-05-15T00:00:00",
"fund_id": "12",
"funded_amount": {
"value": 10000
},
"funded_date": "2004-05-15T00:00:00",
"name": "Scholarship Proposal",
"purpose": "Research Endowment"
}{
"description": "Opportunities help you plan and track efforts to build relationships with prospects and secure major gifts. They can manage information about fundraising activities and the effectiveness of your efforts.",
"type": "object",
"properties": {
"ask_amount": {
"description": "The monetary amount solicited from the prospect for the opportunity.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"ask_date": {
"format": "date-time",
"description": "The date when the solicitation was made. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>2015-09-18T16:25:00</i>.",
"type": "string",
"x-supports-datetime-offset": false
},
"campaign_id": {
"description": "The immutable system record ID of the campaign associated with the opportunity. The campaign sets the overall objectives for raising money.",
"type": "string"
},
"deadline": {
"format": "date-time",
"description": "The goal date for the opportunity to result in a gift. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>2015-09-18T16:25:00</i>.",
"type": "string",
"x-supports-datetime-offset": false
},
"expected_amount": {
"description": "The monetary amount that is realistically expected to result from the opportunity.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"expected_date": {
"format": "date-time",
"description": "The date when the prospect is expected to give in response to the opportunity. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>2015-09-18T16:25:00</i>.",
"type": "string",
"x-supports-datetime-offset": false
},
"fund_id": {
"description": "The immutable system record ID of the fund associated with the opportunity. The fund designates the specific financial purpose of a gift and identifies the financial account for that gift.",
"type": "string"
},
"funded_amount": {
"description": "The monetary amount that the prospect gave in response to the opportunity.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
},
"funded_date": {
"format": "date-time",
"description": "The date when the prospect gave in response to the opportunity. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>2015-09-18T16:25:00</i>.",
"type": "string",
"x-supports-datetime-offset": false
},
"fundraisers": {
"description": "The set of immutable constituent system record IDs for the fundraisers assigned to the opportunity.",
"type": "array",
"items": {
"description": "Fundraiser constituents interact with other constituents and prospects on behalf of your organization to cultivate relationships and advance opportunities to secure major gifts. When the target constituent fulfills an opportunity ask, the fundraiser can receive credit to track performance and foster fundraising accomplishments.",
"type": "object",
"properties": {
"constituent_id": {
"description": "The immutable system record ID of the constituent associated with the fundraiser.",
"type": "string"
},
"credit_amount": {
"description": "The amount credited to the fundraiser for the opportunity.",
"type": "object",
"properties": {
"value": {
"format": "double",
"description": "The monetary value.",
"type": "number"
}
}
}
},
"x-display-name": "Opportunity fundraiser",
"x-display-id": "OpportunityFundraiser"
}
},
"inactive": {
"description": "Indicates whether the opportunity is inactive.",
"type": "boolean"
},
"name": {
"description": "The name that identifies the opportunity throughout the program, such as in lists or on constituent records. Character limit: 255. This property cannot be set to null.",
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"purpose": {
"description": "The intended use for any money raised as a result of the opportunity. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/58e3b2597c1af25c58b9c4e3/operations/ListOpportunityPurposes\"><b>Purposes</b></a> table. This property cannot be set to null.",
"type": "string"
},
"status": {
"description": "The status that indicates where the opportunity is in the solicitation process. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/58e3b2597c1af25c58b9c4e3/operations/ListOpportunityStatuses\"><b>Proposal Status</b></a> table.",
"type": "string"
}
},
"example": {
"ask_amount": {
"value": 10000
},
"ask_date": "2002-07-30T00:00:00Z",
"campaign_id": "6",
"deadline": "2005-05-15T00:00:00Z",
"expected_amount": {
"value": 10000
},
"expected_date": "2004-05-15T00:00:00Z",
"fund_id": "12",
"funded_amount": {
"value": 10000
},
"funded_date": "2004-05-15T00:00:00Z",
"name": "Scholarship Proposal",
"purpose": "Research Endowment"
},
"x-hidden": true,
"x-display-name": "Edit opportunity",
"x-display-id": "EditOpportunity"
}Response 200 OK
Returned when the operation successfully edits the opportunity.
Response 400 Bad Request
Returned when the specified opportunity ID in the request URL body or the specified request parameters are not in the appropriate format.
Response 403 Forbidden
Returned when the user does not have permission to edit the opportunity.
Response 404 Not Found
Returned when the specified opportunity is not found.
Code samples
@ECHO OFF
curl -v -X PATCH "https://api.sky.blackbaud.com/opportunity/v1/opportunities/{opportunity_id}"
-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/opportunity/v1/opportunities/{opportunity_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/opportunity/v1/opportunities/{opportunity_id}");
URI uri = builder.build();
HttpPatch request = new HttpPatch(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/opportunity/v1/opportunities/{opportunity_id}?" + $.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: "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/opportunity/v1/opportunities/{opportunity_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:@"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/opportunity/v1/opportunities/{opportunity_id}');
$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_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
'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", "/opportunity/v1/opportunities/{opportunity_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
'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", "/opportunity/v1/opportunities/{opportunity_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/opportunity/v1/opportunities/{opportunity_id}')
request = Net::HTTP::Patch.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