Update a Volunteer Opportunity

PUT

/api/VolunteerOpportunity/:volunteerOpportunityId

PUT

/api/VolunteerOpportunity/:volunteerOpportunityId

curl -X PUT https://api.virtuoussoftware.com/api/VolunteerOpportunity/volunteerOpportunityId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "<string>",
  "startDateTime": "<dateTime>",
  "endDateTime": "<dateTime>",
  "timeZone": "<string>",
  "preferredNumberOfHours": "<double>",
  "projectId": "<integer>",
  "locationName": "<string>",
  "description": "<string>",
  "isActive": "<boolean>",
  "isLocalOnly": "<boolean>",
  "address1": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "postal": "<string>",
  "country": "<string>",
  "preferredDateTime": "<dateTime>",
  "currentPriority": "<string>",
  "currentNeed": "<integer>",
  "customFields": [
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    },
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    }
  ]
}'

{
  "id": "<integer>",
  "volunteerOpportunityUrl": "<string>",
  "name": "<string>",
  "locationName": "<string>",
  "displayAddress": "<string>",
  "startDateTime": "<string>",
  "endDateTime": "<string>",
  "preferredDateTime": "<string>",
  "timeZone": "<string>",
  "description": "<string>",
  "createDateTimeUtc": "<dateTime>",
  "createdByUser": "<string>",
  "modifiedDateTimeUtc": "<dateTime>",
  "modifiedByUser": "<string>",
  "isActive": "<boolean>",
  "isLocalOnly": "<boolean>",
  "preferredNumberOfHours": "<double>",
  "projectId": "<integer>",
  "totalVolunteers": "<integer>",
  "totalVolunteerHours": "<double>",
  "volunteerOrganizers": [
    {
      "id": "<integer>",
      "volunteerOrganizerUrl": "<string>",
      "contactId": "<integer>",
      "displayName": "<string>",
      "firstName": "<string>",
      "avatarUrl": "<string>",
      "primaryPhone": "<string>",
      "primaryEmail": "<string>",
      "contactUrl": "<string>",
      "volunteerOpportunityUrl": "<string>"
    },
    {
      "id": "<integer>",
      "volunteerOrganizerUrl": "<string>",
      "contactId": "<integer>",
      "displayName": "<string>",
      "firstName": "<string>",
      "avatarUrl": "<string>",
      "primaryPhone": "<string>",
      "primaryEmail": "<string>",
      "contactUrl": "<string>",
      "volunteerOpportunityUrl": "<string>"
    }
  ],
  "currentNeed": "<integer>",
  "currentPriority": "<string>",
  "currentPriorityName": "<string>",
  "currentNeedFilledPercentage": "<double>",
  "hoursFilledPercentage": "<double>",
  "volunteerOrganizersUrl": "<string>",
  "volunteersUrl": "<string>",
  "customFields": [
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    },
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    }
  ]
}

Authentication

AuthorizationBearer

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

Path parameters

volunteerOpportunityIdstringRequired

Request

This endpoint expects an object.

namestringOptional

startDateTimestringOptional

endDateTimestringOptional

timeZonestringOptional

preferredNumberOfHoursstringOptional

projectIdstringOptional

locationNamestringOptional

descriptionstringOptional

isActivestringOptional

isLocalOnlystringOptional

address1stringOptional

address2stringOptional

citystringOptional

statestringOptional

postalstringOptional

countrystringOptional

preferredDateTimestringOptional

currentPrioritystringOptional

currentNeedstringOptional

customFieldslist of objectsOptional

Response

idstringOptional

volunteerOpportunityUrlstringOptional

namestringOptional

locationNamestringOptional

displayAddressstringOptional

startDateTimestringOptional

endDateTimestringOptional

preferredDateTimestringOptional

timeZonestringOptional

descriptionstringOptional

createDateTimeUtcstringOptional

createdByUserstringOptional

modifiedDateTimeUtcstringOptional

modifiedByUserstringOptional

isActivestringOptional

isLocalOnlystringOptional

preferredNumberOfHoursstringOptional

projectIdstringOptional

totalVolunteersstringOptional

totalVolunteerHoursstringOptional

volunteerOrganizerslist of objectsOptional

currentNeedstringOptional

currentPrioritystringOptional

currentPriorityNamestringOptional

currentNeedFilledPercentagestringOptional

hoursFilledPercentagestringOptional

volunteerOrganizersUrlstringOptional

volunteersUrlstringOptional

customFieldslist of objectsOptional

Errors

400

Bad Request Error