Get Started
Studio API
- Introduction
- Streaming
- CMS
- Events
- Creative Works
- Entities
- Content Types
- Annotations
- GETGet annotation
- GETList annotations
- POSTCreate annotation
- PATCHUpdate annotation
- DELDelete annotation
- Annotation Types
- Annotation Sets
- Action Types
- Action Secrets
- GET
- OTT
- Monetization
- IAM
- Integration
- Analytics
Content Delivery API
Deep dive
Update annotation set
UpdateAnnotationSet
Updates type
curl --request PATCH \
--url https://api.mottostreaming.com/annotations/sets/v1/{set_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"set_id": "<string>",
"set": {
"project_id": "<string>",
"name": "<string>",
"icon_asset_id": "<string>",
"priority": "<string>",
"disabled": true,
"custom_data": {},
"sport": "SPORT_UNSPECIFIED"
},
"update_mask": "<string>"
}'{
"set": {
"id": "<string>",
"project_id": "<string>",
"name": "<string>",
"icon_asset_id": "<string>",
"priority": "<string>",
"disabled": true,
"custom_data": {},
"sport": "SPORT_UNSPECIFIED"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
AnnotationSet bundles together annotation types that are related, e.g. football annotation types (goal, corner kick, red card, etc).
The name of the annotation set.
The asset ID of the icon. Can be left empty to show no icon.
The priority determines the order in which the annotation sets are shown in the UI. A higher value means it shows up earlier in the list. Note: this also determines the order of the groups in the list response. The groups are ordered by the highest priority of the first element in each group.
Whether the annotation set should be shown in the management UI or not.
Data that can be used to store additional information about the annotation set. This can be useful to communicate additional information to downstream systems that want to act on annotations of this set (e.g. to render overlays in a video).
The sport that this set relates to. Optional.
SPORT_UNSPECIFIED, SPORT_SOCCER, SPORT_AMERICAN_FOOTBALL, SPORT_FUTSAL, SPORT_HANDBALL, SPORT_BASKETBALL, SPORT_VOLLEYBALL, SPORT_RUGBY, SPORT_CRICKET, SPORT_BASEBALL, SPORT_SOFTBALL, SPORT_FIELD_HOCKEY, SPORT_ICE_HOCKEY, SPORT_BEACH_SOCCER, SPORT_BEACH_VOLLEYBALL, SPORT_BEACH_HANDBALL Response
AnnotationSet bundles together annotation types that are related, e.g. football annotation types (goal, corner kick, red card, etc).
The name of the annotation set.
System generated unique identifier for the annotation set.
The asset ID of the icon. Can be left empty to show no icon.
The priority determines the order in which the annotation sets are shown in the UI. A higher value means it shows up earlier in the list. Note: this also determines the order of the groups in the list response. The groups are ordered by the highest priority of the first element in each group.
Whether the annotation set should be shown in the management UI or not.
Data that can be used to store additional information about the annotation set. This can be useful to communicate additional information to downstream systems that want to act on annotations of this set (e.g. to render overlays in a video).
The sport that this set relates to. Optional.
SPORT_UNSPECIFIED, SPORT_SOCCER, SPORT_AMERICAN_FOOTBALL, SPORT_FUTSAL, SPORT_HANDBALL, SPORT_BASKETBALL, SPORT_VOLLEYBALL, SPORT_RUGBY, SPORT_CRICKET, SPORT_BASEBALL, SPORT_SOFTBALL, SPORT_FIELD_HOCKEY, SPORT_ICE_HOCKEY, SPORT_BEACH_SOCCER, SPORT_BEACH_VOLLEYBALL, SPORT_BEACH_HANDBALL curl --request PATCH \
--url https://api.mottostreaming.com/annotations/sets/v1/{set_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"set_id": "<string>",
"set": {
"project_id": "<string>",
"name": "<string>",
"icon_asset_id": "<string>",
"priority": "<string>",
"disabled": true,
"custom_data": {},
"sport": "SPORT_UNSPECIFIED"
},
"update_mask": "<string>"
}'{
"set": {
"id": "<string>",
"project_id": "<string>",
"name": "<string>",
"icon_asset_id": "<string>",
"priority": "<string>",
"disabled": true,
"custom_data": {},
"sport": "SPORT_UNSPECIFIED"
}
}