# Dropbox

> Automatically store rendered files in your Dropbox folders

- **URL**: https://orshot.com/docs/integrations/dropbox

---

The Orshot Dropbox integration allows you to automatically save generated files directly to your Dropbox account. When enabled, every render (images, PDFs, videos) via the API can be stored in a specified Dropbox folder, making it easy to organize, share, and access your generated content.

## Connecting Dropbox

![](https://orshot.com/docs/integrations/dropbox-page.png)

1. Navigate to **Workspace > Settings > Storage** in your Orshot dashboard
2. Click **Connect Dropbox**
3. Authorize Orshot to access your Dropbox account
4. Select or create a default folder for storing renders

## Using Dropbox in API Requests

If Dropbox is enabled on the Storage page, all your renders will automatically be uploaded to Dropbox — no need to add `connections` in your API request.

To explicitly control the upload or specify custom options, add the `connections` parameter to your render request:```json
{
  "templateId": 25,
  "modifications": {
    "headline": "Hello World"
  },
  "response": {
    "type": "url",
    "format": "png"
  },
  "connections": [
    {
      "type": "storage",
      "provider": "dropbox"
    }
  ]
}
```### Specifying a Custom Folder

Override the default folder by specifying a `folder` path:```json
{
  "connections": [
    {
      "type": "storage",
      "provider": "dropbox",
      "folder": "/Marketing/Campaign-2024"
    }
  ]
}
```### Custom File Names

Use `response.fileName` to set a custom name for the uploaded file:```json
{
  "templateId": 25,
  "modifications": { "headline": "Hello" },
  "response": {
    "type": "url",
    "format": "png",
    "fileName": "marketing-banner-001"
  },
  "connections": [
    {
      "type": "storage",
      "provider": "dropbox",
      "folder": "/Banners"
    }
  ]
}
```## API Response Examples

### Successful Upload```json
{
  "data": {
    "content": "https://store.orshot.com/cloud/w-50/renders/images/abc123.png",
    "type": "url",
    "format": "png",
    "responseTime": "1.2s"
  },
  "connections": [
    {
      "type": "storage",
      "provider": "dropbox",
      "path": "/Marketing/Campaign-2024/abc123.png",
      "status": "success"
    }
  ]
}
```### Multi-Page Upload

When rendering multi-page templates, each page is uploaded separately:```json
{
  "data": [
    {
      "page": 1,
      "pageId": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
      "content": "https://storage.orshot.com/cloud/w-50/renders/images/abc123.png"
    },
    {
      "page": 2,
      "pageId": "b2c3d4e5-6f78-9012-bcde-f23456789012",
      "content": "https://storage.orshot.com/cloud/w-50/renders/images/def456.png"
    }
  ],
  "format": "png",
  "type": "url",
  "responseTime": 3166.01,
  "totalPages": 2,
  "renderedPages": 2,
  "connections": [
    {
      "type": "storage",
      "provider": "dropbox",
      "path": [
        { "page": 1, "path": "/Renders/template_page_1.png" },
        { "page": 2, "path": "/Renders/template_page_2.png" }
      ],
      "status": "success"
    }
  ]
}
```### Upload Failed (with Warning)

Connection issues return warnings but don't block the render:```json
{
  "data": {
    "content": "https://store.orshot.com/cloud/w-50/renders/images/abc123.png",
    "type": "url",
    "format": "png",
    "responseTime": "1.2s"
  },
  "warnings": [
    {
      "title": "Failed to upload to dropbox: Token expired",
      "details": ""
    }
  ],
  "connections": [
    {
      "type": "storage",
      "provider": "dropbox",
      "path": null,
      "status": "error",
      "error": "Token expired"
    }
  ]
}
```### Dropbox Not Connected```json
{
  "data": {
    "content": "https://store.orshot.com/cloud/w-50/renders/images/abc123.png",
    "type": "url",
    "format": "png"
  },
  "warnings": [
    {
      "title": "Dropbox connection not found for this workspace",
      "details": ""
    }
  ]
}
```## Connection Parameters

| Parameter  | Type   | Required | Description                                              |
| ---------- | ------ | -------- | -------------------------------------------------------- |
| `type`     | string | Yes      | Must be `"storage"`                                      |
| `provider` | string | Yes      | Must be `"dropbox"`                                      |
| `folder`   | string | No       | Custom folder path. Uses default folder if not specified |

## Notes

- **Non-blocking**: Dropbox upload failures won't block your render—you'll still get the image URL
- **Automatic refresh**: Access tokens are automatically refreshed when they expire
- **Folder creation**: Folders are created automatically if they don't exist
- **Supported formats**: PNG, JPG, JPEG, WebP, AVIF, PDF, MP4, GIF

## Need Help?

- Contact support at hi@orshot.com or use the chat button in your Orshot dashboard