Update an export

put

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

Updates an export. Omitted fields are unchanged. Supply destination to re-point or reconfigure delivery: it is re-translated and the export's destination is updated together with the export, in one transaction. Changing query or record_limit requires destination too, so the export query and its destination stay in sync. The export must have exactly one destination, and its type cannot change in place (delete and recreate to switch type).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

The export id (UUID).

Body Params

Fields to change. Omitted fields are unchanged. Include destination to change delivery; query and record_limit require it.

name

string

description

string

query

object

What to export. The server adds the destination (and recordLimit, if record_limit is supplied) into this object before saving.

record_limit

object

schedule

string

enum

Allowed:

status

string

enabled

boolean

end_date

string

run_time

string

run_day_of_week

integer

0 to 6

run_timezone

string

IANA time zone for run_time and run_day_of_week. Omit to keep the current zone.

destination

Where and how to deliver. The type field selects the variant, and integration_id references a saved integration of that type.

Responses

401

Missing or invalid API key / secret.

404

No export with this id in the key's organization.

Language

Credentials

Loading…

Response

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

application/json

200The updated export and its destinations.

400Invalid body or a failed validation: query/record_limit without destination, an integration_id outside the key's organization, an export that does not have exactly one destination, or an attempted destination type change.

409An export with this name already exists in the project.