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

token
string
required

Token string.

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

Slug of the field.

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

Body

application/json

Attachment field update payload.

value
any
required

New value for the attachment field identified by field_slug. The accepted value depends on the type and configuration of the field.

Use a string for text fields, a number for numeric fields, an ISO 8601 date for date fields, and an option slug for choice fields. A value outside the option set of a choice field returns a 422 response. For file-type fields, use an object containing the base64-encoded file data and a filename.

Response

Attachment field updated.

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

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

entry
object

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