POST
/
ott
/
page_components
/
v1
curl --request POST \
  --url https://api.mottostreaming.com/ott/page_components/v1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "project_id": "<string>",
  "name": "<string>",
  "type": "<string>",
  "data": {},
  "props": {},
  "environments": [
    "<string>"
  ],
  "visibility": "VISIBILITY_UNSPECIFIED",
  "group_id": "<string>"
}'
{
  "page_component": {
    "id": "<string>",
    "project_id": "<string>",
    "name": "<string>",
    "type": "<string>",
    "data": {},
    "props": {},
    "environments": [
      "<string>"
    ],
    "visibility": "VISIBILITY_UNSPECIFIED",
    "group_id": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
project_id
string
required
​
name
string
​
type
string

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

​
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.

​
props
object

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

  1. If you are using the Motto OTT platform, you can find the available keys and values in our OTT documentation.
  2. If you are rendering the component yourself, you can use this map to pass arbitrary data to your rendering engine.
​
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).

​
visibility
enum<string>
Available options:
VISIBILITY_UNSPECIFIED,
VISIBILITY_PUBLISHED,
VISIBILITY_UNLISTED,
VISIBILITY_HIDDEN
​
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.

Response

200
application/json
OK
​
page_component
object