Skip to main content
PATCH
/
clients
/
{id}
Update client
curl --request PATCH \
  --url https://api.sftpsync.io/clients/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "type": "SFTP",
  "sftpUsername": "<string>",
  "sftpPassword": "<string>",
  "sftpPrivateKey": "<string>",
  "sftpPassphrase": "<string>",
  "useHostedSFTP": true,
  "awsUserName": "<string>",
  "awsPublicKey": "<string>",
  "awsPassword": "<string>",
  "ipWhitelist": [
    "<string>"
  ],
  "sftpServerDataId": "<string>",
  "emailAllowedSenders": [
    "<string>"
  ],
  "emailAllowedFormats": [],
  "emailSubjectFilter": "<string>",
  "emailInboundAddress": "jsmith@example.com"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "workspaceId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "sftpUsername": "<string>",
  "useHostedSFTP": true,
  "awsUserName": "<string>",
  "awsPublicKey": "<string>",
  "ipWhitelist": [
    "<string>"
  ],
  "sftpServerDataId": "<string>",
  "emailInbox": {
    "inboundAddress": "<string>",
    "allowedSenders": [
      "<string>"
    ],
    "allowedFormats": [],
    "subjectFilter": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Body

application/json

Deprecated — alias for UpdateConnectionParams.

​
name
string
required
​
type
enum<string>
default:SFTP

Connection kind. Defaults to SFTP. Set to EMAIL to create an email inbox connection — the email* fields then apply and SFTP fields are ignored.

Available options:
SFTP,
EMAIL
​
sftpUsername
string
​
sftpPassword
string
​
sftpPrivateKey
string
​
sftpPassphrase
string
​
useHostedSFTP
boolean
​
awsUserName
string
​
awsPublicKey
string
​
awsPassword
string
​
ipWhitelist
string[]
​
sftpServerDataId
string
​
emailAllowedSenders
string[]

EMAIL only. Allowed senders — full address (alice@acme.com) or root-domain pattern (@acme.com). Empty/omitted = accept any sender.

Maximum array length: 50
​
emailAllowedFormats
enum<string>[]

EMAIL only. Attachment accept-list. Required and non-empty for EMAIL connections.

Minimum array length: 1
Available options:
csv,
xlsx,
xls,
json,
xml,
tsv
​
emailSubjectFilter
string

EMAIL only. Case-insensitive substring required in the subject. Empty = no filter.

Maximum string length: 200
​
emailInboundAddress
string<email>

EMAIL only, create-only and immutable. Custom inbound address {workspace-slug}.{connection-slug}@in.filefeed.io. Omit to have one generated (feed-XXXX@in.filefeed.io).

Maximum string length: 320

Response

200 - application/json

Client

Deprecated — alias for Connection. Removed when API version 2024-09-01 sunsets on 2027-05-25.

​
id
string
required
​
name
string
required
​
type
enum<string>
required

Connection kind. Always present as of API version 2026-05-25.

Available options:
SFTP,
EMAIL
​
workspaceId
string
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
sftpUsername
string
​
useHostedSFTP
boolean
​
awsUserName
string

Server-generated slug ({name}-{workspace}). Used as clientName for outbound uploads.

​
awsPublicKey
string
​
ipWhitelist
string[]
​
sftpServerDataId
string
​
emailInbox
object

Resolved inbox config for an EMAIL connection. Returned on Connection.emailInbox, present only when type = EMAIL.