FIfiles
partner_channels
Partner Channels

Create Partner Channel

Changed on

Create Partner Channel

post/partner_channels

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/partner_channels
  • Auth
    none declared

Request body multipart/form-data

direction'two_way' | 'to_partner' | 'from_partner'

Channel directions. two_way enables both directions, to_partner enables outgoing downloads, and from_partner enables incoming uploads.

use_channel_rootboolean

Use the Channel folder directly for a one-way exchange. Defaults to false. Cannot be changed after creation. Folder name overrides must be blank when enabled, and the Channel must remain one-way.

from_partner_folder_namestring

Optional Channel-level from-Partner folder name override.

from_partner_managed_folder_pathsstring[]

Managed folder paths inside the from-Partner folder.

from_partner_route_pathstring

Optional route path for files uploaded by the Partner.

to_partner_folder_namestring

Optional Channel-level to-Partner folder name override.

to_partner_managed_folder_pathsstring[]

Managed folder paths inside the to-Partner folder.

to_partner_route_pathstring

Optional route path for files delivered to the Partner.

partner_idinteger required

ID of the Partner this Channel belongs to.

pathstring required

Channel path relative to the Partner root folder.

workspace_idinteger

ID of the Workspace associated with this Partner Channel.

Example request

{
  "direction": "two_way",
  "from_partner_folder_name": "incoming",
  "from_partner_managed_folder_paths": [
    "claims/received"
  ],
  "from_partner_route_path": "processing/from-partner",
  "to_partner_folder_name": "outgoing",
  "to_partner_managed_folder_paths": [
    "reports/monthly"
  ],
  "to_partner_route_path": "delivery/to-partner",
  "partner_id": 1,
  "path": "claims/medical"
}

Response

The PartnerChannels object.

idinteger

The unique ID of the Partner Channel.

workspace_idinteger

ID of the Workspace associated with this Partner Channel.

direction'two_way' | 'to_partner' | 'from_partner'

Channel directions. two_way enables both directions, to_partner enables outgoing downloads, and from_partner enables incoming uploads.

use_channel_rootboolean

Use the Channel folder directly for a one-way exchange. Defaults to false. Cannot be changed after creation. Folder name overrides must be blank when enabled, and the Channel must remain one-way.

partner_idinteger

ID of the Partner this Channel belongs to.

partner_channel_template_idinteger

ID of the Partner Channel Template that manages this Channel, if any.

pathstring

Channel path relative to the Partner root folder.

to_partner_folder_namestring

Optional Channel-level to-Partner folder name override.

from_partner_folder_namestring

Optional Channel-level from-Partner folder name override.

from_partner_route_pathstring

Optional route path for files uploaded by the Partner.

to_partner_route_pathstring

Optional route path for files delivered to the Partner.

to_partner_managed_folder_pathsstring[]

Managed folder paths inside the to-Partner folder.

from_partner_managed_folder_pathsstring[]

Managed folder paths inside the from-Partner folder.

effective_to_partner_folder_namestring

Resolved to-Partner subfolder name. Null when the direction is disabled or uses the Channel folder directly.

effective_from_partner_folder_namestring

Resolved from-Partner subfolder name. Null when the direction is disabled or uses the Channel folder directly.

channel_pathstring

Resolved Channel folder path.

to_partner_folder_pathstring

Resolved to-Partner folder path.

from_partner_folder_pathstring

Resolved from-Partner folder path.

Example response

{
  "id": 1,
  "direction": "two_way",
  "partner_id": 1,
  "partner_channel_template_id": 1,
  "path": "claims/medical",
  "to_partner_folder_name": "outgoing",
  "from_partner_folder_name": "incoming",
  "from_partner_route_path": "processing/from-partner",
  "to_partner_route_path": "delivery/to-partner",
  "to_partner_managed_folder_paths": [
    "reports/monthly"
  ],
  "from_partner_managed_folder_paths": [
    "claims/received"
  ],
  "effective_to_partner_folder_name": "outgoing",
  "effective_from_partner_folder_name": "incoming",
  "channel_path": "partners/acme/claims/medical",
  "to_partner_folder_path": "partners/acme/claims/medical/outgoing",
  "from_partner_folder_path": "partners/acme/claims/medical/incoming"
}

Changes