Resource that represents a custom field.

$idstring

$schemaconst

Specific value: "https://schema.yext.com/config/km/field/v1"

descriptionstring

Description of the custom field .

descriptionTranslationarray

Translations of the description for different locale codes.

Each item of this array must be:

Type: object

string Required

The locale code of the translation.

string Required

The value of the translation.

displayNamestring Required

Display name of the field.

displayNameTranslationarray

Translations of the displayName for different locale codes.

Each item of this array must be:

groupenum (of string) Required

The ID of the custom field group for which this field belongs, NONE if this field isn’t in a custom field group. Custom fields that are in the same group are displayed in a section together in the entity page and have the same permissions

Must be one of:

  • “NONE”
  • “GROUP1”
  • “GROUP2”
  • “GROUP3”
  • “GROUP4”
  • “GROUP5”
  • “GROUP6”
  • “GROUP7”
  • “GROUP8”
  • “GROUP9”
  • “GROUP10”
  • “GROUP11”
  • “GROUP12”
  • “GROUP13”
  • “GROUP14”
  • “GROUP15”
  • “GROUP16”
  • “GROUP17”
  • “GROUP18”
  • “GROUP19”
  • “GROUP20”
  • “GROUP21”
  • “GROUP22”
  • “GROUP23”
  • “GROUP24”
  • “GROUP25”
  • “GROUP26”
  • “GROUP27”
  • “GROUP28”
  • “GROUP29”
  • “GROUP30”

localizationenum (of string) Required

Custom Field multi-language profile behavior. PRIMARYONLY: The Custom Field can only have a value set on its primary language profile. OVERRIDABLE: The Custom Field can have a value set on any alternate language profiles, which will override the primary language profile value when the alternate language profile is requested. When requested, if a value is not set for an alternate language profile, the primary language profile value will be returned. LANGUAGESPECIFIC: The Custom Field can have a value set on any alternate language profiles. When requested, if a value is not set for an alternate language profile, no value will be returned.

Must be one of:

  • “PRIMARY_ONLY”
  • “OVERRIDABLE”
  • “LOCALE_SPECIFIC”

typeobject

Property that defines data type for this field’s content.

object

A Boolean (Yes/No) type.

object

A Date type.

object

A type describing a certain date.

integer Required

Year of the date.

Value must be greater or equal to 0

integer Required

Month of the date.

Value must be greater or equal to 1 and lesser or equal to 12

integer Required

Day of the date.

Value must be greater or equal to 1 and lesser or equal to 31

object

A type describing a certain date.

Same definition as type_dateType_minValue

object

A Decimal type.

string

string

object

An Image type.

Must not be:

Type: object

const

Specific value: true

object Required

Must not be:

Type: object

const

Specific value: false

object

boolean

A flag determining if the image is simple or complex. A simple image contains a source url and an alternate text of an image. A complex image contains a simple image, caption, details and a click-through URL.

object

Minimum size of the image.

integer Required

Width of the image in pixels.

Value must be greater or equal to 0 and lesser or equal to 10000

integer Required

Height of the image in pixels.

Value must be greater or equal to 0 and lesser or equal to 10000

array of enum (of string)

The set of aspect ratios supported by the image type.

Must contain a maximum of 1 items

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • null
  • null
  • null
  • null
  • null
  • null
  • null
  • null
  • null
  • null

integer

The horizontal value for the aspect ratio.

integer

The vertical value for the aspect ratio.

boolean

Flag to determine if a custom aspect ratio is supported by this image.

boolean

Flag to determine if any aspect ratio is allowed.

object

A List type.

string Required

The type ID of the list items.

integer

Minimum size of the list.

Value must be greater or equal to 0

integer

Maximum size of the list.

Value must be greater or equal to 0

The type of the list items.

Property that defines data type for this field’s content.

Same definition as type
Type: object

object

An Entity reference type.

array of string

List of support entity type IDs.

Each item of this array must be:

Type: string

object

An Option type that contains a list of values (options) that a user can select from.

array of object

A list of available options for this type.

Each item of this array must be:

Type: object

string Required

The display name of an option.

string Required

The value of an option.

array

Translations of the displayName for different locale codes.

Each item of this array must be:

boolean

Flag that determines if this type has no options.

object

A Rich Text type, which contains a text that can be decorated with common formatting options such as bold and italics.

integer

The minimum length of the text.

Value must be greater or equal to 0

integer

The maximum length of the text.

Value must be greater or equal to 0

array of enum (of string)

List of supported rich text formats.

Each item of this array must be:

Type: enum (of string)

Supported rich text format.

Must be one of:

  • “BOLD”
  • “ITALICS”
  • “UNDERLINE”
  • “BULLETED_LIST”
  • “NUMBERED_LIST”
  • “HYPERLINK”

object

A String type.

enum (of string) Required

The stereotype of the value for this field type, which can be a single-line text (SIMPLE), multiline text (MULTILINE) or a url (URL).

Must be one of:

  • “SIMPLE”
  • “MULTILINE”
  • “URL”

integer

The minimum length of the text.

Value must be greater or equal to 0

integer

The maximum length of the text.

Value must be greater or equal to 0

object

A Struct type which contains a group of subfields that each have a unique subfield ID.

array of object Required

List of subfields of the struct type.

Must contain a minimum of 1 items

Each item of this array must be:

Type: object

A subfield of the struct type.

string Required

The name of the subfield.

string Required

The display name of the subfield.

array

Translations of the displayName for different locale codes.

Each item of this array must be:

boolean Required

Flag that determines if this subfield is required.

string Required

The type ID of the subfield.

object

Property that defines data type for this field’s content.

Same definition as type

object

A Video type.

Type: object

If the conditions in the “If” tab are respected, then the conditions in the “Then” tab should be respected. Otherwise, the conditions in the “Else” tab should be respected.

Type: object

const Required

Specific value: true

Must not be:

Type: object

The following properties are required:

  • descriptionType
Type: object

If the conditions in the “If” tab are respected, then the conditions in the “Then” tab should be respected. Otherwise, the conditions in the “Else” tab should be respected.

Type: object

const Required

Specific value: false
Type: object

The following properties are required:

  • descriptionType

boolean

A flag determining if the video is simple or complex. A simple video contains a source url a video. A complex image contains a simple video and a description.

object

Type of description of the video.

enum (of string) Required

The stereotype of the description of the video.

Must be one of:

  • “MULTILINE”

integer

Minimum length of the description.

Value must be greater or equal to 0

integer

Maximum length of the description.

Value must be greater or equal to 0

typeIdstring Required

The ID of this field’s type.