Groups

Create Group

Creates a new Group

post/groups

Request

Request body

namestring required
defaultboolean

Indicates whether this Group is the default Group.

parent_idinteger
hierarchystring

Create Group(s) from a pipe delimited hierarchy string. Will start from the end of the string and create the necessary Groups to produce the desired hierarchy.

Response

OK

idinteger required
created_atstring date-time

The date and time at which this record was created.

updated_atstring date-time

The date and time at which this record was most recently updated.

account_idinteger required
namestring

The name of the Group.

defaultboolean

Indicates whether this Group is the default Group.

ancestrystring nullable

A pipe delimited list of ancestor Group IDs, starting with the root Group and ending with the immediate parent Group.

ancestry_namesstring nullable required

A pipe delimited list of ancestor Group names, starting with the root Group and ending with the immediate parent Group.

watched_group_subscriptions_countinteger required

The count of subscriptions to this Group.

is_sampleboolean required

Indicates whether this Group is a sample Group.

unarchived_vehicles_countinteger required

The count of unarchived Vehicles within this Group.

Example response

{
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00"
}

Changes

No recorded changes to this operation across all 6 revisions of this API.