Skip to main content
PUT
Update fund

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

Path Parameters

fund_slug
string
required

Slug of the fund.

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

Body

application/json

Fund update payload.

budget
number

Total budget of the fund, in the fund's currency.

currency
string

ISO 4217 currency code of the fund's amounts.

translated
object

Translated fund field values keyed by field name.

Response

Fund updated.

Fund holding a monetary budget, tracking allocated and available amounts.

allocated

Amount allocated from the budget, in the fund's currency.

available

Amount still available to allocate, in the fund's currency, equal to budget minus allocated.

budget

Total budget of the fund, in the fund's currency.

created
string<date-time>

Date and time when the fund was created.

currency
string

ISO 4217 currency code of the fund's amounts.

description
object

Translated description of the fund, keyed by locale code.

name
object

Translated name of the fund, keyed by locale code.

slug
string

URL-safe identifier of the fund.

updated
string<date-time>

Date and time when the fund was last updated.