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

Header parameters

sessionTokenstringRequired

Session authentication token.

Body

schemestringRequired

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

Example: skype

Responses

200

Success

application/json

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

500

Server error, see response body for further details.

application/json

post

HTTPcURLJavaScriptPython

POST /pod/v1/admin/system/protocols HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "scheme": "skype"
}

{
  "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.