Publish choices
POST
https://api.vidmoat.com/v1/projects/{id}/interactivePut an interactive project's choices on one of its finished exports so its watch link plays them, update them after a change without rendering again, or take them off.
Path parameters#
idstringrequiredThe project id.
Body#
exportIdstringrequiredThe export (render job id) to publish on. It must still show the project's picture:samePicturein the list.publishbooleandefaulttruefalsetakes the choices off; the video plays as an ordinary one.sharebooleantruealso makes the watch link and returns it asshareUrl;falsetakes the link away. Omit to leave the link as it is.
Response#
Returns 200.
Response fields#
okbooleantrue.publishedbooleanWhether the export carries choices now.scenesintegerWithpublish: true: scenes published.itemsintegerWithpublish: true: interactive parts published.shareUrlstring or nullWithpublish: true: the watch link, ornullwhen the export has none.notestringWithpublish: true, no link and nosharesent: how to make one.sharedbooleanOnly whensharewas sent: whether the export has a link now.shareErrorstringOnly whensharewas sent and changing the link failed. The publish itself still happened.
Errors#
Besides the errors any request can get (authentication, rate limits):
| Status | Code | When |
|---|---|---|
| 404 | not_found | No such project, or it is not yours. The two are indistinguishable on purpose. |
| 400 | invalid_request | exportId is missing, or publish or share is not a boolean. |
| 402 | plan_required | The plan cannot publish an interactive link, or interactive video is not switched on for this account. |
| 409 | conflict | The export has not finished, was made before exports were fingerprinted, or the picture changed since (render again); the project has no choices; or the choices would leave a viewer stuck (problems lists them). |