Create a Gift Ask | Virtuous Developer Documentation

curl -X POST https://api.virtuoussoftware.com/api/GiftAsk \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "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>"
    }
  ]
}'

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

contactIdstringOptionalformat: "style"

askAmountstringOptional

askDatestringOptionalformat: "style"

expectedFulfillmentDatestringOptional

notesstringOptionalformat: "style"

askTypestringOptionalformat: "style"

frequencystringOptional

declinedstringOptionalformat: "style"

projectIdstringOptional

segmentIdstringOptionalformat: "style"

assignedUserIdstringOptional

secondaryAssignedUserIdstringOptionalformat: "style"

statusstringOptional

customFieldslist of objectsOptional

Response

idstringOptional

giftAskUrlstringOptional

giftsAppliedUrlstringOptional

contactIdstringOptional

contactUrlstringOptional

askAmountstringOptional

askAmountFormattedstringOptional

askDatestringOptional

askDateFormattedstringOptional

expectedFulfillmentDatestringOptional

expectedFulfillmentDateFormattedstringOptional

notesstringOptional

askTypestringOptional

frequencystringOptional

declinedstringOptional

createDateTimeUtcstringOptional

createdByUserstringOptional

modifiedDateTimeUtcstringOptional

modifiedByUserstringOptional

projectIdstringOptional

projectstringOptional

projectUrlstringOptional

segmentIdstringOptional

segmentstringOptional

segmentCodestringOptional

segmentUrlstringOptional

assignedUserIdstringOptional

assignedUserstringOptional

secondaryAssignedUserstringOptional

secondaryAssignedUserIdstringOptional

statusstringOptional

customFieldslist of objectsOptional

Errors

400

Bad Request Error