Add a person to a recognition group

Adds an existing person to a people recognition group of the organization the API key belongs to.

Input. groupId is the 24-character id of a people group (from List recognition groups); personId is the numeric id of a person (from List people). Vehicle groups are not supported by this route.

Response. 204 No Content with an empty body.

Notes. The call is idempotent: adding a person who is already in the group changes nothing and also answers 204. A 404 means the group or the person does not exist or is not visible to the organization, never that the person was or was not a member.

Side effects. The updated group is sent to the Cores of the organization, so recognition alerts that use the group start matching the person. Undo it with Remove a person from a recognition group.

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

number
required

The numeric id of the person

Responses
204

The person is in the group, whether they were added now or were already a member.

400

groupId is not a 24-character id, or personId is not an integer.

401

Unauthorized - Authentication is required and has failed or has not been provided.

403

The group is shared with the organization by another organization, without permission to change its people.

404

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

409

The person is private and the group is not, or the person is hidden from users of an alert that uses the group.

500

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

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!