Update plan

Update a plan. The body is split into sections, and sections that are omitted are left unchanged: general replaces the title, subtitle, description, and campus; type changes the service type; sharing replaces the public sharing options; and template renames a plan template. First retrieve the current plan from GET /api/plans/{id}, then send back the sections you want to change.

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

Body Params

The sections of the plan to update

general
object | null

The plan's general details. When provided, replaces the title, subtitle, description, and campus.

template
object | null

The template's details. Only applies when the record is a plan template.

type
object | null

The plan's service type. When provided, changes the type.

sharing
object | null

The plan's public sharing options. When provided, replaces all of the options.

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