Create Group

POST 
https://secure.fleetio.com/api/v1/groups

Creates a new Group

Request

application/json

Body

namestringrequired

Possible values: <= 255 characters

defaultboolean

Indicates whether this Group is the default Group.

parent_idId (integer)

Possible values: >= 1

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.

Responses

201

OK

Response Headers

application/json

Schema

Schema

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

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

Example: 2023-03-14T13:46:27-06:00

account_idId (integer)required

Possible values: >= 1

namestring

The name of the Group.

defaultboolean

Indicates whether this Group is the default Group.

ancestrystringnullable

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

ancestry_namesstringnullablerequired

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

watched_group_subscriptions_countintegerrequired

The count of subscriptions to this Group.

is_samplebooleanrequired

Indicates whether this Group is a sample Group.

unarchived_vehicles_countintegerrequired

The count of unarchived Vehicles within this Group.

Example (auto)

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "account_id": 0,
  "name": "string",
  "default": true,
  "ancestry": "string",
  "ancestry_names": "string",
  "watched_group_subscriptions_count": 0,
  "is_sample": true,
  "unarchived_vehicles_count": 0
}

401

Request could not be authenticated

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

403

Insufficient permission to perform this operation

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

422

Unprocessable Entity

application/json

Schema

Schema

errors object
property name* string[]
Array [
string
]

Example (auto)

{
  "errors": {}
}

Example

{
  "errors": {
    "field1": [
      "error1",
      "error2"
    ],
    "field2": [
      "error3"
    ]
  }
}

500

Something unexpected happened

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

• curl
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Body

{
  "name": "string",
  "default": true,
  "parent_id": 0,
  "hierarchy": "string"
}

ResponseClear

Click the Send API Request button above and see the response here!