Get command's preview data

Fetches the command's preview data or executes the preview item

URLRequires AuthHTTP Method

/api/v1/commands.preview

yes

GET

Payload

ArgumentExampleRequiredDescription

command

unmute

Required

The name of the command to be executed.

roomId

ByehQjC44FwMeiLbX

Required

The ID of the room.

params

@user123

Optional Default: undefined

Parameters of the command if required.

Last updated

Rocket.Chat versions receive support for six months after release.