Post

post

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

Create a new command template. Resource: commands Authorized roles: administrator

Body Params

CommandTemplate

organizationId

uuid

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

name

string

required

length ≤ 32

Name of this command template.

command

string

required

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

required

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

required

lambdaUri

string | null

deliverySettings

object

schema

json | null

uuid

createdAt

date-time

updatedAt

date-time

201