Skip to main content
PUT
Update 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"

employeeGroupId
string
required

String (32-character hex string). The internal ID of the employee group to update, as returned in the id field of the list, create, and update responses. Must match the id property in the request body.

Example:

"3f2a9c1b8e7d4a6f9b0c1d2e3f4a5b6c"

Body

application/json

This is a full replace, not a partial update: both name and isDefault are overwritten with the values provided in the request body.

id
string
required

The employee group's ID. Must match the employeeGroupId path parameter.

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. Treated as false when omitted.

Response

OK — returns the updated 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.