Create a file

Updated:

POST/storage/{connection_id}/file

Creates a StorageFile. Provide the unified StorageFile fields in the request body; they are mapped to the provider's API. Returns the created StorageFile.

Parameters

fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection

Payload

idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
The file or folder name, including the file's extension
descriptionstring
parent_idstring
user_idstring
(reference to HrisEmployee)
sizenumber
type enum
Valid values:
"FILE"
"FOLDER"
Whether this is a file or a folder
mime_typestring
permissions array
download_urlstring
This link expires after 1 hour. When you need to retrieve the contents of a file, call the "Retrieve a file" endpoint again to get a new download_url.
hashstring
datastring
base64 encoded file contents used to create/update only
versionstring
web_urlstring
references array
The records the file is attached to (e.g. an invoice or a candidate), each by its id and type
tagsstring array
labels
metadata array

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoThe file or folder name, including the file's extension
descriptionstringNo
parent_idstringNo
user_idstringNo(reference to HrisEmployee)
sizenumberNo
typeenumNoWhether this is a file or a folder Values: FILE, FOLDER
mime_typestringNo
permissionsStoragePermission[]No
permissions[].user_idstringNo(reference to HrisEmployee)
permissions[].group_idstringNo(reference to HrisGroup)
permissions[].rolesenum[]YesValues: OWNER, READ, WRITE
permissions[].is_hiddenbooleanNo
permissions[].is_publicbooleanNo
download_urlstringNoThis link expires after 1 hour. When you need to retrieve the contents of a file, call the "Retrieve a file" endpoint again to get a new download_url.
hashstringNo
datastringNobase64 encoded file contents used to create/update only
versionstringNo
web_urlstringNo
referencesStorageReference[]NoThe records the file is attached to (e.g. an invoice or a candidate), each by its id and type
references[].idstringNo
references[].typestringNo
references[].namestringNo
tagsstring[]Nolabels
metadataStorageMetadata[]No
metadata[].idstringNo
metadata[].slugstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'POST',
  url: 'https://api.unified.to/storage/5de520f96e439b002043d8dc/file',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?