Skip to main content
POST
Upload a file to an attachment field.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

field
string

Optional ID of the attachment field to upload to.

record
string

Optional ID of the record the attachment belongs to.

Body

application/json
file
file
required

The file to upload.

Response

OK

Entity storing attachment related information of a field's value.

id
string
required
valueType
string
required
discriminator
string
required
textValue
string
required
numericValue
number<double>
required
isDefault
boolean
required
archived
boolean
required
priority
integer<int32>
required
userGroup
string
required

usergroup

attachmentStatus
string
required
contentType
string
required
fileSize
integer<int64>
required
fileExtension
string
required
originalFileExtension
string
required
awsS3Key
string
required
versionCount
integer<int32>
required
updatedBy
string
required
source
enum<string>
required
Available options:
USER,
GOOGLE,
SHAREPOINT
fieldId
string
idOrTransientId
string
transientIdOrId
string
textOrNumericValue
string
empty
boolean
office365Eligible
boolean
wopiFileLockPresent
boolean