Update a sub-composition's animation state

To send overlays to their In and Out states, you'll need two things:

With that data on hand

  1. Prepare a PATCH request to https://app.singular.live/apiv2/controlapps/:appToken/control, which is the endpoint to animate a control app In and Out.

  2. Replace :appToken with the actual app token for your app instance.

  3. Add a request body with the actual sub-composition ID and update the value of the sub-composition's state to In or Out. The request body should look like this, but with sub-composition ID and state filled in.

        "subCompositionName": "your-subcomposition-name",
        "state": "<toState>"

After sending the request, you should get a 200 OK response with a payload of { "success": true }.

Last updated