POST /clubs/{club_id}/videos – Clubplatform API

Video

Creates a video.

post/clubs/{club_id}/videos

Request

Base URL
https://api.clubplatform.de/api
URL
https://api.clubplatform.de/api/clubs/{club_id}/videos
Auth
API key in query parameter auth_token

Path parameters

club_idinteger required

ID of the club.

Request body

Example request

{
  "video": {
    "locale": "de-DE",
    "ranking": 5,
    "prio": true
  }
}

Response

Created

idinteger

ID of the video.

titlestring required

Title of the video.

descriptionstring

Description of the video.

localestring

Locale of the object. 'de-DE', 'en-GB' or 'nl-NL'. This locale must be whitelisted for your club!

published_atstring date-time required

Date and time when a video was published.

Date of published_at might be before the time the video got imported the first time.

positioninteger

Position of the video in the original feed.

source_type'youtube' required

Source of the video.

keywordsstring[]

List of keywords.

durationinteger

Duration in seconds of the video.

categoriesstring[] required

List of categories.

external_view_countinteger

Number of total views on the original video platform.

match_idinteger

The ID of the match associated with this video, if any.

protectedboolean

Whether this video is protected.

rankinginteger

The value of ranking can be between 1 to 100 or null. If ranking_feature of this club is disabled it will always be null

prioboolean

send_as_notificationboolean

Example response

{
  "locale": "de-DE",
  "ranking": 5,
  "prio": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.