Field Deprecations in User endpoints

Stephen Boyle
Stephen Boyle Blackbaud Employee
Tenth Anniversary Kudos 5 First Reply Name Dropper
in Education Management APIs

Breaking Change:

Two fields were introduced to correct a datatype/allowed value mismatch. The UI supports values of “Yes”, “No” and “No answer” for these fields, but the API only provided a true/false Boolean field.

These fields:

  • latino_hispanic (replaces is_latino_hispanic)
  • international (replaces is_international)

Were added to these endpoints as string datatype fields with allowed values of “Yes”, “No” and “No answer”:

  1. GET Users extended by user
  2. GET Users extended by role(s)
  3. GET Users changed by base role(s)
  4. POST User create
  5. PATCH User update

The original fields, is_latino_hispanic and is_international, will be deprecated in March 2024. This is a breaking change and has been noted in the field description documentation as well.

Categories