Add a vehicle to a vehicle group

Adds a saved vehicle to a vehicle group of the application's organization.

Input. groupId is the 24-character id of a vehicle group from List vehicle groups; vehicleId is the numeric id of a saved vehicle from List vehicles.

Response. 204 No Content with an empty body.

Notes. The call is idempotent: adding a vehicle that is already in the group changes nothing and also answers 204. An unsaved vehicle answers 400; save it first. A 404 means the group or the vehicle does not exist or is not visible to the access token, never that the vehicle was or was not a member.

Side effects. The updated group is sent to the Cores that use it, so alerts that use the group start matching the vehicle. Undo with Remove a vehicle from a vehicle group.

Request examples

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

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.

number
required
1 to 9007199254740991

The numeric id of a saved vehicle, from List vehicles.

Responses
204

The vehicle is in the group, whether it was added now or was already a member.

400

groupId is not a 24-character id, vehicleId is not a positive integer, or the vehicle is not saved.

404

Vehicle or vehicle group not found in this organization.

409

The vehicle is private and the group is not, or the vehicle is hidden from users of an alert that uses the group.

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:
*/*