Save chord chart

post

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

Create or replace the arrangement's chord chart. The chart can be downloaded as a PDF, transposed to any of the arrangement's keys, from /api/songs/{song}/arrangements/{arrangement}/chordchart/{key}.pdf.

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 chord chart

content

string | null

The raw chord chart text. Plain text where a line holding only a section name (e.g. Verse 1, Chorus) starts a section, a line holding only chord names is rendered as chords, and any other line is lyrics.

key

string | null

The name of the musical key the chord chart was written in (e.g. C).

size

int32 | null

The font size used when rendering the chart.

font

string | null

The font used when rendering the chart.

color

string | null

The color used for chord markings when rendering the chart.

columns

int32 | null

The number of columns used when rendering the chart.

useSequence

boolean

When true, the chart is generated from the arrangement's play order (ExpandedSequence): sections are emitted in that order, consecutive repeats collapse into one block tagged with a play count, and sections not referenced by the play order are omitted. When false (the default), the chart prints its sections in the order they appear in Content. Enabling this makes the arrangement-level sequence editor read-only; the play order is then edited here.

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.

404Not Found