---
title: "Update data export"
method: PATCH
path: "/data-exports/{id}"
tags: ["Data Exports"]
---

# Update data export

`PATCH /data-exports/{id}`

## Request

- Base URL: `https://api.sequenzy.com/api/v1`
- URL: `https://api.sequenzy.com/api/v1/data-exports/{id}`
- Auth: HTTP bearer

Renames, changes datasets or frequency, pauses or resumes, moves the destination, or rotates credentials. Location and credential changes are verified with a test write first. Newly added event datasets start from the time of the change. Changing the bucket or prefix continues from the current progress in the new location.

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string
  - `bucket` string
  - `region` string, nullable
  - `endpoint` string, nullable: Send null or an empty string to clear a custom endpoint.
  - `pathPrefix` string, nullable
  - `accessKeyId` string: Must be sent together with secretAccessKey.
  - `secretAccessKey` string: Must be sent together with accessKeyId.
  - `datasets` string[]
  - `frequency` 'every_5_minutes' | 'every_15_minutes' | 'hourly' | 'daily'
  - `isEnabled` boolean: false pauses the export, true resumes it.

## Response `200`

Data export updated

- object
  - `success` boolean
  - `dataExport` DataExport: A bucket that Sequenzy streams workspace data to as gzipped JSON lines.
    - `id` string
    - `name` string
    - `provider` 's3' | 'gcs'
    - `bucket` string
    - `region` string
    - `endpoint` string, nullable
    - `pathPrefix` string
    - `accessKeyId` string: Masked access key ID, for example AKIA…WXYZ. The secret is never returned.
    - `datasets` string[]
    - `frequency` 'every_5_minutes' | 'every_15_minutes' | 'hourly' | 'daily'
    - `isEnabled` boolean
    - `status` 'idle' | 'queued' | 'running' | 'failed': failed means the last run failed; it retries automatically with backoff.
    - `startFrom` string, date-time
    - `exportedThrough` object: Per dataset. Event datasets: everything recorded up to this timestamp has been written. subscribers: date of the last complete snapshot. null until the first export of that dataset.
    - `nextRunAt` string, date-time, nullable
    - `lastRunAt` string, date-time, nullable
    - `lastSuccessAt` string, date-time, nullable
    - `lastError` string, nullable
    - `lastErrorAt` string, date-time, nullable
    - `consecutiveFailures` integer
    - `totalRowsExported` integer
    - `createdAt` string, date-time
    - `updatedAt` string, date-time

## Other responses

- `400`: Validation error or the test write failed
- `401`: Unauthorized
- `404`: Data export not found

## Changes

- **2026-10-16** `db3873ca3d4d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/sequenzy/apis/sequenzy-api/changes/data-exports/:id/patch.md)

---

[API](https://skmtc.dev/sequenzy/apis/sequenzy-api.md) - [All operations](https://skmtc.dev/sequenzy/apis/sequenzy-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sequenzy/apis/sequenzy-api/revisions/8156dc12d8b4?raw)