CMS API Custom Fields Reference

This is a reference to video fields returned by the CMS API for a get request to: https://cms.api.brightcove.com/v1/accounts/{{account_id}}/video_fields.

Custom fields

Field	Type	Description
`max_custom_fields`	Number	Number of custom fields a publisher can create on the account
`custom_fields`	Array	List of custom field objects on the account
`standard_fields`	Array	List of fields that are required or have a description. Standard fields that have neither will not appear in this array.

Custom field map

For each custom field:

Field	Type	Description
`id`	String	Internal name of the field. Cannot be updated; any mismatch during update requests will result in rejection.
`description`	String
`display_name`	String
`type`	String	One of 'enum', 'string', 'boolean', 'date' (ISO-8601 date format), or 'numeric' (which translate to 'List', 'Text', 'Toggle', 'Date Picker', or 'Number Input' in the UI)
`enum_values`	Array	Array of String values valid for the custom field; only present when type = 'enum'
`required`	Boolean	Whether this field must have a value before the video can be activated
`numeric_values`	Map	Specifies a `max` and `min` range for numeric fields. The `max` and `min` values are required for validation but can be omitted if no range validation is needed. Example: { "max": 200, "min": 50 }.