Update a Pledge
curl --request PUT \
--url https://api.virtuoussoftware.com/api/v2/Pledge/{pledgeId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"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: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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/{pledgeId}', 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/{pledgeId}"
payload = {
"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.put(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/v2/Pledge/{pledgeId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\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.PutAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/v2/Pledge/{pledgeId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'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.put("https://api.virtuoussoftware.com/api/v2/Pledge/{pledgeId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\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/{pledgeId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\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/{pledgeId}';
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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": 800045,
"contactId": 100234,
"amountPledged": 5000,
"frequency": "Quarterly",
"pledgeDate": "2025-03-01T00:00:00Z",
"expectedFulfillmentDate": "2026-03-01T00:00:00Z",
"createDateTimeUtc": "2025-03-01T11:00:00Z",
"createdByUser": "Development Team",
"modifiedDateTimeUtc": "2025-11-15T18:00:00Z",
"modifiedByUser": "Partner Integration",
"segmentId": 2012,
"segment": "Capital Campaign — Phase II",
"projectId": 1503,
"project": "Building Renovation",
"isPrivate": false,
"status": "PartiallyFulfilled",
"payments": [
{
"id": 900200,
"expectedPaymentDate": "2025-06-01T00:00:00Z",
"expectedAmount": 1000,
"giftId": 500140,
"actualAmount": 1000
},
{
"id": 900201,
"expectedPaymentDate": "2025-10-01T00:00:00Z",
"expectedAmount": 1000,
"giftId": 500142,
"actualAmount": 1000
}
],
"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
Update a Pledge
Similar to other update methods in the API, excluding a property will remove its value from the object. If you’re only updating a single property, the entire model is still required.
PUT
/
api
/
v2
/
Pledge
/
{pledgeId}
Update a Pledge
curl --request PUT \
--url https://api.virtuoussoftware.com/api/v2/Pledge/{pledgeId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"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: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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/{pledgeId}', 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/{pledgeId}"
payload = {
"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.put(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/v2/Pledge/{pledgeId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\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.PutAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/v2/Pledge/{pledgeId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'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.put("https://api.virtuoussoftware.com/api/v2/Pledge/{pledgeId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\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/{pledgeId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\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/{pledgeId}';
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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": 800045,
"contactId": 100234,
"amountPledged": 5000,
"frequency": "Quarterly",
"pledgeDate": "2025-03-01T00:00:00Z",
"expectedFulfillmentDate": "2026-03-01T00:00:00Z",
"createDateTimeUtc": "2025-03-01T11:00:00Z",
"createdByUser": "Development Team",
"modifiedDateTimeUtc": "2025-11-15T18:00:00Z",
"modifiedByUser": "Partner Integration",
"segmentId": 2012,
"segment": "Capital Campaign — Phase II",
"projectId": 1503,
"project": "Building Renovation",
"isPrivate": false,
"status": "PartiallyFulfilled",
"payments": [
{
"id": 900200,
"expectedPaymentDate": "2025-06-01T00:00:00Z",
"expectedAmount": 1000,
"giftId": 500140,
"actualAmount": 1000
},
{
"id": 900201,
"expectedPaymentDate": "2025-10-01T00:00:00Z",
"expectedAmount": 1000,
"giftId": 500142,
"actualAmount": 1000
}
],
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
(Required) The pledge identifier.
Body
application/json
The total amount the donor has committed to give.
How often the pledge is paid, for example Monthly or Annually.
The date the pledge was made.
The date the pledge is expected to be paid in full.
The identifier of the gift ask this gift fulfills.
The identifier of the segment this record is attributed to.
The identifier of the project this record is designated to.
When true, the record is only visible to users with permission to view private records.
The scheduled payments that make up the pledge.
Show child attributes
Show child attributes
Custom field values to set on the record. Field names must match custom fields configured for the organization.
Show child attributes
Show child attributes
Response
OK
The unique identifier of the record in Virtuous.
The identifier of the contact this record belongs to.
The UTC date and time the record was created.
The name of the user who created the record.
The UTC date and time the record was last modified.
The name of the user who last modified the record.
The identifier of the segment this record is attributed to.
The identifier of the project this record is designated to.
When true, the record is only visible to users with permission to view private records.
Show child attributes
Show child attributes
The custom field values stored on the record.
Show child attributes
Show child attributes
Last modified on August 11, 2026
Was this page helpful?
⌘I