# pause-role

This command allows you to pause a role for a user for a specified duration. This means that the role is removed from the user for the specified duration. After the duration has passed, the role will be automatically reassigned to the user.

## Required permissions

MoonlightBot requires the following permissions to successfully execute this command:

* Manage Roles

By default, a user is required to have the following permissions to use this command:

* Manage Roles

For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](/docs/get-started/permission-tutorial.md)

## Syntax

```
/pause-role <user> <role> <duration> [reason] [notify]
```

### Options

* `user`: The user to pause the role for
* `role`: The role to pause for the user
* `duration`: The duration for which the role should be paused for the user. For more information on the duration format, refer to the [options page](/docs/get-started/options.md#durations)
* `reason`: The reason for pausing the role for the user. This is an optional parameter, which can be used for record-keeping
* `notify`: Sends a Direct Message to inform the user about the role pause. This is optional and contains the role name, duration, expiration date and reason

## Logs

* `PAUSE_ROLE_EXTEND`: This log is triggered when a role pause's duration is extended/reduced. It will log the user, the role, the responsible moderator, the reason and the duration of the extension/reduction
* `PAUSE_ROLE_ADD`: This log is triggered when a role is paused for a user. It will log the user, the role, the responsible moderator, the reason and the duration of the role pause

For more information on setting up those logs, refer to the [log setup tutorial](/docs/readme.md#logging)


---

# 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://moonlightbot.gitbook.io/docs/role-management-commands/pause-role.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.