Remove students from a group
Changed onIdempotently 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
Request
- Base URLhttps://api.skilljar.com (the document declares no server; this is the origin it was published from)
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Request body
Response
OK
Changes
- warning
added the new
already_in_pathenum value to the////response property for the response status - warning
added the new
already_in_pathenum 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
- warning
- info
media type
application/jsonwas changed to a more specific media typeapplication/vnd.api+jsonfor the response status - info
media type
application/jsonwas changed to a more specific media typeapplication/vnd.api+jsonfor the response status - info
media type
application/jsonwas changed to a more specific media typeapplication/vnd.api+jsonfor the response status - info
media type
application/jsonwas changed to a more specific media typeapplication/vnd.api+jsonfor the response status - info
media type
application/jsonwas changed to a more specific media typeapplication/vnd.api+jsonfor the response status - info
media type
application/jsonwas changed to a more specific media typeapplication/vnd.api+jsonfor the response status - info
media type
application/jsonwas changed to a more specific media typeapplication/vnd.api+jsonfor the response status
- info