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
VolunteerName | 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": "5a1d190c-05b9-4bb4-9f2d-ac1c9f99a90b", "ContactKey": "90ca30bd-3d08-4145-8e3e-7860ab019c64", "VolunteerOpportunityTravelKey": "0b25eac3-3244-437e-ab84-0c6e98e15ae5", "Bio": "sample string 4", "StartOn": "2025-02-08T10:18:19.4671315Z", "EndOn": "2025-02-08T10:18:19.4671315Z", "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>90ca30bd-3d08-4145-8e3e-7860ab019c64</ContactKey> <EndOn>2025-02-08T05:18:19.4671315-05:00</EndOn> <StartOn>2025-02-08T05:18:19.4671315-05:00</StartOn> <VolunteerExperienceLevel> <ExperienceLevel>sample string 1</ExperienceLevel> <HourlyRate>1</HourlyRate> <SkillsMultiplier>2</SkillsMultiplier> </VolunteerExperienceLevel> <VolunteerKey>5a1d190c-05b9-4bb4-9f2d-ac1c9f99a90b</VolunteerKey> <VolunteerOpportunityTravel> <Description>sample string 1</Description> <Distance>2</Distance> </VolunteerOpportunityTravel> <VolunteerOpportunityTravelKey>0b25eac3-3244-437e-ab84-0c6e98e15ae5</VolunteerOpportunityTravelKey> </Volunteer>