Private Group Events (Live September 23, 2024)
Level of Effort: Low
Backwards compatible.
Why Should I Make the Update?
 Support your CSR admins in finding opportunities that support private groups! Make it easy to find and organize a corporate group event.
Private Group Opps is intended to function as a directory to support your CSR admins and other individuals in their ability to find organizations that offer private group events. The actual event sign-up should take place in your system.
How to Make the Update
Add a Filter: Implement a UI selection that adds
greatFor: [privateGroups]
to yoursearchOpportunities
call.Display the Field: If the
greatFor
field includesprivateGroups
, display this on your opportunity detail page.
Private Groups Information Included in the API:
privateGroup
Object Detaillocations:
Options:
virutal
orgLocation: at one of the organization’s locations
volGroupLocation: at a location chosen by the volunteer e.g. a park or an office
privateGroupSignupType
: Tells you whether individuals and private groups can connect with this opportunity, or if only private groups can connect with this opportunityOptions: availableToAll, privateGroupsOnly
donation:
Whether there is a required, optional or no donation needed for this private group event.Options: noDonation, required, optional
donationDetail
: open text notes from the organization regarding details about a donation for a private group event
Opportunities Suited Only for Private Groups
To prevent individuals connecting with opportunities specified for private groups only, opportunities that are open to private groups only - and not to individuals look to volunteer by themselves - will not initially be sent over the API. You can add in this opportunities by changing includePrivateGroupsOnly
to true.
We recommend you add a tag for these opportunities to let potential volunteers know that these opportunities are only suited for private groups. Below is an example tag.
Â
Â
Example Call and Return
query {
searchOpportunities(input:{
location:"US"
includePrivateGroupsOnly: true
greatFor: [privateGroups]
}){
currentPage
resultsSize
opportunities {
id
greatFor
privateGroup{locations, donationDetail, privateGroupSignupType, donation}
}
}
}