ScheduleGroups

Adds a user to a schedule group, or sets their lead flag when already a member.

Requires ManageJobs and an Idempotency-Key header. The user must be an active user of this organization (ids from GET /api/v1/users). A user may belong to several groups. Example: PUT /api/v1/schedule-groups/7/members/3f2a… with { "isLead": true }.

put/api/v1/schedule-groups/{id}/members/{userId}

Request

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

Path parameters

idinteger required

Schedule group id. Example: 7.

userIdstring required

User id (string GUID) to add.

Request body

isLeadboolean nullable

True makes the user a crew lead / foreman of this group (listed first), false a regular member. Omit to keep the current flag (a newly added member is not a lead).

Response

The group with its members after the change.

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.