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

Allocation creation payload.

amount
number
required

Amount to allocate to the application, in the fund's currency.

Cannot exceed the fund's available budget.

application
string
required

Slug of the application to allocate funds to.

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

Slug of the fund to draw the allocation from.

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

Response

Allocation created.

Award of funds from a fund's budget to an application, forming the application-level grant slot that allocation payments are drawn against.

Carries the allocated amount and the fund's currency, the outstanding balance due, and references to the related applicant, application, fund, chapter, and season.

amount
number

Total amount allocated to the application from the fund, in the fund's currency.

applicant
object | null

Applicant who owns the application the allocation belongs to.

null when the application has no applicant.

application
object | null

Application the allocation belongs to.

null when the allocation has no associated application.

chapter
object | null

Chapter the application belongs to.

null when the application has no chapter.

created
string<date-time>

Date and time when the allocation was created.

currency
string

ISO 4217 currency code of the allocation's amounts, drawn from the fund's currency.

fund
object

Fund the allocation draws from.

paid
number

Outstanding amount due on the allocation, in the fund's currency, after deducting payments already made.

season
object

Season the allocation belongs to.

slug
string

URL-safe identifier of the allocation.

updated
string<date-time>

Date and time when the allocation was last updated.