Update assignment

put

https://{tenant}.onechurchsoftware.com/api/plans/{plan}/assignments/{assignment}

Full update of a volunteer assignment's team, position, status, comments, and times; the person cannot be changed. First retrieve the current assignment from GET /api/plans/{plan}/assignments/{assignment}, apply your changes, then send back the full object.

Required permission: Full Write Service Plans

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

plan

int32

required

≥ 1

The id of the plan

assignment

int32

required

≥ 1

The id of the assignment

Body Params

The current version of the assignment

status

object | null

required

The volunteer's response status: 0 = not contacted, 1 = accepted, 2 = declined, 3 = pending.

team

object | null

required

The team (group) the assignment is on.

position

object | null

required

The serving position assigned.

person

object | null

A reference to an existing record by its id.

times

array of objects | null

The plan times the volunteer is scheduled for. When writing, provide the id of each plan time to schedule; at least one is required on non-template plans.

times

comments

string | null

Comments left for or by the volunteer.

enroll

boolean | null

Write-only. Set true to also enroll the volunteer as a member of the team's group.

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