Skip to main content
PUT
Only the properties you include in the request body are updated; omitted properties keep their current values.
Within entry_fields, only the field slugs you include are updated, and any field slug that does not exist on the form for the entry is ignored. For most field types the value you supply replaces the stored value. Table fields are merged cell by cell: include only the cells you want to change, and send a cell with an empty value to clear it.

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

Path Parameters

entry_slug
string
required

Slug of the entry.

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

Body

application/json

Entry update payload.

category
string

Slug of the category.

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

Slug of the chapter.

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

Slug of the entrant.

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

Title of the entry.

status
enum<string>

Entry status.

Available options:
submitted,
in_progress,
resubmission_required,
resubmitted
moderation_status
enum<string>

Moderation status of the entry.

Available options:
approved,
undecided,
rejected
entry_fields
object

Entry field values keyed by field slug. Each key must be a valid 8-letter field slug. The value type depends on the field type.

custom_deadline
string

Custom deadline in yyyy-mm-dd hh:mm format.

Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) ([01][0-9]|2[0-3]):[0-5][0-9]$
grant_status
string

Slug of the grant status. Available when the grants feature is enabled.

Pattern: ^[A-Za-z]{8}$
grant_end_date
string<date>

Date when the grant ends. Available when the grants feature is enabled.

Response

Entry updated.

Single entry, including the entrant, form field responses, attachments, contributors, and status.

entrant
object

Entrant who created and owns the entry.

auto_score
integer

Automated score calculated for the entry.

category
object

Category the entry is assigned to.

chapter
object

Chapter the entry is assigned to.

comments
string

Manager comments recorded on the entry, joined into a single string.

contributor_count
integer

Number of contributors linked to the entry.

created
string<date-time>

Date and time when the entry was created.

custom_deadline
string

Custom submission deadline for the entry, or - when none is set.

division
integer | null

Division number assigned to the entry, or null when none is assigned.

eligibility_status
string

Eligibility status of the entry.

files_count
integer

Number of files uploaded to the entry.

form
object

Entry form used to capture the entry.

grant_end_date
string | null

Date when the grant ends, or null when not applicable.

grant_status
object | null

Grant status assigned to the entry, or null when none is set.

local_id
integer

Sequential identifier of the entry within the account.

moderation_status
string

Moderation status of the entry.

parent_category
object | null

Parent of the assigned category, or null when the category has no parent.

payment_status
string

Payment status of the entry.

plagiarism_scan_status
string

Plagiarism scan status of the entry.

review_status
string

Review status of the entry.

season
object

Season the entry belongs to.

slug
string

URL-safe identifier of the entry.

status
string

Submission status of the entry. Possible values include submitted, in_progress, resubmission_required, resubmitted, invited, and not_approved_for_submission.

submitted
string<date-time> | null

Date and time when the entry was submitted, or null when not yet submitted.

tags
string

Tags applied to the entry, as a comma-separated list.

title
string

Title of the entry.

updated
string<date-time>

Date and time when the entry was last updated.

user_comments
string

Comments left by users on the entry, joined into a single string.

entry_fields
object[]

Form field responses captured on the entry.

attachments
object[]

Files attached to the entry.

contributors
object[]

Contributors linked to the entry.