Change an added destination

Replaces the settings of one destination that was added to an export, such as its fields, file format or connection. Send the whole destination in the same shape as destination on create; each added destination in a read carries its current settings in that shape as destination, so read it, change what you need, and send it back. The type cannot change, and the connection must not be one another destination on the export already uses. The export's original destination is changed with PUT /api/v1/exports/{id} instead.

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

The export id (UUID).

uuid
required

The id of one of the export's added destinations, as listed in destinations on GET /api/v1/exports/{id}.

Body Params

File-write options supported by S3 and email destinations (not Slack).

string
enum
required
Allowed:
uuid
required

A saved s3 integration.

string

Object key prefix (folder path) within the bucket.

string
enum
Allowed:
string
enum
required

What each output record encodes. The value valid for a given export depends on its source (e.g. contacts_only for an audience export, raw_events for a pixel or DSP event export).

string
enum
required
Allowed:
fields
array of strings

Output column allow-list. Omit to use the default set for the record type.

fields
string
enum

How to render multi-value fields. Defaults to first.

Allowed:
string
boolean

Deliver a file even when there are zero records. Defaults to false.

boolean

Combine a multi-window run into one file. Not allowed with parquet. Defaults to false.

Responses

401

Missing or invalid API key / secret.

404

No export with this id in the key's organization, or no destination with this id on the export.

409

The destination is the export's original.

413

Request body larger than 1 MiB.

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