Update line item

put

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

Full update: the title, length, description, section, attachments, song, and notes are replaced by the submitted values; the item's type and position are left unchanged (use PUT /api/plans/{id}/lineitems/order to move items). First retrieve the plan from GET /api/plans/{id}, take the item from its items list, apply your changes, then send back the full item.

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

item

int32

required

≥ 1

The id of the line item

Body Params

The current version 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".

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.

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.

404Not Found