Groups

Remove students from a group

Changed on

Idempotently remove students from the group.

Per JSON:API to-many relationship DELETE semantics, this is idempotent: if the student is not a member, the row is returned with status: "deleted" — there is no separate not_a_member outcome on the wire (the service-level discriminator tracks the difference for the audit log and event dispatch).

Within-batch duplicate detection is first-wins on id.

Returns 404 if the group is not in the caller's organization.

Required OAuth scope: student-groups:write

delete/v2/groups/{id}/relationships/students/

Request

Path parameters

idstring required

Request body

Response

OK

Changes

    • 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

      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

    • info

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