songs/arrangements/create

Creates an arrangement tied to a specified song.

POST
https://api.elvanto.com/v1/songs/arrangements/create.{json|xml|php}

Parameters

Name Type Description
song_id Required string The ID of the Song to tie to the arrangement to
name Required string The name of the new arrangement
copyright string Copyright details for this arrangement
sequence array An array of strings, detailing the sequence of the song.
minutes number How long the arrangement is in minutes. A song that goes for 3 minutes and 45 seconds would have 3 in this field
seconds number The number of seconds for the songs length. A song that goes for 3 minutes and 45 seconds would have 45 in this field
bpm number The BPM (Beats per Minute) of the arrangement
key_male string Male led key
key_female string Female led key
chord_chart_key string Original Key for the Chord Chart to transpose from
chord_chart string Chord Chart in ChordPro format, with newlines represented as n characters
keys array Array of key objects. Each object must have the following attributes:
name - Name of the new key
key_starting - Starting key of the new key.
They may also have the following attributes:
key_ending - Ending key
keys_alternate - Array of objects with their own key_starting parameter and a name parameter representing capo/alternative keys for the chord charts.
Expected request JSON HTTP POST
{
    "song_id": "07be5283-864b-4204-bf81-e45ce365fb99",
    "name": "Modern Arrangement",
    "copyright": "2021 Music Company",
    "sequence": [
        "Verse 1",
        "Chorus",
        "Verse 2",
        "Chorus",
        "Bridge",
        "Verse 3",
        "Chorus"
    ],
    "minutes": 3,
    "seconds": 45,
    "bpm": 82,
    "chord_chart_key": "A#m",
    "chord_chart": "VERSE 1\\n[A]This is my [C]Glad Noise!\\nFor the [D]Lord I make Glad Noises!\\n\\nCHORUS\\n[C]Make them loudly!\\n[F]I may not make them nicely!\\n[G]But loud and glad they are!",
    "keys": [
        {
            "name": "Normal",
            "key_starting": "A#m"
        },
        {
            "name": "Other Key",
            "key_starting": "Db"
        }
    ]
}
Expected response JSON XML PHP
{
    "generated_in": "0.021",
    "status": "ok",
    "arrangements": {
        "id": "3ef550f4-7b98-4052-a445-826b7303ab33",
        "keys": [
            {
                "id": "188f7a7c-cfc1-4609-9b16-0cc45d640e98",
                "name": "Normal"
            },
            {
                "id": "93a891ce-2134-4e94-82ce-211208d0e913",
                "name": "Alternate Key"
            }
        ]
    }
}
Error responses

Please see our response status codes documentation for details of potential error responses for any API request.