# Channel Option

<figure><img src="/files/mJ6oApbVnMit61eNPzXj" alt=""><figcaption></figcaption></figure>

The channel option block allows for any channel to be selected from the server and used later in the commands actions. Channel IDs may also be used.

{% hint style="warning" %}
Only the channels to which the user has access can be selected.
{% endhint %}

<figure><img src="/files/0kRsc2rIzp6yMBNu9ONN" alt=""><figcaption></figcaption></figure>

You can retrieve the variable of the option via the **Clipboard** or the block itself. The format of the variable is `{option_optionname}`, where `optionname` is the [name](#option-name) of the option.

Additionally, channel option variables can be combined with other variables to target the channel selected in the option.  `{}` brackets must be excluded from the option when used as a target, like in the example below:

<table><thead><tr><th width="376">❌ Wrong</th><th>☑️ Correct</th></tr></thead><tbody><tr><td><code>{channel_name[{option_channel}]}</code></td><td><code>{channel_name[option_channel]}</code></td></tr><tr><td><code>{BGVAR_status[{option_channel}]}</code></td><td><code>{BGVAR_status[option_channel]}</code></td></tr></tbody></table>

<figure><img src="/files/kQi5MEyfYXrD7w8Uu9dV" alt=""><figcaption></figcaption></figure>

## Option Name

This field requires an input for your unique option name. The designated name will then be the reference for your option variable.

<figure><img src="/files/yT5CbrjPv14aRGUXGCYr" alt=""><figcaption></figcaption></figure>

## Option Description&#x20;

The option description field allows you to assign a custom description to your option. It is useful to describe what the option is used for.

<figure><img src="/files/MdZq3ZmBfWbksiPVaH09" alt=""><figcaption></figcaption></figure>

## Set Required

With this switch you are able to toggle if the option should be required or not in order to execute the command.

<figure><img src="/files/ReHnWTlkq0ulv3ROrDv8" alt=""><figcaption></figcaption></figure>


---

# 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://documentation.botghost.com/custom-commands-and-events/options/channel-option.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.