Update Project By Id

Project Update Guidelines

When using the Update Project By ID API, the entire project object must be sent in the request body. While certain fields such as scene image, sentence, lines.text, lines.html, and scene.settings are explicitly intended for user modification, developers may update other attributes at their own discretion—provided they fully understand the attribute’s function and expected value format.

⚠️ Caution:
Modifying system-generated or unknown fields without understanding their structure and dependencies can result in data integrity issues or project rendering failures. Setting incorrect or invalid values may lead to project corruption. Fields such as uuid, imageMetadata, voiceOverAudioIds, assetResponseId, and other internal references should not be altered unless explicitly documented.

✅ What You Can Update

1. Scene Background Visual
   • Field: scenes[n].image
   • Description: You can replace the existing image or video URL for a specific scene to change its background visual.
   • Example:
     json

     "image": "https://your-new-media-url.com/video.mp4"

2. Subtitle Text Content
   • Fields:
     • scenes[n].sentence
     • scenes[n].lines[m].text
     • scenes[n].lines[m].html
   • Description: Update the displayed subtitle or on-screen text by modifying these fields.
   • Example:
     JSON

     "sentence": "New sentence with <strong>bold</strong> words.",
     "lines": [
       {
         "text": "New sentence with bold words.",
         "html": "New sentence with <strong>bold</strong> words."
       }
     ]

3. Scene Settings
   • Field: scenes[n].settings
   • Description: You may update values under the settings object to control playback behaviour, audio options, text visibility, etc.
   • Example:
     JSON

     "settings": {
       "imageZoomPan": false,
       "muteClipAudio": false,
       "loopVideo": true
     }

Do not remove any part of the JSON. Even if a field seems unused, it may be essential for rendering, playback, or saving the project correctly.