https://man.liquidfiles.com
LiquidFiles Documentation

When building a API client, this covers how to tell the client what settings should be set or not set in the client. This will make things a lot cleaner as we can avoid server side error messages, and provide client side validation.

Parameters

Request Info
Info Value
Request URL /account
Request VERB GET
Response Parameters
Parameter Type Description
api_version String The current API version is 3.
version String The version number of the LiquidFiles system.
version_numeric Integer The version number of the LiquidFiles system in numeric format. Version v2.3.1 will be listed as 20301.
api_client_size_override Integer The value (in Megabytes) for API clients (such as the Outlook plugin) when to override the normal client behaviour and send files through the LiquidFiles appliance instead.
max_expiration Integer The users max message expiration number of days.
max_file_size Integer The maximum file size this user is allowed to send (in Mb).
can_change_expiration Boolean True if the user is allowed to change file expiration time.
default_file_expiration Integer The number of days the users default expiration is.
can_change_expires_after Boolean True if the user is allowed to change expires_after.
max_expires_after Integer The max number of days the user can set the Max Expires After to. Blank if no limit.
limit_extensions String A comma separated list of accepted file extensions the user is allowed to send. Blank if no limit. If set, these are the only permitted file extensions.
blocked_extensions String A comma separated list of blocked files types. Blank if no limit. Either limit_extensions or blocked_extensions will be set. Never both.
default_bcc_myself Boolean True if the LiquidFiles appliance will default to bcc the user on delivery.
can_change_bcc_myself Boolean True if the user is permitted to change the BCC myself setting.
default_authorization Integer
  • 0: Anyone can download
  • 1: Anyone after authentication can download
  • 2: Specified recipients and local users can download
  • 3: Only specified recipients can download
can_override_size_limit Boolean True if the user can change the value of the api_client_size_override.
enable_send_folders Boolean True if the send folders feature should be enabled in the Outlook plugin.
api_enable_secure_send Boolean True if the Secure Send feature should be enabled in the Outlook plugin.
allow_users_to_change_authorization Boolean True if users can change from the default authorization method.
limit_recipient_domains Boolean True if the user is limited to what domains the can send messages
can_send_to_local_users Boolean True if the user can send to local users as well as the limited recipient domains.
can_use_file_requests Boolean True if the user is permitted to use the File Request feature.
can_invite_users Boolean True if the user is permitted to invite users.
can_use_specified_recipients Boolean True if the user is permitted to set the authorization level of Specified Recipients Only.
can_use_specified_recipients_and_local Boolean True if the user is permitted to set the authorization level of Specified Recipients and Local Users.
can_use_anyone_with_auth Boolean True if the user is permitted to set the authorization level of Anyone (with authentication).
can_use_anyone Boolean True if the user is permitted to set the authorization level with no Authentication.
disable_sending Boolean True if the user is not permitted to send files.
recipients_domains Array The list of limited recipient domains the user can only send to.
custom_settings mixed Copied directly from the users groups custom api settings value.

In case the user is presented with an interface (email client plugin, …) these responses dictates what should be visible to the end user. If the user is allowed to change the file expiration, show the control with the listed default parameters. If the user isn't allowed to change file expiration, either grey out or remove those controls.

Example Response

curl -X GET -H 'Content-Type: application/json' --user gXvoqaFzd1jYQ9f13sPO06:x https://www.example.com/account

{"user":
  {
    "api_version":4,
    "version":"v3.0.7",
    "version_numeric":30006,
    "menubar_title":"",
    "page_title":"",
    "delete_inactive_user":0,
    "api_client_size_override":10,
    "max_expiration":180,
    "max_expires_after":0,
    "can_change_expires_after":true,
    "max_file_size":1000,
    "can_change_expiration":true,
    "default_file_expiration":30,
    "limited_extensions":"",
    "blocked_extensions":"exe, vbs, pif, scr, bat, cmd, com, cpl",
    "default_authorization":3,
    "allow_users_to_change_authorization":true,
    "default_bcc_myself":true,
    "can_override_size_limit":true,
    "enable_send_folders":true,
    "limit_recipient_domains":false,
    "can_send_to_local_users":true,
    "can_use_file_requests":true,
    "can_invite_users":true,
    "enable_send_messages":true,
    "can_use_filelinks":true,
    "filelink_default_require_authentication":true,
    "filelink_can_change_require_authentication":true,
    "filelink_can_change_expiration":true,
    "filelink_default_expiration":14,
    "filelink_max_expiration":180,
    "can_use_specified_recipients":true,
    "can_use_specified_recipients_and_local":true,
    "can_use_anyone_with_auth":true,
    "can_use_anyone":true,
    "can_change_private_message":true,
    "default_private_message":false,
    "accept_html_message":true,
    "recipients_domains":[],
    "custom_settings":""
  }
}

Deprecated responses in API v4

The following API responses are still available in LiquidFiles v3.0.x and will be removed in LiquidFiles version 3.2.

The Example above is only listing the current api responses, in LiquidFiles v3.0.x, the following will be listed as well:

Old Parameter New Parameter Description
enable_private_message can_change_private_message True if default_private_message is set. This is primarily for the Outlook plugin.
change_expiration can_change_expiration Direct replacement, for consistency.
accepted_filetypes limited_extensions Direct replacement.