> For the complete documentation index, see [llms.txt](https://docs.mixeffect.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mixeffect.app/automate/shortcuts/actions/record-macro.md).

# Record Macro

### Parameters

* **Index**: One-based index for the macro (1-100).
* **Name**: An optional name for the macro.
* **Notes**: The description for the macro.
* **Color**: A hex color value for the macro.
* **Label**: A short text label for the macro when displayed in Grid mode.
* **Icon**: A string referencing an [SF Symbol](https://developer.apple.com/sf-symbols/) to be used as the icon for the macro.
* **Icon Color**: A hex color value for the icon.
* **Text Color**: A hex color value for the macro's text color.
* **Replace Existing**: Toggle if you want to replace an existing macro at the given index. If false, an error will appear if you try to replace an existing macro.

### **Returns**

Macro object.