Login
    Contents x
    Get Command's Preview Data
      • Print
      • Dark
        Light
      • PDF
      Contents

      Get Command's Preview Data

        • Print
        • Dark
          Light
        • PDF
        Article summary

        Get
        /api/v1/commands.preview

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

        Header parameters
        X-Auth-Token
        stringRequired

        The authToken of the authenticated user.

        ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
        X-User-Id
        stringRequired

        The userId of the authenticated user.

        ExamplerbAXPnMktTFbNpwtJ
        Query parameters
        command
        stringRequired

        The name of the command to be executed.

        Exampleunmute
        roomId
        stringRequired

        The ID of the room.

        ExampleByehQjC44FwMeiLbX
        params
        string

        Parameters of the command if required. It is undefined by default.

        Example@user123
        Responses
        200

        OK

        object
        Was this article helpful?
        What's Next
        Rocket.Chat versions receive support for six months after release.
        Change password!
        Changing your password will log you out immediately. Use the new password to log back in.
        Change profile
        Success!
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.
        Logout