Update a category

{
  "created": "2025-01-15T09:00:00Z",
  "description": {
    "en_GB": "Submit your documentary films exploring real-world subjects and stories."
  },
  "divisions": 1,
  "form": {
    "slug": "GhIjKlMn",
    "link": "https://api.au.cr4ce.com/form/GhIjKlMn",
    "name": {
      "en_GB": "Entry form"
    }
  },
  "name": {
    "en_GB": "Documentary"
  },
  "parent": {
    "slug": "KlMnOpQr",
    "link": "https://api.au.cr4ce.com/category/KlMnOpQr",
    "name": {
      "en_GB": "Film"
    }
  },
  "promoted": null,
  "season": {
    "slug": "QrStUvWx",
    "link": "https://api.au.cr4ce.com/season/QrStUvWx",
    "name": {
      "en_GB": "2025"
    }
  },
  "shortcode": {
    "en_GB": "01"
  },
  "slug": "AbCdEfGh",
  "status": "active",
  "updated": "2025-06-20T14:30:00Z",
  "chapters": [
    {
      "slug": "MnOpQrSt",
      "link": "https://api.au.cr4ce.com/chapter/MnOpQrSt",
      "name": {
        "en_GB": "Film"
      }
    }
  ],
  "entrant_max_entries": null,
  "entry_name_label": {
    "en_GB": "Entry title"
  },
  "fill_entry_name": false,
  "image_heading": {
    "en_GB": "Category image"
  },
  "images": [
    {
      "token": "AbCdEfGhIjKlMnOp",
      "link": "https://api.au.cr4ce.com/file/AbCdEfGhIjKlMnOp",
      "filename": "example.png",
      "download": "https://files.au.cr4ce.com/file/AbCdEfGhIjKlMnOp/example.png?Expires=1781657570&Signature=REDACTED&Key-Pair-Id=REDACTED"
    }
  ],
  "max_image_width": 300,
  "packing_slip_instructions": {
    "en_GB": "Attach this slip to each physical submission."
  },
  "pdf_packing_slip": false
}

{
  "message": "<string>",
  "status_code": 400
}

{
  "message": "<string>",
  "status_code": 401
}

{
  "message": "<string>",
  "status_code": 403
}

{
  "message": "<string>",
  "status_code": 404
}

{
  "message": "<string>",
  "status_code": 422,
  "errors": {}
}

{
  "message": "<string>",
  "status_code": 429
}

{
  "status": "Maintenance in progress"
}

PUT

category

{category_slug}

{
  "created": "2025-01-15T09:00:00Z",
  "description": {
    "en_GB": "Submit your documentary films exploring real-world subjects and stories."
  },
  "divisions": 1,
  "form": {
    "slug": "GhIjKlMn",
    "link": "https://api.au.cr4ce.com/form/GhIjKlMn",
    "name": {
      "en_GB": "Entry form"
    }
  },
  "name": {
    "en_GB": "Documentary"
  },
  "parent": {
    "slug": "KlMnOpQr",
    "link": "https://api.au.cr4ce.com/category/KlMnOpQr",
    "name": {
      "en_GB": "Film"
    }
  },
  "promoted": null,
  "season": {
    "slug": "QrStUvWx",
    "link": "https://api.au.cr4ce.com/season/QrStUvWx",
    "name": {
      "en_GB": "2025"
    }
  },
  "shortcode": {
    "en_GB": "01"
  },
  "slug": "AbCdEfGh",
  "status": "active",
  "updated": "2025-06-20T14:30:00Z",
  "chapters": [
    {
      "slug": "MnOpQrSt",
      "link": "https://api.au.cr4ce.com/chapter/MnOpQrSt",
      "name": {
        "en_GB": "Film"
      }
    }
  ],
  "entrant_max_entries": null,
  "entry_name_label": {
    "en_GB": "Entry title"
  },
  "fill_entry_name": false,
  "image_heading": {
    "en_GB": "Category image"
  },
  "images": [
    {
      "token": "AbCdEfGhIjKlMnOp",
      "link": "https://api.au.cr4ce.com/file/AbCdEfGhIjKlMnOp",
      "filename": "example.png",
      "download": "https://files.au.cr4ce.com/file/AbCdEfGhIjKlMnOp/example.png?Expires=1781657570&Signature=REDACTED&Key-Pair-Id=REDACTED"
    }
  ],
  "max_image_width": 300,
  "packing_slip_instructions": {
    "en_GB": "Attach this slip to each physical submission."
  },
  "pdf_packing_slip": false
}

