API reference

Groups

/groups

A group is who a group-scoped event is about. A static group keeps a list you add to; a dynamic group holds whoever's attributes contain its filter, so nobody keeps it up. Beside the groups 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 Political party pack a group is, for example, “Montserrado County”.

GET/groupsList · ?q ?external_ref ?temporary POST/groupsCreate GET/groups/{group_id}Read PATCH/groups/{group_id}Update · attributes replaced whole POST/groups/{group_id}/membersAdd members · up to 500shown →GET/groups/{group_id}/membersMembers · static DELETE/groups/{group_id}/members/{member_id}Remove a member POST/groups/syncBuild from an attribute GET/groups/{group_id}/matchesMatches · dynamic POST/groups/{group_id}/deactivateDeactivate · no delete

POSTAdd to a group

Requires groups:write. Up to 500 memberships or people — the group's own kind — in one call. Somebody already in it is not an error, so a sync can send its whole list every time. One id this instance has no record of, or one member of staff, refuses the lot before anything is written.

Path parameters

group_iduuid · required

The group id.

Body parameters

member_idsuuid[] · required · max 500

Raven's ids for the memberships or people. Each is added once however often it is sent.

Returns

200 with added: how many were new. 400 on a dynamic group, which keeps no list, or for an unknown id or a member of staff, named. 409 on a temporary list.

Response body

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

FieldTypeDescription

addedintegerHow many of the ids were new to the group. Somebody already in it is not counted and not an error.

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

Previous← Authentication, keys and scopes NextEvent types →