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": {
    "fieldMappings": [
      {
        "target": "<string>",
        "source": "<string>",
        "transform": "<string>",
        "value": "<string>",
        "sources": [
          "<string>"
        ],
        "delimiter": " "
      }
    ],
    "options": {},
    "validations": {}
  },
  "clientId": "<string>",
  "schemaId": "<string>",
  "direction": "inbound",
  "isActive": true,
  "webhookIds": [
    "<string>"
  ]
}
'
import requests

url = "https://api.sftpsync.io/pipelines/{id}"

payload = {
    "name": "<string>",
    "mappings": {
        "fieldMappings": [
            {
                "target": "<string>",
                "source": "<string>",
                "transform": "<string>",
                "value": "<string>",
                "sources": ["<string>"],
                "delimiter": " "
            }
        ],
        "options": {},
        "validations": {}
    },
    "clientId": "<string>",
    "schemaId": "<string>",
    "direction": "inbound",
    "isActive": True,
    "webhookIds": ["<string>"]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    mappings: {
      fieldMappings: [
        {
          target: '<string>',
          source: '<string>',
          transform: '<string>',
          value: '<string>',
          sources: ['<string>'],
          delimiter: ' '
        }
      ],
      options: {},
      validations: {}
    },
    clientId: '<string>',
    schemaId: '<string>',
    direction: 'inbound',
    isActive: true,
    webhookIds: ['<string>']
  })
};

fetch('https://api.sftpsync.io/pipelines/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sftpsync.io/pipelines/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'mappings' => [
        'fieldMappings' => [
                [
                                'target' => '<string>',
                                'source' => '<string>',
                                'transform' => '<string>',
                                'value' => '<string>',
                                'sources' => [
                                                                '<string>'
                                ],
                                'delimiter' => ' '
                ]
        ],
        'options' => [
                
        ],
        'validations' => [
                
        ]
    ],
    'clientId' => '<string>',
    'schemaId' => '<string>',
    'direction' => 'inbound',
    'isActive' => true,
    'webhookIds' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sftpsync.io/pipelines/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"mappings\": {\n    \"fieldMappings\": [\n      {\n        \"target\": \"<string>\",\n        \"source\": \"<string>\",\n        \"transform\": \"<string>\",\n        \"value\": \"<string>\",\n        \"sources\": [\n          \"<string>\"\n        ],\n        \"delimiter\": \" \"\n      }\n    ],\n    \"options\": {},\n    \"validations\": {}\n  },\n  \"clientId\": \"<string>\",\n  \"schemaId\": \"<string>\",\n  \"direction\": \"inbound\",\n  \"isActive\": true,\n  \"webhookIds\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.sftpsync.io/pipelines/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"mappings\": {\n    \"fieldMappings\": [\n      {\n        \"target\": \"<string>\",\n        \"source\": \"<string>\",\n        \"transform\": \"<string>\",\n        \"value\": \"<string>\",\n        \"sources\": [\n          \"<string>\"\n        ],\n        \"delimiter\": \" \"\n      }\n    ],\n    \"options\": {},\n    \"validations\": {}\n  },\n  \"clientId\": \"<string>\",\n  \"schemaId\": \"<string>\",\n  \"direction\": \"inbound\",\n  \"isActive\": true,\n  \"webhookIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.sftpsync.io/pipelines/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"mappings\": {\n    \"fieldMappings\": [\n      {\n        \"target\": \"<string>\",\n        \"source\": \"<string>\",\n        \"transform\": \"<string>\",\n        \"value\": \"<string>\",\n        \"sources\": [\n          \"<string>\"\n        ],\n        \"delimiter\": \" \"\n      }\n    ],\n    \"options\": {},\n    \"validations\": {}\n  },\n  \"clientId\": \"<string>\",\n  \"schemaId\": \"<string>\",\n  \"direction\": \"inbound\",\n  \"isActive\": true,\n  \"webhookIds\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "name": "<string>",
  "mappings": {
    "fieldMappings": [
      {
        "target": "<string>",
        "source": "<string>",
        "transform": "<string>",
        "value": "<string>",
        "sources": [
          "<string>"
        ],
        "delimiter": " "
      }
    ],
    "options": {},
    "validations": {}
  },
  "isActive": true,
  "clientId": "<string>",
  "schemaId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "direction": "inbound",
  "webhooks": [
    {
      "id": "<string>",
      "name": "<string>",
      "url": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Body

application/json
​
name
string
required
​
mappings
object
required

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

​
clientId
string
required

Connection id this pipeline is bound to.

​
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
​
isActive
boolean

Whether the pipeline is active on creation. Backend default: true.

​
webhookIds
string[]

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.