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 June 2020 release, which will go live next Monday night (June 22nd):

🚨 Breaking Change Alert 🚨

We know, we just said we avoid making breaking changes. But we are making a change that affects the event custom fields endpoint. Specifically, we are eliminating the need to include an Event ID in the URL, since custom fields apply to all events. So:

/api/Event/{eventId}/Invitations/CustomFields
is now
/api/EventInvitation/CustomFields

New Endpoints

We are adding two new endpoints in this release, to support the addition of custom field functionality on Pledges and Recurring Gifts:

  • /api/v2/Pledge/CustomFields
  • /api/RecurringGift/CustomFields

Updated Endpoints

We've updated some endpoints to add character limits for specific fields. These updates apply to the following endpoints and fields:

/api/Contact POST/PUT

  • Name, InformalName limited to 200 chars
  • Prefix/Title limited to 60 chars
  • First, Middle, Last Name limited to 100 chars
  • Suffix limited to 60 chars
  • Label limited to 100 chars
  • Address1, Address 2 limited to 100 chars
  • City, State, Country limited to 60 chars
  • Postal limited to 20 chars

/api/ContactIndividual POST/PUT

  • Prefix/Title limited to 60 chars
  • First, Middle, Last Name limited to 100 chars
  • Suffix limited to 60 chars

/api/ContactAddress POST/PUT

  • Label limited to 100 chars
  • Address1, Address 2 limited to 100 chars
  • City, State, Country limited to 60 chars
  • Postal limited to 20 chars

We've also updated Event Invitation endpoints:

  • /api/Event/{eventId}/Invitations/{eventInvitationId} - added ContactIndividualId to response
  • /api/EventInvitation/Query - added ContactIndividualId as query parameter

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?