UtilitayDevelopers
Ravenraven
Get an API key
API reference

Classes

/groups

A class is who a group-scoped event is about. A static class keeps a list you add to; a dynamic class holds whoever's attributes contain its filter, so nobody keeps it up. Beside the classes somebody keeps are temporary lists, picked by a person for one send: you can see them, but a key cannot change one and an event cannot name one. In the High school pack a class is, for example, “5A”.

GET/groupsList · ?q ?external_ref ?temporaryPOST/groupsCreateGET/groups/{group_id}ReadPATCH/groups/{group_id}Update · attributes replaced wholePOST/groups/{group_id}/membersAdd members · up to 500GET/groups/{group_id}/membersMembers · staticDELETE/groups/{group_id}/members/{member_id}Remove a memberPOST/groups/syncBuild from an attributeGET/groups/{group_id}/matchesMatches · dynamicPOST/groups/{group_id}/deactivateDeactivate · no deleteshown →

POSTDeactivate a class

Requires groups:write. There is no delete: a class that has been sent to is part of that record. Nothing already sent is touched and the membership stays as it was, so turning it back on in Raven gives the same class.

Path parameters
group_iduuid · required
The class id.
Body parameters
reasonstring · optional · max 500
Kept in the audit trail.
Returns

200 with the class, status: inactive. 409 on a temporary list.

Response body

One class: the same fields in every pack. Press Response on the sample to see one whole.

FieldTypeDescription
iduuidWhat an event's group_id names.
namestringUnique in the instance.
kindstatic | dynamicstatic keeps a list; dynamic holds whoever matches its filter.
member_kindsubject | contactWhether it holds students or parents. Fixed when it is made.
filterobject | nullA dynamic group's filter: the student or parent attributes a member's must contain.Varies by pack
derived_fromstring | nullThe subject attribute a group the records keep up was built from. null on a group somebody keeps.
attributesobjectShaped by the High school pack's group_schema.Varies by pack
temporarybooleantrue on a list somebody picked for a send. It cannot be named on an event, and a key cannot change it.
external_refstring | nullYour own id, as you sent it.
statusactive | inactive
created_atdatetime
updated_atdatetime

On failure the body is { error, code } instead.

Previous← Authentication, keys and scopesNextEvent types →