Pilot Groups

Groups of pilots for bulk operations (activation, welcome emails, billing). All endpoints require manager access (user_group_id ≤ 150), except manager_do and manager_welcomize which require user_group_id ≤ 150.


List Pilot Groups

GET /pilot_groups/manager_index.json

List all pilot groups for the company. When called as a JSON request, returns groups with a pilot_count field. Ordered alphabetically by name.

Response

{
  "pilotGroups": [
    {
      "PilotGroup": {
        "id": "abc123",
        "company_id": "42",
        "name": "Instructors",
        "pilot_count": 5
      }
    }
  ]
}

View Pilot Group

GET /pilot_groups/manager_view/{id}.json

Full details for a single group including all member pilots. Each user also shows which other groups they belong to.

Path Parameters

Parameter
Type
Description

id

UUID

Pilot group ID

Response


Create Pilot Group

POST /pilot_groups/manager_add.json

Create a new pilot group.

Request Body

Field
Type
Required
Description

PilotGroup.name

string

Yes

Group name

Response


Edit Pilot Group

POST /pilot_groups/manager_edit/{id}.json

PUT /pilot_groups/manager_edit/{id}.json

Update a pilot group. A GET to this endpoint returns the current group data (including its members) for pre-populating a form.

Path Parameters

Parameter
Type
Description

id

UUID

Pilot group ID

Request Body

Field
Type
Required
Description

PilotGroup.name

string

Yes

Group name

PilotGroup.User

array

No

Array of {"id": "..."} objects to set group membership

Response


Delete Pilot Group

POST /pilot_groups/manager_delete/{id}.json

DELETE /pilot_groups/manager_delete/{id}.json

Delete a pilot group. Members are not deleted — only the group record and memberships.

Path Parameters

Parameter
Type
Description

id

UUID

Pilot group ID

Response


Bulk Activate / Deactivate Group

GET /pilot_groups/manager_do/{pilotGroupId}/{action}.json

Activate or deactivate all pilots in a group. Only affects users whose current active status differs from the target state.

Path Parameters

Parameter
Type
Description

pilotGroupId

UUID

Pilot group ID

action

string

1 to activate, 0 to deactivate

Response


Send Welcome Emails to Group

POST /pilot_groups/manager_welcomize/{pilotGroupId}.json

Send welcome / account confirmation emails to all active members of the group who have an email address.

Path Parameters

Parameter
Type
Description

pilotGroupId

UUID

Pilot group ID

Response

Last updated