Patch

patch

https://api.formant.io/v1/admin/command-templates/{id}

Update an existing command template. Resource: commands Authorized roles: administrator

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

PartialCommandTemplate

organizationId

uuid

ID for the organization in which you want to create this new command template.

name

string

length ≤ 32

Name of this command template.

command

string

Function, script, or routine that will be executed by a command in this template.

description

string

length ≤ 1024

Description of this command template.

parameterEnabled

boolean

If you want to send parameters with your command, set this to true.

allowParameterOverride

boolean

parameterValue

string

length ≤ 1024

This string will be passed as a parameter when this command is sent.

parameterMeta

object

You can use this to add many parameters in a more structured way.

deviceScope

object | null

Currently unused, ignore.

enabled

boolean

If set to false, this command template will be deleted.

deviceFilter

object | null

lambdaUri

string | null

deliverySettings

object

schema

json | null

uuid

createdAt

date-time

updatedAt

date-time

200