Videos

Update a video

patch/api/v1/videos/{id}

Request

  • Base URL: https://api.firework.com
  • URL: https://api.firework.com/api/v1/videos/{id}
  • Auth: OAuth 2 (client credentials, token URL /oauth/token, scopes: videos:write)

Path parameters

idstring required

video ID

Request body

accessstring

Visibility, e.g. "public" or "private"

descriptionstring
hashtagsstring[]
business_store_idstring

ID of the business store the products belong to

captionstring
custom_fieldsobject
action_urlstring nullable

Video CTA destination URL. Required when action_type is present.

product_idsstring[]
action_typestring nullable

Video CTA action type, e.g. "shop_now" or "custom"

display_social_attributionsboolean

When true, external_media (source, url, username) is required

archived_atstring date-time nullable
poster_urlstring

URL of a poster image (jpg, jpeg, png or webp). Pass an empty string to remove existing posters.

variant_idsstring[]
video_hiddenboolean

Hide the video from product video feeds

audio_disabledboolean
action_custom_labelstring nullable

Label for action_type "custom"; must be omitted for other action types.

Response

Updated video

accessstring

Visibility, e.g. "public" or "private"

idstring
descriptionstring nullable
hashtagsstring[]
published_atstring date-time nullable

When the video is/was published; null for an unpublished draft. A future value is scheduled.

durationnumber nullable

Duration in seconds

captionstring nullable
custom_fieldsobject
action_urlstring nullable
product_idsstring[]
action_typestring nullable
thumbnail_urlstring nullable
display_social_attributionsboolean nullable
content_generation_type'aigc' nullable

Whether the video contains AI-generated content.

archived_atstring date-time nullable
audio_disabledboolean
action_custom_labelstring nullable
is_publishedboolean

Whether the video is currently live (published_at is set and not in the future). Evaluated at request time, so a scheduled video flips to true automatically when its time passes.

action_type_translationstring nullable

Translated CTA display label; for custom actions, this is the custom label.

watch_urlstring

Web URL where a viewer can watch the video.

Changes

No recorded changes to this operation across all 1 revision of this API.