Skip to main content
PATCH
/
pipelines
/
{id}
Update pipeline
curl --request PATCH \
  --url https://api.sftpsync.io/pipelines/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "mappings": [
    {
      "sourceField": "<string>",
      "targetField": "<string>",
      "transform": "<string>",
      "defaultValue": "<unknown>"
    }
  ],
  "clientId": "<string>",
  "schemaId": "<string>",
  "direction": "inbound",
  "webhookIds": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "mappings": [
    {
      "sourceField": "<string>",
      "targetField": "<string>",
      "transform": "<string>",
      "defaultValue": "<unknown>"
    }
  ],
  "isActive": true,
  "workspaceId": "<string>",
  "clientId": "<string>",
  "schemaId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "direction": "inbound"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Body

application/json
​
name
string
required
​
mappings
object
required
​
clientId
string
required
​
schemaId
string
required
​
direction
enum<string>
default:inbound

Set to "outbound" to create a pipeline that accepts data via the Outbound Uploads API.

Available options:
inbound,
outbound
​
webhookIds
string[]

Response

200 - application/json

Pipeline

​
id
string
required
​
name
string
required
​
mappings
object
required
​
isActive
boolean
required
​
workspaceId
string
required
​
clientId
string
required
​
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