Remove group members

delete

https://{tenant}.onechurchsoftware.com/api/groups/members

Remove group members across all groups, along with their custom field responses. Provide ids, or explicitly set include to false to remove every member matching the filters; an empty body is rejected. Custom fields can also be used as filters; see filtering by custom fields.

Required permission: Limited Write Groups

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

role

int32

≥ 1

The id of a member role to filter by. Values come from /api/property_values/small_group_member_roles/values.

position

string

Comma-delimited list of serving position ids. Use -1 to include members with no position.

type

string

Comma-delimited list of member type ids (or type names). Values come from the group type's member types list: append _member_types to the group type code (e.g. /api/property_values/group_type_class_member_types/values).

recordType

string

Comma-delimited list of record type ids. Matches the member's person record type.

campus

string

Comma-delimited list of campus ids. Use -1 to include members without a campus. Values come from /api/locations.

groupType

string

Comma-delimited list of group type ids. Returns memberships in groups of those types.

category

string

Return memberships whose group's category name contains the given text.

person

int32

The id of the person whose memberships to return.

smallGroup

int32

≥ 1

The id of a group. Returns only memberships in that group.

groupName

string

Return memberships whose group's name contains the given text.

first

string

Return members whose first name contains the given text.

last

string

Return members whose last name contains the given text.

name

string

Text matched against the member's names and aliases. When multiple words are given, every word must match.

string

Return members whose email address contains the given text.

phone

string

Return members whose phone number contains the given digits.

gender

string

Comma-delimited list of gender ids. Use -1 to include members with no gender. Values come from /api/property_values/gender/values.

age.start

double

Return members at least this old.

age.end

double

Return members at most this old.

date

date-time

Return only memberships in effect on this date.

lastAttended.start

date-time

Return members who last attended on or after this date.

lastAttended.end

date-time

Return members who last attended on or before this date.

added.start

date-time

Return members added on or after this date.

added.end

date-time

Return members added on or before this date.

dropped.start

date-time

Return members dropped on or after this date.

dropped.end

date-time

Return members dropped on or before this date.

admin

boolean

Whether the member is a group administrator.

access

boolean

Whether the member has special group permissions or is an administrator.

notes

string

Return memberships whose notes contain the given text.

current

boolean

Whether the membership is current, i.e. started and not yet ended.

filter

string

Body Params

Which members to remove

ids

array of doubles | null

The ids the operation applies to: an include list by default, or an exclude list when include is false. For deletes, required unless include is false.

ids

include

boolean | null

Whether ids is an include list (true, default) or an exclude list (false). Setting include to false with no ids applies the operation to every record matching the query filters.

Responses

200

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here!