Update the people of a recognition group

Adds and removes several people in one people recognition group of the application's organization, with a result for each person, so one bad id does not fail the whole request.

Input. groupId in the path is the 24-character id of a people group. The body holds add and remove, arrays of numeric person ids, each optional, at most 500 ids per array and no id twice. At least one id is required, and an id may not be in both arrays.

Response. 200 with { groupId, results }: one entry per id, adds first then removes, in the order sent. status is added or removed when the call changed the group, unchanged when the person was already in that state, notFound when the person does not exist or is not visible to the organization, and conflict (with a message) when a private person cannot join a group that is not private.

Notes. A missing group is a 404 for the whole request. A rule about the group as a whole also refuses the whole request with 409 before anything changes: removing the last people of a group an alert uses, or adding people hidden from users of an alert that uses the group.

Side effects. The updated group is sent to the Cores of the organization once for the additions and once for the removals.

Required scope: write:faces

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The 24-character id of a people recognition group

Body Params

The person ids to add to and remove from the group.

add
array of numbers
length ≤ 500

Person ids to add to the group, at most 500

add
remove
array of numbers
length ≤ 500

Person ids to remove from the group, at most 500

remove
Responses

400

groupId is not a 24-character id, a list holds more than 500 ids, a duplicate or a non-integer, both lists are empty, or an id is in both.

404

The group does not exist, or is not visible to the organization.

409

The change would leave empty a group that an alert uses, or would add people hidden from users of an alert that uses the group. Nothing was changed.

500

Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*