Skip to main content
POST
Create Data Export
Adds a bucket as a data export destination. Before saving, Sequenzy writes a small test file to <pathPrefix>/_sequenzy/connection-test.json. If that write fails, nothing is saved and the response explains why. The first export starts immediately. Requires data_exports:write, subscribers:read and analytics:read, because the destination receives subscriber and engagement data. See Data exports for the file layout, row schemas and warehouse loading recipes.

Request

string
required
Display name, up to 255 characters.
string
required
s3 for Amazon S3 or any S3-compatible service, gcs for Google Cloud Storage.
string
required
Bucket name, not a URL.
string | null
Bucket region, for example us-east-1. Required for Amazon S3 without a custom endpoint. Defaults to auto for GCS and custom endpoints.
string | null
HTTPS origin of an S3-compatible service such as Cloudflare R2, MinIO or Backblaze B2. It must resolve to a public address. Not allowed with gcs.
string | null
default:""
Folder inside the bucket. Leading and trailing slashes are removed. Letters, numbers, / and ! _ . * ' ( ) = - are allowed; .. segments are rejected.
string
required
Access key ID. For GCS, the HMAC access ID.
string
required
Secret access key (GCS: HMAC secret). Stored encrypted and never returned.
string[]
Any of email_events, sms_events, custom_events, subscribers. Unknown values return 422.
string
default:"every_15_minutes"
every_5_minutes, every_15_minutes, hourly or daily.
string | null
ISO timestamp, at most 30 days ago, to include events recorded since then. Defaults to now. The subscriber snapshot always reflects current data.