Update a Gift

PUT

/api/Gift/:giftId

PUT

/api/Gift/:giftId

curl -X PUT https://api.virtuoussoftware.com/api/Gift/giftId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "giftType": "<string>",
  "giftDate": "<dateTime>",
  "amount": "<double>",
  "batch": "<string>",
  "segmentId": "<integer>",
  "receiptSegmentId": "<integer>",
  "mediaOutletId": "<integer>",
  "notes": "<string>",
  "isPrivate": "<boolean>",
  "receiptDate": "<dateTime>",
  "contactIndividualId": "<integer>",
  "contactPassthroughId": "<integer>",
  "cashAccountingCode": "<string>",
  "state": "<string>",
  "isTaxDeductible": "<boolean>",
  "giftAskId": "<integer>",
  "passthroughGiftAskId": "<integer>",
  "grantId": "<integer>",
  "contactMembershipId": "<integer>",
  "currencyCode": "<string>",
  "exchangeRate": "<decimal>",
  "checkNumber": "<string>",
  "creditCardType": "<string>",
  "cryptocoinType": "<string>",
  "transactionHash": "<string>",
  "coinSoldForCash": "<boolean>",
  "coinAmount": "<double>",
  "dateCoinWasSold": "<dateTime>",
  "coinSaleAmount": "<double>",
  "tickerSymbol": "<string>",
  "numberOfShares": "<double>",
  "stockSoldForCash": "<boolean>",
  "dateStockWasSold": "<dateTime>",
  "stockSaleAmount": "<double>",
  "iraCustodian": "string",
  "nonCashGiftTypeId": "<integer>",
  "nonCashGiftType": "<string>",
  "description": "<string>",
  "nonCashSoldForCash": "<boolean>",
  "dateNonCashWasSold": "<dateTime>",
  "nonCashOriginalAmount": "<double>",
  "nonCashSaleAmount": "<double>",
  "giftDesignations": [
    {
      "projectId": "<integer>",
      "amount": "<double>",
      "state": "<string>"
    },
    {
      "projectId": "<integer>",
      "amount": "<double>",
      "state": "<string>"
    }
  ],
  "giftPremiums": [
    {
      "premiumId": "<integer>",
      "quantity": "<integer>",
      "state": "<string>"
    },
    {
      "premiumId": "<integer>",
      "quantity": "<integer>",
      "state": "<string>"
    }
  ],
  "pledgePayments": [
    {
      "id": "<integer>",
      "amount": "<double>",
      "state": "<string>"
    },
    {
      "id": "<integer>",
      "amount": "<double>",
      "state": "<string>"
    }
  ],
  "recurringGiftPayments": [
    {
      "id": "<integer>",
      "amount": "<double>",
      "state": "<string>"
    },
    {
      "id": "<integer>",
      "amount": "<double>",
      "state": "<string>"
    }
  ],
  "tributeType": "<string>",
  "tributeId": "<integer>",
  "tributeDescription": "<string>",
  "acknowledgeeId": "<integer>",
  "customFields": [
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    },
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    }
  ]
}'

