ScheduleGroups

Replaces a schedule group's complete membership.

Requires ManageJobs and an Idempotency-Key header. Same as saving the member picker on the Schedule Groups page: listed users become (or stay) members, everyone else is removed, and isLead is set exactly for leadIds. All or nothing: an id that is not an active user of this organization, or a lead missing from userIds, changes nothing. Jobs already assigned are not changed. For single changes use PUT / DELETE .../members/{userId}. Example: { "userIds": ["3f2a…", "9b1c…"], "leadIds": ["3f2a…"] }.

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

Request

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

Path parameters

idinteger required

Schedule group id. Example: 7.

Request body

userIdsstring[] required

User ids (string GUIDs, from GET /api/v1/users) of every member, each an active user of this organization; [] removes everyone. At most 500.

leadIdsstring[] nullable

The crew leads / foremen among userIds (each must also be in userIds); omitted or [] = no leads.

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.