Preview new plans

post

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

Compute the plans that POST /api/plans would create with the given options, without creating anything. Option "none" returns undated plans, "copy" repeats the times of the plan given in copy, and "custom" builds the first plan from times; later plans follow the service type's frequency starting from start. Pass the returned list back to the create endpoint as preview, optionally setting template on individual entries.

Required permission: Full Write Service Plans

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The options for the new plans

type

object | null

The service type of the new plans.

count

int32

The number of plans to create.

copy

int32 | null

The id of the plan whose times are repeated, when the option is "copy".

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.

start

date-time | null

The first plan's day, as a UTC instant read in the church's time zone: only that local day is used, and plan times come from times or the copied plan. Prefer startDate, since midnight UTC falls on the previous day for churches west of UTC. Later plans follow the service type's frequency. Required unless the option is "none".

startDate

date | null

The first plan's calendar day in the church's time zone (yyyy-MM-dd). Composes start (church midnight) when start is omitted; ignored when start is sent. Also the day of every entry in times that carries no startDate.

times

array of objects | null

The service and rehearsal times of the first plan, when the option is "custom": instants, or church-zone startTime / endTime on the day given by startDate.

times

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.

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

200OK