SKskilljar
Groups

Update groups

Changed on

Update up to BATCH_MAX_ITEMS groups in a single request.

Each item identifies a group via id (obfuscated, required). Updatable attributes: name, rule_email_domains, send_course_enrollment_email, category_id. At least one mutating field per item is required (enforced by the schema).

Within-batch duplicate detection is first-wins on id: the first occurrence of an id is processed; subsequent occurrences are pre-marked as duplicate_in_batch without reaching the service. This matches the POST endpoint's first-wins semantics on name.

A null value for category_id is meaningful — it clears the category assignment. Distinguishing "not provided" from "explicitly null" uses Pydantic's model_fields_set.

See api_v2/docs/batch-responses.md for the envelope shape.

Required OAuth scope: student-groups:write

patch/v2/groups/

Request

Request body

Response

OK

Changes

  • bed169429eb2Revision changes
    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • warning

      added the new already_in_path enum value to the //// response property for the response status

    • warning

      added the new already_in_path enum value to the //// response property for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status

  • 9fc34e55336dRevision changes
    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status