Create a Gift Ask
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."
}Gift Asks
Create a Gift Ask
POST
/
api
/
GiftAsk
Create a Gift Ask
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
Body
application/json
Response
OK
Last modified on April 23, 2026
Was this page helpful?