Playlists

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

Responses
chevron-right
200Success
application/json
get
/api/media/playlists
200Success
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstring · uuidRead-onlyRequired
sermonsstring · uuid[]Optional
sermon_countstringRead-onlyRequired
podcastsstring · uuid[]Optional
podcast_countstringRead-onlyRequired
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyRequired
namestring · max: 255Required
descriptionstring · nullableOptional
bannerstring · nullableOptional
youtube_idstring · max: 50 · nullableOptional

ID of the YouTube playlist

last_synced_atstring · date-time · nullableOptional

Last sync date with YouTube

modulestring · enumOptional
  • podcast - Podcast
  • sermon - Sermon
Possible values:
churchstring · uuidRequired
Responses
post
/api/media/playlists
201Success
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

A UUID string identifying this playlist.

Responses
chevron-right
200Success
application/json
get
/api/media/playlists/{id}
200Success
put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

A UUID string identifying this playlist.

Body
idstring · uuidRead-onlyRequired
sermonsstring · uuid[]Optional
sermon_countstringRead-onlyRequired
podcastsstring · uuid[]Optional
podcast_countstringRead-onlyRequired
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyRequired
namestring · max: 255Required
descriptionstring · nullableOptional
bannerstring · nullableOptional
youtube_idstring · max: 50 · nullableOptional

ID of the YouTube playlist

last_synced_atstring · date-time · nullableOptional

Last sync date with YouTube

modulestring · enumOptional
  • podcast - Podcast
  • sermon - Sermon
Possible values:
churchstring · uuidRequired
Responses
chevron-right
200Success
application/json
put
/api/media/playlists/{id}
200Success
delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

A UUID string identifying this playlist.

Responses
delete
/api/media/playlists/{id}
204

No response body

No content

patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

A UUID string identifying this playlist.

Body
idstring · uuidRead-onlyOptional
sermonsstring · uuid[]Optional
sermon_countstringRead-onlyOptional
podcastsstring · uuid[]Optional
podcast_countstringRead-onlyOptional
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyOptional
namestring · max: 255Optional
descriptionstring · nullableOptional
bannerstring · nullableOptional
youtube_idstring · max: 50 · nullableOptional

ID of the YouTube playlist

last_synced_atstring · date-time · nullableOptional

Last sync date with YouTube

modulestring · enumOptional
  • podcast - Podcast
  • sermon - Sermon
Possible values:
churchstring · uuidOptional
Responses
chevron-right
200Success
application/json
patch
/api/media/playlists/{id}
200Success