Skip to main content
POST
/
destinations
/
{destination_id}
/
transfer
Create transfer
curl --request POST \
  --url https://api.prequel.co/destinations/{destination_id}/transfer \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "full_refresh": false,
  "is_debug_mode": false,
  "models": [
    "<string>"
  ],
  "start_transfer_window_at": "2023-11-07T05:31:56Z",
  "end_transfer_window_at": "2023-11-07T05:31:56Z",
  "tags": {}
}
'
{
  "status": "<string>",
  "data": {
    "transfer_id": "<string>"
  },
  "message": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
destination_id
string
required

Destination ID.

Body

application/json
​
full_refresh
boolean
default:false

When true: runs a full refresh from the start of the recipient's configured transfer window. When false: runs incrementally from the last successful transfer.

​
is_debug_mode
boolean
default:false

Enables debug-level logging for the transfer run.

​
models
string[]

Specifies models to run. If unspecified or left empty all models will be run.

​
start_transfer_window_at
string<date-time>

All rows transferred will have a last_updated_at value greater than or equal to this value. If omitted the Unix epoch will be used. Timestamps should be represented in RFC3339 format.

​
end_transfer_window_at
string<date-time>

All rows transferred will have a last_updated_at value less than this value. If omitted the current time will be used. Timestamps should be represented in RFC3339 format.

​
tags
object

Tags to apply to the transfer. Tags are key-value pairs where keys and values must contain only alphanumeric characters and underscores/hyphens.

Response

OK

​
status
string
required
Allowed value: "success"
​
data
object
required
​
message
string
required