Skip to main content
PUT
Upsert Driver Group
Your externalIdentifier is the upsert key. Send a new value to create a group, which needs a displayName; send the same value again to update that group. created in the response says which happened. Fields you leave out keep their current values. driverIds is the group’s full roster. Sending it replaces the list, [] removes everyone, and leaving it out changes nothing. To add or remove one driver without resending the roster, use addFirstVersionContractIds and removeFirstVersionContractIds on Upsert Driver. There is no delete call. To disable a group, upsert it with isActive: false. A disabled group can lose members but can’t gain new ones.

Authorizations

Authorization
string
header
required

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

Body

application/json

PUT /v1/fleet/driver-groups/upsert request body.

Keyed on external_identifier within the calling org's own internal fleet. Omitted fields are left unchanged; an explicit null unassigned_driver_timeout_minutes clears it.

externalIdentifier
string
required

Your own id for this group; the upsert key.

Minimum string length: 1
displayName
string | null

Required when the group is created.

Minimum string length: 1
isActive
boolean | null

Defaults to true for a new group. Set false to disable a group.

unassignedDriverTimeoutMinutes
integer | null
driverIds
string[] | null

Full list of your drivers in this group. Omit to leave membership unchanged; send [] to remove all.

Response

OK

firstVersionContractId
string
required

Stable id of the driver group across versions.

displayName
string
required
isActive
boolean
required
providerId
string
required
drivers
DriverGroupMember · object[]
required

Drivers of your organization in this group.

created
boolean
required
externalIdentifier
string | null
unassignedDriverTimeoutMinutes
integer | null