---
title: "Video"
method: POST
path: "/clubs/{club_id}/videos"
tags: ["Video"]
---

# 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`

Creates a video.

## Path parameters

- `club_id` integer, required

## Request body

- object
  - `video` object
    - `id` integer: ID of the video.
    - `title` string, required: Title of the video.
    - `description` string: Description of the video.
    - `locale` string: Locale of the object. 'de-DE', 'en-GB' or 'nl-NL'. This locale must be whitelisted for your club!
    - `published_at` string, 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.
    - `position` integer: Position of the video in the original feed.
    - `source_type` 'youtube', required: Source of the video.
    - `keywords` string[]: List of keywords.
    - `duration` integer: Duration in seconds of the video.
    - `categories` string[], required: List of categories.
    - `external_view_count` integer: Number of total views on the original video platform.
    - `preview_images` object: Preview images of the video in different resolutions.
      - `thumbnail` string: URL to the image. (120x90>)
      - `medium` string: URL to the image. (320x138>)
      - `large` string: URL to the image. (480x360>)
    - `cover_image` object: Cover image of the video in different resolutions.
      - `small` string: URL to the image.
      - `medium` string: URL to the image.
      - `large` string: URL to the image.
    - `embed_codes` object[], required
      - `code` string: HTML/JS snippet to embed the video in a HTML page.
      - `target` 'any': Target platform of the embed code.
      - `format` 'flash' | 'html5': Format of the video.
      - `quality` string: Quality of the video. For example: "adaptive" (the quality is determined automatically based on the requestiong device), "hd", "sd" (generic quality identifiers), "1080", "720" (specific quality identifiers).
    - `video_links` object[], required: List of links to the original platform to watch the video.
      - `url` string: URL to the video.
      - `target` string: Target platform for the video. For example: "any", "mobile", "desktop".
    - `video_sources` object[]
      - `url` string: URL to the video source.
      - `format` string: Format of the video source. For example: "flash", "mp4", "html5".
      - `quality` string: Quality of the video used by the embed code. For example: "adaptive" (the quality is determined automatically based on the requestiong device), "hd", "sd" (generic quality identifiers), "1080", "720" (specific quality identifiers).
    - `match_id` integer: The ID of the match associated with this video, if any.
    - `protected` boolean: Whether this video is protected.
    - `ranking` integer: 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
    - `prio` boolean
    - `send_as_notification` boolean
    - `external_preview_image_url` string, required: URL to preview image.

## Response `202`

Created

- object
  - `id` integer: ID of the video.
  - `title` string, required: Title of the video.
  - `description` string: Description of the video.
  - `locale` string: Locale of the object. 'de-DE', 'en-GB' or 'nl-NL'. This locale must be whitelisted for your club!
  - `published_at` string, 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.
  - `position` integer: Position of the video in the original feed.
  - `source_type` 'youtube', required: Source of the video.
  - `keywords` string[]: List of keywords.
  - `duration` integer: Duration in seconds of the video.
  - `categories` string[], required: List of categories.
  - `external_view_count` integer: Number of total views on the original video platform.
  - `preview_images` object: Preview images of the video in different resolutions.
    - `thumbnail` string: URL to the image. (120x90>)
    - `medium` string: URL to the image. (320x138>)
    - `large` string: URL to the image. (480x360>)
  - `cover_image` object: Cover image of the video in different resolutions.
    - `small` string: URL to the image.
    - `medium` string: URL to the image.
    - `large` string: URL to the image.
  - `embed_codes` object[], required
    - `code` string: HTML/JS snippet to embed the video in a HTML page.
    - `target` 'any': Target platform of the embed code.
    - `format` 'flash' | 'html5': Format of the video.
    - `quality` string: Quality of the video. For example: "adaptive" (the quality is determined automatically based on the requestiong device), "hd", "sd" (generic quality identifiers), "1080", "720" (specific quality identifiers).
  - `video_links` object[], required: List of links to the original platform to watch the video.
    - `url` string: URL to the video.
    - `target` string: Target platform for the video. For example: "any", "mobile", "desktop".
  - `video_sources` object[]
    - `url` string: URL to the video source.
    - `format` string: Format of the video source. For example: "flash", "mp4", "html5".
    - `quality` string: Quality of the video used by the embed code. For example: "adaptive" (the quality is determined automatically based on the requestiong device), "hd", "sd" (generic quality identifiers), "1080", "720" (specific quality identifiers).
  - `match_id` integer: The ID of the match associated with this video, if any.
  - `protected` boolean: Whether this video is protected.
  - `ranking` integer: 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
  - `prio` boolean
  - `send_as_notification` boolean

## Other responses

- `400`: Parameter missing
- `401`: Unauthorized
- `404`: Not Found

---

[API](https://skmtc.dev/clubplatform/apis/clubplatform-api.md) - [All operations](https://skmtc.dev/clubplatform/apis/clubplatform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/clubplatform/apis/clubplatform-api/revisions/5c107a185e03?raw)