Update sermon

put

https://{tenant}.onechurchsoftware.com/api/sermons/{id}

Update an existing sermon. This is a full update: optional fields that are omitted are cleared, except tags and featured, which are left unchanged. First retrieve the current sermon from /api/sermons/{id}, apply your changes, then send back the full object.

Required permission: Full Write Sermons

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the sermon to update.

Body Params

The details of the sermon

title

string | null

required

The sermon title. Maximum 200 characters.

summary

string | null

Short summary of what the sermon is about. Plain text; any HTML is stripped.

notes

string | null

The sermon notes (HTML). Text wrapped in tags becomes a fill-in-the-blank answer in the notes viewer.

date

date-time | null

The sermon's publish date and time (UTC). Defaults to the current time when creating a sermon; required when updating one.

speaker

object | null

The sermon speaker. Provide either id or code when writing. Values come from /api/property_values/speakers/values.

tags

series

object | null

The series the sermon belongs to. Only id is used when writing. Values come from /api/property_values/series/values.

transcript

string | null

The full transcript text.

verses

array of objects | null

The Bible passages the sermon covers.

verses

featured

boolean | null

Whether the sermon is marked as featured. Left unchanged when omitted on a write.

public

boolean | null

Whether the sermon is set to show on the public sermons portal. Defaults to false when omitted on a write.

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