Update song

Full update of the song's details and song-level files: optional fields that are omitted are cleared, and files omitted from the files list are removed. Arrangements are not affected; manage them through the arrangement endpoints. First retrieve the current song from /api/songs/{id}, apply your changes, then send back the full object.

Required permission: Full Write Songs

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the song

Body Params

The current version of the song

string | null
required

The title of the song. Must be unique.

string | null

The CCLI number of the song.

string | null

Notes about the song.

string | null

The authors of the song.

string | null
category
object | null

The category the song is organized under. Provide either id or code when writing. Values come from /api/property_values/song_categories/values.

default
object | null

The song's default arrangement, created along with the song. Required when creating a song; ignored when updating one (manage arrangements through the arrangement endpoints). When name is omitted it defaults to "Default Arrangement".

files
array of objects | null

Files and links attached to the song itself rather than to a specific arrangement or key.

files
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

OK

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json