Add Entities
Add entities to an entity group
Path parameters
entityGroupId
Entity Group ID or Entity Group ForeignID
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
entityIds
List of entity IDs or foreign IDs to add to the group
copyUsersFrom
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 first entity the group. 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.
Response
This endpoint returns an object.
id
entities
metadata
foreignId
name
emailToName