Create | Dropbox API Documentation

import requests
url = "https://api.dropboxapi.com/2/file_requests/create"
payload = {
    "destination": "/File Requests/Homework",
    "title": "Homework submission",
    "deadline": {
        "deadline": "2020-10-12T17:00:00Z",
        "allow_late_uploads": { ".tag": "seven_days" }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "created": "2015-10-05T17:00:00Z",
  "file_count": 3,
  "id": "oaCAVmEyrqYnkZX9955Y",
  "is_open": true,
  "title": "Homework submission",
  "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y",
  "deadline": {
    "deadline": "2020-10-12T17:00:00Z",
    "allow_late_uploads": {
      ".tag": "seven_days"
    }
  },
  "description": "Please submit your homework here.",
  "destination": "/File Requests/Homework"
}

Creates a file request for this user.

Required scope: file_requests.write

Endpoint format: RPC

Authentication: User

Creates a file request for this user. **Required scope:** `file_requests.write` **Endpoint format:** [RPC](https://docs.dropboxapi.com/dropbox-api/docs/technical-reference/request-response-formats#rpc-endpoints) **Authentication:** [User](https://docs.dropboxapi.com/dropbox-api/docs/auth-types#user-authentication)

Authentication

AuthorizationBearer

OAuth 2.0 token issued to a specific user. Use Authorization: Bearer <token>.

Public clients should use the authorization code flow with PKCE (S256).

For background or offline access, send token_access_type=offline during authorization and use the returned refresh token to obtain new access tokens.

You can generate a short-lived access token from the App Console; see Testing with a generated token.

OAuth 2.0 token issued to a specific user. Use `Authorization: Bearer <token>`. Public clients should use the authorization code flow with PKCE (S256). For background or offline access, send `token_access_type=offline` during authorization and use the returned refresh token to obtain new access tokens. You can generate a short-lived access token from the App Console; see [Testing with a generated token](https://docs.dropboxapi.com/dropbox-api/docs/oauth#testing-with-a-generated-token).

Headers

Dropbox-API-Path-RootstringOptional

Scopes path-based operations to a namespace (root). The value is a JSON serialization of the common.PathRoot union: {".tag": "home"}, {".tag": "root", "root": "<namespace_id>"}, or {".tag": "namespace_id", "namespace_id": "<namespace_id>"}. On failure the request returns 422 with a common.PathRootError.

Scopes path-based operations to a namespace (root). The value is a JSON serialization of the `common.PathRoot` union: `{".tag": "home"}`, `{".tag": "root", "root": "<namespace_id>"}`, or `{".tag": "namespace_id", "namespace_id": "<namespace_id>"}`. On failure the request returns 422 with a `common.PathRootError`.

Request

This endpoint expects an object.

destinationstringRequiredformat: "\/(.|[\r\n])*"

The path of the folder in the Dropbox where uploaded files will be sent. For apps with the app folder permission, this will be relative to the app folder.

titlestringRequired>=1 character

The title of the file request. Must not be empty.

deadlineobject or nullOptional

The deadline for the file request. Deadlines can only be set by Professional and Business accounts.

descriptionstring or nullOptional

A description of the file request.

openbooleanOptionalDefaults to true

Whether or not the file request should be open. If the file request is closed, it will not accept any file submissions, but it can be opened later.

video_project_idstring or nullOptional

If this request was created from video project, its id.

Response headers

X-Dropbox-Request-IdstringOptional

A unique identifier for the request, useful for debugging and support.

Response

Successful response

createddatetime

When this file request was created.

file_countlong

The number of files this file request has received.

idstringformat: "[-_0-9a-zA-Z]+">=1 character

The ID of the file request.

is_openboolean

Whether or not the file request is open. If the file request is closed, it will not accept any more file submissions.

titlestring>=1 character

The title of the file request.

urlstring>=1 character

The URL of the file request.

deadlineobject or nullOptional

The deadline for this file request. Only set if the request has a deadline.

descriptionstring or nullOptional

A description of the file request.

destinationstring or nullOptionalformat: "\/(.|[\r\n])*"

The path of the folder in the Dropbox where uploaded files will be sent. This can be null if the destination was removed. For apps with the app folder permission, this will be relative to the app folder.

video_project_idstring or nullOptional

If this request was created from video project, its id.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error