Opportunity (Beta)

This API manages opportunity information and related entities such as opportunity fundraisers, opportunity attachments, and opportunity custom fields.

POST Opportunity

Creates an opportunity.

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 opportunity to create.

constituent_idProperty is requiredstringThe constituent identifier of the prospect associated with the opportunity.
nameProperty is requiredstringThe name that identifies the opportunity throughout the program, such as in lists or on constituent records.
purposestringThe intended use for any money raised as a result of the opportunity. Available values are in the Purposes table.
statusstringThe status that indicates where the opportunity is in the solicitation process. Available values are in the Proposal Status table.
deadlinedateTimeThe goal date for the opportunity to result in a gift. Uses ISO-8601 format: 2015-09-18T16:25:00
ask_datedateTimeThe date when the solicitation was made. Uses ISO-8601 format: 2015-09-18T16:25:00.
ask_amountcurrencyThe monetary amount solicited from the prospect for the opportunity.
expected_datedateTimeThe date when the prospect is expected to give in response to the opportunity. Uses ISO-8601 format: 2015-09-18T16:25:00.
expected_amountcurrencyThe monetary amount that is realistically expected to result from the opportunity.
funded_datedateTimeThe date when the prospect gave in response to the opportunity. Uses ISO-8601 format: 2015-09-18T16:25:00.
funded_amountcurrencyThe monetary amount that the prospect gave in response to the opportunity.
campaign_idcampaignThe identifier of the campaign associated with the opportunity. The campaign sets the overall objectives for raising money.
fund_idfundThe identifier 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.
fundraisersarray of opportunity fundraiserThe fundraisers assigned to the opportunity.
inactiveboolIndicates whether the opportunity is inactive.

{
  "constituent_id": "306",
  "name": "Scholarship Proposal",
  "purpose": "Research Endowment",
  "deadline": "2005-05-15T00:00:00",
  "ask_date": "2002-07-30T00:00:00",
  "ask_amount": {
    "value": 10000
  },
  "expected_date": "2004-05-15T00:00:00",
  "expected_amount": {
    "value": 10000
  },
  "funded_date": "2004-05-15T00:00:00",
  "funded_amount": {
    "value": 10000
  },
  "campaign_id": "6",
  "fund_id": "12"
}
{
  "description": "Represents the Opportunity entity",
  "type": "object",
  "properties": {
    "id": {
      "description": "The opportunity identifier.",
      "type": "string"
    },
    "constituent_id": {
      "description": "The constituent identifier of the prospect associated with the opportunity.",
      "type": "string"
    },
    "name": {
      "description": "The name that identifies the opportunity throughout the program, such as in lists or on constituent records.",
      "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/58e3b27ba9db950fa048c8ac\"><b>Purposes</b></a> table.",
      "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/58e3b27ba9db950fa048c8ab\"><b>Proposal Status</b></a> table.",
      "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"
    },
    "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"
    },
    "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"
        }
      }
    },
    "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"
    },
    "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"
        }
      }
    },
    "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"
    },
    "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"
        }
      }
    },
    "campaign_id": {
      "description": "The identifier of the campaign associated with the opportunity. The campaign sets the overall objectives for raising money.",
      "type": "string"
    },
    "fund_id": {
      "description": "The identifier 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"
    },
    "fundraisers": {
      "description": "The fundraisers assigned to the opportunity.",
      "type": "array",
      "items": {
        "description": "Represents the Fundraiser entity",
        "type": "object",
        "properties": {
          "constituent_id": {
            "description": "The constituent identifier of 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"
              }
            }
          }
        }
      }
    },
    "linked_gifts": {
      "description": "The identifiers of the gifts related to the opportunity.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "inactive": {
      "description": "Indicates whether the opportunity is inactive.",
      "type": "boolean"
    },
    "date_added": {
      "format": "date-time",
      "description": "The date when the opportunity 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 opportunity 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": "306",
    "name": "Scholarship Proposal",
    "purpose": "Research Endowment",
    "deadline": "2005-05-15T00:00:00",
    "ask_date": "2002-07-30T00:00:00",
    "ask_amount": {
      "value": 10000
    },
    "expected_date": "2004-05-15T00:00:00",
    "expected_amount": {
      "value": 10000
    },
    "funded_date": "2004-05-15T00:00:00",
    "funded_amount": {
      "value": 10000
    },
    "campaign_id": "6",
    "fund_id": "12"
  },
  "x-hidden": true
}

Response 200

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

{
  "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 opportunity.

Response 404

Returned when the specified constituent is not found.

Code samples

@ECHO OFF

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


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

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