Create Protocol

Adds a URI protocol to a pod's configuration. Each pod stores a configuration to indicate which URI protocols can be transformed to a link inside a message in the UI.

Add an entry to URI protocols supported by the company (pod)

post

/v1/admin/system/protocols

Header parameters

sessionTokenstringrequired

Session authentication token.

Body

schemestringrequired

URI protocol scheme (example: http, https, ftp)

Example: skype

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'yourpodURL.symphony.com/pod/v1/admin/system/protocols' \
  --header 'sessionToken: text' \
  --header 'Content-Type: application/json' \
  --data '{"scheme":"skype"}'

200

400

401

403

500

200

{
  "scheme": "skype"
}

Success

📘 Naming

The name specified for the scheme parameter must start with a letter, must contain only letters, numbers, dashes, dots, and plus characters, and cannot be null.

❗️ Required Permissions

This endpoint may only be called by Service User accounts with the User Provisioning role.

See Bot Permissions for a list of roles and associated privileges.