Create plans

post

https://{tenant}.onechurchsoftware.com/api/plans

Create one or more service plans. First call POST /api/plans/preview with the same options to compute the plans that would be created, then send the options back with the returned list as preview. Returns the id and dates of the first plan created.

Required permission: Full Write Service Plans

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The options for the new plans, including the preview list

preview

array of objects | null

required

The plans to create, exactly as returned by POST /api/plans/preview. Only each entry's times and template are used; optionally set template on an entry to build that plan from a plan template. Required when creating.

preview*

type

object | null

The service type of the new plans.

option

string | null

How the plans' times are determined: "none" creates undated plans, "copy" repeats the times of the plan given in copy, and "custom" builds the first plan from times. Required when previewing.

location

object | null

The campus of the new plans.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

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

200OK