api-v1-unit_groups

Create one or more new units groups.

Discussion

This endpoint is only available if the facility has custom unit groups enabled.

This endpoint can create multiple empty unit groups at once by providing a unit_groups array of objects with the name parameter.

Common errors that may be encountered:

  • Unit groups must have unique names across the facility. If non-unique names are provided or names conflict with any existing unit group, a list of errors will be returned under 'errors' -> 'name_assignments'.
post/v1/{facility_id}/unit_groups

Path parameters

facility_idnumber required

Request body

unit_groupsstring[] required

Array of Unit Group names

Response

ok

Changes

No recorded changes to this endpoint across all 1 revision of this API.