# 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: 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:

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

The question should be specific, self-contained, and written in natural language.
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.