Partner Channel Templates

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

List Partner Channel Templates

Endpoint

GET/partner_channel_templates

Return Object

PartnerChannelTemplate[]

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

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",
    "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 either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

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",
  "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 either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

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`
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","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",
  "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 either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

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`
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","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",
  "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 either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

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`
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 folder name after Template override and default.
effective_from_partner_folder_name string	Resolved from-Partner folder name after Template override and default.

Example PartnerChannelTemplate Object

{
  "id": 1,
  "workspace_id": 1,
  "direction": "two_way",
  "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