Patch

patch

https://api.formant.io/v1/admin/commands/{id}

Update an existing command instance. Resource: commands Authorized roles: operator

Path Params

string

required

Body Params

PartialCommand

organizationId

uuid

ID of the organization in which you want to create this new command instance.

deviceId

uuid

ID of the device on which this command should run.

userId

uuid | null

ID of the user who issued this command.

commandTemplateId

uuid | null

eventTriggerId

uuid

Used by Formant agent only, ignore.

command

string

Function, script, or routine to execute.

parameter

object

deliveredAt

date-time | null

Used by Formant agent only, ignore.

canceledAt

date-time | null

Used by Formant agent only, ignore.

respondedAt

date-time | null

Used by Formant agent only, ignore.

success

boolean | null

Used by Formant agent only, ignore.

streamName

string | null

Used by Formant agent only, ignore.

streamType

string | null

enum

Used by Formant agent only, ignore.

200