Groups

Group management

📄️ Move a group form property up or down (ManageGroup role required)

Move a group form property up or down (ManageGroup role required)

📄️ Delete a group form property and its column (ManageGroup role required)

Delete a group form property and its column (ManageGroup role required)

📄️ List all groups

List all groups

📄️ Create a new group (ManageGroupRole role required)

Create a new group (ManageGroupRole role required)

📄️ Get groups formatted for calendar display

Get groups formatted for calendar display

📄️ Get IDs of groups whose all members are in the session cart

Get IDs of groups whose all members are in the session cart

📄️ Get a single group by ID

Get a single group by ID

📄️ Update group name, type, and description (ManageGroupRole role required)

Update group name, type, and description (ManageGroupRole role required)

📄️ Delete a group (ManageGroupRole role required)

Deletes a group. Members and custom properties are cascade-deleted. Returns 409 Conflict if the group is the audience for one or more events, is referenced by an event type — reassign those first — or is a volunteer ministry's pool, which is deleted with the ministry.

📄️ Check whether all members of a group are in the session cart

Check whether all members of a group are in the session cart

📄️ Get members of a group with family address info

Get members of a group with family address info

📄️ Get group member-role memberships (events/roles per member)

Get group member-role memberships (events/roles per member)

📄️ Get the role options for a group

Get the role options for a group

📄️ Add a new role to a group (ManageGroupRole role required)

Add a new role to a group (ManageGroupRole role required)

📄️ Get cell phone numbers for group members (respects Do Not SMS)

Get cell phone numbers for group members (respects Do Not SMS)

📄️ Get cell phone numbers for a Sunday School class, segmented by role

Get cell phone numbers for a Sunday School class, segmented by role

📄️ Get mailing email addresses for group members grouped by role

Returns member email addresses for all group members, excluding those with the DoNotEmail property. sToEmailAddress is a system setting added by the composer, not returned here.

📄️ Get email addresses for a Sunday School class, segmented by role

Get email addresses for a Sunday School class, segmented by role

📄️ Export people emails with group memberships as CSV

Export people emails with group memberships as CSV

📄️ Export Sunday School class roster as CSV

Export Sunday School class roster as CSV

📄️ Remove a person from a group (ManageGroupRole role required)

Remove a person from a group (ManageGroupRole role required)

📄️ Add a person to a group (ManageGroupRole role required)

Add a person to a group (ManageGroupRole role required)

📄️ Update a group member's role (ManageGroupRole role required)

Update a group member's role (ManageGroupRole role required)

📄️ Update a group role name or sort order (ManageGroupRole role required)

Update a group role name or sort order (ManageGroupRole role required)

📄️ Delete a group role (ManageGroupRole role required)

Delete a group role (ManageGroupRole role required)

📄️ Set the default role for a group (ManageGroupRole role required)

Set the default role for a group (ManageGroupRole role required)

📄️ Enable or disable group-specific properties (ManageGroupRole role required)

Enable or disable group-specific properties (ManageGroupRole role required)

📄️ Set a group's active status (ManageGroupRole role required)

Set a group's active status (ManageGroupRole role required)

📄️ Set the email export flag for a group (ManageGroupRole role required)

Set the email export flag for a group (ManageGroupRole role required)

📄️ Get all available group property definitions

Get all available group property definitions

📄️ Get properties assigned to a specific group

Get properties assigned to a specific group

📄️ Assign or update a property on a group (ManageGroup role required)

Assign or update a property on a group (ManageGroup role required)

📄️ Remove a property from a group (ManageGroup role required)

Remove a property from a group (ManageGroup role required)