latestOpenAPI 3.1.02026-08-1182263351.1 KB
f8025de20169
Groups
Remove students from a group
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/
Path parameters
idstring required
Request body
Response
OK