Add a destination to an export

post

https://api.delivr.ai/api/v1/exports/{id}/destinations

Adds one more delivery destination to an existing export. The destination is the same shape as destination on create, and references a saved integration by id. An export can have at most 5 destinations, each on a different connection; marketplace destinations cannot be combined with others, and a DelivrDSP destination cannot be added to an existing export.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

The export id (UUID).

Body Params

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

type

string

enum

required

Allowed:

integration_id

uuid

required

A saved s3 integration.

prefix

string

Object key prefix (folder path) within the bucket.

path_format

string

enum

Allowed:

record_type

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). match_key delivers a single identifier column and no attribute columns, for activation on a platform with no Delivr connector; see match_key.

match_key

string

enum

Which identifier a match_key export delivers. Required when record_type is match_key and refused otherwise; fields and array_transform are refused alongside it. Audience sources only: a run on any other source fails.

hem is the SHA-256 lowercase hashed email, in a sha256_lc_hem column. uid2 is that same value converted to a UID2 token, in a uid2 column. maid is a device advertising id (mobile or CTV) tied to the person, and household_ip is the person's household network, an IPv4 address or an IPv6 /64, each in a column of the same name. A file holds one row per distinct value; people with no value are left out.

Allowed:

file_format

string

enum

required

Allowed:

fields

array of strings

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

fields

array_transform

string

enum

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

Allowed:

filename_template

string

emit_empty_file

boolean

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

combine_output

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.

413

Request body larger than 1 MiB.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The added destination.

400Missing destination, an invalid destination, an integration_id outside the key's organization, more than 5 destinations total, two destinations on the same connection, or a marketplace destination combined with another destination.