Groups are a list of entities that you can use to quickly assign multiple resources to an Event at once.
Groups can contain People (type PEOPLE) or Items (type ITEMS). When they contain Items, they are called Collections. The API does not distinguish between Groups and Collections, though they are visually distinct in platform UIs.
Create a Group
Creates a Group (for PEOPLE type) or Collection (for ITEMS type) based on the provided fields.
Request Body
orgIdstring · uuid · readOnly · requiredThe id of the
Organizationthat owns thisGroup.namestring · requiredThe name of the
Group.typeinteger · enum · requiredThe type of entities a
Groupcontains.Value Name Description 0 PEOPLE A GroupofPeople1 ITEMS A CollectionofItemsEnum values:01entityIdsstring[] · requiredThe ids of the entities in this
Group. ForPEOPLEGroups, these arePersonids. ForITEMSGroups(also calledCollections), these areItemids.
notesstringSupports basic HTML tags and formatting.
Responses
The newly created Group.
groupobject
Update a Group
Updates the specified Group or Collection by setting the values of the fields passed. Any fields not provided will be left unchanged. By design, you cannot change a Group's id or type.
path Parameters
groupIdstring · uuid · requiredThe id of the
Group.
Request Body
namestringThe name of the
Group.entityIdsstring[]The ids of the entities in this
Group. ForPEOPLEGroups, these arePersonids. ForITEMSGroups(also calledCollections), these areItemids.notesstringSupports basic HTML tags and formatting.
Responses
The updated Group.
groupobject