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.
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:
{
"templateId": 25,
"modifications": {
"headline": "Hello World"
},
"response": {
"type": "url",
"format": "png"
},
"connections": [
{
"type": "storage",
"provider": "dropbox"
}
]
}Override the default folder by specifying a folder path:
{
"connections": [
{
"type": "storage",
"provider": "dropbox",
"folder": "/Marketing/Campaign-2024"
}
]
}Use response.fileName to set a custom name for the uploaded file:
{
"templateId": 25,
"modifications": { "headline": "Hello" },
"response": {
"type": "url",
"format": "png",
"fileName": "marketing-banner-001"
},
"connections": [
{
"type": "storage",
"provider": "dropbox",
"folder": "/Banners"
}
]
}{
"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"
}
]
}When rendering multi-page templates, each page is uploaded separately:
{
"data": [
{
"page": 1,
"content": "https://storage.orshot.com/cloud/w-50/renders/images/abc123.png"
},
{
"page": 2,
"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"
}
]
}Connection issues return warnings but don't block the render:
{
"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"
}
]
}{
"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": ""
}
]
}| 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 |
