Name Type Description
id Required string The UUID of the key to edit
key_starting Required string The starting (main) key to be used for this Key.
name string The name of the new Key
key_ending string The ending key of this key, if a key change occurs
keys_alternate array Array of Alternate (capo) key object. Each object must have a key attribute and may contain an optional name attribute
Expected request JSON HTTP POST
    "id": "cb90719c-b10f-412b-88f1-e035de01229e",
    "name": "G Minor - Modern Take (Updated)",
    "key_starting": "Gm",
    "keys_alternate": [
            "key": "Eb",
            "name": "Bass Guitar"
Expected response JSON XML PHP
    "generated_in": 0.05,
    "status": "ok",
    "key": {
        "id": "cb90719c-b10f-412b-88f1-e035de01229e"
Error responses

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

  • 250: No Arrangement ID provided You need to specify the ID of the arrangement.
  • 250: The "key_starting" parameter is required The key, or a capo key, is missing the key_starting parameter
  • 250: The "key_starting" parameter must be a valid key A key_starting value provided is invalid