LiquidFiles Documentation
LiquidFiles Documentation

File Request API

With the File Request API, you can automate sending File Requests from other applications using the API. This is a fairly simple API.

Request

Request Info
Info Value
Request URL /requests
Request VERB POST
Request Parameters
Parameter Type Description
recipient String Who should receive this File Request.
subject String The subject in the email sent in the File Request.
message String The message in the File Request Email.
send_email Boolean (Optional) Defaults to true. If set to false, the LiquidFiles system will not send the message to the recipient (if you want to insert the File Request URL somewhere else).
expires_at Date (Optional) Date in YYYY-MM-DD format when this File Request Expires.
multiuse Boolean (Optional) If set to true, the File Request will be permitted to be reused multiple times.
bcc_myself Boolean (Optional) If set to true, the LiquidFiles system will copy the sender of the request.
Response Parameters
Parameter Type Description
url String The File Request URL.
expires_at Date When this File Request Expires.
subject String The subject in the File Request Email.
message String The message in the File Request Email.

The http response codes are 200 OK if the File Request was successful, and 422 Unprocessable Entity if anything went wrong. In case of an error, there's also an error message with what went wrong.

Example Creating a File Request using curl

curl -X POST --user nkpIxMK9ucUUE7FvfNpdAf:x \
     -H "Accept: application/json" \
     -H "Content-Type: application/json"  \
     -d '{"request":{"recipient":"recipient@company.com", "subject":"test", "message":"test message"}}' \
     https://liquidfiles.company.com/requests

API response

{"request":
  {
    "url":"https://test.host/requests/MoZTmymhPXuV7Mx4rNe0x7",
    "expires_at":"2017-01-03",
    "subject":"test",
    "message":"test message"
  }
}