Copy group

post

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

Create a new group as a copy of an existing one, optionally copying its members, serving positions and member custom fields.

Required permission: Full Write Groups

Required permission: Create Groups

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the group to copy

Body Params

Details for the new group

name

string | null

required

The name of the new group.

positions

boolean

Whether to copy the group's serving positions.

campus

object | null

The campus that manages the new group, by id. Omit to leave the new group unmanaged.

fields

boolean

Whether to copy the group's member custom field definitions.

members

boolean

Whether to copy the group's current members.

memberFields

boolean

Whether to also copy each member's custom field responses. Applies only when members and fields are both true.

memberPositions

boolean

Whether to also copy each member's position assignments. Applies only when members and positions are both true.

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.

200OK