Skip to main content
POST
Create employee group

Authorizations

Authorization
string
header
required

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

Path Parameters

organizationId
string
required

String. The organization's internal ID (32-character hex string).

Example:

"11adfe2a080040e3892ffb89c21ec44e"

Body

application/json

The id property must not be supplied — it is generated by the server and returned in the response.

name
string
required

Display name of the employee group. Must not be blank, is trimmed, and must be unique within the organization (case-insensitive).

Maximum string length: 255
isDefault
boolean | null

Whether this group should become the organization's default group. When the organization uses employee groups, users newly added to the organization are automatically assigned to the default group. Existing users are not moved to the group when it is set as default. Setting this to true automatically unsets the organization's previous default group, if any. Defaults to false when omitted.

Response

Created — returns the newly created employee group

id
string
required

Unique internal identifier of the employee group.

name
string
required

Display name of the employee group.

isDefault
boolean
required

Whether this is the organization's default employee group. When the organization uses employee groups, users newly added to the organization are automatically assigned to the default group, when one is set. Existing users are not moved to the group when it is set as default. At most one group per organization can be the default at a time.