Skip to main content
PATCH
Update a brand video page

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<shortuuid>
required

URL-safe brand identifier.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
page_id
string<shortuuid>
required

Identifier of the page, as listed.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json

Payload to change a video page.

name
string | null

Internal label, 1 to 120 characters, unique among the brand's pages of this kind; a name already in use is refused with 422.

Required string length: 1 - 120
Pattern: ^[^\x00]{1,120}$
brand_name_override
string | null

Header brand name to show instead of the brand's own; empty to use the brand's name.

Maximum string length: 120
Pattern: ^[^\x00]{0,120}$
tagline
string | null

One-line tagline under the brand name; empty for none.

Maximum string length: 160
Pattern: ^[^\x00]{0,160}$
primary_color
string | null

Header background colour, a 6-digit hex value such as #0a84ff.

Pattern: ^#[0-9A-Fa-f]{6}$
accent_color
string | null

Button and link colour, a 6-digit hex value such as #ff9500.

Pattern: ^#[0-9A-Fa-f]{6}$
youtube_url
string | null

YouTube video URL; empty to show the resolved product's first video.

Maximum string length: 512
Pattern: ^[^\x00]{0,512}$
description
string | null

Brand-level text shown below the video, up to 500 characters.

Maximum string length: 500
Pattern: ^[^\x00]{0,500}$

The full list of call-to-action buttons, up to three, replacing the current list.

Maximum array length: 3

Response

OK

A brand-styled landing page built around a YouTube video.

id
string<shortuuid>
required

Identifier of the page.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
name
string
required

Internal label shown to brand managers when picking a page for a rule.

brand_name_override
string
required

Header brand name shown instead of the brand's own; empty to use the brand's name.

tagline
string
required

One-line tagline under the brand name; empty when none.

primary_color
string
required

Header background colour, a 6-digit hex value such as #0a84ff.

accent_color
string
required

Button and link colour, a 6-digit hex value such as #ff9500.

created
string<date-time>
required

ISO-8601 creation timestamp.

modified
string<date-time>
required

ISO-8601 last-modified timestamp.

youtube_url
string
required

YouTube video shown on the page; empty to show the first video attached to the product being resolved.

description
string
required

Brand-level text shown below the video; empty when none.

Up to three call-to-action buttons, in order.