{
  "id": "<integer>",
  "transactionSource": "<string>",
  "transactionId": "<string>",
  "contactId": "<integer>",
  "contactName": "<string>",
  "contactUrl": "<string>",
  "giftType": "<string>",
  "giftTypeFormatted": "<string>",
  "giftDate": "<dateTime>",
  "giftDateFormatted": "<string>",
  "amount": "<double>",
  "amountFormatted": "<string>",
  "currencyCode": "<string>",
  "exchangeRate": "<decimal>",
  "baseCurrencyCode": "<string>",
  "batch": "<string>",
  "createDateTimeUtc": "<dateTime>",
  "createdByUser": "<string>",
  "modifiedDateTimeUtc": "<dateTime>",
  "modifiedByUser": "<string>",
  "segmentId": "<integer>",
  "segment": "<string>",
  "segmentCode": "<string>",
  "segmentUrl": "<string>",
  "mediaOutletId": "<integer>",
  "mediaOutlet": "<string>",
  "grantId": "<integer>",
  "grant": "<string>",
  "grantUrl": "<string>",
  "notes": "<string>",
  "tribute": "<string>",
  "tributeId": "<integer>",
  "tributeType": "<string>",
  "acknowledgeeIndividualId": "<integer>",
  "receiptDate": "<dateTime>",
  "receiptDateFormatted": "<string>",
  "contactPassthroughId": "<integer>",
  "contactPassthroughUrl": "<string>",
  "contactIndividualId": "<integer>",
  "cashAccountingCode": "<string>",
  "giftAskId": "<integer>",
  "contactMembershipId": "<integer>",
  "giftDesignations": [
    {
      "id": "<integer>",
      "projectId": "<integer>",
      "project": "<string>",
      "projectCode": "<string>",
      "externalAccountingCode": "<string>",
      "projectType": "<string>",
      "projectLocation": "<string>",
      "projectUrl": "<string>",
      "amountDesignated": "<double>",
      "display": "<string>"
    },
    {
      "id": "<integer>",
      "projectId": "<integer>",
      "project": "<string>",
      "projectCode": "<string>",
      "externalAccountingCode": "<string>",
      "projectType": "<string>",
      "projectLocation": "<string>",
      "projectUrl": "<string>",
      "amountDesignated": "<double>",
      "display": "<string>"
    }
  ],
  "giftPremiums": [
    {
      "id": "<integer>",
      "premiumId": "<integer>",
      "premium": "<string>",
      "premiumUrl": "<string>",
      "quantity": "<integer>",
      "display": "<string>"
    },
    {
      "id": "<integer>",
      "premiumId": "<integer>",
      "premium": "<string>",
      "premiumUrl": "<string>",
      "quantity": "<integer>",
      "display": "<string>"
    }
  ],
  "pledgePayments": [
    {
      "id": "<integer>",
      "expectedPaymentDate": "<dateTime>",
      "expectedAmount": "<double>",
      "giftId": "<integer>",
      "actualAmount": "<double>"
    },
    {
      "id": "<integer>",
      "expectedPaymentDate": "<dateTime>",
      "expectedAmount": "<double>",
      "giftId": "<integer>",
      "actualAmount": "<double>"
    }
  ],
  "recurringGiftPayments": [
    {
      "id": "<integer>",
      "gift": {
        "id": "<integer>",
        "contactId": "<integer>",
        "giftDate": "<dateTime>",
        "amount": "<double>"
      },
      "expectedAmount": "<double>",
      "expectedPaymentDate": "<dateTime>",
      "dismissPaymentDate": "<dateTime>",
      "fulfillPaymentDate": "<dateTime>"
    },
    {
      "id": "<integer>",
      "gift": {
        "id": "<integer>",
        "contactId": "<integer>",
        "giftDate": "<dateTime>",
        "amount": "<double>"
      },
      "expectedAmount": "<double>",
      "expectedPaymentDate": "<dateTime>",
      "dismissPaymentDate": "<dateTime>",
      "fulfillPaymentDate": "<dateTime>"
    }
  ],
  "giftUrl": "<string>",
  "isPrivate": "<boolean>",
  "isTaxDeductible": "<boolean>",
  "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.

GiftDate will just use the Date portion of the value to set the UTC date. There is no date or time conversion on this field, so make sure that the gift date is the UTC date of the gift.

Authentication

AuthorizationBearer

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

Path parameters

giftIdstringRequired

Request

This endpoint expects an object.

giftTypestringOptional

giftDatestringOptional

amountstringOptional

batchstringOptional

segmentIdstringOptional

receiptSegmentIdstringOptional

mediaOutletIdstringOptional

notesstringOptional

isPrivatestringOptional

receiptDatestringOptional

contactIndividualIdstringOptional

contactPassthroughIdstringOptional

cashAccountingCodestringOptional

statestringOptional

isTaxDeductiblestringOptional

giftAskIdstringOptional

passthroughGiftAskIdstringOptional

grantIdstringOptional

contactMembershipIdstringOptional

currencyCodestringOptional

exchangeRatestringOptional

checkNumberstringOptional

creditCardTypestringOptional

cryptocoinTypestringOptional

transactionHashstringOptional

coinSoldForCashstringOptional

coinAmountstringOptional

dateCoinWasSoldstringOptional

coinSaleAmountstringOptional

tickerSymbolstringOptional

numberOfSharesstringOptional

stockSoldForCashstringOptional

dateStockWasSoldstringOptional

stockSaleAmountstringOptional

iraCustodianstringOptional

nonCashGiftTypeIdstringOptional

nonCashGiftTypestringOptional

descriptionstringOptional

nonCashSoldForCashstringOptional

dateNonCashWasSoldstringOptional

nonCashOriginalAmountstringOptional

nonCashSaleAmountstringOptional

giftDesignationslist of objectsOptional

giftPremiumslist of objectsOptional

pledgePaymentslist of objectsOptional

recurringGiftPaymentslist of objectsOptional

tributeTypestringOptional

tributeIdstringOptional

tributeDescriptionstringOptional

acknowledgeeIdstringOptional

customFieldslist of objectsOptional

Response

idstringOptional

transactionSourcestringOptional

transactionIdstringOptional

contactIdstringOptional

contactNamestringOptional

contactUrlstringOptional

giftTypestringOptional

giftTypeFormattedstringOptional

giftDatestringOptional

giftDateFormattedstringOptional

amountstringOptional

amountFormattedstringOptional

currencyCodestringOptional

exchangeRatestringOptional

baseCurrencyCodestringOptional

batchstringOptional

createDateTimeUtcstringOptional

createdByUserstringOptional

modifiedDateTimeUtcstringOptional

modifiedByUserstringOptional

segmentIdstringOptional

segmentstringOptional

segmentCodestringOptional

segmentUrlstringOptional

mediaOutletIdstringOptional

mediaOutletstringOptional

grantIdstringOptional

grantstringOptional

grantUrlstringOptional

notesstringOptional

tributestringOptional