{
  "message": "<string>",
  "status_code": 400
}

{
  "message": "<string>",
  "status_code": 401
}

{
  "message": "<string>",
  "status_code": 403
}

{
  "message": "<string>",
  "status_code": 404
}

{
  "message": "<string>",
  "status_code": 422,
  "errors": {}
}

{
  "message": "<string>",
  "status_code": 429
}

{
  "status": "Maintenance in progress"
}

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

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

category_slug

string

required

Slug of the category.

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

Body

application/json

Category update payload.

status

enum<string>

Active or inactive state of the category.

Available options:

active,

inactive

translated

object

Translated category field values keyed by field name.

Show child attributes

chapters

string[]

Array of chapter slugs.

Each chapter must belong to the season for the category.

divisions

integer

Number of divisions.

Required range: x >= 1

entrant_max_entries

integer | null

Maximum number of entries per entrant.

Required range: x >= 1

fill_entry_name

boolean

Specifies whether to prefill the entry name when the category is selected.

locked

boolean

Specifies whether the category is locked.

max_image_width

integer

Maximum image width.

parent

string

Slug of the parent category.

The parent category must belong to the season for the category, and cannot be the category itself or one of its descendants.

pdf_packing_slip

boolean

Specifies whether to generate a PDF packing slip.

Required when translated.packing_slip_instructions is provided.

Response

Category updated.

Competition category that entries are submitted to.

Includes the entry form used for submissions, its translated name and description, the season it belongs to, and the rules that govern entries within it. Categories can be nested under a parent category and made available across one or more chapters.

created

string<date-time>

Date and time when the category was created.

description

object

Description shown to entrants on the category, 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.

Show child attributes

divisions

integer

Number of divisions configured for the category. Always at least 1.

Required range: x >= 1

form

object

Entry form attached to the category.

Show child attributes

name

object

Display name of the category.

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.

Show child attributes

parent

object | null

Parent category this category sits under.

null for a top-level category.

Show child attributes

promoted

enum<integer> | null

Promotion state of the category.

1 when promoted, 0 when not, and null when no preference has been set.

Available options:

0,

1,

null

season

object

Season the category belongs to.

Show child attributes

shortcode

object

Short code used to reference the category.

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.

Show child attributes

slug

string

Short URL-safe identifier for the category.

status

enum<string>

Current state of the category.

Available options:

active,

inactive

updated

string<date-time>

Date and time when the category was last updated.

chapters

object[]

Chapters the category is available in.

Show child attributes

entrant_max_entries

integer | null

Maximum number of entries a single entrant may submit to this category.

null when the number of entries is not capped.

entry_name_label

object

Custom label for the entry-name field shown to entrants.

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.

Show child attributes

fill_entry_name

boolean

Specifies whether entrants are asked to name their entry when submitting to this category.

image_heading

object

Heading shown above the category images.

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.

Show child attributes

images

object[]

Images attached to the category.

Show child attributes

max_image_width

integer

Maximum display width for the category images, in pixels.

packing_slip_instructions

object

Instructions shown on the packing slip for the category.

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.

Show child attributes

pdf_packing_slip

boolean

Specifies whether a PDF packing slip is enabled for the category.

Retrieve a category Delete a category

Account

Assignments

Attachments

Categories

Chapters

Contributors

Documents

Entries

Entries (realtime)

Fields

Files

Leaderboard

Orders

Review tasks

Rounds

Score sets

Seasons

Taxes

Users

Webhooks

Authorizations

Headers

Path Parameters

Body

Response