Comment on page
Update multiple sub-compositions in one call
To update multiple sub-compositions in one API call, you'll need two things:
With that data on hand
- 1.Prepare a
PATCHrequest tohttps://app.singular.live/apiv2/controlapps/:appToken/control, which is the endpoint to update a control app. - 2.Replace
:appTokenwith the actual app token for your app instance. - 3.Add a request body with the actual sub-composition IDs and payload structures, and include the updates you'd like to make. The request body should look like this, but with sub-composition IDs and payload data filled in.
Sub-composition name
Sub-composition ID
[
{
"subCompositionName": "your-subcomposition-name-1",
"payload": {
"controlnode-field": "control node content"
},
},
{
"subCompositionName": "your-subcomposition-name-2",
"payload": {
"controlnode-field": "control node content"
},
"state": "<toState>"
}
]
[
{
"subCompositionId": "your-subcomposition-id-1",
"payload": {
"controlnode-field": "control node content"
},
},
{
"subCompositionId": "your-subcomposition-id-2",
"payload": {
"controlnode-field": "control node content"
},
"state": "<toState>"
}
]
You can also send the final sub-composition in the list to its In or Out state with this request.
After sending the request, you should get a
200 OK response with a payload of { "success": true }.