ScheduleGroups

Edits a schedule group; only the fields sent change.

Requires ManageJobs and an Idempotency-Key header. "" clears description / colorHex; "parentGroupId": 0 moves the group to the top level. Moving a group under itself or one of its own crews is refused. Example: PATCH /api/v1/schedule-groups/7 { "name": "Crew A (North)" }.

patch/api/v1/schedule-groups/{id}

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/schedule-groups/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

Schedule group id. Example: 7.

Request body

namestring nullable

Group name, 1–100 characters. Required on create; cannot be cleared. Example: "Install Crew A".

descriptionstring nullable

Optional description shown on the dispatch board, up to 500 characters; "" clears it.

colorHexstring nullable

Colour for calendar / board rendering as 6-digit hex, e.g. "#2e7d32" (the # is optional; stored lower-case); "" clears it.

parentGroupIdinteger nullable

Id of the parent group (e.g. the division a crew belongs to); 0 makes the group top-level. Omit on PATCH to keep the current parent (on create, omitted = top-level). A moved group is placed last among its new siblings; a group cannot be moved under itself or its own descendants.

Response

The group after the edit.

idinteger

Numeric id of the group. Stable within this organization.

syncIdstring uuid

Globally unique sync id (GUID). Use it as the after pagination cursor.

namestring

Group name, e.g. "Install Crew A".

descriptionstring nullable

Optional description shown on the dispatch board.

colorHexstring nullable

Hex colour used for calendar / board rendering, e.g. "#2e7d32"; null when unset.

parentGroupIdinteger nullable

Id of the parent group (e.g. the division a crew belongs to); null for top-level groups.

parentGroupNamestring nullable

Name of the parent group; null for top-level groups.

displayOrderinteger

Sort position among siblings (ascending). Pages are returned in id order, so sort by this client-side when rendering a board.

createdAtstring date-time

UTC creation timestamp.

updatedAtstring date-time nullable

UTC timestamp of the last edit; null when never edited.

Changes

No recorded changes to this operation across all 1 revision of this API.