Sign in

v50

latestOpenAPI 3.1.0Creative Force Client Subscription Termsraw.githubusercontent.com2026-07-137852387.4 KB
Fields

Create a field

Creates a field.

post/field

Headers

Accept'application/vnd.Creative Force.v2.3+json' | 'application/vnd.Creative Force.v2.3+xml' required

Defines the response type.

x-api-languagestring[]

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.

Request body

type'checkbox' | 'checkboxlist' | 'content' | 'country' | 'currency' | 'date' | 'datetime' | 'drop-down-list' | 'email' | 'file' | 'lookup' | 'numeric' | 'phone' | 'radio' | 'table' | 'text' | 'textarea' | 'time' | 'url' required

Type of the field.

tabstring required

Slug of the tab the field belongs to.

formstring

Slug of the form the field belongs to.

The form must be valid for the active season and the field type.

currencystring

Currency code.

Required when type is currency.

Response

Field created.

entrant_read_accessboolean

Whether entrants can view this field.

entrant_write_accessboolean

Whether entrants can edit this field.

auto_scoringinteger

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

categoriesstring[]

Category slugs the field is associated with. The single-element array ["*"] indicates the field applies to every category.

{"stackTrail":"components:schemas:Field:properties:category_count","oasType":"schema","type":"unknown","description":"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."}
createdstring date-time

Date and time when the field was created.

file_typesstring[]

Permitted file extensions for file fields. Empty when the field does not accept file uploads or no restriction applies.

help_textobject

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_textobject

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.

labelobject

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.

max_file_sizeinteger nullable

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

maximum_charactersinteger nullable

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

maximum_wordsinteger nullable

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

minimum_charactersinteger nullable

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

minimum_wordsinteger nullable

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

optionsstring[]

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

orderinteger

Position of the field within its tab, used for ordering.

protectionstring

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

registrationstring nullable

Registration attribute the field is mapped to, or null when the field is not mapped to a registration attribute.

requiredboolean

Whether a value is required for the field.

resourcestring

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

searchableboolean

Whether the field is included in search.

slugstring

Short URL-safe identifier for the field.

titleobject

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.

typestring

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

updatedstring date-time

Date and time when the field was last updated.

visibilitystring[]

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

Example response

{
  "entrant_read_access": true,
  "entrant_write_access": true,
  "auto_scoring": 0,
  "categories": [
    "*"
  ],
  "category_count": "all",
  "conditional_field": null,
  "created": "2025-01-15T09:00:00Z",
  "file_types": [],
  "form": {
    "slug": "GhIjKlMn",
    "link": "https://api.au.cr4ce.com/form/GhIjKlMn",
    "name": {
      "en_GB": "Entry form"
    }
  },
  "help_text": {
    "en_GB": "<p>Provide a concise summary of your work.</p>"
  },
  "hint_text": {
    "en_GB": "<p>Up to 500 words.</p>"
  },
  "label": {
    "en_GB": "<p>Summary</p>"
  },
  "max_file_size": null,
  "maximum_characters": null,
  "maximum_words": 500,
  "minimum_characters": null,
  "minimum_words": null,
  "options": [],
  "order": 1,
  "protection": "standard",
  "registration": null,
  "required": true,
  "resource": "entries",
  "searchable": true,
  "season": {
    "slug": "QrStUvWx",
    "link": "https://api.au.cr4ce.com/season/QrStUvWx",
    "name": {
      "en_GB": "2025"
    }
  },
  "slug": "AbCdEfGh",
  "tab": {
    "slug": "StUvWxYz",
    "link": "https://api.au.cr4ce.com/tab/StUvWxYz",
    "name": {
      "en_GB": "About you"
    }
  },
  "title": {
    "en_GB": "Summary"
  },
  "type": "textarea",
  "updated": "2025-06-20T14:30:00Z",
  "visibility": [
    "qualifying",
    "vip_judging"
  ]
}