POST
/
ott
/
platforms
/
v1

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
id
string
required

System generated identifier for the platform.

project_id
string
required
name
string

The name of this platform. Not shown to end users.

hosts
string[]

The hosts that this platform should be served on. Should follow the format of example.com or ott.example.com. Should not include https://, www. or any path components. This should be left empty if the page is not specific to any specific host, but should cover all hosts that may serve the OTT platform.

locales
string[]

The locales you would like to support on this platform. The format should be the language code, e.g. "en", "de", "fr", etc, optionally followed by a region code, e.g. "en-US", "en-GB", etc.

Note: The platform itself may not support all locales. When it does not, it will default to default_locale.

default_locale
string

The default locale for this platform. This is used to determine the default language for the platform.

Note: The platform itself may not support all languages. It will reject the default_locale if it references an unsupported language.

title
object

A map of localized titles for this platform, for end users to see. The key is the locale. Important: this is also used in the page's HTML <metadata> and <title> tags. Can be overwritten by individual pages.

logo_asset_id
string

The logo asset ID that should be used as the logo for this platform.

favicon_asset_id
string

The favicon asset ID that should be used as the favicon for this platform.

colors
object

A set of colors that should be used in the platform. The available keys are currently:

  • primary: The primary color of the platform (in light mode). This is used to highlight important elements.
  • primary_dark: The primary color of the platform (in dark mode). This is used to highlight important elements.
  • background: The background color of the platform (in light mode).
  • background_dark: The background color of the platform (in dark mode).
  • button_from and button_to: The gradient colors for buttons.

The values should be hex color codes, e.g. #FFFFFF.

navbar_entries
object[]

A set of navigation bar entries that should be shown on the platform.

footer_entries
object[]

A set of footer entries that should be shown on the platform.

feature_configuration
object

The features that should be enabled on this platform. Any feature not included in this list will be disabled by default (unless it is a required, non-configurable feature).

The key in this map is a feature ID. Currently supported features: search: The search feature. This will add a search field to the navigation bar. sign_up: The sign up/in feature. This will add a sign up/in button to the navigation bar.

scripts
string

Web only. Scripts that should be included in the pages of the platform. Primarily useful for such things as Google Analytics scripts.

css
string

Web only. Global CSS rules that should be included in all pages of the platform. This is useful in two scenarios:

  1. Affecting default styling across all pages of the platform
  2. Affecting page-specific styling for static pages that do not have a Page object to represent them (e.g. a sign in/up page). In all other scenarios, it is recommended to apply CSS rules to the Page object itself.

Response

200 - application/json
platform
object

Platform is a configuration object that defines the structure of a Motto OTT platform instance.

List platformsUpdate platform