Update position

put

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

Full update: optional fields that are omitted are cleared. The group is required but a position cannot be moved to another group. First retrieve the current position from /api/groups/positions/{id}, 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

int32

required

≥ 1

The id of the position

Body Params

The details of the position

group

object | null

required

The group the position belongs to. On writes, provide the id; a position cannot be moved to another group on update.

enrollment

object | null

required

How volunteers enroll in the position: 1 = anyone can sign up, 2 = approval required. On writes, provide the id.

name

string | null

The name of the serving position.

description

string | null

The description of the serving position.

listed

boolean

Whether the position is listed publicly.

active

boolean

Whether the position is active.

form

object | null

The sign-up form, when one is linked. On writes, provide the id; omit to clear it.

leader

object | null

A reference to an existing record by its id.

merchant

object | null

The merchant account used for position-related payments. Only returned to authenticated callers. On writes, provide the id; omit to clear it.

max

int32 | null

The maximum number of volunteers, when the position is capped.

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.

404Not Found