Skip to main content
PUT
Every property in the request body is optional; only properties that are supplied are written. Properties that are omitted retain their current value. On success the response carries the post-update attachment representation.
Attachment fields are linked to the attachment and are distinct from form fields. If the attachment has no attachment fields, you can omit attachment_fields from the request body.

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

token
string
required

Token string.

Pattern: ^[A-Za-z0-9]{16}$|^[A-Za-z0-9]{32}$

Body

application/json

Fields to update on an existing attachment.

Every property is optional; only properties that are supplied are written.

attachment_fields
object

Values for the form fields captured against this attachment, keyed by field slug.

Each value must conform to the type of the corresponding field on the parent attachments tab; for example, a text field accepts a string, a choice field accepts the slug of one of its options, and a number field accepts a numeric value.

Field slugs that do not exist on the parent tab are rejected.

order
integer

Position of the attachment within its tab. Lower values sort earlier.

tab
string

Slug of the tab to move the attachment to.

Must reference a tab whose type is Attachments; tabs of other types are rejected.

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

Response

Attachment updated.

File attached to an application through an attachments-typed form tab.

Carries the file itself together with the form-field metadata captured against it, the application it belongs to, and the tab through which it was added.

application
object

Application the attachment belongs to.

attachment_fields
object[]

Form fields captured against this attachment.

One item per field defined on the parent attachments tab, in form order. The exact set of keys varies by field type.

created
string<date-time>

Time the attachment was created.

file
object

File backing the attachment.

order
integer

Position of the attachment within its tab.

tab
object

Attachments tab the attachment belongs to.

token
string

Token identifying the attachment file. Same value as file.token.

updated
string<date-time>

Time the attachment was last updated.