curl --request POST \
--url https://api.virtuoussoftware.com/api/GiftAsk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contactId": "<integer:required>",
"askAmount": "<double:required>",
"askDate": "<dateTime:optional>",
"expectedFulfillmentDate": "<dateTime:optional>",
"notes": "<string:optional>",
"askType": "<string:FixedAsk|RecurringAsk:required>",
"frequency": "<string:optional>",
"declined": "<boolean:optional:default=false>",
"projectId": "<integer:optional>",
"segmentId": "<integer:optional>",
"assignedUserId": "<integer:optional>",
"secondaryAssignedUserId": "<integer:optional>",
"status": "<string: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>',
askAmount: '<double:required>',
askDate: '<dateTime:optional>',
expectedFulfillmentDate: '<dateTime:optional>',
notes: '<string:optional>',
askType: '<string:FixedAsk|RecurringAsk:required>',
frequency: '<string:optional>',
declined: '<boolean:optional:default=false>',
projectId: '<integer:optional>',
segmentId: '<integer:optional>',
assignedUserId: '<integer:optional>',
secondaryAssignedUserId: '<integer:optional>',
status: '<string:required>',
customFields: [
{name: '<string:required>', value: '<string:optional>'},
{name: '<string:required>', value: '<string:optional>'}
]
})
};
fetch('https://api.virtuoussoftware.com/api/GiftAsk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/GiftAsk"
payload = {
"contactId": "<integer:required>",
"askAmount": "<double:required>",
"askDate": "<dateTime:optional>",
"expectedFulfillmentDate": "<dateTime:optional>",
"notes": "<string:optional>",
"askType": "<string:FixedAsk|RecurringAsk:required>",
"frequency": "<string:optional>",
"declined": "<boolean:optional:default=false>",
"projectId": "<integer:optional>",
"segmentId": "<integer:optional>",
"assignedUserId": "<integer:optional>",
"secondaryAssignedUserId": "<integer:optional>",
"status": "<string: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/GiftAsk");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"contactId\": \"<integer:required>\",\n \"askAmount\": \"<double:required>\",\n \"askDate\": \"<dateTime:optional>\",\n \"expectedFulfillmentDate\": \"<dateTime:optional>\",\n \"notes\": \"<string:optional>\",\n \"askType\": \"<string:FixedAsk|RecurringAsk:required>\",\n \"frequency\": \"<string:optional>\",\n \"declined\": \"<boolean:optional:default=false>\",\n \"projectId\": \"<integer:optional>\",\n \"segmentId\": \"<integer:optional>\",\n \"assignedUserId\": \"<integer:optional>\",\n \"secondaryAssignedUserId\": \"<integer:optional>\",\n \"status\": \"<string:required>\",\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/GiftAsk",
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>',
'askAmount' => '<double:required>',
'askDate' => '<dateTime:optional>',
'expectedFulfillmentDate' => '<dateTime:optional>',
'notes' => '<string:optional>',
'askType' => '<string:FixedAsk|RecurringAsk:required>',
'frequency' => '<string:optional>',
'declined' => '<boolean:optional:default=false>',
'projectId' => '<integer:optional>',
'segmentId' => '<integer:optional>',
'assignedUserId' => '<integer:optional>',
'secondaryAssignedUserId' => '<integer:optional>',
'status' => '<string: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/GiftAsk")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contactId\": \"<integer:required>\",\n \"askAmount\": \"<double:required>\",\n \"askDate\": \"<dateTime:optional>\",\n \"expectedFulfillmentDate\": \"<dateTime:optional>\",\n \"notes\": \"<string:optional>\",\n \"askType\": \"<string:FixedAsk|RecurringAsk:required>\",\n \"frequency\": \"<string:optional>\",\n \"declined\": \"<boolean:optional:default=false>\",\n \"projectId\": \"<integer:optional>\",\n \"segmentId\": \"<integer:optional>\",\n \"assignedUserId\": \"<integer:optional>\",\n \"secondaryAssignedUserId\": \"<integer:optional>\",\n \"status\": \"<string:required>\",\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/GiftAsk")
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 \"askAmount\": \"<double:required>\",\n \"askDate\": \"<dateTime:optional>\",\n \"expectedFulfillmentDate\": \"<dateTime:optional>\",\n \"notes\": \"<string:optional>\",\n \"askType\": \"<string:FixedAsk|RecurringAsk:required>\",\n \"frequency\": \"<string:optional>\",\n \"declined\": \"<boolean:optional:default=false>\",\n \"projectId\": \"<integer:optional>\",\n \"segmentId\": \"<integer:optional>\",\n \"assignedUserId\": \"<integer:optional>\",\n \"secondaryAssignedUserId\": \"<integer:optional>\",\n \"status\": \"<string:required>\",\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/GiftAsk';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '<integer:required>',
askAmount: '<double:required>',
askDate: '<dateTime:optional>',
expectedFulfillmentDate: '<dateTime:optional>',
notes: '<string:optional>',
askType: '<string:FixedAsk|RecurringAsk:required>',
frequency: '<string:optional>',
declined: '<boolean:optional:default=false>',
projectId: '<integer:optional>',
segmentId: '<integer:optional>',
assignedUserId: '<integer:optional>',
secondaryAssignedUserId: '<integer:optional>',
status: '<string: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": "<integer>",
"giftAskUrl": "<string>",
"giftsAppliedUrl": "<string>",
"contactId": "<integer>",
"contactUrl": "<string>",
"askAmount": "<double>",
"askAmountFormatted": "<string>",
"askDate": "<dateTime>",
"askDateFormatted": "<string>",
"expectedFulfillmentDate": "<dateTime>",
"expectedFulfillmentDateFormatted": "<string>",
"notes": "<string>",
"askType": "<string>",
"frequency": "<string>",
"declined": "<boolean>",
"createDateTimeUtc": "<dateTime>",
"createdByUser": "<string>",
"modifiedDateTimeUtc": "<dateTime>",
"modifiedByUser": "<string>",
"projectId": "<integer>",
"project": "<string>",
"projectUrl": "<string>",
"segmentId": "<integer>",
"segment": "<string>",
"segmentCode": "<string>",
"segmentUrl": "<string>",
"assignedUserId": "<integer>",
"assignedUser": "<string>",
"secondaryAssignedUser": "<string>",
"secondaryAssignedUserId": "<integer>",
"status": "<string>",
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
]
}{
"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."
}Create a Gift Ask
Records a gift ask on a contact — a solicitation for a specific amount, usually tied to a project and a fundraiser. Set declined when the ask was turned down, and expectedFulfillmentDate to track when you expect the gift.
curl --request POST \
--url https://api.virtuoussoftware.com/api/GiftAsk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contactId": "<integer:required>",
"askAmount": "<double:required>",
"askDate": "<dateTime:optional>",
"expectedFulfillmentDate": "<dateTime:optional>",
"notes": "<string:optional>",
"askType": "<string:FixedAsk|RecurringAsk:required>",
"frequency": "<string:optional>",
"declined": "<boolean:optional:default=false>",
"projectId": "<integer:optional>",
"segmentId": "<integer:optional>",
"assignedUserId": "<integer:optional>",
"secondaryAssignedUserId": "<integer:optional>",
"status": "<string: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>',
askAmount: '<double:required>',
askDate: '<dateTime:optional>',
expectedFulfillmentDate: '<dateTime:optional>',
notes: '<string:optional>',
askType: '<string:FixedAsk|RecurringAsk:required>',
frequency: '<string:optional>',
declined: '<boolean:optional:default=false>',
projectId: '<integer:optional>',
segmentId: '<integer:optional>',
assignedUserId: '<integer:optional>',
secondaryAssignedUserId: '<integer:optional>',
status: '<string:required>',
customFields: [
{name: '<string:required>', value: '<string:optional>'},
{name: '<string:required>', value: '<string:optional>'}
]
})
};
fetch('https://api.virtuoussoftware.com/api/GiftAsk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/GiftAsk"
payload = {
"contactId": "<integer:required>",
"askAmount": "<double:required>",
"askDate": "<dateTime:optional>",
"expectedFulfillmentDate": "<dateTime:optional>",
"notes": "<string:optional>",
"askType": "<string:FixedAsk|RecurringAsk:required>",
"frequency": "<string:optional>",
"declined": "<boolean:optional:default=false>",
"projectId": "<integer:optional>",
"segmentId": "<integer:optional>",
"assignedUserId": "<integer:optional>",
"secondaryAssignedUserId": "<integer:optional>",
"status": "<string: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/GiftAsk");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"contactId\": \"<integer:required>\",\n \"askAmount\": \"<double:required>\",\n \"askDate\": \"<dateTime:optional>\",\n \"expectedFulfillmentDate\": \"<dateTime:optional>\",\n \"notes\": \"<string:optional>\",\n \"askType\": \"<string:FixedAsk|RecurringAsk:required>\",\n \"frequency\": \"<string:optional>\",\n \"declined\": \"<boolean:optional:default=false>\",\n \"projectId\": \"<integer:optional>\",\n \"segmentId\": \"<integer:optional>\",\n \"assignedUserId\": \"<integer:optional>\",\n \"secondaryAssignedUserId\": \"<integer:optional>\",\n \"status\": \"<string:required>\",\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/GiftAsk",
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>',
'askAmount' => '<double:required>',
'askDate' => '<dateTime:optional>',
'expectedFulfillmentDate' => '<dateTime:optional>',
'notes' => '<string:optional>',
'askType' => '<string:FixedAsk|RecurringAsk:required>',
'frequency' => '<string:optional>',
'declined' => '<boolean:optional:default=false>',
'projectId' => '<integer:optional>',
'segmentId' => '<integer:optional>',
'assignedUserId' => '<integer:optional>',
'secondaryAssignedUserId' => '<integer:optional>',
'status' => '<string: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/GiftAsk")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contactId\": \"<integer:required>\",\n \"askAmount\": \"<double:required>\",\n \"askDate\": \"<dateTime:optional>\",\n \"expectedFulfillmentDate\": \"<dateTime:optional>\",\n \"notes\": \"<string:optional>\",\n \"askType\": \"<string:FixedAsk|RecurringAsk:required>\",\n \"frequency\": \"<string:optional>\",\n \"declined\": \"<boolean:optional:default=false>\",\n \"projectId\": \"<integer:optional>\",\n \"segmentId\": \"<integer:optional>\",\n \"assignedUserId\": \"<integer:optional>\",\n \"secondaryAssignedUserId\": \"<integer:optional>\",\n \"status\": \"<string:required>\",\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/GiftAsk")
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 \"askAmount\": \"<double:required>\",\n \"askDate\": \"<dateTime:optional>\",\n \"expectedFulfillmentDate\": \"<dateTime:optional>\",\n \"notes\": \"<string:optional>\",\n \"askType\": \"<string:FixedAsk|RecurringAsk:required>\",\n \"frequency\": \"<string:optional>\",\n \"declined\": \"<boolean:optional:default=false>\",\n \"projectId\": \"<integer:optional>\",\n \"segmentId\": \"<integer:optional>\",\n \"assignedUserId\": \"<integer:optional>\",\n \"secondaryAssignedUserId\": \"<integer:optional>\",\n \"status\": \"<string:required>\",\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/GiftAsk';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '<integer:required>',
askAmount: '<double:required>',
askDate: '<dateTime:optional>',
expectedFulfillmentDate: '<dateTime:optional>',
notes: '<string:optional>',
askType: '<string:FixedAsk|RecurringAsk:required>',
frequency: '<string:optional>',
declined: '<boolean:optional:default=false>',
projectId: '<integer:optional>',
segmentId: '<integer:optional>',
assignedUserId: '<integer:optional>',
secondaryAssignedUserId: '<integer:optional>',
status: '<string: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": "<integer>",
"giftAskUrl": "<string>",
"giftsAppliedUrl": "<string>",
"contactId": "<integer>",
"contactUrl": "<string>",
"askAmount": "<double>",
"askAmountFormatted": "<string>",
"askDate": "<dateTime>",
"askDateFormatted": "<string>",
"expectedFulfillmentDate": "<dateTime>",
"expectedFulfillmentDateFormatted": "<string>",
"notes": "<string>",
"askType": "<string>",
"frequency": "<string>",
"declined": "<boolean>",
"createDateTimeUtc": "<dateTime>",
"createdByUser": "<string>",
"modifiedDateTimeUtc": "<dateTime>",
"modifiedByUser": "<string>",
"projectId": "<integer>",
"project": "<string>",
"projectUrl": "<string>",
"segmentId": "<integer>",
"segment": "<string>",
"segmentCode": "<string>",
"segmentUrl": "<string>",
"assignedUserId": "<integer>",
"assignedUser": "<string>",
"secondaryAssignedUser": "<string>",
"secondaryAssignedUserId": "<integer>",
"status": "<string>",
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
]
}{
"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.
Body
The identifier of the contact this record belongs to.
The amount being asked for.
The date the ask was made.
The date the pledge is expected to be paid in full.
Free-text notes stored on the record.
The type of ask, for example a solicitation or a proposal.
How often the requested gift would recur, for one-time or recurring asks.
When true, the ask was declined by the donor.
The identifier of the project this record is designated to.
The identifier of the segment this record is attributed to.
The identifier of the user responsible for the record.
The identifier of a second user responsible for the record.
The current status of the record.
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.
A link to the related contact.
The askAmount value, formatted for display.
The askDate value, formatted for display.
The expectedFulfillmentDate value, formatted for display.
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 project this record is designated to.
A link to the related project.
The identifier of the segment this record is attributed to.
A link to the related segment.
The custom field values stored on the record.
Show child attributes
Show child attributes
Was this page helpful?