send_custom_request Method

Sends a custom request to the Dropbox API.

Syntax

def send_custom_request(http_method: str, request_path: str, request_body: str) -> None: ...

Remarks

This method can be used to send arbitrary requests to the Dropbox API.

Valid values for HttpMethod are:

• GET
• POST (default if empty)

The value passed for RequestPath must already be URL-encoded in a manner acceptable to the Dropbox API. The RequestBody parameter may be empty if not needed.

Usage

When this method is called, the class does the following:

1. Builds a request URL, including query parameters, as follows:
   • The specified RequestPath is appended to the Dropbox API endpoint, https://api.dropboxapi.com/2.
   • All query parameters in the QueryParam* properties are added to the request URL.
2. Sends the request using the specified HttpMethod, the request URL build in step 1, the header information held by authorization and other_headers, and the given RequestBody (if non-empty).
3. Stores the response headers in the ParsedHeader* properties, and the response body in the specified local_file, or resource_data (using the same logic as download_file).

If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.