Appearance
Upload a file to a record
POST
/api/nova/files/upload
Stores a document as multipart form data and attaches it to the record given by recordId, so it appears on that record's Files tab. Works for any record type - job, candidate, company, contact, lead, opportunity or placement - because the type is resolved from the record itself and does not have to be supplied. categoryId is optional and, when given, is resolved against the account's file categories. Allowed file types are controlled by the account's upload extension list (docx, doc, odf, rtf, txt, csv, pdf, odt, ppt, xls, png, jpg, jpeg, tiff by default). The response contains the stored file's id, name, content type, size and the record it was linked to. Returns 400 when the file is missing, the record cannot be found, the category is unknown or the file type is not allowed, 401 for an invalid API key and 429 when the account's daily file allowance or rate limit is exceeded.
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Request Body
multipart/form-data
Format
"binary"Responses
OK
application/json
JSON "data": { "categoryId": "string", "categoryName": "string", "contentType": "string", "expiresOn": "string", "extension": "string", "id": "string", "name": "string", "recordId": "string", "recordLabel": "string", "recordType": "string", "showInClientPortal": true, "size": 0, "uploadedBy": "string", "uploadedOn": "string" }, "error": "string", "message": "string", "requestId": "string", "success": true
{
}