API ReferenceEntity Group

Add Entities

Add entities to an entity group

Path parameters

entityGroupIdstringRequired

Entity Group ID or Entity Group ForeignID

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
entityIdslist of stringsRequired

List of entity IDs or foreign IDs to add to the group

copyUsersFromboolean or stringOptional

Entity ID / foreign ID of an entity currently in the group to copy users and roles from OR a boolean defining if users should be copied to the new entities.

If not provided or false, users and roles will not be copied. If true, users and roles will be copied from the entity with the most users that has been updated most recently. If a valid ID is provided, users and roles will be copied from the corresponding provided entity in the group.

Note: If users copied, any preexisting users will be left alone, and users with the same foreign ID will not be copied.

filterRoleslist of stringsOptional

List of roles to filter users by. If not provided, all users will be copied. If provided, only users with the provided roles will be copied.

Response

This endpoint returns an object.
idstring
entitieslist of objects
metadatamap from strings to strings
foreignIdstringOptional
namestringOptional
emailToNamestringOptional

Errors