POST api/v2.0/Volunteer/AddToPoolByContactKey?contactKey={contactKey}

Add a new user to the General Volunteer Pool. Can only be accessed by an Admin user.

Request Information

URI Parameters

Name	Description	Type	Additional information
contactKey	ContactKey of the user to add to the Volunteer Pool.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Volunteer

Name	Description	Type	Additional information
VolunteerKey	The Unique Identifier for a Volunteer.	globally unique identifier	None.
ContactKey	The Unique Identifier for the Contact associated with this Volunteer record.	globally unique identifier	None.
VolunteerOpportunityTravelKey	The Unique Identifier for the Travel Information for this Volunteer record.	globally unique identifier	None.
Bio	Volunteer Biography information.	string	None.
StartOn	Volunteer availability start date.	date	None.
EndOn	Volunteer availability end date.	date	None.
VolunteerExperienceLevel	Level of Volunteer Experience.	VolunteerExperienceLevel	None.
VolunteerOpportunityTravel	Volunteer Travel preferences.	VolunteerOpportunityTravel	None.

Response Formats

application/json, text/json

Sample:

{
  "VolunteerKey": "1213ce87-0fd5-4b3b-a91c-48598fa24416",
  "ContactKey": "a264ddd1-f73e-4d02-9e9c-4086ff427282",
  "VolunteerOpportunityTravelKey": "ae78d477-d036-4671-b4f7-fcdd072f21ef",
  "Bio": "sample string 4",
  "StartOn": "2025-05-13T01:12:48.5951843Z",
  "EndOn": "2025-05-13T01:12:48.5951843Z",
  "VolunteerExperienceLevel": {
    "ExperienceLevel": "sample string 1",
    "SkillsMultiplier": 2.0,
    "HourlyRate": 1.0
  },
  "VolunteerOpportunityTravel": {
    "Description": "sample string 1",
    "Distance": 2
  }
}

application/xml, text/xml

Sample:

<Volunteer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Volunteer">
  <Bio>sample string 4</Bio>
  <ContactKey>a264ddd1-f73e-4d02-9e9c-4086ff427282</ContactKey>
  <EndOn>2025-05-12T21:12:48.5951843-04:00</EndOn>
  <StartOn>2025-05-12T21:12:48.5951843-04:00</StartOn>
  <VolunteerExperienceLevel>
    <ExperienceLevel>sample string 1</ExperienceLevel>
    <HourlyRate>1</HourlyRate>
    <SkillsMultiplier>2</SkillsMultiplier>
  </VolunteerExperienceLevel>
  <VolunteerKey>1213ce87-0fd5-4b3b-a91c-48598fa24416</VolunteerKey>
  <VolunteerOpportunityTravel>
    <Description>sample string 1</Description>
    <Distance>2</Distance>
  </VolunteerOpportunityTravel>
  <VolunteerOpportunityTravelKey>ae78d477-d036-4671-b4f7-fcdd072f21ef</VolunteerOpportunityTravelKey>
</Volunteer>