API for adding constituents to groups?

Yves Parent

We are trying to create some custom groups that would be recipients of School Forms (Core → Content → School Forms → Settings → Recipients). Under recipients you can add a role, a school year, a grade, a group or people individually.

Building a group is a slow manual process where each person must be searched and selected. I am wondering if there is an API to add constituents to a group. We would use our data warehouse to retrieve the list of people we want then script out the necessary API calls.

Noah Cooper

You can use the create, update, or createOrUpdate methods of the REST API. Alternatively, if you are handling many records at once, it's worth considering using the Luminate Web Services API instead, specifically the AddRelationships operation. The REST API requires making one request per constituent, while Web Services allows you to pass hundreds of records at a time.