Links

Update a control app's content

patch
https://app.singular.live/apiv2/controlapps/:appToken/control
Update control app

Example request bodies by sub-composition name or ID

By name
By ID
[
{
"subCompositionName": "<subCompositionName>",
"payload": {
"<controlnodeId>": "<controlnode content>",
"<...>": "<...>"
}
}, {
...
}
]
[
{
"subCompositionId": "<subcompositionId>",
"payload": {
"<controlnodeId>": "<controlnode content>",
"<...>": "<...>"
}
}, {
...
}
]

Control node field types

<fieldType>
Example
Description
<Text>
"John Doe"
A single line of text.
<Text Area>
"Title/nSubtitle"
Multiple lines of text.
<Number>
123.45
A number.
<Image>
"https://www.gstatic.com/webp/gallery3/1.png"
An image URL.
<Color>
"lightgray", "#33AAFF", "#33AAFF55", rbg(150, 150, 150)", rgba(255, 150, 150, 0.5)"
An HTML color name, a color HEX code, a color HEX code with alpha, a color rgb value, or a color rgba value.
<Checkbox>
true, false
A checkbox checked (true) or unchecked (false).
<Audio>
"https://domain.com/audio.mp3"
The URK of an audio file.
JSON Text>
"{"id": 1,"firstname": "John","lastname": "Doe"}"
A stringified JSON object.
<Time Control>
{"command": "play"}, {"command": "pause"}, {"command": "reset"}
Plays, pauses, or resets the timer.
<Button>
"execute"
Triggers a button click event.