Sign in

v50

latestOpenAPI 3.0.3raw.githubusercontent.com2025-01-2810050281.4 KB
Custom Fields

Update a Custom Field

Update a new custom field for the account

patch/v1/accounts/{{account_id}}/video_fields/custom_fields/{{custom_field_id}}

Path parameters

account_idstring required

Video Cloud account ID.

custom_field_idstring required

Custom Field ID.

Headers

Content-Typestring required

Content-Type: application/json

Authorizationstring required

Authorization: Bearer {access_token} - see Getting Access Tokens

Request body

descriptionstring

description (instruction for user)

display_namestring

display name

enum_valuesstring[]

Array of string values for select type fields (by default the maximum is 100 values; this can be increased up to 1000 by submitting a request to Support).

This field is required for enum types, and not allowed for string types.

idstring

Data name for the field (used to access it in searches, etc.)

Note the following requirements for the custom field id:

  • all lowercase
  • no spaces (use underscore [_] instead)
  • max length: 128 single-byte characters
  • must be unique among all custom fields for the account
  • must not be one of the Reserved names

Note that updating the id will trigger an internal process to update the id in any videos that have the custom field.

requiredboolean

whether field must have a value before video can be active

typestring

custom field type (enum or string)

Response

200

descriptionstring

description (instruction for user)

display_namestring

display name

enum_valuesstring[]

Array of string values for select type fields (by default the maximum is 100 values; this can be increased up to 1000 by submitting a request to Support).

This field is required for enum types, and not allowed for string types.

idstring

Data name for the field (used to access it in searches, etc.)

Note the following requirements for the custom field id:

  • all lowercase
  • no spaces (use underscore [_] instead)
  • max length: 128 single-byte characters
  • must be unique among all custom fields for the account
  • must not be one of the Reserved names

Note that updating the id will trigger an internal process to update the id in any videos that have the custom field.

requiredboolean

whether field must have a value before video can be active

typestring

custom field type (enum or string)