Join BoxWorks 2024 to discover what's possible with content and AI!
Register now!A standard representation of a file request, as returned from any file request API endpoints by default.
42037322
The unique identifier for this file request.
file_request
file_request
Value is always file_request
2020-09-28T10:53:43-08:00
The date and time when the file request was created.
The user who created this file request.
Following documents are requested for your process
The optional description of this file request. This is shown in the Box UI to users uploading files.
This defaults to description of the file request that was copied to create this file request.
1
The HTTP etag
of this file. This can be used in combination with
the If-Match
header when updating a file request. By providing that
header, a change will only be performed on the file request if the etag
on the file request still matches the etag
provided in the If-Match
header.
2020-09-28T10:53:43-08:00
The date after which a file request will no longer accept new submissions.
After this date, the status
will automatically be set to
inactive
.
The folder that this file request is associated with.
Files submitted through the file request form will be uploaded to this folder.
true
Whether a file request submitter is required to provide a description of the files they are submitting.
When this setting is set to true, the Box UI will show a description field on the file request form.
This defaults to setting of file request that was copied to create this file request.
true
Whether a file request submitter is required to provide their email address.
When this setting is set to true, the Box UI will show an email field on the file request form.
This defaults to setting of file request that was copied to create this file request.
active
The status of the file request. This defaults
to active
.
When the status is set to inactive
, the file request
will no longer accept new submissions, and any visitor
to the file request URL will receive a HTTP 404
status
code.
This defaults to status of file request that was copied to create this file request.
Value is one of active
,inactive
Please upload documents
The title of file request. This is shown in the Box UI to users uploading files.
This defaults to title of the file request that was copied to create this file request.
2020-09-28T10:53:43-08:00
The date and time when the file request was last updated.
The user who last modified this file request.
/f/19e57f40ace247278a8e3d336678c64a
The generated URL for this file request. This URL can be shared with users to let them upload files to the associated folder.
{
"id": "42037322",
"type": "file_request",
"created_at": "2020-09-28T10:53:43-08:00",
"created_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"description": "Following documents are requested for your process",
"etag": "1",
"expires_at": "2020-09-28T10:53:43-08:00",
"folder": {
"id": "12345",
"type": "folder",
"etag": "1",
"name": "Contracts",
"sequence_id": "3"
},
"is_description_required": true,
"is_email_required": true,
"status": "active",
"title": "Please upload documents",
"updated_at": "2020-09-28T10:53:43-08:00",
"updated_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"url": "/f/19e57f40ace247278a8e3d336678c64a"
}