Update plan time

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
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.

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
boolean | null

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

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

OK

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json