Get Started
Content Delivery API
Deep dive
curl --request PATCH \
--url https://api.mottostreaming.com/cms/types/v1 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"base_type": "BASE_TYPE_UNSPECIFIED",
"type": {
"project_id": "<string>",
"base_type": "BASE_TYPE_UNSPECIFIED",
"name": "<string>",
"id": "<string>",
"description": "<string>",
"field_groups": [
{
"title": "<string>",
"fields": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "FIELD_TYPE_UNSPECIFIED",
"input_type": "INPUT_TYPE_UNSPECIFIED",
"validations": {
"count": {
"min": "<string>",
"max": "<string>"
},
"length": {
"min": "<string>",
"max": "<string>"
},
"range": {
"start": "<unknown>",
"exclude_start": true,
"end": "<unknown>",
"exclude_end": true
},
"in": {
"values": [
"<unknown>"
]
},
"link_type": {
"type_ids": [
"<string>"
],
"base_type": "BASE_TYPE_UNSPECIFIED",
"additional_fields": [
"<string>"
],
"editor_filter": {}
},
"asset": {
"types": [
"<string>"
]
}
},
"default_value": "<unknown>",
"visibility": "VISIBILITY_UNSPECIFIED"
}
]
}
],
"disabled": true,
"visibility": "VISIBILITY_UNSPECIFIED",
"settings": {
"allow_following": true,
"allow_push_notifications": true
}
},
"update_mask": "<string>"
}
'{
"type": {
"project_id": "<string>",
"base_type": "BASE_TYPE_UNSPECIFIED",
"name": "<string>",
"id": "<string>",
"description": "<string>",
"field_groups": [
{
"title": "<string>",
"fields": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "FIELD_TYPE_UNSPECIFIED",
"input_type": "INPUT_TYPE_UNSPECIFIED",
"validations": {
"count": {
"min": "<string>",
"max": "<string>"
},
"length": {
"min": "<string>",
"max": "<string>"
},
"range": {
"start": "<unknown>",
"exclude_start": true,
"end": "<unknown>",
"exclude_end": true
},
"in": {
"values": [
"<unknown>"
]
},
"link_type": {
"type_ids": [
"<string>"
],
"base_type": "BASE_TYPE_UNSPECIFIED",
"additional_fields": [
"<string>"
],
"editor_filter": {}
},
"asset": {
"types": [
"<string>"
]
}
},
"default_value": "<unknown>",
"visibility": "VISIBILITY_UNSPECIFIED"
}
]
}
],
"disabled": true,
"visibility": "VISIBILITY_UNSPECIFIED",
"settings": {
"allow_following": true,
"allow_push_notifications": true
}
}
}Update type
curl --request PATCH \
--url https://api.mottostreaming.com/cms/types/v1 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"base_type": "BASE_TYPE_UNSPECIFIED",
"type": {
"project_id": "<string>",
"base_type": "BASE_TYPE_UNSPECIFIED",
"name": "<string>",
"id": "<string>",
"description": "<string>",
"field_groups": [
{
"title": "<string>",
"fields": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "FIELD_TYPE_UNSPECIFIED",
"input_type": "INPUT_TYPE_UNSPECIFIED",
"validations": {
"count": {
"min": "<string>",
"max": "<string>"
},
"length": {
"min": "<string>",
"max": "<string>"
},
"range": {
"start": "<unknown>",
"exclude_start": true,
"end": "<unknown>",
"exclude_end": true
},
"in": {
"values": [
"<unknown>"
]
},
"link_type": {
"type_ids": [
"<string>"
],
"base_type": "BASE_TYPE_UNSPECIFIED",
"additional_fields": [
"<string>"
],
"editor_filter": {}
},
"asset": {
"types": [
"<string>"
]
}
},
"default_value": "<unknown>",
"visibility": "VISIBILITY_UNSPECIFIED"
}
]
}
],
"disabled": true,
"visibility": "VISIBILITY_UNSPECIFIED",
"settings": {
"allow_following": true,
"allow_push_notifications": true
}
},
"update_mask": "<string>"
}
'{
"type": {
"project_id": "<string>",
"base_type": "BASE_TYPE_UNSPECIFIED",
"name": "<string>",
"id": "<string>",
"description": "<string>",
"field_groups": [
{
"title": "<string>",
"fields": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "FIELD_TYPE_UNSPECIFIED",
"input_type": "INPUT_TYPE_UNSPECIFIED",
"validations": {
"count": {
"min": "<string>",
"max": "<string>"
},
"length": {
"min": "<string>",
"max": "<string>"
},
"range": {
"start": "<unknown>",
"exclude_start": true,
"end": "<unknown>",
"exclude_end": true
},
"in": {
"values": [
"<unknown>"
]
},
"link_type": {
"type_ids": [
"<string>"
],
"base_type": "BASE_TYPE_UNSPECIFIED",
"additional_fields": [
"<string>"
],
"editor_filter": {}
},
"asset": {
"types": [
"<string>"
]
}
},
"default_value": "<unknown>",
"visibility": "VISIBILITY_UNSPECIFIED"
}
]
}
],
"disabled": true,
"visibility": "VISIBILITY_UNSPECIFIED",
"settings": {
"allow_following": true,
"allow_push_notifications": true
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
BASE_TYPE_UNSPECIFIED, BASE_TYPE_EVENT, BASE_TYPE_CREATIVE_WORK, BASE_TYPE_ENTITY Show child attributes
Show child attributes
BASE_TYPE_UNSPECIFIED, BASE_TYPE_EVENT, BASE_TYPE_CREATIVE_WORK, BASE_TYPE_ENTITY Show child attributes
Show child attributes
Show child attributes
Show child attributes
FIELD_TYPE_UNSPECIFIED, FIELD_TYPE_STRING, FIELD_TYPE_INTEGER, FIELD_TYPE_DOUBLE, FIELD_TYPE_DATETIME, FIELD_TYPE_BOOLEAN, FIELD_TYPE_LINK, FIELD_TYPE_ASSET, FIELD_TYPE_OBJECT INPUT_TYPE_UNSPECIFIED, INPUT_TYPE_COLOR_PICKER, INPUT_TYPE_TEXTAREA Show child attributes
Show child attributes
Show child attributes
Show child attributes
Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.
Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.
Show child attributes
Show child attributes
BASE_TYPE_UNSPECIFIED, BASE_TYPE_EVENT, BASE_TYPE_CREATIVE_WORK, BASE_TYPE_ENTITY Additional fields that can be collected along with the link. The entries in this array are the keys of the
dictionary in which these fields are stored. The values in that dictionary are untyped fields, and can be any JSON.
E.g. shirt_number and position are additional fields for a link to a player.
This is a special field to assist the Studio UI in filtering selectable links while managing content items.
There should be a key for each element in the type_ids array (e.g. season).
The value is a KQL filter query with a dynamic component (e.g. fields.competition.id:{competition.id}).
In this example, {competition.id} is a placeholder that will be replaced with the id property of the object
referenced by the property on this type called competition.
Important: do not confuse competition in the example above with a type_id. It is a field name of the type that
is defined in the key.
Show child attributes
Show child attributes
Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.
VISIBILITY_UNSPECIFIED, VISIBILITY_PUBLISHED, VISIBILITY_UNLISTED, VISIBILITY_HIDDEN VISIBILITY_UNSPECIFIED, VISIBILITY_PUBLISHED, VISIBILITY_UNLISTED, VISIBILITY_HIDDEN Show child attributes
Show child attributes
Whether the content type is able to be followed by users. Defaults to false.
Whether the content type can be be the source of push notifications. When the messaging service detects related activity that would invoke a push notification, it will check this field to determine if it should send a push notification. For example, if a user follows a competition entity, this may be too broad a category to trigger notifications on, as it may then cause a push notification for every match within that competition. Defaults to false.
Response
OK
Show child attributes
Show child attributes
BASE_TYPE_UNSPECIFIED, BASE_TYPE_EVENT, BASE_TYPE_CREATIVE_WORK, BASE_TYPE_ENTITY Show child attributes
Show child attributes
Show child attributes
Show child attributes
FIELD_TYPE_UNSPECIFIED, FIELD_TYPE_STRING, FIELD_TYPE_INTEGER, FIELD_TYPE_DOUBLE, FIELD_TYPE_DATETIME, FIELD_TYPE_BOOLEAN, FIELD_TYPE_LINK, FIELD_TYPE_ASSET, FIELD_TYPE_OBJECT INPUT_TYPE_UNSPECIFIED, INPUT_TYPE_COLOR_PICKER, INPUT_TYPE_TEXTAREA Show child attributes
Show child attributes
Show child attributes
Show child attributes
Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.
Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.
Show child attributes
Show child attributes
BASE_TYPE_UNSPECIFIED, BASE_TYPE_EVENT, BASE_TYPE_CREATIVE_WORK, BASE_TYPE_ENTITY Additional fields that can be collected along with the link. The entries in this array are the keys of the
dictionary in which these fields are stored. The values in that dictionary are untyped fields, and can be any JSON.
E.g. shirt_number and position are additional fields for a link to a player.
This is a special field to assist the Studio UI in filtering selectable links while managing content items.
There should be a key for each element in the type_ids array (e.g. season).
The value is a KQL filter query with a dynamic component (e.g. fields.competition.id:{competition.id}).
In this example, {competition.id} is a placeholder that will be replaced with the id property of the object
referenced by the property on this type called competition.
Important: do not confuse competition in the example above with a type_id. It is a field name of the type that
is defined in the key.
Show child attributes
Show child attributes
Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.
VISIBILITY_UNSPECIFIED, VISIBILITY_PUBLISHED, VISIBILITY_UNLISTED, VISIBILITY_HIDDEN VISIBILITY_UNSPECIFIED, VISIBILITY_PUBLISHED, VISIBILITY_UNLISTED, VISIBILITY_HIDDEN Show child attributes
Show child attributes
Whether the content type is able to be followed by users. Defaults to false.
Whether the content type can be be the source of push notifications. When the messaging service detects related activity that would invoke a push notification, it will check this field to determine if it should send a push notification. For example, if a user follows a competition entity, this may be too broad a category to trigger notifications on, as it may then cause a push notification for every match within that competition. Defaults to false.