Update group member

put

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

Full update of a group membership: the role, dates, notes, manager and position assignments are replaced with the given values; the person cannot be changed. First retrieve the current member from /api/groups/{group}/members/{member}, apply your changes, then send back the full object.

Required permission: Limited Write Groups

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

group

int32

required

≥ 1

The id of the group

member

int32

required

≥ 1

The id of the member

Body Params

The details of the membership

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