Partner Channels

A PartnerChannel defines a structured communication path within a Partner root folder, including directional folder names and partner-scoped routing configuration.

List Partner Channels

Command

files-cli partner-channels list

Output

Outputs a list of PartnerChannel objects according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

files-cli partner-channels list

Show Partner Channel

Command

files-cli partner-channels find

Output

Outputs a PartnerChannel object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required		Partner Channel ID.

Example Request

files-cli partner-channels find \
  --id=1

Create Partner Channel

Command

files-cli partner-channels create

Output

Outputs a PartnerChannel object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDefaultDescription
--direction=
string		"two_way"Channel directions. two_way enables both directions, to_partner enables outgoing downloads, and from_partner enables incoming uploads.
Possible values: two_way, to_partner, from_partner
--from-partner-folder-name=
string		Optional Channel-level from-Partner folder name override.
--from-partner-managed-folder-paths=
array(string)		Managed folder paths inside the from-Partner folder.
--from-partner-route-path=
string		Optional route path for files uploaded by the Partner.
--to-partner-folder-name=
string		Optional Channel-level to-Partner folder name override.
--to-partner-managed-folder-paths=
array(string)		Managed folder paths inside the to-Partner folder.
--to-partner-route-path=
string		Optional route path for files delivered to the Partner.
--partner-id=
int64
Required		ID of the Partner this Channel belongs to.
--path=
string
Required		Channel path relative to the Partner root folder.
--workspace-id=
int64		0ID of the Workspace associated with this Partner Channel.

Example Request

files-cli partner-channels create \
  --partner-id=1 \
  --path="claims/medical"

Update Partner Channel

Command

files-cli partner-channels update

Output

Outputs a PartnerChannel object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required		Partner Channel ID.
--direction=
string		Channel directions. two_way enables both directions, to_partner enables outgoing downloads, and from_partner enables incoming uploads.
Possible values: two_way, to_partner, from_partner
--from-partner-folder-name=
string		Optional Channel-level from-Partner folder name override.
--from-partner-managed-folder-paths=
array(string)		Managed folder paths inside the from-Partner folder.
--from-partner-route-path=
string		Optional route path for files uploaded by the Partner.
--to-partner-folder-name=
string		Optional Channel-level to-Partner folder name override.
--to-partner-managed-folder-paths=
array(string)		Managed folder paths inside the to-Partner folder.
--to-partner-route-path=
string		Optional route path for files delivered to the Partner.
--path=
string		Channel path relative to the Partner root folder.

Example Request

files-cli partner-channels update \
  --id=1 \
  --direction="two_way"

Delete Partner Channel

Command

files-cli partner-channels delete

Output

No output is returned.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required		Partner Channel ID.

Example Request

files-cli partner-channels delete \
  --id=1

The PartnerChannel Object

Some of the commands above return a PartnerChannel object. The attributes of this object are listed below.

AttributeDescription
id
int64		The unique ID of the Partner Channel.
workspace_id
int64		ID of the Workspace associated with this Partner Channel.
direction
string		Channel directions. two_way enables both directions, to_partner enables outgoing downloads, and from_partner enables incoming uploads.
Possible values: two_way, to_partner, from_partner
partner_id
int64		ID of the Partner this Channel belongs to.
partner_channel_template_id
int64		ID of the Partner Channel Template that manages this Channel, if any.
path
string		Channel path relative to the Partner root folder. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
to_partner_folder_name
string		Optional Channel-level to-Partner folder name override.
from_partner_folder_name
string		Optional Channel-level from-Partner folder name override.
from_partner_route_path
string		Optional route path for files uploaded by the Partner.
to_partner_route_path
string		Optional route path for files delivered to the Partner.
to_partner_managed_folder_paths
array(string)		Managed folder paths inside the to-Partner folder.
from_partner_managed_folder_paths
array(string)		Managed folder paths inside the from-Partner folder.
effective_to_partner_folder_name
string		Resolved to-Partner folder name after Channel override and default.
effective_from_partner_folder_name
string		Resolved from-Partner folder name after Channel override and default.
channel_path
string		Resolved Channel folder path.
to_partner_folder_path
string		Resolved to-Partner folder path.
from_partner_folder_path
string		Resolved from-Partner folder path.