Update a data export

Partial update of an existing DataExport. Status transitions are separate action endpoints — use /pause, /resume, /disable. If-Match ETag supported for optimistic concurrency control; mismatch returns 412 Precondition Failed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Partial update of a DataExport. Status transitions (pause/resume/ disable) are separate action endpoints — use POST /data-exports/{id}/pause | /resume | /disable. If supplied, filters and fieldSelection replace the prior selection config for their resource keys.

string
entities
array of objects
entities
piiEntities
array of objects
piiEntities
destination
object

Delivery destination. Currently supports S3 only; non-AWS destinations are planned. roleArn must trust the Wingspan source account and require the ExternalId: wingspan-{accountId}-{dataExportId} for confused-deputy prevention.

schedule
object

Schedule for the export. Cron expression with explicit timezone. Minimum cadence is hourly; maximum is daily.

string
enum
Defaults to Parquet

Output format. Parquet is recommended for Redshift / Snowflake / BigQuery COPY-style ingestion. Csv is provided for legacy tooling. JsonLines and Json are aliases for Json (newline-delimited).

Allowed:
fieldSelection
object

Optional per-resource column projection. Keys are the eligible DataExportResource object names. Values are dot-notation field paths for that resource. Omitted resources export their default field set. Default = all non-sensitive fields, except for Person and Account PII, which default to a non-PII subset (id, externalId, status, events, actors, metadata). Including PII requires explicit opt-in here AND the calling Authorization must carry the relevant data-export.{resource}.pii:read scope.

filters
object

Optional per-resource row filters. Keys are eligible DataExportResource object names. A resource filter may only be supplied for resources present in entities; otherwise create/update returns 422 ValidationError. Each resource filter is applied after the run's watermark window, so a row must both be changed in the run window and satisfy the resource filter to be emitted.

metadata
object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers
string
length between 1 and 255
^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json