> ## Documentation Index
> Fetch the complete documentation index at: https://docs.closient.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Add product video

> Attach a YouTube video link to the product. The URL must be one a video id can be parsed from (watch / youtu.be / embed); other URLs are rejected with 422. Requires the ``organization.contribute_organization`` permission on the membership.



## OpenAPI

````yaml /openapi/openapi-dashboard.json post /dashboard/api/v1/trade-items/{organization_id}/{gtin}/videos
openapi: 3.1.0
info:
  title: Brand Dashboard API (Internal)
  version: 1.0.0
  description: >
    Internal endpoints powering the brand dashboard UI. Not intended for
    external integrations — use the Products, Brands, and other public APIs
    instead.


    ## Authentication


    All endpoints require an API key passed via the `X-API-Key` HTTP header,
    unless otherwise noted.


    ```

    X-API-Key: csb_<body>_<checksum>

    ```


    Generate API keys in **Settings > API Keys** in your dashboard, or via the
    Account API.

    Session-based (cookie) authentication is also accepted for browser-based
    access.


    ## Rate Limits


    | Tier        | Requests / minute | Requests / day |

    |-------------|-------------------|----------------|

    | Default     | 300               | 10,000         |

    | Custom      | Contact us        | Contact us     |


    Rate-limit headers are included on every response so callers can
    self-throttle without

    hitting our 429s ("informed governor"):


    - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400`

    - `RateLimit-Limit` — quota for the **most-restrictive** currently-active
    window

    - `RateLimit-Remaining` — requests left in that window

    - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew
    safe)


    Legacy `X-RateLimit-*` aliases are also emitted for back-compat.
    `X-RateLimit-Reset`

    keeps the absolute Unix-timestamp shape to avoid breaking existing
    consumers.


    When rate-limited, you receive `429 Too Many Requests` with a
    `retry_after_seconds` field

    in the error envelope and a `Retry-After` header.


    ## Pagination


    List endpoints return paginated results in this envelope:


    ```json

    {
      "data": [...],
      "pagination": {
        "page": 1,
        "page_size": 25,
        "total_count": 342,
        "total_pages": 14,
        "has_next": true,
        "has_previous": false
      }
    }

    ```


    Use `?page=2&page_size=50` query parameters. Maximum page size is 100.


    ## Error Responses


    All errors conform to [RFC 9457 Problem
    Details](https://www.rfc-editor.org/rfc/rfc9457)

    with `Content-Type: application/problem+json`:


    ```json

    {
      "type": "https://closient.com/docs/errors/not_found",
      "title": "Not Found",
      "status": 404,
      "detail": "The requested resource was not found.",
      "error_code": "not_found",
      "retryable": false,
      "timestamp": "2026-03-31T12:00:00+00:00"
    }

    ```


    Common error codes: `unauthorized` (401), `forbidden` (403), `not_found`
    (404),

    `validation_error` (422), `rate_limited` (429), `internal_error` (500).
  termsOfService: https://www.closient.com/terms/
servers:
  - url: https://www.closient.com
security: []
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /dashboard/api/v1/trade-items/{organization_id}/{gtin}/videos:
    post:
      tags:
        - Videos
      summary: Add product video
      description: >-
        Attach a YouTube video link to the product. The URL must be one a video
        id can be parsed from (watch / youtu.be / embed); other URLs are
        rejected with 422. Requires the ``organization.contribute_organization``
        permission on the membership.
      operationId: apps_dashboard_api_videos_add_video
      parameters:
        - in: path
          name: organization_id
          schema:
            description: UUID of the organization that owns the product.
            format: shortuuid
            maxLength: 22
            minLength: 22
            pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
            title: Organization Id
            type: string
          required: true
          description: UUID of the organization that owns the product.
        - in: path
          name: gtin
          schema:
            description: >-
              GTIN-8/12/13/14 of the target product. Normalized to GTIN-14 by
              zero-padding before lookup.
            pattern: ^\d{8,14}$
            title: Gtin
            type: string
          required: true
          description: >-
            GTIN-8/12/13/14 of the target product. Normalized to GTIN-14 by
            zero-padding before lookup.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProductVideoIn'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductVideoOut'
      security:
        - APIKeyHeaderAuth: []
        - OAuthTokenAuth: []
        - SessionAuth: []
components:
  schemas:
    ProductVideoIn:
      description: Request body for adding a YouTube video link to a product.
      examples:
        - description: How to use the product
          priority: 0
          title: Product overview
          youtube_url: https://www.youtube.com/watch?v=dQw4w9WgXcQ
      properties:
        youtube_url:
          description: >-
            YouTube video URL. Must be a watch / youtu.be / embed URL a video id
            can be parsed from.
          examples:
            - https://www.youtube.com/watch?v=dQw4w9WgXcQ
          format: uri
          title: Youtube Url
          type: string
        title:
          default: ''
          description: Caption for the video. Empty string when not specified.
          examples:
            - Product overview
          maxLength: 255
          title: Title
          type: string
        description:
          default: ''
          description: Free-text description of the video. Empty string when not specified.
          title: Description
          type: string
        priority:
          default: 0
          description: >-
            Display order within the product's video list. Lower numbers appear
            first; ties break on ``-created``.
          minimum: 0
          title: Priority
          type: integer
      required:
        - youtube_url
      title: ProductVideoIn
      type: object
    ProductVideoOut:
      description: A single YouTube video attached to a product.
      examples:
        - created: '2025-07-01T14:00:00Z'
          description: How to use the product
          embed_url: https://www.youtube.com/embed/dQw4w9WgXcQ
          id: keATfB8VP2gSjcnTbsMNQL
          priority: 0
          thumbnail_url: https://img.youtube.com/vi/dQw4w9WgXcQ/maxresdefault.jpg
          title: Product overview
          video_id: dQw4w9WgXcQ
          youtube_url: https://www.youtube.com/watch?v=dQw4w9WgXcQ
      properties:
        id:
          description: >-
            URL-safe 22-character shortuuid encoding of the row's UUID primary
            key. Stable across the row's lifetime; suitable for sharing in URLs,
            log lines, and external SDK clients. Accepted on input as either the
            shortuuid form or the canonical UUID form
            (``xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx``).
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Id
          type: string
        youtube_url:
          description: YouTube video URL as entered.
          examples:
            - https://www.youtube.com/watch?v=dQw4w9WgXcQ
          format: uri
          title: Youtube Url
          type: string
        title:
          description: Caption for the video. Empty string when not set.
          maxLength: 255
          title: Title
          type: string
        description:
          description: Free-text description of the video. Empty string when not set.
          title: Description
          type: string
        priority:
          description: >-
            Display order within the product's video list. Lower numbers appear
            first.
          minimum: 0
          title: Priority
          type: integer
        video_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Parsed YouTube video id (e.g. ``dQw4w9WgXcQ``). Null when the URL
            couldn't be parsed.
          title: Video Id
        embed_url:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            YouTube embed URL derived from ``video_id``. Null when the URL
            couldn't be parsed.
          format: uri
          title: Embed Url
        thumbnail_url:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            YouTube thumbnail URL derived from ``video_id``. Null when the URL
            couldn't be parsed.
          format: uri
          title: Thumbnail Url
        created:
          description: ISO-8601 UTC timestamp of when the video was added.
          format: date-time
          title: Created
          type: string
      required:
        - id
        - youtube_url
        - title
        - description
        - priority
        - created
      title: ProductVideoOut
      type: object
  securitySchemes:
    APIKeyHeaderAuth:
      type: apiKey
      in: header
      name: X-API-Key
    OAuthTokenAuth:
      type: http
      scheme: bearer
    SessionAuth:
      type: apiKey
      in: cookie
      name: sessionid

````