NAnash
Fleet

Upsert Driver Group

Create or update a driver group in your internal fleet, keyed on your own externalIdentifier. Sending the same externalIdentifier again updates the existing group; the response's created field tells you which happened. Omitted fields are left unchanged. To disable a group, upsert with isActive: false — there is no delete call. driverIds replaces the full list of your drivers in the group. New members require an active group; existing members may be kept or removed while the group is inactive.

put/v1/fleet/driver-groups/upsert

Request

  • Base URL
    https://api.sandbox.usenash.com
  • Auth
    none declared

Request body

externalIdentifierstring required

Your own id for this group; the upsert key.

displayNamestring nullable

Required when the group is created.

isActiveboolean nullable

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

unassignedDriverTimeoutMinutesinteger nullable
driverIdsstring[] nullable

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

Response

OK

firstVersionContractIdstring required

Stable id of the driver group across versions.

externalIdentifierstring nullable
displayNamestring required
isActiveboolean required
unassignedDriverTimeoutMinutesinteger nullable
providerIdstring required
createdboolean required

Changes

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