Skip to main content
PUT
Update field

Authorizations

x-api-key
string
header
required

API key used to authenticate and authorise every request. Include it in the x-api-key header.

Headers

Accept
enum<string>
required

Defines the response type.

Available options:
application/vnd.Creative Force.v2.3+json,
application/vnd.Creative Force.v2.3+xml
x-api-language
enum<string>[]

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.

Available options:
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

Path Parameters

field_slug
string
required

Slug of the field.

Pattern: ^[A-Za-z]{8}$

Body

application/json

Field update payload.

Only the properties you include are updated; omitted properties keep their current values.

type
string

Type of the field.

Field type cannot be changed after creation. Send this only to assert the current value; any other value returns 422 Unprocessable Entity.

resource
string

Resource the field collects data for.

Resource cannot be changed after creation. Send this only to assert the current value, in lower case exactly as GET field/{fieldSlug} returns it; any other value returns 422 Unprocessable Entity.

translated
object

Translated field values keyed by field name.

tab
string

Slug of the tab the field belongs to.

The tab must sit on the same form as the field. A tab on another form returns 422 Unprocessable Entity; a field cannot be moved between forms.

Pattern: ^[A-Za-z]{8}$
order
integer

Position of the field within its tab.

protection
enum<string>

Protection level governing access to the data for the field.

Available options:
standard,
elevated,
maximum
currency
string

Currency code.

Applies to fields of type currency. The currency must be enabled for the account.

role_option
enum<string>

Scope of role access for the field.

Use all to apply the field to every role, or select to restrict it to the roles named in role_access_settings.

Available options:
all,
select
role_access_settings
object

Per-role access settings, keyed by numeric role ID.

Every role referenced must belong to the current account. Omit this property to leave the current role access settings unchanged.

category_option
enum<string>

Scope of category association for the field.

Use all to apply the field to every category, or select to restrict it to the categories named in categories.

Available options:
all,
select
categories
integer[]

Numeric category IDs the field is associated with.

Every category referenced must belong to the current account.

options
string

Selectable options for choice fields, one option per line separated by a carriage return and line feed.

Send a string rather than an array. Required for the field types that take options: checkboxlist, drop-down-list, and radio.

Sending this property rewrites the display text held in translated.option_text, unless you send that property in the same request.

required
boolean

Specifies whether a value is required for the field.

searchable
boolean

Specifies whether the field is included in search.

A maximum of three fields per resource can be searchable within a season. The request is rejected when that limit is already reached.

autocomplete
boolean

Specifies whether the field offers autocomplete suggestions.

auto_scoring
boolean

Specifies whether the field is scored automatically.

auto_tag
boolean

Specifies whether values in the field are added as tags.

plagiarism_detection
boolean

Specifies whether the field is checked for plagiarism.

include_timezone
boolean

Specifies whether the field captures a timezone alongside the date and time.

preselect_current_date
boolean

Specifies whether the field is preselected with the current date.

entrant_read_access
boolean

Specifies whether entrants can view the field.

entrant_write_access
boolean

Specifies whether entrants can edit the field.

maximum_words
integer | null

Maximum number of words accepted, or null when no limit applies.

minimum_words
integer | null

Minimum number of words required, or null when no limit applies.

maximum_characters
integer | null

Maximum number of characters accepted, or null when no limit applies.

minimum_characters
integer | null

Minimum number of characters required, or null when no limit applies.

file_types
string[]

Permitted file extensions for file fields.

Each value must be one of the file types selectable for the account, for example pdf, docx, jpg, or mp4.

max_file_size
integer | null

Maximum upload size in megabytes for file fields, or null when no limit applies.

Cannot exceed the maximum upload size configured for the account.

Required range: x >= 0
min_video_length
integer | null

Minimum video length in seconds, or null when no limit applies.

Required range: x >= 1
max_video_length
integer | null

Maximum video length in seconds, or null when no limit applies.

Must be greater than or equal to min_video_length.

Required range: x >= 1
image_dimension_constraints
object

Pixel dimension constraints for image uploads.

Only the constraints you include are updated; omitted constraints keep their current values. Any key other than the four below is rejected.

configuration
string

JSON-encoded configuration for the field type, sent as a string.

Structure is validated against the type of the field. Applies to the types that carry extra configuration, such as table.

conditional
boolean

Specifies whether the field is shown conditionally on the value of another field.

When true, conditional_field, conditional_pattern, and conditional_visibility are all required.

conditional_field
string | null

Slug of the field whose value controls whether this field is shown.

Must be an existing field in the current account that is not in the trash, and cannot be the field being updated.

Pattern: ^[A-Za-z]{8}$
conditional_pattern
string | null

Comparison applied to the value of the controlling field.

Supported comparisons are is, is not, empty, is not empty, is checked, is not checked, is any of, is not any of, is greater than, is less than, contains, does not contain, starts with, does not start with, ends with, and does not end with.

conditional_visibility
string | null

Effect applied when the condition matches.

Use show to display the field when the condition matches, or hide to conceal it.

conditional_value
any

Value the controlling field is compared against, or null when no value applies.

Response

Field updated.

entrant_read_access
boolean

Whether entrants can view this field.

entrant_write_access
boolean

Whether entrants can edit this field.

auto_scoring
integer

Score awarded automatically for the field, or 0 when automatic judging is not configured.

categories
string[]

Category slugs the field is associated with, or ["*"] for every category.

category_count
any

Number of categories the field is associated with, all when it applies to every category, or null when not category-scoped.

conditional_field
object | null

Field whose value controls whether this field is shown, or null when the field is not conditional.

created
string<date-time>

Date and time when the field was created.

file_types
string[]

Permitted file extensions for file fields, empty when no restriction applies.

form
object | null

Form the field belongs to, or null when the field is not attached to a form.

help_text
object

Help text shown for the field, as an HTML fragment keyed by locale code.

hint_text
object

Hint text shown for the field, as an HTML fragment keyed by locale code.

label
object

Label of the field, as an HTML fragment keyed by locale code.

max_file_size
integer | null

Maximum upload size in megabytes for file fields, or null when no limit applies.

maximum_characters
integer | null

Maximum number of characters accepted, or null when no limit applies.

maximum_words
integer | null

Maximum number of words accepted, or null when no limit applies.

minimum_characters
integer | null

Minimum number of characters required, or null when no limit applies.

minimum_words
integer | null

Minimum number of words required, or null when no limit applies.

options
string[]

Selectable options for choice fields (for example, drop-down or radio). Empty when the field type has no options.

order
integer

Position of the field within its tab.

protection
string

Protection level governing access to the data for the field (for example, standard, elevated, or maximum).

registration
string | null

Registration attribute the field is mapped to, or null if unmapped.

required
boolean

Whether a value is required for the field.

resource
string

Resource the field collects data for (for example, the entry or application, contributors, referees, attachments, or users).

schema
object | null

Column structure of a table field, or null for every other field type.

searchable
boolean

Whether the field is included in search.

season
object

Season the field belongs to.

slug
string

Short URL-safe identifier for the field.

tab
object | null

Tab the field belongs to, or null when the field is not attached to a tab.

title
object

Plain-text title of the field, keyed by locale code.

type
string

Field type (for example, text, textarea, drop-down-list, file, currency, or date).

updated
string<date-time>

Date and time when the field was last updated.

visibility
string[]

Contexts in which the field is visible (for example, qualifying, top_pick, voting, gallery, or vip_judging).