Tags
Creator tags can be managed using the CREATE USER and UPDATE USER endpoints. There are two types of tags associated with creators: general tags and authorized stream tags.
General tags are added, edited, and returned with the user object when it is returned in the API. This allows you to add information for future use.
Requirements:
- Must be an array of objects.
- Each tag object must have a "name" field.
Additional fields can be included in each tag object and will be stored and returned.
Example:
"tags": [
{
"name": "Sports Commentator",
"experience": "5 years",
"specialty": "Football"
},
{
"name": "Podcast Host"
}
]
"authorized_stream_tags" define the tags a user can add to a stream. When adding a stream, a user can add tags to the stream from this list, and their selected tags will appear as stream tags.
Requirements:
- Must be an array of objects.
- Each tag object must have a "name" field.
- Optional "tag_thumbnail" field can be included to display an image next to the tag name in the user interface.
Any other fields can be added and will be stored and returned when the stream is retrieved.
Example:
"authorized_stream_tags": [
{
"name": "NFL",
"tag_thumbnail": "https://example.com/nfl-logo.png",
"league_id": "nfl-2023",
"season": "2023-2024"
},
{
"name": "NBA",
"tag_thumbnail": "https://example.com/nba-logo.png"
}
]
Returned as "tags" in the stream object.
Always includes the "name" field and any additional information associated with the tag.
These tags are typically derived from the creator's authorized stream tags when the stream is created, and represent what tags a user has selected in their interface from the list of authorized stream tags.
Example:
"tags": [
{
"name": "NFL",
"tag_thumbnail": "https://example.com/nfl-logo.png",
"league_id": "nfl-2023",
"season": "2023-2024",
"game_id": "20231015-SEA-CIN"
}
]