Skip to main content
POST
Create a Volunteer Opportunity

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string

The display name of the record.

startDateTime
string
endDateTime
string
timeZone
string
preferredNumberOfHours
string
projectId
string

The identifier of the project this record is designated to.

locationName
string
description
string

A free-text description of the record.

isActive
string

When true, the record is active and available for use.

isLocalOnly
string
address1
string

The first line of the street address.

address2
string

The second line of the street address.

city
string

The city of the address.

state
string

The state or province of the address.

postal
string

The postal or ZIP code of the address.

country
string

The country of the address.

preferredDateTime
string
currentPriority
string
currentNeed
string
customFields
object[]

Custom field values to set on the record. Field names must match custom fields configured for the organization.

Response

OK

id
string

The unique identifier of the record in Virtuous.

volunteerOpportunityUrl
string
name
string

The display name of the record.

locationName
string
displayAddress
string
startDateTime
string
endDateTime
string
preferredDateTime
string
timeZone
string
description
string

The free-text description stored on the record.

createDateTimeUtc
string

The UTC date and time the record was created.

createdByUser
string

The name of the user who created the record.

modifiedDateTimeUtc
string

The UTC date and time the record was last modified.

modifiedByUser
string

The name of the user who last modified the record.

isActive
string
isLocalOnly
string
preferredNumberOfHours
string
projectId
string

The identifier of the project this record is designated to.

totalVolunteers
string
totalVolunteerHours
string
volunteerOrganizers
object[]
currentNeed
string
currentPriority
string
currentPriorityName
string
currentNeedFilledPercentage
string
hoursFilledPercentage
string
volunteerOrganizersUrl
string
volunteersUrl
string
customFields
object[]

The custom field values stored on the record.

Last modified on August 11, 2026