DELETE api/v2.0/Volunteer/WithdrawFromOpportunity?volunteerOpportunityKey={volunteerOpportunityKey}&comments={comments}

Removes the requesting user from a Volunteer Opportunity. If successful, responds with a 204 (no content). If the current user is not currently listed as a Volunteer for the specified Volunteer Opportunity, responds with a 404 (not found).

Request Information

URI Parameters

NameDescriptionTypeAdditional information
volunteerOpportunityKey

globally unique identifier

Required

comments

string

Default value is

Body Parameters

None.

Response Information

Resource Description

VolunteerOpportunity
NameDescriptionTypeAdditional information
VolunteerOpportunityKey

The Unique Identifier for the Volunteer Opportunity.

globally unique identifier

None.

Title

The Title of the Volunteer Opportunity.

string

None.

Description

Descriptions for the Volunteer Opportunity.

string

None.

Deadline

Sign-up deadline for the Volunteer Opportunity.

string

None.

AdditionalRequirements

Additional Volunteer Requirements for this Volunteer Opportunity.

string

None.

Location

Location for the Volunteer Opportunity.

string

None.

VolunteersNeeded

Number of Volunteers needed for this Volunteer Opportunity.

integer

None.

CreatedOn

Date the Volunteer Opportunity was created.

date

None.

CloseDate

Date that registration as a Volunteer Closes.

date

None.

UpdatedOn

Date this Volunteer Opportunity was last updated.

date

None.

EstimatedHours

Estimated Hours required for the Volunteer Opportunity.

decimal number

None.

SkillMultiplier

decimal number

None.

StartDateTime

Date and Time the Volunteer Opportunity begins.

date

None.

EndDateTime

Date and Time the Volunteer Opportunity ends.

date

None.

Community

If the Volunteer Opportunity is linked to a specific Community, this will contain the Community data for that Community.

Community

None.

RequiresApproval

Indicates whether the Volunteer Opportunity requires approval by an administrator. **Note that at this time, only Volunteer Opportunities where this value is FALSE can be Volunteered for via the API.

boolean

None.

Status

Enumeration for the Volunteer Opportunity's Status. May be null. See the Status Object documentation for additional information about possible values.

Status

None.

StatusText

The Volunteer Opportunity's Status.

string

None.

CanSignUpViaApi

Tells whether a user can Volunteer for this Opportunity via the API.

boolean

None.

ApplicationStatus

The status of the Volunteer Opportunity Application/Sign-up for the current user.

VolunteerApplicationStatuses

None.

ApplicationStatusText

The Application Status text.

string

None.

VolunteerOpportunityTypeKey

Indicates the opportunity type that the Volunteer Opportunity is associated with

globally unique identifier

None.

LinkToListOfOpportunities

Link to reach the volunteer opportunities page

string

None.

PictureUrl

Thumbnail image src associated to Volunteer Opportunity

string

None.

LinkToOpportunity

Link to reach the specific Volunteer Opportunity

string

None.

OpportunityName

Name of the Volunteer Opportunity

string

None.

OpportunityAddress

Exact Address for the Volunteer Opportunity

string

None.

VolunteerSpotsAvailable

The number of volunteer spots that are left for the Volunteer Opportunity

integer

None.

Points

The total points that will be awarded to the Volunteer for the Volunteer Opportunity

integer

None.

VolunteerOpportunityIntegrationCode

The unique AMS code for this Volunteer Opportunity

string

None.

Response Formats

application/json, text/json

