Skip to main content
PATCH
Toggle pipeline active status

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Response

200 - application/json

Pipeline

id
string
required
name
string
required
mappings
object
required

The mapping definition the API expects. Field mappings live under fieldMappings; not a bare array.

isActive
boolean
required
clientId
string
required

Connection id this pipeline is bound to.

schemaId
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
direction
enum<string>
default:inbound

Pipeline direction. Outbound pipelines accept data via the Outbound Uploads API.

Available options:
inbound,
outbound
webhooks
object[]

Webhooks linked to this pipeline. Present and non-empty only when the pipeline has associated webhooks.