Create line item

post

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

Add a line item to one of the plan's sections: a section header (type section) or a regular or song item (type item). For song items, set song to schedule a song.

Required permission: Full Write Service Plans

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the plan

Body Params

The details of the line item

when

object | null

required

The section of the plan the item belongs to: code "plan_section_before", "plan_section_during", or "plan_section_after".

type

object | null

The type of the line item: code "section" for a section header, or "item" for a regular or song item. Required when creating; the type cannot be changed on an update.

description

string | null

The item's description, as HTML.

title

string | null

The title of the line item.

minutes

int32

The minutes portion of the item's length.

seconds

int32

The seconds portion of the item's length.

order

int32 | null

The position of the item within its section. When creating an item it is appended to the end of the section if omitted; ignored on an update (use the order endpoint to move items).

files

array of objects | null

The item's attachments. When writing, include the id of each existing file to keep; entries without an id are added.

files

song

object | null

The song to schedule on the line item.

notes

array of objects | null

The notes attached to the item. When writing, the submitted list replaces the item's notes.

notes

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