Sign in

v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB
content type schemas

Create schema

Create a new schema for a site

post/v2/sites/{site_id}/content_type_schemas/

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

Request body

Example request

{
  "metadata": {
    "display_name": "Concert Venue",
    "name": "concert_venue",
    "sections": [
      {
        "title": "Roku Related Fields",
        "fields": [
          {
            "param": "roku-app-id",
            "label": "Roku App ID",
            "required": true,
            "details": {
              "inputType": "email",
              "placeholder": "Input a value here.",
              "pattern": "[a-z0-9-]+\\.(?:com|org)(?:\\.[a-z]{2,3})?"
            }
          }
        ]
      }
    ],
    "description": "The Concert Venue Schema allows to group Media Items (e.g. Concerts) depending on the Venue where it took place.",
    "is_active": true
  }
}

Response

Request to create schema successful

schemastring
idstring

Unique identifier for a resource

createdstring

Date and time at which the resource was created

last_modifiedstring

Date and time at which the resource was most recently modified

typestring

Name of the type of resource.

relationshipsobject

Ancilliary resources associated to the primary resource being read

Example response

{
  "schema": "https://schema.jwplayer.com/types/thumbnail.json",
  "id": "Ny05CEfj",
  "created": "2019-09-25T15:29:11.042095+00:00",
  "last_modified": "2019-09-25T15:29:11.042095+00:00",
  "metadata": {
    "display_name": "Concert Venue",
    "name": "concert_venue",
    "sections": [
      {
        "title": "Roku Related Fields",
        "fields": [
          {
            "param": "roku-app-id",
            "label": "Roku App ID",
            "required": true,
            "details": {
              "inputType": "email",
              "placeholder": "Input a value here.",
              "pattern": "[a-z0-9-]+\\.(?:com|org)(?:\\.[a-z]{2,3})?"
            }
          }
        ]
      }
    ],
    "description": "The Concert Venue Schema allows to group Media Items (e.g. Concerts) depending on the Venue where it took place.",
    "is_active": true
  }
}