> 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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.mixeffect.app/automate/shortcuts/actions/record-macro.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.