Update plan time

put

https://{tenant}.onechurchsoftware.com/api/plans/{plan}/times/{id}

Update a rehearsal or service time and the teams expected at it. First retrieve the plan from GET /api/plans/{id}, take the time from its times list, apply your changes, then send back the full time.

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

int32

required

≥ 1

The id of the time

Body Params

The current version of the time

int32

The id of the time. When creating a plan time, include an existing time's id to update it instead.

name

string | null

The name of the time (e.g. Rehearsal, Service).

type

object | null

The type of the time.

date

object | null

When the time starts and ends.

teams

array of objects | null

On a plan's times, the teams expected to serve at that time, each with its id and name. Not returned on nested times. When writing, provide the id of each team (group) expected at the time.

teams

future

boolean | null

Write-only. When true, the change is repeated on later plans of the same service type and location.

startDate

date | null

Also accepted on writes (POST /plans/{id}/times, PUT /plans/{plan}/times/{id}, and the times of the preview entries sent to POST /plans and POST /plans/{id}/copy) and composes date when date is omitted; ignored when date is sent. The calendar date the time starts on, in the church's time zone (yyyy-MM-dd). Populated on the plan, assignment, swap and opportunity times the serving reads return, except the nested times of team needs, team assignment rows, team-member positions, run-sheet line items, auto-schedule conflicts and the respond/send-email result payload.

startTime

string | null

Also accepted on writes (POST /plans/{id}/times, PUT /plans/{plan}/times/{id}, and the times of the preview entries sent to POST /plans and POST /plans/{id}/copy) and composes date when date is omitted; ignored when date is sent. Wall-clock start of the time in the church's time zone (HH:mm). Populated on the plan, assignment, swap and opportunity times the serving reads return, except the nested times of team needs, team assignment rows, team-member positions, run-sheet line items, auto-schedule conflicts and the respond/send-email result payload.

endTime

string | null

Also accepted on writes (POST /plans/{id}/times, PUT /plans/{plan}/times/{id}, and the times of the preview entries sent to POST /plans and POST /plans/{id}/copy) and composes date when date is omitted; ignored when date is sent. Wall-clock end of the time in the church's time zone (HH:mm). Populated on the plan, assignment, swap and opportunity times the serving reads return, except the nested times of team needs, team assignment rows, team-member positions, run-sheet line items, auto-schedule conflicts and the respond/send-email result payload.

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