Client Info Request

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

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 "Accept: application/json" -H "Content-Type: application/json" --user gXvoqaFzd1jYQ9f13sPO06:x https://www.example.com/account

{"user":
  {
    "version":"v3.2.0",
    "version_numeric":30200,
    "menubar_title":"",
    "page_title":"",
    "delete_inactive_user":0,
    "user_id": "joe-user-company-com",
    "email": "joe.user@company.com",
    "name": "Joe User",
    "group":"Local Users",
    "group_id":"local-users",
    "is_local":true,
    "can_use_messages":true,
    "can_use_filelinks":true,
    "can_use_file_requests":true,
    "can_invite_users":true,
    "limited_extensions":"",
    "blocked_extensions":"exe, vbs, pif, scr, bat, cmd, com, cpl",
    recipient_aliases: ["aliased-recipient@company.com"],
    sender_aliases: ["aliased-sender@company.com"],
    "message_default_expiration":30,
    "message_max_expiration":180,
    "message_max_expires_after":0,
    "message_can_change_expires_after":true,
    "message_max_size":100000,
    "message_default_authorization":3,
    "message_can_change_authorization":true,
    "message_default_bcc_myself":true,
    "message_can_change_bcc_myself":true,
    "message_can_send_to_local_users":true,
    "message_can_use_specified_recipients":true,
    "message_can_use_specified_recipients_and_local":true,
    "message_can_use_specified_recipients_and_domains":true,
    "message_can_use_anyone_with_auth":true,
    "message_can_use_anyone":true,
    "message_can_change_private_message":true,
    "message_default_private_message":false,
    "message_can_use_html":true,
    "message_limit_recipients":false,
    "message_recipient_domains":[],
    "message_recipient_pattern":"",
    "filedrop_url":"https://liquidfiles.company.com/filedrop/~hdcosj",
    "filedrop_email_url":"https://liquidfiles.company.com/filedrop/joe.user@company.com",
    "filelink_default_require_authentication":true,
    "filelink_can_change_require_authentication":true,
    "filelink_can_change_expiration":true,
    "filelink_default_expiration":14,
    "filelink_max_expiration":180,
    "filelink_can_change_download_confirmation":true,
    "filelink_default_download_confirmation":true,
    "file_request_permission":3,
    "file_request_multiuse":false,
    "file_request_multiuse_can_change":true,
    "client_size_override":10,
    "client_can_override_size_limit":true,
    "client_can_send_folders":true,
    "client_custom_settings":"",
    "client_encryption_key":"iSqrRYINzsqPVUnv6qty90vQDrl9PZ5rcl0P0suszeju"
  }
}

Deprecated responses

The following table outlines changes to the Client Info Request API. When the changes where made and when deprecated responses will be removed.

The Example above is only listing the current api responses, there may be deprecated responses as well (that shouldn't be used).