Update a video's visibility

PATCH/v1/videos/{id}

Sets the video's visibility. private (the default) keeps playback sessions mintable only through authenticated callers; unlisted and public additionally enable the anonymous embed surface — the hosted watch page, the copy-paste iframe, and oEmbed. public alone marks the hosted page indexable. Requires an API key with write scope. Rate limit: 60 requests per 60 s per caller.

Error codes: unauthorized (401), insufficient_scope (403), account_not_approved (403), invalid_project_id (400), not_found (404), video_not_found (404), invalid_body (400).

Authentication

apiKey — Project API key: Authorization: Bearer vh_live_... (live mode) or Authorization: Bearer vh_test_... (test mode). Keys carry read and/or write scopes.

Parameters

Name	In	Type	Required	Description
`id`	path	string (Ulid)	Yes	—

Request body

required

Content type: application/json

Schema: VideoUpdateRequest

{
  "visibility": "unlisted"
}

Responses

Status	Meaning
`200`	The updated video.
`400`	The request body or query failed validation. The per-operation description lists the exact `error.code` values.
`401`	No valid credential was presented.
`403`	The credential is valid but does not permit this action. The per-operation description lists the exact `error.code` values.
`404`	The resource does not exist or is not visible to this caller.
`429`	Rate limit exceeded.

Example request

{
  "visibility": "unlisted"
}

Try it

PATCH

/v1/videos/{id}

Test mode only

API playground

Send a live request to api.videohati.com with a test-mode key.

This playground blocks vh_live_ keys. Use a key that starts with vh_test_ only; a request with a live key never leaves your browser.

Test-mode API key

The key is stored in your browser on docs.videohati.com only.

Request body (JSON)