Create assignment

post

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

Schedule a volunteer for a serving position. Provide the person, the team, the position, the response status, and the plan times to schedule (at least one on non-template plans). Set enroll to also add the volunteer to the team's group. Returns 400 when the person is already assigned to the position or has a block-out date on one of the times.

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

Body Params

The details 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