Documents: post

Save new document

Request - POST

You will need to supply a request body with this method.
You will need to include your access token upon making a request. For more information, see the authentication and authorization page.

Example request with authorization:

curl -- POST Base URI:
--header "Authorization: Bearer MTQ0NjJkZmQ5OTM2NDE1ghNNBiuyUYUN"

Request Body
Example request body:

Content-Type: application/json
"DocumentTypeId": integer,
"Records": [
"RecordTypeId": integer,
"RecordId": long
"FileName": "string",
"FileBase64": "string",
"ExpiryDate": "datetime",
"UploadToPortals": boolean

Document Type:

The list below describes the possible document type ids.

UnSpecified = 1
Contract = 2
Statement = 3
Invoice = 4
Letter = 5
Spreadsheet = 6
Certificates = 7
Photo = 8
EICR = 9
Brochure = 10
Window Card = 11
EPCGraph = 12
Example field on request:

"DocumentTypeId": 1


If successful, this method returns a response body with the following structure, note that some fields will have default values, such as updates related fields:

Example response:

Content-Type: application/json
"DocumentId": long,
"RecordId": long,
"RecordTypeId": integer,
"DocumentTypeId": integer,
"DocumentTypeName": string,
"FileName": string,
"Shared": boolean,
"LastUpdateUserId": long,
"LastUpdateUserForeName": string,
"LastUpdateUserSurName": string,
"LastUpdateIP": string,
"LastUpdate": "date",
"Icon": "string",
"MediaId": long,
"MediaGUID": string,
"MediaURLPrimary": string,
"FileBase64": string,
"UploadToPortals": boolean,
"ExpirationDate": "date",
"PasswordProtected": boolean,
"Password": string,
"Public": boolean,
"ProofType": integer,
"LinkedName": string,
"Compliance": boolean,
"IsImage": boolean,
"FileSize": float