Scriptlets

Install scriptlet

Install scriptlet on a player. Only compatible with KDA player models. Please contact your sales representative for more information.

PUT

/api/v1/scriptlet

Install scriptlet

curl --request PUT \
  --url 'https://voyager.korbyt.com/api/v1/scriptlet?id=1&name=sample_scriplet&parameters=%3Cstring%3E&playerid=1&playername=sample_player' \
  --header 'Authorization: Bearer <token>'

Authorizations

Authorizationstringheaderrequired

Access token from POST /api/v1/auth/login

Query Parameters

idintegerquery

Conditionally required. Scriptlet id. If 'name' is provided, id is optional

Example: 1

namestringquery

Conditionally required. Scriplet name. If id is provided, name is optional

Example: sample_scriplet

parametersstringquery

Parameter overrides

playeridintegerquery

Conditionally required. Id of the player to apply the scriptlet to

Example: 1

playernamestringquery

Conditionally required. name of the player to apply the scriptlet to

Example: sample_player

Response

Success. Response body is not documented in the source collection.

Still need help? Share an idea