Add group member

post

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

Add a person to the group. Any pending membership request from the person is removed, and an archived person is automatically unarchived. The member's custom field responses can be set with fields. Fails when the group is inactive or at its maximum capacity.

Required permission: Limited Write Groups

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The group to add the person to

Body Params

Details for the member

role

object | null

required

The member's role in the group (e.g. leader, member). On writes, provide either the id or the code; the code wins when both are set.

fields

array of objects | null

Custom fields for this object

fields

person

object | null

A reference to an existing record by its id.

positions

array of objects | null

The serving positions the member is assigned to (id and name). On writes, provide the positions by id; an update replaces the member's assignments with the given list.

positions

permissions

object | null

The member's special permissions within the group. Applied only when the caller is a group administrator and admin is false.

manager

object | null

The member's manager, when one is assigned. Omitting it on a write clears the manager.

start

date-time | null

When the membership starts (UTC).

end

date-time | null

When the membership ends (UTC), when the member has been dropped.

admin

boolean

Whether the member is a group administrator. Applied only when the caller is a group administrator.

notes

string | null

Notes entered on the membership.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

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

text/plain

application/json

text/json

404Not Found