VolunteerInitiative
Represents all volunteer activities within a single volunteering
initiative. This object is available in API version 64.0 and later.
Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Special Access Rules
This object is available only if the VolunteerManagementPsl permission set license is enabled and the Manage Volunteer Data permission is assigned to users.
Fields
AttendanceRate
- Type: percent
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The percentage of volunteers who've fulfilled their commitments to the volunteer initiative up to and including today's date.
Description
- Type: textarea
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The description of the volunteer initiative.
EndDate
- Type: date
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The end date of the volunteer initiative.
FilledAssignmentCount
- Type: int
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The total number of filled volunteer position assignments.
IsPublished
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: Determines whether the volunteer initiative is accessible in Experience Cloud.
- Default value: false
LastReferencedDate
- Type: dateTime
- Properties: Filter, Nillable, Sort
- Description: The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
- Type: dateTime
- Properties: Filter, Nillable, Sort
- Description: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.
Name
- Type: Text
- Properties: Create, Filter, Group, idLookup, Sort, Update
- Description: The name of the volunteer initiative.
OpenAssignmentCount
- Type: int
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The total number of available volunteer position assignments.
OwnerId
- Type: reference
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
-
Description: ID of the owner of this object. ID of the creator of this
object.
This field is a polymorphic relationship field.
- Relationship Name: Owner
- Refers To: Group, User
ParentVolunteerInitiativeId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The lookup to the parent volunteer initiative.
This field is a relationship field.
- Relationship Name: ParentVolunteerInitiative
- Refers To: VolunteerInitiative
StartDate
- Type: date
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The start date of the volunteer initiative.
Status
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The status of the volunteer initiative.
-
Possible values:
- Archived
- Canceled
- Complete
- In Progress
- Postponed
- Upcoming
TotalActiveVolunteerCount
- Type: int
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The total number of unique, active volunteers for this initiative who have completed the hours eligibility and have PositionAssignment statuses in the configured MaxAttendee eligibility list.
TotalAssignmentCount
- Type: int
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The total number of open volunteer position assignments plus the number of filled volunteer position assignments.
TotalVolunteerHours
- Type: int
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The total number of hours that were volunteered during this initiative.
Associated Objects
This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as VolunteerInitiative. Otherwise, they're available in the specified API version and later.
- VolunteerInitiativeHistory
- History is available for tracked fields of the object.
- VolunteerInitiativeOwnerSharingRule
- Sharing rules are available for the object.
- VolunteerInitiativeShare
- Sharing is available for the object.