While we update our API regularly, one of our top priorities is to maintain a consistent level of service for our integration partners. This means that, as a general rule, we strive to implement changes that are not breaking changes, and that allow existing integrations to continue to work as-is. In those rare cases when we do introduce a potential breaking change, we'll be sure to call that out to you here.

Without further ado, here's what's coming in our Spring 2020 release, which will go live next Monday night (March 31st):

🚨 Breaking Change Alert 🚨

We know, we just said we avoid making breaking changes. But we are making changes to the Gift Ask response payload to improve the data provided. Changes in this release are:

  •  AskAmount is now decimal
  • AskDate is now DateTime
  • ExpectedFulfillmentDate is now DateTime
  • ProjectDesignationId will be replaced with ProjectId

New Endpoints

We're adding several new endpoints in this release, including a number of bulk query endpoints. Here are the new endpoints coming in this release:

  • /api/EventInvitation/QueryOptions (get query options for event invitations)
  • /api/EventInvitation/Query (execute a custom query for event invitations)
  • /api/GiftAsk/{giftAskId}/Gifts (get gifts linked to a gift ask)
  • /api/GiftAsk/QueryOptions (get query options for gift asks)
  • /api/GiftAsk/Query (execute a custom query for gift asks)
  • /api/GiftAsk/CustomFields (get all enabled custom fields for gift asks)
  • /api/Grant/{grantId}/Gifts (get gifts linked to a grant)
  • /api/Grant/QueryOptions (get query options for grants)
  • /api/Grant/Query (execute a custom query for grants)
  • /api/Grant/CustomFields (get all enabled custom fields for grants)
  • /api/PlannedGift/{plannedGiftId}/Gifts (get gifts linked to a planned gift)
  • /api/PlannedGift/QueryOptions (get query options for planned gifts)
  • /api/PlannedGift/Query (execute a custom query for planned gifts)
  • /api/PlannedGift/CustomFields (get all enabled custom fields for planned gifts)
  • /api/Premium/CustomFields (get all enabled custom fields for premiums)

Updated Endpoints

Not content to just add a slew of new endpoints, we've also updated the response model for some of our existing endpoints. Here's what's new in this release:

  • ContactNote response will now include NoteDate
  • Grant response will now include CreateDateTimeUtc and ProjectId
  • PlannedGift will now include ContactId, PlannedGiftType, NumberOfOccurrences, CurrentValue, and ProjectId
  • RecurringGift will now include TransactionSource and TransactionId

As always, if you have any questions about these or other features, feel free to contact our team using the support widget in Virtuous, or drop us a line at support@virtuoussoftware.com.

Did this answer your question?