Skip to main content
POST
Error

Authorizations

x-cdata-authtoken
string
header
required

A Sync user auth token. Generate one via POST /v2/users/generate-token.

Path Parameters

workspace_id
string
required

Workspace identifier.

Body

application/json
name
string
required
destination
object
required

Destination connection; may also include a connector name.

labels
string[]
schedule
object
alert
object
steps
object[]

Optional steps to create together with the pipeline. Steps are created as a single sequential chain following the order of this array: the first step becomes the entry point and each subsequent step is linked after the previous one. Step IDs are generated by Sync, so previous_step_id and next_step_id must not be supplied here; use the per-step endpoints to build pipelines with parallel branches. Every requested step is validated before the pipeline is persisted. If any step is missing, invalid, incompatible, already assigned, duplicated, or references a missing entity, the entire create request fails with a 400 or 404 response; invalid steps are not skipped.

Response

The requested resource.

id
string
name
string
workspace_id
string
schedule
object
destination
object

A lightweight reference to a related resource.

labels
string[]
alert
object
last_run
object | null
permissions
object
variable
object
created_at
string<date-time>
updated_at
string<date-time>