Update key

put

https://{tenant}.onechurchsoftware.com/api/songs/{song}/arrangements/{arrangement}/keys/{key}

Full update of the key and its files: optional fields that are omitted are cleared, and files omitted from the files list are removed. Do not include the generated chord chart entry (the file with a null id) in the files list. Keys are returned as part of the arrangement; first retrieve the current key from /api/songs/{song}/arrangements/{arrangement}, apply your changes, then send back the full object.

Required permission: Full Write Songs

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

song

int32

required

≥ 1

The id of the song

arrangement

int32

required

≥ 1

The id of the arrangement

key

int32

required

≥ 1

The id of the key

Body Params

The current version of the key

startKey

object | null

required

The key the arrangement starts in. Provide either id or code when writing. Values come from /api/property_values/song_keys/values.

startMode

object | null

required

Whether the starting key is major or minor. Provide either id or code (key_type_major or key_type_minor) when writing.

endKey

object | null

The key the arrangement ends in, when it differs from the starting key. Provide either id or code when writing. Values come from /api/property_values/song_keys/values.

endMode

object | null

Whether the ending key is major or minor. Provide either id or code (key_type_major or key_type_minor) when writing.

description

string | null

A description of the key (e.g. who it is sung by).

files

array of objects | null

Files and links attached to the key. Includes a generated chord chart entry when the arrangement has a chord chart. Writes replace the full list: files omitted from the list are removed. Do not send back the generated chord chart entry (the entry with a null id).

files

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