Group User & Manager

English only

Use Cases

Add users to group

Adds one or more users to an existing group as participants. Users already in the group are reported under alreadyAddedIds.

mutation {
  addUsersToGroup(
    groupId: "group-uuid"
    userIds: ["user-uuid-1", "user-uuid-2"]
  ) {
    addedIds
    alreadyAddedIds
    failedIds
  }
}

You can also use ref instead of id for both the group and users:

mutation {
  addUsersToGroup(
    groupRef: "group-sales"
    userRefs: ["EMP-001", "EMP-002"]
  ) {
    addedIds
    alreadyAddedIds
    failedIds
  }
}

Remove users from group

mutation {
  removeUsersFromGroup(
    groupId: "group-uuid"
    userIds: ["user-uuid-1"]
  ) {
    removedIds
    alreadyRemovedIds
    failedIds
  }
}

Add managers to group

mutation {
  addManagersToGroup(
    groupId: "group-uuid"
    userIds: ["user-uuid-1"]
  ) {
    response {
      succeededIds
      failedIds
    }
  }
}

Remove managers from group

mutation {
  removeManagersFromGroup(
    groupId: "group-uuid"
    userIds: ["user-uuid-1"]
  ) {
    response {
      succeededIds
      failedIds
    }
  }
}

GraphQL Definitions

Mutations

addUsersToGroup(
  groupId: UUID, groupRef: String,
  userIds: [UUID!], userRefs: [String!]
): AddUsersToGroup

removeUsersFromGroup(
  groupId: UUID, groupRef: String,
  userIds: [UUID!], userRefs: [String!]
): RemoveUsersFromGroup

addManagersToGroup(
  groupId: UUID, groupRef: String,
  userIds: [UUID!], userRefs: [String!]
): AddManagersToGroup

removeManagersFromGroup(
  groupId: UUID, groupRef: String,
  userIds: [UUID!], userRefs: [String!]
): RemoveManagersFromGroup

Notes

  • Both id and ref can be used for groups (groupId/groupRef) and users (userIds/userRefs).
  • The response clearly indicates which operations succeeded, which were already in the desired state, and which failed.
  • A user can be both a participant and a manager in the same group — these are managed independently.
  • For bulk user sync, combine updateOrCreateUser with addUsersToGroup using ref fields for reliable matching.
Close notification