Create a field
Creates a field.
formula or ai field types through the API.Authorizations
API key used to authenticate and authorise every request.
Include it in the x-api-key header.
Headers
Defines the response type.
application/vnd.Creative Force.v2.3+json, application/vnd.Creative Force.v2.3+xml Defines the languages included in the response. If non are provided, the account default language is returned.
Value all overrides any other values present.
You can request multiple languages using a comma-separated string of languages.
The selected language must be supported by your account or a 400 error is returned.
all, ar_AR, bg_BG, bn_IN, ca_ES, cs_CZ, cy_GB, da_DK, de_DE, en_GB, en_US, el_GR, es_NN, es_LA, et_EE, fa_NN, fi_FI, fr_FR, fr_CA, he_IL, hi_IN, hr_HR, hu_HU, hy_AM, it_IT, ja_JP, ko_KR, lt_LT, ms_MY, nl_NL, nb_NO, pl_PL, pt_BR, ro_RO, ru_RU, sk_SK, sl_SI, sq_AL, sr_RS, sv_SE, sw_NN, th_TH, tr_TR, uk_UA, vi_VN, zh_CN, zh_HK Body
Field creation payload.
Type of the field.
checkbox, checkboxlist, content, country, currency, date, datetime, drop-down-list, email, file, lookup, numeric, phone, radio, table, text, textarea, time, url Slug of the tab the field belongs to.
^[A-Za-z]{8}$Translated field values keyed by field name.
Slug of the form the field belongs to.
The form must be valid for the active season and the field type.
^[A-Za-z]{8}$Currency code.
Required when type is currency.
Response
Field created.
Whether entrants can view this field.
Whether entrants can edit this field.
Score awarded automatically for the field, or 0 when automatic judging is not configured.
Category slugs the field is associated with. The single-element array ["*"] indicates the field applies to every category.
Number of categories the field is associated with. The string all indicates the field applies to every category (paired with categories of ["*"]). null when the field is not category-scoped.
Field whose value controls whether this field is shown, or null when the field is not conditional.
Date and time when the field was created.
Permitted file extensions for file fields. Empty when the field does not accept file uploads or no restriction applies.
Form the field belongs to, or null when the field is not attached to a form.
Help text shown for the field, as an HTML fragment.
Map keyed by locale code (for example, en_GB or fr_FR). Keys are drawn from the languages enabled on the account. Values are the translated string.
Hint text shown for the field, as an HTML fragment.
Map keyed by locale code (for example, en_GB or fr_FR). Keys are drawn from the languages enabled on the account. Values are the translated string.
Label of the field, as an HTML fragment.
Map keyed by locale code (for example, en_GB or fr_FR). Keys are drawn from the languages enabled on the account. Values are the translated string.
Maximum upload size in megabytes for file fields, or null when no limit applies.
Maximum number of characters accepted, or null when no limit applies.
Maximum number of words accepted, or null when no limit applies.
Minimum number of characters required, or null when no limit applies.
Minimum number of words required, or null when no limit applies.
Selectable options for choice fields (for example, drop-down or radio). Empty when the field type has no options.
Position of the field within its tab, used for ordering.
Protection level governing access to the data for the field (for example, standard, elevated, or maximum).
Registration attribute the field is mapped to, or null when the field is not mapped to a registration attribute.
Whether a value is required for the field.
Resource the field collects data for (for example, the entry or application, contributors, referees, attachments, or users).
Whether the field is included in search.
Season the field belongs to.
Short URL-safe identifier for the field.
Tab the field belongs to, or null when the field is not attached to a tab.
Plain-text title of the field.
Map keyed by locale code (for example, en_GB or fr_FR). Keys are drawn from the languages enabled on the account. Values are the translated string.
Field type (for example, text, textarea, drop-down-list, file, currency, or date).
Date and time when the field was last updated.
Contexts in which the field is visible (for example, qualifying, top_pick, voting, gallery, or vip_judging).