Rename a vehicle group

Changes the name of a vehicle group of the application's organization, and returns the group.

Input. groupId in the path. name in the body: 1 to 100 characters once leading and trailing spaces are removed, and different from the name of every other vehicle group of the organization that created the group, ignoring case. A group may take its own name again, in another case.

Response. 200 with the renamed group.

Notes. The organization must have created the group, or have the admin role on a group another organization shares with it; otherwise 403. Delete a vehicle group has the same rule. A name that is already used answers 409 with code: VEHICLE_GROUP_NAME_EXISTS.

Side effects. The group is sent again to the Cores that use it. Undo with another rename.

Request examples

PUT /v3/vehicle-api/groups/6512bd43d9caa6e02c990b0a

{ "name": "Contractors" }

Required scope: write:vehicles

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The 24-character id of the vehicle group, from List vehicle groups.

Body Params

The new name of the group.

string
required
length between 1 and 100

The name of the group, 1 to 100 characters once leading and trailing spaces are removed. Unique among the vehicle groups of the organization, ignoring case.

Responses

400

groupId is not a 24-character id, or name is missing, empty or longer than 100 characters.

404

Vehicle group not found in this organization.

429

Too many requests. Try again later.

500

Internal server error.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*