Skip to main content
POST
Upload file for document

Authorizations

Authorization
string
header
required

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

Path Parameters

documentId
string
required

Body

multipart/form-data
file
file
required
effectiveAtDate
string

Date indicating when the document is effective from.

description
string

Description of the uploaded document.

Response

201 - application/json

File uploaded for document

id
string
required

Unique identifier for the document.

fileName
string | null
required

The file name of the document.

title
string
required

The document's title.

description
string | null
required

The document's description

mimeType
string
required

Mime type of the document.

uploadedBy
object | null
required

The actor who uploaded this document. It could be a user or an app.

creationDate
string<date-time>
required

Date of when the document was uploaded.

updatedDate
string<date-time>
required

Date when the document was last updated.

deletionDate
string<date-time> | null
required

Date of when the document was deleted. Is set to null if the document has not been deleted.

effectiveDate
string<date-time> | null
required

The document's effective date.

url
string
required

The document's URL.