Opportunity (Beta) Entity Reference

Updated: May 9, 2017

This topic describes the entity and type representations for common items that the Opportunity API uses. To learn about how to set up your developer account and work with the SKY API, see the Getting Started guide.

 

Opportunity

The opportunity entity has the following properties:

Property Type Description
id string The opportunity identifier.
constituent_id string The constituent identifier of the prospect associated with the opportunity.
name string The name that identifies the opportunity throughout the program, such as in lists or on constituent records.
purpose string The intended use for any money raised as a result of the opportunity.
status string The status that indicates where the opportunity is in the solicitation process.
deadline dateTime The goal date for the opportunity to result in a gift. Uses ISO-8601 format: 2015-09-18T16:25:00.
ask_date dateTime The date when the solicitation was made. Uses ISO-8601 format: 2015-09-18T16:25:00.
ask_amount currency The monetary amount solicited from the prospect for the opportunity.
expected_date dateTime The date when the prospect is expected to give in response to the opportunity. Uses ISO-8601 format: 2015-09-18T16:25:00.
expected_amount currency The monetary amount that is realistically expected to result from the opportunity.
funded_date dateTime The date when the prospect gave in response to the opportunity. Uses ISO-8601 format: 2015-09-18T16:25:00.
funded_amount currency The monetary amount that the prospect gave in response to the opportunity.
campaign_id string The identifier of the campaign associated with the opportunity. The campaign sets the overall objectives for raising money.
fund_id string 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.
fundraisers array of opportunity fundraiser The fundraisers assigned to the opportunity.
linked_gifts array of string The identifiers of the gifts related to the opportunity.
inactive boolean Indicates whether the opportunity is inactive.
date_added dateTime The date when the opportunity was created. Includes an offset from UTC in ISO-8601 format: 1969-11-21T10:29:43-04:00.
date_modified dateTime The date when the opportunity was last modified. Includes an offset from UTC in ISO-8601 format: 1969-11-21T10:29:43-04:00.

 

Opportunity attachment

The opportunity attachment entity has the following properties:

Property Type Description
id string The opportunity attachment identifier.
parent_id string The parent object's identifier.
tags array of string The tags associated with the attachment. Tags supplement the attachment’s name and description and identify it based on how an organization categorizes attachments. Available values are the entries in the Document Tags table.
name string The name of the attachment.
type string The attachment type. Available values are physical and link. Physical attachments are uploaded files such as images, PDFs, or Word documents that are saved locally or on the network. They are stored and managed in the system. Link attachments are links to files such as images, blog posts, or YouTube videos that are online or in a cloud storage account. They are stored and managed externally. At this time, only link attachments can be created through the API.
url string The URL for the attachment. The URL for a physical gift attachment contains a time-bound signature that limits access to 60 minutes.
content_type string The content type. Only applies to physical attachments.
file_name string The file name. Only applies to physical attachments.
file_size long The file size in bytes. Only applies to physical attachments.
thumbnail_url string The URL for a thumbnail. Only applies to physical attachments that are images. Contains a time-bound signature that limits access to 60 minutes.

 

Opportunity fundraiser

The opportunity fundraiser entity has the following properties:

Property Type Description
constituent_id string The constituent identifier of the fundraiser.
credit_amount currency The amount credited to the fundraiser for the opportunity.