Video routes: update · StartupBuilder

Reference for Video, one group of Video routes.

Video.update

Changes the given properties of a Video. Verb page.

Text

PATCH /{namespace}/videos/{id}

Path: id. Body, as JSON: the other inputs. Emits Video.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Video.
`timeline`	`json`		The ordered scenes on a fixed grid, the only timing truth for picture, voice and captions.
`brand`	Brand		The Brand whose voice, palette and type the Video uses.
`offer`	Offer		The Offer the Video presents, when it presents one.

Returns

Output	Type	Required	Description
`video`	Video	required	The Video.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

curl -X PATCH https://api.sb/leaseline.app/videos/video_xVlGG2TxBA \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"timeline":{}}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "video": {
    "$id": "https://api.sb/leaseline.app/videos/video_xVlGG2TxBA",
    "$type": "Video",
    "status": "Draft",
    "timeline": {},
    "brand": "brand_PluVQrB1HF"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Video.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Video.updateCopy Anchor Link

Video.update