> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://virtuous.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://virtuous.ferndocs.com/_mcp/server.

# Create a Volunteer Opportunity

POST https://api.virtuoussoftware.com/api/VolunteerOpportunity
Content-Type: application/json

Reference: https://virtuous.ferndocs.com/reference/crm-plus/volunteering/create-a-volunteer-opportunity

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api.virtuoussoftware.com` (https://api.virtuoussoftware.com, default)
- `{{baseUrl}}api` ({{baseUrl}}api)

## Request

### Body (application/json)

This endpoint expects an object.

- `name` (string, optional)
- `startDateTime` (string, optional)
- `endDateTime` (string, optional)
- `timeZone` (string, optional)
- `preferredNumberOfHours` (string, optional)
- `projectId` (string, optional)
- `locationName` (string, optional)
- `description` (string, optional)
- `isActive` (string, optional)
- `isLocalOnly` (string, optional)
- `address1` (string, optional)
- `address2` (string, optional)
- `city` (string, optional)
- `state` (string, optional)
- `postal` (string, optional)
- `country` (string, optional)
- `preferredDateTime` (string, optional)
- `currentPriority` (string, optional)
- `currentNeed` (string, optional)
- `customFields` (list of ApiVolunteerOpportunityPostRequestBodyContentApplicationJsonSchemaCustomFieldsItems, optional)

## Response

### 200

OK

- `id` (string, optional)
- `volunteerOpportunityUrl` (string, optional)
- `name` (string, optional)
- `locationName` (string, optional)
- `displayAddress` (string, optional)
- `startDateTime` (string, optional)
- `endDateTime` (string, optional)
- `preferredDateTime` (string, optional)
- `timeZone` (string, optional)
- `description` (string, optional)
- `createDateTimeUtc` (string, optional)
- `createdByUser` (string, optional)
- `modifiedDateTimeUtc` (string, optional)
- `modifiedByUser` (string, optional)
- `isActive` (string, optional)
- `isLocalOnly` (string, optional)
- `preferredNumberOfHours` (string, optional)
- `projectId` (string, optional)
- `totalVolunteers` (string, optional)
- `totalVolunteerHours` (string, optional)
- `volunteerOrganizers` (list of ApiVolunteerOpportunityPostResponsesContentApplicationJsonSchemaVolunteerOrganizersItems, optional)
- `currentNeed` (string, optional)
- `currentPriority` (string, optional)
- `currentPriorityName` (string, optional)
- `currentNeedFilledPercentage` (string, optional)
- `hoursFilledPercentage` (string, optional)
- `volunteerOrganizersUrl` (string, optional)
- `volunteersUrl` (string, optional)
- `customFields` (list of ApiVolunteerOpportunityPostResponsesContentApplicationJsonSchemaCustomFieldsItems, optional)

## Errors

### 400 Bad Request Error

BadRequest

- `any`

## Types

### ApiVolunteerOpportunityPostRequestBodyContentApplicationJsonSchemaCustomFieldsItems

- `name` (string, optional)
- `value` (string, optional)
- `displayName` (string, optional)

### ApiVolunteerOpportunityPostResponsesContentApplicationJsonSchemaVolunteerOrganizersItems

- `id` (string, optional)
- `volunteerOrganizerUrl` (string, optional)
- `contactId` (string, optional)
- `displayName` (string, optional)
- `firstName` (string, optional)
- `avatarUrl` (string, optional)
- `primaryPhone` (string, optional)
- `primaryEmail` (string, optional)
- `contactUrl` (string, optional)
- `volunteerOpportunityUrl` (string, optional)

### ApiVolunteerOpportunityPostResponsesContentApplicationJsonSchemaCustomFieldsItems

- `name` (string, optional)
- `value` (string, optional)
- `displayName` (string, optional)

## Examples

**Request**

```json
{
  "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>"
    }
  ]
}
```

**Response**

```json
{
  "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>"
    }
  ]
}
```

**SDK Code**

```python Volunteering_createAVolunteerOpportunity_example
import requests

url = "https://api.virtuoussoftware.com/api/VolunteerOpportunity"

