Update a Planned Gift | Virtuous Developer Documentation

curl -X PUT https://api.virtuoussoftware.com/api/PlannedGift/plannedGiftId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "plannedGiftDate": "<dateTime>",
  "plannedGiftType": "<string>",
  "frequency": "Once|Monthly|Quarterly|Semiannually|Annually|Biennially",
  "anticipatedAmount": "<double>",
  "anticipatedStartDate": "<dateTime>",
  "numberOfOccurrences": "<integer>",
  "currentValue": "<double>",
  "contactIndividualId": "<integer>",
  "assignedUserId": "<integer>",
  "projectId": "<integer>",
  "segmentId": "<integer>",
  "thankYouDate": "<dateTime>",
  "customFields": [
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    },
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    }
  ]
}'

{
  "id": "<integer>",
  "plannedGiftUrl": "<string>",
  "giftsAppliedUrl": "<string>",
  "contactId": "<integer>",
  "contactUrl": "<string>",
  "plannedGiftDate": "<string>",
  "pkannedGiftType": "<string>",
  "frequency": "<string>",
  "anticipatedAmount": "<string>",
  "anticipatedStartDate": "<string>",
  "numberOfOccurrences": "<integer>",
  "currentValue": "<string>",
  "fulfilled": "<string>",
  "projectId": "<integer>",
  "project": "<string>",
  "projectUrl": "<string>",
  "segmentId": "<integer>",
  "segment": "<string>",
  "segmentUrl": "<string>",
  "createDateTimeUtc": "<dateTime>",
  "createdByUser": "<string>",
  "modifiedDateTimeUtc": "<dateTime>",
  "modifiedByUser": "<string>",
  "customFields": [
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    },
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    }
  ]
}

Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only updating a single property, the entire model is still required.

Authentication

AuthorizationBearer

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

Path parameters

plannedGiftIdstringRequired

Request

This endpoint expects an object.

plannedGiftDatestringOptional

plannedGiftTypestringOptional

frequencystringOptional

anticipatedAmountstringOptional

anticipatedStartDatestringOptional

numberOfOccurrencesstringOptional

currentValuestringOptional

contactIndividualIdstringOptional

assignedUserIdstringOptional

projectIdstringOptional

segmentIdstringOptional

thankYouDatestringOptional

customFieldslist of objectsOptional

Response

idstringOptional

plannedGiftUrlstringOptional

giftsAppliedUrlstringOptional

contactIdstringOptional

contactUrlstringOptional

plannedGiftDatestringOptional

pkannedGiftTypestringOptional

frequencystringOptional

anticipatedAmountstringOptional

anticipatedStartDatestringOptional

numberOfOccurrencesstringOptional

currentValuestringOptional

fulfilledstringOptional

projectIdstringOptional

projectstringOptional

projectUrlstringOptional

segmentIdstringOptional

segmentstringOptional

segmentUrlstringOptional

createDateTimeUtcstringOptional

createdByUserstringOptional

modifiedDateTimeUtcstringOptional

modifiedByUserstringOptional

customFieldslist of objectsOptional

Errors

400

Bad Request Error