Update page component

Authorizations

Authorization

string

header

required

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

Path Parameters

page_component_id

string

required

Body

application/json

page_component_id

string

required

page_component_update

object

required

page_component_update.project_id

string

required

page_component_update.data

object

Data needed by individual components. Each component can have its own data structure. Refer to the documentation for the specific component to see what data is needed.

page_component_update.environments

string[]

The environments in which this component should be rendered. The available options are: "web", "ios", "android", "tvos", "lg", "samsung", "androidtv" If left empty, the component will be rendered in all environments (when possible).

page_component_update.group_id

string

An arbitrary string that can be used to group components together. This is useful to render a group of components in a shared container so that they can be styled/positioned together. Any component that shares a group_id with another component must immediately precede or follow it. If a group_id is not provided, the component's own id will be used as the group_id.

page_component_update.name

string

page_component_update.props

object

Additional properties that can be used to customize the rendering of this component. This can be used in two ways:

If you are using the Motto OTT platform, you can find the available keys and values in our OTT documentation.
If you are rendering the component yourself, you can use this map to pass arbitrary data to your rendering engine.

page_component_update.type

string

The type of component that should be rendered. Refer to the documentation to find the available types.

page_component_update.visibility

enum<string>

Available options:

VISIBILITY_UNSPECIFIED,

VISIBILITY_PUBLISHED,

VISIBILITY_UNLISTED,

VISIBILITY_HIDDEN

update_mask

string

required

A comma-separated list of fields to be updated. Only fields specified in this mask will be updated. Note: to update the configuration of any of the non-standard fields on this component, use type in the field mask instead of their field name. For example, if this component is for the video player, do not include video_player in the field mask. Instead, include type.

Response

200 - application/json

page_component

object

page_component.project_id

string

required

page_component.data

object

Data needed by individual components. Each component can have its own data structure. Refer to the documentation for the specific component to see what data is needed.

page_component.environments

string[]

page_component.group_id

string

page_component.id

string

page_component.name

string

page_component.props

object

Additional properties that can be used to customize the rendering of this component. This can be used in two ways:

If you are using the Motto OTT platform, you can find the available keys and values in our OTT documentation.
If you are rendering the component yourself, you can use this map to pass arbitrary data to your rendering engine.

page_component.type

string

The type of component that should be rendered. Refer to the documentation to find the available types.

page_component.visibility

enum<string>

Available options:

VISIBILITY_UNSPECIFIED,

VISIBILITY_PUBLISHED,

VISIBILITY_UNLISTED,

VISIBILITY_HIDDEN

Get Started

Studio API

Content Delivery API

Deep dive

Update page component

Authorizations

Path Parameters

Body

Response