Skip to main content
POST

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

Body

application/json

Inputs for the assignment creation request.

The request is processed asynchronously: the response is 202 Accepted with an empty body. Created assignments become available via GET /assignment once processing completes.

Inputs for creating assignments in bulk.

One assignment is created for each pairing of an entry from entries with a judge from judges under score_set, and every resulting assignment is linked to all rounds listed in rounds. Existing assignments for the same entry, judge, and score set are updated in place rather than duplicated.

score_set
string
required

Slug of the score set to assign under.

Its current season must be either active or draft. Entries and rounds must belong to the same form as this score set.

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

Slugs of the entries to include.

Each entry must belong to the same form as score_set.

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

Slugs of the users to assign as judges.

Each user must hold the Judge role for the account.

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

Slugs of the judging rounds to link the assignments to.

Each round must be a judging round on the same form as score_set.

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

Response

Assignment creation accepted.

The response body is empty. Created assignments become available via GET /assignment once processing completes.