Creates a vehicle group in the organization the API key belongs to, optionally with saved vehicles in it, and returns it.

Input. name is required: 1 to 100 characters once leading and trailing spaces are removed, and different from the name of every other vehicle group the organization created, ignoring case. memberIds is optional: up to 500 numeric ids of saved vehicles from List vehicles, no id twice.

Response. 201 with the group, its memberIds and memberCount.

Notes. A name that is already used answers 409 with code: VEHICLE_GROUP_NAME_EXISTS. A member id that is not a vehicle of the organization, or that the API key may not see, answers 404; an unsaved vehicle answers 400, save it first. In every one of these cases nothing is created. The group is not private: every user of the organization sees it.

Side effects. A group created with vehicles is sent to the Cores of the organization, so alerts that use it can match them. Undo with Delete a vehicle group.

Request examples

POST /v1/vehicle-api/groups

{ "name": "Employees" }

POST /v1/vehicle-api/groups

{ "name": "Employees", "memberIds": [1093527491036451, 1093527491036452] }