Sign in

v1

latestOpenAPI 3.1.02026-07-2416666272.6 KB
Custom Fields

Update custom field

Updates a custom field on a video (by id query). key is optional (must stay unique), value is required (1-500 chars).

put/videos/{video_id}

Path parameters

video_idstring uuid required

Unique identifier for the video

Query parameters

custom_fields'true' required

Set to 'true' to update a custom field

idstring uuid required

Custom field ID to update

Request body

keystring

New key for the custom field. Must be unique per video.

valuestring

New value for the custom field. Required and cannot be empty.

Example request

{
  "key": "updated_category",
  "value": "Updated Category"
}

Response

Custom field updated successfully

idstring uuid

Unique identifier for the custom field

video_idstring uuid

ID of the video this custom field belongs to

keystring

Custom field key/name

valuestring nullable

Custom field value

created_atstring date-time

Custom field creation timestamp

updated_atstring date-time

Last update timestamp

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "video_id": "987fcdeb-51a2-4e59-a125-23379b3692b5",
  "key": "category",
  "value": "Educational",
  "created_at": "2023-01-15T10:30:00Z",
  "updated_at": "2023-01-15T10:30:00Z"
}