Skip to main content
POST
The tab must be of type Attachments; tabs of other types are rejected.
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.
The uploaded file is validated and stored before the response is returned; the attachment itself is finalized shortly after. A GET on the returned Location immediately after the 201 may briefly return a response with a null body until finalization is complete.

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

​
entry_slug
string
required

Slug of the entry.

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

Entry tab slug

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

Body

application/json

File and metadata for a new attachment on the specified entry tab.

filename, data, and order are required. attachment_fields is optional and may be omitted when the parent tab has no required attachment fields.

​
filename
string
required

Original filename of the uploaded file, including the extension.

​
data
string<byte>
required

Base64-encoded contents of the file.

The encoded payload must round-trip cleanly through standard base64 decoding; payloads with stray characters, incorrect padding, or other malformed encoding are rejected.

​
order
integer
required

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

​
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:

  • text, textarea, email, url, phone, ai — string.
  • numeric — number.
  • currency — string holding a decimal value, for example "1234.56".
  • checkbox — boolean (true/false; 1 and 0 are also accepted).
  • radio, drop-down-list — string matching one of the defined option keys for the field (case-insensitive).
  • checkboxlist — array of option keys, or a comma-separated string such as "opt1,opt2".
  • country — ISO 3166 alpha-2 country code; lower-case codes are accepted and stored upper-cased.
  • date — YYYY-MM-DD string or an object such as {date: "2026-06-16"}; the bare string form is wrapped server-side into the object form.
  • datetime — YYYY-MM-DD HH:MM string or an object such as {date: "2026-06-16 14:30"}; same wrapping behaviour as date.
  • time — HH:MM string.

Field slugs that do not exist on the parent tab are rejected. Fields marked as required on the parent tab must be supplied; omitting them returns a 422.

formula fields are computed server-side and cannot be set through this property. file fields are not settable here; upload files through POST /entry/{entry_slug}/upload/{field_slug} instead. table and lookup field types are not handled by this property; consult their dedicated endpoints if your tab uses them.

Response

Attachment created.

Receipt returned after an attachment is created.

Carries the short opaque token and canonical URL for the new attachment together with the underlying file record, so callers can immediately reference the new attachment and fetch the stored file.

​
token
string

Opaque identifier for the new attachment. Used as the {token} path parameter on /attachment/{token}.

​
link
string<uri>

Canonical URL for the new attachment resource.

​
file
UploadResult · object

Receipt returned when a file is uploaded to a category, chapter, entry, or user field.

Carries the original filename, a short opaque token that addresses the stored file, and the canonical URL through which the file can be retrieved.

Example: