Comment on page
Update a sub-composition's content and animation state in one call
To update a sub-composition's content and update animation state in one API request, 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 and animate a control app In and Out. - 2.Replace
:appTokenwith the actual app token for your app instance. - 3.Add a request body with the actual sub-composition ID and payload structure. Include the updates you'd like to make and change
statetoInorOut. The request body should look like this, but with the sub=composition ID, payload data, and state filled in.
Sub-composition name
Sub-composition ID
[
{
"subCompositionName": "your-subcomposition-name",
"payload": {
"controlnode-field": "control node content"
},
"state": "<toState>"
}
]
[
{
"subCompositionId": "your-subcomposition-id",
"payload": {
"controlnode-field": "control node content"
},
"state": "<toState>"
}
]
After sending the request, you should get a
200 OK response with a payload of { "success": true }.