Partner Channel Templates

A PartnerChannelTemplate defines reusable Partner Channel configuration that can be applied to Partners.

Route path patterns can be fixed paths shared by all assigned Partners, or include {{partner_name}} to expand to a single folder name. Slashes in Partner names become pipes (|). Leading and trailing whitespace, percent signs, and null bytes are percent-encoded. Names consisting of . or .. become %2E or %2E%2E. For example, a Partner named "Acme " uses the folder "Acme%20", while "Acme%20" uses "Acme%2520". These percent sequences are literal folder-name characters, not URL encoding to decode. The expanded route must point to an existing folder in the same Workspace.

List Partner Channel Templates

Command

files-cli partner-channel-templates list

Output

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

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Additional Arguments

Example Request

files-cli partner-channel-templates list

Show Partner Channel Template

Command

files-cli partner-channel-templates find

Output

Outputs a PartnerChannelTemplate object according to the output format.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Flags

FlagDescription
--id=
int64
Required		Partner Channel Template ID.

Example Request

files-cli partner-channel-templates find \
  --id=1

Create Partner Channel Template

Command

files-cli partner-channel-templates create

Output

Outputs a PartnerChannelTemplate object according to the output format.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

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
--use-channel-root
boolean		falseUse 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 Template must remain one-way.
--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-pattern=
string		Optional route path pattern for files uploaded by the Partner. Supports {{partner_name}}.
--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-pattern=
string		Optional route path pattern for files delivered to the Partner. Supports {{partner_name}}.
--name=
string
Required		The name of the Partner Channel Template.
--path=
string
Required		Channel path relative to the Partner root folder.
--workspace-id=
int64		0ID of the Workspace associated with this Partner Channel Template.

Example Request

files-cli partner-channel-templates create \
  --name="Claims Template" \
  --path="claims/medical"

Update Partner Channel Template

Command

files-cli partner-channel-templates update

Output

Outputs a PartnerChannelTemplate object according to the output format.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Flags

FlagDescription
--id=
int64
Required		Partner Channel Template 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
--use-channel-root
boolean		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 Template must remain one-way.
--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-pattern=
string		Optional route path pattern for files uploaded by the Partner. Supports {{partner_name}}.
--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-pattern=
string		Optional route path pattern for files delivered to the Partner. Supports {{partner_name}}.
--name=
string		The name of the Partner Channel Template.
--path=
string		Channel path relative to the Partner root folder.

Example Request

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

Delete Partner Channel Template

Command

files-cli partner-channel-templates delete

Output

No output is returned.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Flags

FlagDescription
--id=
int64
Required		Partner Channel Template ID.

Example Request

files-cli partner-channel-templates delete \
  --id=1

The PartnerChannelTemplate Object

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

AttributeDescription
id
int64		The unique ID of the Partner Channel Template.
workspace_id
int64		ID of the Workspace associated with this Partner Channel Template.
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
use_channel_root
boolean		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 Template must remain one-way.
name
string		The name of the Partner Channel Template.
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_pattern
string		Optional route path pattern for files uploaded by the Partner. Supports {{partner_name}}.
to_partner_route_path_pattern
string		Optional route path pattern for files delivered to the Partner. Supports {{partner_name}}.
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 subfolder name. Null when the direction is disabled or uses the Channel folder directly.
effective_from_partner_folder_name
string		Resolved from-Partner subfolder name. Null when the direction is disabled or uses the Channel folder directly.