Create group

post

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

Create a new group. Provide people to enroll as leaders with leaders; the group's custom field responses (defined per group type) can be set with fields. Omitted boolean options are treated as false, so send active: true for a normal active group.

Required permission: Create Groups

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The details of the small group

name

string | null

required

The group's name.

type

object | null

required

The group's type. On writes, provide either the id or the code; the code wins when both are set.

membership

object | null

required

How people join the group: 1 = auto enroll, 2 = approval required. On writes, provide the id.

fields

array of objects | null

Custom fields for this object

fields

description

string | null

The group's full HTML description.

category

object | null

The group's category. On writes, provide either the id or the code; the code wins when both are set.

language

object | null

The group's language. On writes, provide either the id or the code; the code wins when both are set.

childcare

boolean | null

Whether childcare is provided in the group.

managedBy

object | null

The campus that manages the group. On writes, provide the id.

parent

object | null

A reference to an existing record by its id.

children

array of objects | null

The group's sub-groups. On writes, provide the sub-groups by id.

children

listed

boolean | null

Whether the group is listed in group listings.

active

boolean | null

Whether the group is active. Omitting it (or sending false) on a write deactivates the group, which requires a deactivation reason.

maxCapacity

int32 | null

The maximum number of members, when the group is capped.

showLeadersPublicly

boolean | null

Whether the group's leaders are shown publicly.

restrictRoster

boolean | null

Whether members are prevented from viewing the group roster.

interaction

boolean | null

Whether the group's interactive features are enabled.

form

object | null

The sign-up form (id and name), when one is linked. On writes, provide the id; a custom form is applied only when the group is public.

managers

boolean

Whether the group has managers assigned to its members.

deactivation

object | null

Details for deactivating the group: required when a write sets active to false on an active group. The reason (and any comments) are stored as a note on the group.

merchant

object | null

The merchant account used for paid sign-ups (id and name), when one is configured. On writes, provide the id.

registration

boolean

Whether registration is required to join the group.

leaders

array of objects | null

The group's current leaders. On create, provide the people to enroll as leaders by person id; ignored on update.

leaders

featured

boolean | null

Whether the group is featured.

public

boolean | null

Whether the group is made available to the public.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

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! Or choose an example:

text/plain

application/json

text/json

200OK

404Not Found