Sample:
{
  "VolunteerOpportunityKey": "8ab5cff4-4825-4b8e-ba00-44e1c2bf7e06",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "Deadline": "sample string 4",
  "AdditionalRequirements": "sample string 5",
  "Location": "sample string 6",
  "VolunteersNeeded": 7,
  "CreatedOn": "2019-05-25T20:04:56.4846438Z",
  "CloseDate": "2019-05-25T20:04:56.4846438Z",
  "UpdatedOn": "2019-05-25T20:04:56.4846438Z",
  "EstimatedHours": 11.0,
  "SkillMultiplier": 12.0,
  "StartDateTime": "2019-05-25T20:04:56.4846438Z",
  "EndDateTime": "2019-05-25T20:04:56.4846438Z",
  "Community": {
    "AllowMemberCreatedEvents": true,
    "AllowTickets": true,
    "CanMembersInviteOthers": true,
    "CommunityKey": "0a9275fd-c363-40f1-8260-d626d9bfea85",
    "LegacyGroupKey": "sample string 5",
    "CommunityName": "sample string 6",
    "CommunitySize": 7,
    "CommunityType": "sample string 8",
    "CommunityTypeKey": "a4f92bc5-d7c5-40f3-8969-46a417346369",
    "CommunityTypeName": "sample string 10",
    "CreatedByContactKey": "ac4c8846-45e0-4c55-b63a-b47453d13ee1",
    "CreatedOn": "2019-05-25T20:04:56.4846438Z",
    "Description": "sample string 13",
    "Html": "sample string 14",
    "IsSubscribedToDiscussion": true,
    "IsOnCommunitySync": true,
    "JoinPermissionKey": "8053e1e1-a7f2-4ecf-8096-5dbc8714fe21",
    "LibraryKey": "22951867-6798-4831-8e60-7dab58ef7bb3",
    "LibraryName": "sample string 19",
    "LinkToCommunity": "sample string 20",
    "LinkToCommunityCalendar": "sample string 21",
    "LinkToDiscussion": "sample string 22",
    "LinkToLibrary": "sample string 23",
    "LinkToWebsite": "sample string 24",
    "DiscussionKey": "a5c0ff29-0799-4b6c-89eb-52db56cc078c",
    "DiscussionName": "sample string 26",
    "MicrositeGroupKey": "666352a2-6e71-4e61-a9bd-952ad4e2c760",
    "SiteName": "sample string 28",
    "ViewPermissionKey": "a1bf3353-b94c-433a-9879-37ae047ce242",
    "Statistics": {
      "BlogCount": 1,
      "DocumentCount": 2,
      "MemberCount": 3,
      "DiscussionPostCount": 4,
      "CurrentYearAnnouncementCount": 5,
      "CurrentYearEventCount": 6,
      "LastDocumentUpdatedDate": "2019-05-25T20:04:56.4846438Z",
      "LastMemberJoinedDate": "2019-05-25T20:04:56.4846438Z",
      "LastPostingDate": "2019-05-25T20:04:56.4846438Z",
      "LastBlogPublishedDate": "2019-05-25T20:04:56.4846438Z",
      "LastAnnouncementUpdatedOnDate": "2019-05-25T20:04:56.4846438Z",
      "LastEventUpdatedOnDate": "2019-05-25T20:04:56.4846438Z",
      "MaxActivityDate": "2019-05-25T20:04:56.4846438Z",
      "MinActivityDate": "2019-05-25T20:04:56.4846438Z"
    },
    "CreatedByContact": {
      "LinkToProfile": "sample string 1",
      "PictureUrl": "sample string 2",
      "ContactKey": "28932053-154d-4189-ae52-8ad14b89229b",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "DisplayName": "sample string 6",
      "EmailAddress": "sample string 7",
      "ContactStatusCode": "sample string 8",
      "PrefixCode": "sample string 9",
      "UpdatedOn": "2019-05-25T20:04:56.4846438Z",
      "UpdatedByContactKey": "15523e41-10f2-407c-894b-1d73845b77d4",
      "CompanyName": "sample string 12",
      "CompanyTitle": "sample string 13",
      "SuffixCode": "sample string 14",
      "Designation": "sample string 15",
      "LegacyContactKey": "sample string 16",
      "InformalName": "sample string 17",
      "MiddleName": "sample string 18",
      "IsCompany": true,
      "CompanyLegacyContactKey": "sample string 20",
      "AMSDirectoryOptOut": true,
      "HLDirectoryOptOut": true,
      "HLContactMeOptOut": true,
      "LargePictureUrl": "sample string 24",
      "AgreedToTermsDateTime": "2019-05-25T20:04:56.4846438Z"
    },
    "IntegrationKey": "sample string 30",
    "IntegrationTypeKey": "sample string 31",
    "ParentCommunityKey": "3bbd676f-507f-4ce7-9850-914a79c35e52"
  },
  "RequiresApproval": true,
  "Status": 0,
  "StatusText": "sample string 16",
  "CanSignUpViaApi": true,
  "ApplicationStatus": 0,
  "ApplicationStatusText": "sample string 18",
  "VolunteerOpportunityTypeKey": "56ae22af-490a-45ab-a591-50c2b93a9869",
  "LinkToListOfOpportunities": "sample string 20",
  "PictureUrl": "sample string 21",
  "LinkToOpportunity": "sample string 22",
  "OpportunityName": "sample string 23",
  "OpportunityAddress": "sample string 24",
  "VolunteerSpotsAvailable": 25,
  "Points": 26,
  "VolunteerOpportunityIntegrationCode": "sample string 27"
}

application/xml, text/xml

Sample:
<VolunteerOpportunity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Volunteer">
  <AdditionalRequirements>sample string 5</AdditionalRequirements>
  <ApplicationStatusText>sample string 18</ApplicationStatusText>
  <CloseDate>2019-05-25T16:04:56.4846438-04:00</CloseDate>
  <CreatedOn>2019-05-25T16:04:56.4846438-04:00</CreatedOn>
  <Deadline>sample string 4</Deadline>
  <Description>sample string 3</Description>
  <EndDateTime>2019-05-25T16:04:56.4846438-04:00</EndDateTime>
  <EstimatedHours>11</EstimatedHours>
  <LinkToListOfOpportunities>sample string 20</LinkToListOfOpportunities>
  <LinkToOpportunity>sample string 22</LinkToOpportunity>
  <Location>sample string 6</Location>
  <OpportunityAddress>sample string 24</OpportunityAddress>
  <OpportunityName>sample string 23</OpportunityName>
  <PictureUrl>sample string 21</PictureUrl>
  <Points>26</Points>
  <RequiresApproval>true</RequiresApproval>
  <SkillMultiplier>12</SkillMultiplier>
  <StartDateTime>2019-05-25T16:04:56.4846438-04:00</StartDateTime>
  <StatusText>sample string 16</StatusText>
  <Title>sample string 2</Title>
  <UpdatedOn>2019-05-25T16:04:56.4846438-04:00</UpdatedOn>
  <VolunteerOpportunityKey>8ab5cff4-4825-4b8e-ba00-44e1c2bf7e06</VolunteerOpportunityKey>
  <VolunteerOpportunityTypeKey>56ae22af-490a-45ab-a591-50c2b93a9869</VolunteerOpportunityTypeKey>
  <VolunteerSpotsAvailable>25</VolunteerSpotsAvailable>
  <VolunteersNeeded>7</VolunteersNeeded>
</VolunteerOpportunity>