Create a Pledge
curl --request POST \
--url https://api.virtuoussoftware.com/api/v2/Pledge \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contactId": "<integer:required>",
"amountPledged": "<double:required>",
"frequency": "<string:Once|Weekly|Monthly|Quarterly|Semiannually|Annually|Biennially|Custom:required>",
"pledgeDate": "<dateTime:required>",
"expectedFulfillmentDate": "<dateTime:required>",
"giftAskId": "<integer:optional>",
"segmentId": "<integer:optional>",
"projectId": "<integer:optional>",
"isPrivate": "<boolean:required>",
"payments": [
{
"expectedPaymentDate": "<dateTime:required>",
"expectedAmount": "<double:required>"
},
{
"expectedPaymentDate": "<dateTime:required>",
"expectedAmount": "<double:required>"
}
],
"customFields": [
{
"name": "<string:required>",
"value": "<string:optional>"
},
{
"name": "<string:required>",
"value": "<string:optional>"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '<integer:required>',
amountPledged: '<double:required>',
frequency: '<string:Once|Weekly|Monthly|Quarterly|Semiannually|Annually|Biennially|Custom:required>',
pledgeDate: '<dateTime:required>',
expectedFulfillmentDate: '<dateTime:required>',
giftAskId: '<integer:optional>',
segmentId: '<integer:optional>',
projectId: '<integer:optional>',
isPrivate: '<boolean:required>',
payments: [
{
expectedPaymentDate: '<dateTime:required>',
expectedAmount: '<double:required>'
},
{
expectedPaymentDate: '<dateTime:required>',
expectedAmount: '<double:required>'
}
],
customFields: [
{name: '<string:required>', value: '<string:optional>'},
{name: '<string:required>', value: '<string:optional>'}
]
})
};
fetch('https://api.virtuoussoftware.com/api/v2/Pledge', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/v2/Pledge"
payload = {
"contactId": "<integer:required>",
"amountPledged": "<double:required>",
"frequency": "<string:Once|Weekly|Monthly|Quarterly|Semiannually|Annually|Biennially|Custom:required>",
"pledgeDate": "<dateTime:required>",
"expectedFulfillmentDate": "<dateTime:required>",
"giftAskId": "<integer:optional>",
"segmentId": "<integer:optional>",
"projectId": "<integer:optional>",
"isPrivate": "<boolean:required>",
"payments": [
{
"expectedPaymentDate": "<dateTime:required>",
"expectedAmount": "<double:required>"
},
{
"expectedPaymentDate": "<dateTime:required>",
"expectedAmount": "<double:required>"
}
],
"customFields": [
{
"name": "<string:required>",
"value": "<string:optional>"
},
{
"name": "<string:required>",
"value": "<string:optional>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/v2/Pledge");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"contactId\": \"<integer:required>\",\n \"amountPledged\": \"<double:required>\",\n \"frequency\": \"<string:Once|Weekly|Monthly|Quarterly|Semiannually|Annually|Biennially|Custom:required>\",\n \"pledgeDate\": \"<dateTime:required>\",\n \"expectedFulfillmentDate\": \"<dateTime:required>\",\n \"giftAskId\": \"<integer:optional>\",\n \"segmentId\": \"<integer:optional>\",\n \"projectId\": \"<integer:optional>\",\n \"isPrivate\": \"<boolean:required>\",\n \"payments\": [\n {\n \"expectedPaymentDate\": \"<dateTime:required>\",\n \"expectedAmount\": \"<double:required>\"\n },\n {\n \"expectedPaymentDate\": \"<dateTime:required>\",\n \"expectedAmount\": \"<double:required>\"\n }\n ],\n \"customFields\": [\n {\n \"name\": \"<string:required>\",\n \"value\": \"<string:optional>\"\n },\n {\n \"name\": \"<string:required>\",\n \"value\": \"<string:optional>\"\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/v2/Pledge",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contactId' => '<integer:required>',
'amountPledged' => '<double:required>',
'frequency' => '<string:Once|Weekly|Monthly|Quarterly|Semiannually|Annually|Biennially|Custom:required>',
'pledgeDate' => '<dateTime:required>',
'expectedFulfillmentDate' => '<dateTime:required>',
'giftAskId' => '<integer:optional>',
'segmentId' => '<integer:optional>',
'projectId' => '<integer:optional>',
'isPrivate' => '<boolean:required>',
'payments' => [
[
'expectedPaymentDate' => '<dateTime:required>',
'expectedAmount' => '<double:required>'
],
[
'expectedPaymentDate' => '<dateTime:required>',
'expectedAmount' => '<double:required>'
]
],
'customFields' => [
[
'name' => '<string:required>',
'value' => '<string:optional>'
],
[
'name' => '<string:required>',
'value' => '<string:optional>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.virtuoussoftware.com/api/v2/Pledge")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contactId\": \"<integer:required>\",\n \"amountPledged\": \"<double:required>\",\n \"frequency\": \"<string:Once|Weekly|Monthly|Quarterly|Semiannually|Annually|Biennially|Custom:required>\",\n \"pledgeDate\": \"<dateTime:required>\",\n \"expectedFulfillmentDate\": \"<dateTime:required>\",\n \"giftAskId\": \"<integer:optional>\",\n \"segmentId\": \"<integer:optional>\",\n \"projectId\": \"<integer:optional>\",\n \"isPrivate\": \"<boolean:required>\",\n \"payments\": [\n {\n \"expectedPaymentDate\": \"<dateTime:required>\",\n \"expectedAmount\": \"<double:required>\"\n },\n {\n \"expectedPaymentDate\": \"<dateTime:required>\",\n \"expectedAmount\": \"<double:required>\"\n }\n ],\n \"customFields\": [\n {\n \"name\": \"<string:required>\",\n \"value\": \"<string:optional>\"\n },\n {\n \"name\": \"<string:required>\",\n \"value\": \"<string:optional>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/v2/Pledge")
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 \"contactId\": \"<integer:required>\",\n \"amountPledged\": \"<double:required>\",\n \"frequency\": \"<string:Once|Weekly|Monthly|Quarterly|Semiannually|Annually|Biennially|Custom:required>\",\n \"pledgeDate\": \"<dateTime:required>\",\n \"expectedFulfillmentDate\": \"<dateTime:required>\",\n \"giftAskId\": \"<integer:optional>\",\n \"segmentId\": \"<integer:optional>\",\n \"projectId\": \"<integer:optional>\",\n \"isPrivate\": \"<boolean:required>\",\n \"payments\": [\n {\n \"expectedPaymentDate\": \"<dateTime:required>\",\n \"expectedAmount\": \"<double:required>\"\n },\n {\n \"expectedPaymentDate\": \"<dateTime:required>\",\n \"expectedAmount\": \"<double:required>\"\n }\n ],\n \"customFields\": [\n {\n \"name\": \"<string:required>\",\n \"value\": \"<string:optional>\"\n },\n {\n \"name\": \"<string:required>\",\n \"value\": \"<string:optional>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/v2/Pledge';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '<integer:required>',
amountPledged: '<double:required>',
frequency: '<string:Once|Weekly|Monthly|Quarterly|Semiannually|Annually|Biennially|Custom:required>',
pledgeDate: '<dateTime:required>',
expectedFulfillmentDate: '<dateTime:required>',
giftAskId: '<integer:optional>',
segmentId: '<integer:optional>',
projectId: '<integer:optional>',
isPrivate: '<boolean:required>',
payments: [
{
expectedPaymentDate: '<dateTime:required>',
expectedAmount: '<double:required>'
},
{
expectedPaymentDate: '<dateTime:required>',
expectedAmount: '<double:required>'
}
],
customFields: [
{name: '<string:required>', value: '<string:optional>'},
{name: '<string:required>', value: '<string:optional>'}
]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": 800061,
"contactId": 102301,
"amountPledged": 50000,
"frequency": "Annually",
"pledgeDate": "2025-11-15T00:00:00Z",
"expectedFulfillmentDate": "2026-06-01T00:00:00Z",
"createDateTimeUtc": "2025-11-15T16:35:12Z",
"createdByUser": "Partner Integration",
"modifiedDateTimeUtc": "2025-11-15T16:35:12Z",
"modifiedByUser": "Partner Integration",
"segmentId": 2012,
"segment": "Capital Campaign — Phase II",
"projectId": 1503,
"project": "Building Renovation",
"isPrivate": false,
"status": "Active",
"payments": [
{
"id": 900300,
"expectedPaymentDate": "2026-06-01T00:00:00Z",
"expectedAmount": 50000,
"giftId": null,
"actualAmount": null
}
],
"customFields": []
}{
"message": "Authorization has been denied for this request."
}{
"message": "You do not have permission to perform this action."
}{
"message": "Rate limit exceeded. Try again later."
}Giving
Create a Pledge
Records a pledge — a commitment to give a set amount, usually over several payments. Send payments to define the schedule the pledge is expected to be paid on, and expectedFulfillmentDate for when it should be paid in full.
POST
/
api
/
v2
/
Pledge
Create a Pledge
curl --request POST \
--url https://api.virtuoussoftware.com/api/v2/Pledge \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contactId": "<integer:required>",
"amountPledged": "<double:required>",
"frequency": "<string:Once|Weekly|Monthly|Quarterly|Semiannually|Annually|Biennially|Custom:required>",
"pledgeDate": "<dateTime:required>",
"expectedFulfillmentDate": "<dateTime:required>",
"giftAskId": "<integer:optional>",
"segmentId": "<integer:optional>",
"projectId": "<integer:optional>",
"isPrivate": "<boolean:required>",
"payments": [
{
"expectedPaymentDate": "<dateTime:required>",
"expectedAmount": "<double:required>"
},
{
"expectedPaymentDate": "<dateTime:required>",
"expectedAmount": "<double:required>"
}
],
"customFields": [
{
"name": "<string:required>",
"value": "<string:optional>"
},
{
"name": "<string:required>",
"value": "<string:optional>"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '<integer:required>',
amountPledged: '<double:required>',
frequency: '<string:Once|Weekly|Monthly|Quarterly|Semiannually|Annually|Biennially|Custom:required>',
pledgeDate: '<dateTime:required>',
expectedFulfillmentDate: '<dateTime:required>',
giftAskId: '<integer:optional>',
segmentId: '<integer:optional>',
projectId: '<integer:optional>',
isPrivate: '<boolean:required>',
payments: [
{
expectedPaymentDate: '<dateTime:required>',
expectedAmount: '<double:required>'
},
{
expectedPaymentDate: '<dateTime:required>',
expectedAmount: '<double:required>'
}
],
customFields: [
{name: '<string:required>', value: '<string:optional>'},
{name: '<string:required>', value: '<string:optional>'}
]
})
};
fetch('https://api.virtuoussoftware.com/api/v2/Pledge', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/v2/Pledge"
payload = {
"contactId": "<integer:required>",
"amountPledged": "<double:required>",
"frequency": "<string:Once|Weekly|Monthly|Quarterly|Semiannually|Annually|Biennially|Custom:required>",
"pledgeDate": "<dateTime:required>",
"expectedFulfillmentDate": "<dateTime:required>",
"giftAskId": "<integer:optional>",
"segmentId": "<integer:optional>",
"projectId": "<integer:optional>",
"isPrivate": "<boolean:required>",
"payments": [
{
"expectedPaymentDate": "<dateTime:required>",
"expectedAmount": "<double:required>"
},
{
"expectedPaymentDate": "<dateTime:required>",
"expectedAmount": "<double:required>"
}
],
"customFields": [
{
"name": "<string:required>",
"value": "<string:optional>"
},
{
"name": "<string:required>",
"value": "<string:optional>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/v2/Pledge");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"contactId\": \"<integer:required>\",\n \"amountPledged\": \"<double:required>\",\n \"frequency\": \"<string:Once|Weekly|Monthly|Quarterly|Semiannually|Annually|Biennially|Custom:required>\",\n \"pledgeDate\": \"<dateTime:required>\",\n \"expectedFulfillmentDate\": \"<dateTime:required>\",\n \"giftAskId\": \"<integer:optional>\",\n \"segmentId\": \"<integer:optional>\",\n \"projectId\": \"<integer:optional>\",\n \"isPrivate\": \"<boolean:required>\",\n \"payments\": [\n {\n \"expectedPaymentDate\": \"<dateTime:required>\",\n \"expectedAmount\": \"<double:required>\"\n },\n {\n \"expectedPaymentDate\": \"<dateTime:required>\",\n \"expectedAmount\": \"<double:required>\"\n }\n ],\n \"customFields\": [\n {\n \"name\": \"<string:required>\",\n \"value\": \"<string:optional>\"\n },\n {\n \"name\": \"<string:required>\",\n \"value\": \"<string:optional>\"\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/v2/Pledge",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contactId' => '<integer:required>',
'amountPledged' => '<double:required>',
'frequency' => '<string:Once|Weekly|Monthly|Quarterly|Semiannually|Annually|Biennially|Custom:required>',
'pledgeDate' => '<dateTime:required>',
'expectedFulfillmentDate' => '<dateTime:required>',
'giftAskId' => '<integer:optional>',
'segmentId' => '<integer:optional>',
'projectId' => '<integer:optional>',
'isPrivate' => '<boolean:required>',
'payments' => [
[
'expectedPaymentDate' => '<dateTime:required>',
'expectedAmount' => '<double:required>'
],
[
'expectedPaymentDate' => '<dateTime:required>',
'expectedAmount' => '<double:required>'
]
],
'customFields' => [
[
'name' => '<string:required>',
'value' => '<string:optional>'
],
[
'name' => '<string:required>',
'value' => '<string:optional>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.virtuoussoftware.com/api/v2/Pledge")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contactId\": \"<integer:required>\",\n \"amountPledged\": \"<double:required>\",\n \"frequency\": \"<string:Once|Weekly|Monthly|Quarterly|Semiannually|Annually|Biennially|Custom:required>\",\n \"pledgeDate\": \"<dateTime:required>\",\n \"expectedFulfillmentDate\": \"<dateTime:required>\",\n \"giftAskId\": \"<integer:optional>\",\n \"segmentId\": \"<integer:optional>\",\n \"projectId\": \"<integer:optional>\",\n \"isPrivate\": \"<boolean:required>\",\n \"payments\": [\n {\n \"expectedPaymentDate\": \"<dateTime:required>\",\n \"expectedAmount\": \"<double:required>\"\n },\n {\n \"expectedPaymentDate\": \"<dateTime:required>\",\n \"expectedAmount\": \"<double:required>\"\n }\n ],\n \"customFields\": [\n {\n \"name\": \"<string:required>\",\n \"value\": \"<string:optional>\"\n },\n {\n \"name\": \"<string:required>\",\n \"value\": \"<string:optional>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/v2/Pledge")
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 \"contactId\": \"<integer:required>\",\n \"amountPledged\": \"<double:required>\",\n \"frequency\": \"<string:Once|Weekly|Monthly|Quarterly|Semiannually|Annually|Biennially|Custom:required>\",\n \"pledgeDate\": \"<dateTime:required>\",\n \"expectedFulfillmentDate\": \"<dateTime:required>\",\n \"giftAskId\": \"<integer:optional>\",\n \"segmentId\": \"<integer:optional>\",\n \"projectId\": \"<integer:optional>\",\n \"isPrivate\": \"<boolean:required>\",\n \"payments\": [\n {\n \"expectedPaymentDate\": \"<dateTime:required>\",\n \"expectedAmount\": \"<double:required>\"\n },\n {\n \"expectedPaymentDate\": \"<dateTime:required>\",\n \"expectedAmount\": \"<double:required>\"\n }\n ],\n \"customFields\": [\n {\n \"name\": \"<string:required>\",\n \"value\": \"<string:optional>\"\n },\n {\n \"name\": \"<string:required>\",\n \"value\": \"<string:optional>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/v2/Pledge';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '<integer:required>',
amountPledged: '<double:required>',
frequency: '<string:Once|Weekly|Monthly|Quarterly|Semiannually|Annually|Biennially|Custom:required>',
pledgeDate: '<dateTime:required>',
expectedFulfillmentDate: '<dateTime:required>',
giftAskId: '<integer:optional>',
segmentId: '<integer:optional>',
projectId: '<integer:optional>',
isPrivate: '<boolean:required>',
payments: [
{
expectedPaymentDate: '<dateTime:required>',
expectedAmount: '<double:required>'
},
{
expectedPaymentDate: '<dateTime:required>',
expectedAmount: '<double:required>'
}
],
customFields: [
{name: '<string:required>', value: '<string:optional>'},
{name: '<string:required>', value: '<string:optional>'}
]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": 800061,
"contactId": 102301,
"amountPledged": 50000,
"frequency": "Annually",
"pledgeDate": "2025-11-15T00:00:00Z",
"expectedFulfillmentDate": "2026-06-01T00:00:00Z",
"createDateTimeUtc": "2025-11-15T16:35:12Z",
"createdByUser": "Partner Integration",
"modifiedDateTimeUtc": "2025-11-15T16:35:12Z",
"modifiedByUser": "Partner Integration",
"segmentId": 2012,
"segment": "Capital Campaign — Phase II",
"projectId": 1503,
"project": "Building Renovation",
"isPrivate": false,
"status": "Active",
"payments": [
{
"id": 900300,
"expectedPaymentDate": "2026-06-01T00:00:00Z",
"expectedAmount": 50000,
"giftId": null,
"actualAmount": null
}
],
"customFields": []
}{
"message": "Authorization has been denied for this request."
}{
"message": "You do not have permission to perform this action."
}{
"message": "Rate limit exceeded. Try again later."
}Authorizations
Body
application/json
Response
OK
Was this page helpful?