Dropbox: File requests schemas

16 Dropbox schemas with complete fields and constraints.

← File requests operations · All schemas

Creates a file request for this user — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Arguments for create.
`title`	string	Required within parent	Minimum length: 1
`destination`	string	Required within parent	Pattern: ^(?:/(.\|[\r\n])*)$
`deadline`	JSON	Optional
`deadline (anyOf 1)`	Model	Alternative	Expand Creates a file request for this user — request body — body deadline allow late uploads, deadline
`deadline (anyOf 2)`	null	Alternative
`open`	boolean	Optional
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative
`description (anyOf 2)`	null	Alternative
`video_project_id`	JSON	Optional
`video_project_id (anyOf 1)`	string	Alternative
`video_project_id (anyOf 2)`	null	Alternative

Referenced models: Creates a file request for this user — request body — body deadline allow late uploads, deadline

Creates a file request for this user — request body — body deadline allow late uploads, deadline

Field	Type	Presence	Description and constraints
`$`	object	Root
`deadline`	string	Required within parent
`allow_late_uploads`	JSON	Optional
`allow_late_uploads (anyOf 1)`	Model	Alternative	Expand Update a file request — request body — body deadline tag update allow late uploads value
`allow_late_uploads (anyOf 2)`	null	Alternative

Referenced models: Update a file request — request body — body deadline tag update allow late uploads value

Delete a batch of closed file requests — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Arguments for delete.
`ids`	array	Required within parent
`ids[]`	string	Each item	Minimum length: 1 Pattern: ^(?:[-_0-9a-zA-Z]+)$

Delete a batch of closed file requests — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Result for delete.
`file_requests`	array	Required within parent
`file_requests[]`	Model	Each item	Expand Update a file request — response body

Referenced models: Update a file request — response body

Delete all closed file requests owned by this user — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Result for delete_all_closed.
`file_requests`	array	Required within parent
`file_requests[]`	Model	Each item	Expand Update a file request — response body

Referenced models: Update a file request — response body

Returns a list of file requests owned by this user — file Requests list V2 — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Arguments for list:2.
`limit`	integer	Optional	Minimum: 0

Returns a list of file requests owned by this user — file Requests list V2 — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Result for list:2 and list/continue.
`file_requests`	array	Required within parent
`file_requests[]`	Model	Each item	Expand Update a file request — response body
`cursor`	string	Required within parent
`has_more`	boolean	Required within parent

Referenced models: Update a file request — response body

Returns a list of file requests owned by this user — file Requests list — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Result for list.
`file_requests`	array	Required within parent
`file_requests[]`	Model	Each item	Expand Update a file request — response body

Referenced models: Update a file request — response body

Returns the specified file request — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Arguments for get.
`id`	string	Required within parent	Minimum length: 1 Pattern: ^(?:[-_0-9a-zA-Z]+)$

Returns the total number of file requests owned by this user — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Result for count.
`file_request_count`	JSON	Required within parent
`file_request_count (anyOf 1)`	integer	Alternative	Minimum: 0
`file_request_count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update a file request — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Arguments for update.
`id`	string	Required within parent	Minimum length: 1 Pattern: ^(?:[-_0-9a-zA-Z]+)$
`title`	JSON	Optional
`title (anyOf 1)`	string	Alternative	Minimum length: 1
`title (anyOf 2)`	null	Alternative
`destination`	JSON	Optional
`destination (anyOf 1)`	string	Alternative	Pattern: ^(?:/(.\|[\r\n])*)$
`destination (anyOf 2)`	null	Alternative
`deadline`	Model	Optional	Expand Update a file request — request body — body deadline
`open`	JSON	Optional
`open (anyOf 1)`	boolean	Alternative
`open (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative
`description (anyOf 2)`	null	Alternative

Referenced models: Update a file request — request body — body deadline

Update a file request — request body — body deadline

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	string	Alternative	One of: no_update
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: no_update
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: update
`$ (anyOf 3).deadline`	string	Required within parent
`$ (anyOf 3).allow_late_uploads`	JSON	Optional
`$ (anyOf 3).allow_late_uploads (anyOf 1)`	Model	Alternative	Expand Update a file request — request body — body deadline tag update allow late uploads value
`$ (anyOf 3).allow_late_uploads (anyOf 2)`	null	Alternative
`$ (anyOf 4)`	object	Alternative	Additional keys: not allowed
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: update
`$ (anyOf 5)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 5)..tag`	string	Required within parent	Pattern: ^(?!(?:no_update\|update)$)

Referenced models: Update a file request — request body — body deadline tag update allow late uploads value

Update a file request — request body — body deadline tag update allow late uploads value

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	string	Alternative	One of: one_day, two_days, seven_days, thirty_days, always
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: one_day
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: two_days
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: seven_days
`$ (anyOf 5)`	object	Alternative
`$ (anyOf 5)..tag`	string	Required within parent	Must equal: thirty_days
`$ (anyOf 6)`	object	Alternative
`$ (anyOf 6)..tag`	string	Required within parent	Must equal: always
`$ (anyOf 7)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 7)..tag`	string	Required within parent	Pattern: ^(?!(?:one_day\|two_days\|seven_days\|thirty_days\|always)$)

Update a file request — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A file request https://www.dropbox.com/help/9090 for receiving files into the user's Dropbox account.
`id`	string	Required within parent	Minimum length: 1 Pattern: ^(?:[-_0-9a-zA-Z]+)$
`url`	string	Required within parent	Minimum length: 1
`title`	string	Required within parent	Minimum length: 1
`destination`	JSON	Optional
`destination (anyOf 1)`	string	Alternative	Pattern: ^(?:/(.\|[\r\n])*)$
`destination (anyOf 2)`	null	Alternative
`created`	string	Required within parent
`deadline`	JSON	Optional
`deadline (anyOf 1)`	Model	Alternative	Expand Update a file request — response body — deadline allow late uploads, deadline
`deadline (anyOf 2)`	null	Alternative
`is_open`	boolean	Required within parent
`file_count`	JSON	Required within parent
`file_count (anyOf 1)`	integer	Alternative
`file_count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative
`description (anyOf 2)`	null	Alternative
`video_project_id`	JSON	Optional
`video_project_id (anyOf 1)`	string	Alternative
`video_project_id (anyOf 2)`	null	Alternative

Referenced models: Update a file request — response body — deadline allow late uploads, deadline

Update a file request — response body — deadline allow late uploads, deadline

Field	Type	Presence	Description and constraints
`$`	object	Root
`deadline`	string	Required within parent
`allow_late_uploads`	JSON	Optional
`allow_late_uploads (anyOf 1)`	Model	Alternative	Expand Update a file request — response body — deadline allow late uploads, deadline allow late uploads value
`allow_late_uploads (anyOf 2)`	null	Alternative

Referenced models: Update a file request — response body — deadline allow late uploads, deadline allow late uploads value

Update a file request — response body — deadline allow late uploads, deadline allow late uploads value

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	string	Alternative	Known values: one_day, two_days, seven_days, thirty_days, always
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: one_day
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: two_days
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: seven_days
`$ (anyOf 5)`	object	Alternative
`$ (anyOf 5)..tag`	string	Required within parent	Must equal: thirty_days
`$ (anyOf 6)`	object	Alternative
`$ (anyOf 6)..tag`	string	Required within parent	Must equal: always
`$ (anyOf 7)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 7)..tag`	string	Required within parent	Pattern: ^(?!(?:one_day\|two_days\|seven_days\|thirty_days\|always)$)

Report an issue with this page