Skip to main content
PUT

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

application_slug
string
required

Slug of the application.

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

Slug of the field.

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

Body

application/json

Application field update payload.

value
any
required

New value for the field. The type depends on the field type.

Response

Application field updated.

Single application, including the applicant, form field responses, attachments, contributors, and status.

applicant
object

Applicant who created and owns the application.

auto_score
integer

Automated score calculated for the application.

category
object

Category the application 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 application.

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 application.

files_count
integer

Number of files uploaded to the application.

form
object

Entry form used to capture the application.

grant_end_date
string | null

Date when the grant ends, or null when not applicable. Only present when the grants feature is enabled on the account.

grant_status
object | null

Grant status assigned to the entry, or null when none is set. Only present when the grants feature is enabled on the account.

local_id
integer

Sequential identifier of the entry within the account.

moderation_status
string

Moderation status of the application.

parent_category
object | null

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

payment_status
string

Payment status of the application.

plagiarism_scan_status
string

Plagiarism scan status of the application.

review_status
string

Review status of the application.

season
object

Season the entry belongs to.

slug
string

URL-safe identifier of the application.

status
string

Submission status of the application. 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 application.

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.

application_fields
object[]

Form field responses captured on the application.

attachments
object[]

Files attached to the application.

contributors
object[]

Contributors linked to the application.