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)

POSTyourpodURL.symphony.com/pod/v1/admin/system/protocols

Header parameters

Body

application/json

the protocol to add

scheme*string

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

Example: "skype"

Response

200400401403500

Success

Body

application/json

scheme*string

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

Example: "skype"

Request

JavaScriptCurlPython

const response = await fetch('yourpodURL.symphony.com/pod/v1/admin/system/protocols', {
    method: 'POST',
    headers: {
      "sessionToken": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "scheme": "skype"
    }),
});
const data = await response.json();

Response

200400401403500

{
  "scheme": "skype"
}

📘 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.