Changes To The Constituent API

John Lyons

The Constituent API was updated on 9/14/2016. See our Changelog entries for more information.

Breaking Change Planned

The Constituent (List) endpoint will no longer return deceased constituents by default. Instead, they will be included by setting a new include_deceased option to true.

We will also change the following query string parameters to snake case:

• includeInactive will be include_inactive on Email address (Get list), Online presence (Get list), Phone (Get list), Rating (Get list), Rating categories (Get), and Rating sources (Get)
• categoryName will be category_name on Custom field category values (Get list)
• searchText will be search_text on Constituent search (Get).

New

We added the following endpoints: 

• Rating sources (Get)
• Rating categories (Get)
• Action attachment (Patch)
• Action attachment (Delete)
• Constituent attachment (Patch)
• Constituent attachment (Delete)

Changed

New tags included in the request will be automatically added to the Document Tags table when adding or updating attachments.