payload = {
    "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>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Volunteering_createAVolunteerOpportunity_example
const url = 'https://api.virtuoussoftware.com/api/VolunteerOpportunity';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"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>"}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Volunteering_createAVolunteerOpportunity_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.virtuoussoftware.com/api/VolunteerOpportunity"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"startDateTime\": \"<dateTime>\",\n  \"endDateTime\": \"<dateTime>\",\n  \"timeZone\": \"<string>\",\n  \"preferredNumberOfHours\": \"<double>\",\n  \"projectId\": \"<integer>\",\n  \"locationName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isActive\": \"<boolean>\",\n  \"isLocalOnly\": \"<boolean>\",\n  \"address1\": \"<string>\",\n  \"address2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"postal\": \"<string>\",\n  \"country\": \"<string>\",\n  \"preferredDateTime\": \"<dateTime>\",\n  \"currentPriority\": \"<string>\",\n  \"currentNeed\": \"<integer>\",\n  \"customFields\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"displayName\": \"<string>\"\n    },\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"displayName\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Volunteering_createAVolunteerOpportunity_example
require 'uri'
require 'net/http'

url = URI("https://api.virtuoussoftware.com/api/VolunteerOpportunity")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"startDateTime\": \"<dateTime>\",\n  \"endDateTime\": \"<dateTime>\",\n  \"timeZone\": \"<string>\",\n  \"preferredNumberOfHours\": \"<double>\",\n  \"projectId\": \"<integer>\",\n  \"locationName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isActive\": \"<boolean>\",\n  \"isLocalOnly\": \"<boolean>\",\n  \"address1\": \"<string>\",\n  \"address2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"postal\": \"<string>\",\n  \"country\": \"<string>\",\n  \"preferredDateTime\": \"<dateTime>\",\n  \"currentPriority\": \"<string>\",\n  \"currentNeed\": \"<integer>\",\n  \"customFields\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"displayName\": \"<string>\"\n    },\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"displayName\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java Volunteering_createAVolunteerOpportunity_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.virtuoussoftware.com/api/VolunteerOpportunity")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"startDateTime\": \"<dateTime>\",\n  \"endDateTime\": \"<dateTime>\",\n  \"timeZone\": \"<string>\",\n  \"preferredNumberOfHours\": \"<double>\",\n  \"projectId\": \"<integer>\",\n  \"locationName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isActive\": \"<boolean>\",\n  \"isLocalOnly\": \"<boolean>\",\n  \"address1\": \"<string>\",\n  \"address2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"postal\": \"<string>\",\n  \"country\": \"<string>\",\n  \"preferredDateTime\": \"<dateTime>\",\n  \"currentPriority\": \"<string>\",\n  \"currentNeed\": \"<integer>\",\n  \"customFields\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"displayName\": \"<string>\"\n    },\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"displayName\": \"<string>\"\n    }\n  ]\n}")
  .asString();
```

```php Volunteering_createAVolunteerOpportunity_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.virtuoussoftware.com/api/VolunteerOpportunity', [
  'body' => '{
  "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>"
    }
  ]
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Volunteering_createAVolunteerOpportunity_example
using RestSharp;

var client = new RestClient("https://api.virtuoussoftware.com/api/VolunteerOpportunity");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"<string>\",\n  \"startDateTime\": \"<dateTime>\",\n  \"endDateTime\": \"<dateTime>\",\n  \"timeZone\": \"<string>\",\n  \"preferredNumberOfHours\": \"<double>\",\n  \"projectId\": \"<integer>\",\n  \"locationName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isActive\": \"<boolean>\",\n  \"isLocalOnly\": \"<boolean>\",\n  \"address1\": \"<string>\",\n  \"address2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"postal\": \"<string>\",\n  \"country\": \"<string>\",\n  \"preferredDateTime\": \"<dateTime>\",\n  \"currentPriority\": \"<string>\",\n  \"currentNeed\": \"<integer>\",\n  \"customFields\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"displayName\": \"<string>\"\n    },\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"displayName\": \"<string>\"\n    }\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Volunteering_createAVolunteerOpportunity_example
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "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>"
    ]
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.virtuoussoftware.com/api/VolunteerOpportunity")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```