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

Endpoint

GET/partner_channel_templates

Return Object

PartnerChannelTemplate[]

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

curl https://app.files.com/api/rest/v1/partner_channel_templates.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

[
  {
    "id": 1,
    "workspace_id": 1,
    "direction": "two_way",
    "use_channel_root": false,
    "name": "Claims Template",
    "path": "claims/medical",
    "to_partner_folder_name": "outgoing",
    "from_partner_folder_name": "incoming",
    "from_partner_route_path_pattern": "processing/{{partner_name}}/from-partner",
    "to_partner_route_path_pattern": "delivery/{{partner_name}}/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"
  }
]

Show Partner Channel Template

Endpoint

GET/partner_channel_templates/{id}

Return Object

PartnerChannelTemplate

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.

Request Parameters

Parameter	Description
id int64 Required	Partner Channel Template ID.

Example Request

curl https://app.files.com/api/rest/v1/partner_channel_templates/{id}.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "id": 1,
  "workspace_id": 1,
  "direction": "two_way",
  "use_channel_root": false,
  "name": "Claims Template",
  "path": "claims/medical",
  "to_partner_folder_name": "outgoing",
  "from_partner_folder_name": "incoming",
  "from_partner_route_path_pattern": "processing/{{partner_name}}/from-partner",
  "to_partner_route_path_pattern": "delivery/{{partner_name}}/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"
}

Create Partner Channel Template

Endpoint

POST/partner_channel_templates

Return Object

PartnerChannelTemplate

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.

Request Parameters

Parameter	Default	Description
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	`false`	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 Required		The name of the Partner Channel Template.
path string Required		Channel path relative to the Partner root folder.
workspace_id int64	`0`	ID of the Workspace associated with this Partner Channel Template.

Example Request

curl https://app.files.com/api/rest/v1/partner_channel_templates.json \
  -X POST \
  -H 'Content-Type: application/json' \
  -d '{"direction":"two_way","use_channel_root":false,"from_partner_folder_name":"incoming","from_partner_managed_folder_paths":["claims/received"],"from_partner_route_path_pattern":"processing/{{partner_name}}/from-partner","to_partner_folder_name":"outgoing","to_partner_managed_folder_paths":["reports/monthly"],"to_partner_route_path_pattern":"delivery/{{partner_name}}/to-partner","name":"Claims Template","path":"claims/medical","workspace_id":0}' \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "id": 1,
  "workspace_id": 1,
  "direction": "two_way",
  "use_channel_root": false,
  "name": "Claims Template",
  "path": "claims/medical",
  "to_partner_folder_name": "outgoing",
  "from_partner_folder_name": "incoming",
  "from_partner_route_path_pattern": "processing/{{partner_name}}/from-partner",
  "to_partner_route_path_pattern": "delivery/{{partner_name}}/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"
}

Update Partner Channel Template

Endpoint

PATCH/partner_channel_templates/{id}

Return Object

PartnerChannelTemplate

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.

Request Parameters

Parameter	Description
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

curl https://app.files.com/api/rest/v1/partner_channel_templates/{id}.json \
  -X PATCH \
  -H 'Content-Type: application/json' \
  -d '{"direction":"two_way","use_channel_root":false,"from_partner_folder_name":"incoming","from_partner_managed_folder_paths":["claims/received"],"from_partner_route_path_pattern":"processing/{{partner_name}}/from-partner","to_partner_folder_name":"outgoing","to_partner_managed_folder_paths":["reports/monthly"],"to_partner_route_path_pattern":"delivery/{{partner_name}}/to-partner","name":"Claims Template","path":"claims/medical"}' \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "id": 1,
  "workspace_id": 1,
  "direction": "two_way",
  "use_channel_root": false,
  "name": "Claims Template",
  "path": "claims/medical",
  "to_partner_folder_name": "outgoing",
  "from_partner_folder_name": "incoming",
  "from_partner_route_path_pattern": "processing/{{partner_name}}/from-partner",
  "to_partner_route_path_pattern": "delivery/{{partner_name}}/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"
}

Delete Partner Channel Template

Endpoint

DELETE/partner_channel_templates/{id}

Return Object

No return value.

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.

Request Parameters

Parameter	Description
id int64 Required	Partner Channel Template ID.

Example Request

curl https://app.files.com/api/rest/v1/partner_channel_templates/{id}.json \
  -X DELETE \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

The PartnerChannelTemplate Object

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

Attribute	Description
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.

Example PartnerChannelTemplate Object

{
  "id": 1,
  "workspace_id": 1,
  "direction": "two_way",
  "use_channel_root": false,
  "name": "Claims Template",
  "path": "claims/medical",
  "to_partner_folder_name": "outgoing",
  "from_partner_folder_name": "incoming",
  "from_partner_route_path_pattern": "processing/{{partner_name}}/from-partner",
  "to_partner_route_path_pattern": "delivery/{{partner_name}}/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"
}

Partner Channel Templates

List Partner Channel Templates

Endpoint

Return Object

Authorization Requirement

Additional Arguments

Pagination

Sorting

Filtering

Show Partner Channel Template

Endpoint

Return Object

Authorization Requirement

Request Parameters

Create Partner Channel Template

Endpoint

Return Object

Authorization Requirement

Request Parameters

Update Partner Channel Template

Endpoint

Return Object

Authorization Requirement

Request Parameters

Delete Partner Channel Template

Endpoint

Return Object

Authorization Requirement

Request Parameters

The PartnerChannelTemplate Object