# Upsert FTP Data Source

Upsert FTP Data Source

Endpoint: PATCH /rest/2.0/FTP_DATA_SOURCE
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

## Request fields (application/json; charset=utf-8):

  - `brmObjects` (object)

  - `brmObjects.HostName` (string, required)
    Host Name

  - `brmObjects.RemoteDirectory` (string)
    Remote Directory

  - `brmObjects.AuthenticationMethod` (string, required)
    Authentication Method: Choose how you wish to authenticate to the FTP server:Username/Password: Supply a Username and Password of a user from your FTP system who has the necessary permission to access the directory you specifyPublic/Private Key: BillingPlatform will generate a key pair, and you will need to copy the Public Key into your FTP system, associated with a user who has the necessary permission to access the directory you specify

  - `brmObjects.Transport` (string, required)
    Transport

  - `brmObjects.Created` (string)
    System controlled field: Date and time the record was created

  - `brmObjects.Id` (string, required)
    ID

  - `brmObjects.Port` (string, required)
    Port

  - `brmObjects.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `brmObjects.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `brmObjects.FtpDataSourceName` (string, required)
    FTP Data Source Name

  - `brmObjects.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `externalIDFieldName` (string)
    Enum: "FtpDataSourceName"

## Response 200 fields (application/json):

  - `upsertResponse` (array)

  - `upsertResponse.Id` (integer)

  - `upsertResponse.success` (boolean)

  - `upsertResponse.ErrorText` (string)

  - `upsertResponse.ErrorElementField` (string)

  - `upsertResponse.created` (boolean)