Update arrangement

put

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

Full update of the arrangement's details and 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 and the chord chart are not affected; manage them through their own endpoints. First retrieve the current arrangement 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

Body Params

The current version of the arrangement

name

string | null

required

The name of the arrangement. Must be unique within the song.

meter

object | null

The time signature of the arrangement (e.g. 6/8). Provide either id or code when writing. Values come from /api/property_values/song_meters/values.

speed

object | null

The relative speed of the arrangement (e.g. Medium). Provide either id or code when writing. Values come from /api/property_values/song_speeds/values.

style

object | null

The musical style of the arrangement (e.g. Contemporary). Provide either id or code when writing. Values come from /api/property_values/song_styles/values.

minutes

int32

The minutes portion of the arrangement's length (0-255).

seconds

int32

The seconds portion of the arrangement's length (0-59).

bpm

int32 | null

The tempo of the arrangement in beats per minute.

sequence

object | null

The order of sections the arrangement is played in.

notes

string | null

Notes about the arrangement.

startKey

object | null

The starting key of the arrangement's initial key, created along with the arrangement. Provide either id or code; values come from /api/property_values/song_keys/values. Only used when creating; manage keys through the key endpoints afterwards.

startMode

object | null

Whether the initial key starts major or minor. Provide either id or code (key_type_major or key_type_minor). Only used when creating, together with startKey.

endKey

object | null

The ending key of the arrangement's initial key, when it differs from the starting key. Provide either id or code; values come from /api/property_values/song_keys/values. Only used when creating.

endMode

object | null

Whether the initial key ends major or minor. Provide either id or code (key_type_major or key_type_minor). Only used when creating.

files

array of objects | null

Files and links attached to the arrangement. Writes replace the full list: files omitted from the list are removed.

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