# update_folder_slug

Source: https://modulify.ai/docs/api/folders/update-folder-slug

Changes the slug of one folder, the part of the dashboard URL that identifies it.

- Title: Change a folder web address
- Scope: `sites:write`
- Access: Makes changes
- Endpoint: `POST /v1/update_folder_slug`

Any link someone saved to the old slug stops working immediately. A slug another folder in the workspace already holds is refused with `This folder URL already exists in this workspace!`, so check it with `check_folder_slug_available` first.

Unlike renaming, this does not need the **Edit folders** permission. See [Folders](https://modulify.ai/docs/projects/folders#rename-a-folder-or-change-its-url).

## Request

Call it with a `POST` to `https://api.modulify.ai/v1/update_folder_slug`, sending the inputs below as a JSON object. The token needs the `sites:write` scope.

It makes changes, so send an [Idempotency-Key](https://modulify.ai/docs/api/idempotency) header whenever you might retry it. A retry with the same key gets the first answer back instead of running again.

```bash
curl -X POST https://api.modulify.ai/v1/update_folder_slug \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"folderId":"FOLDER_ID","slug":"SLUG"}'
```

Over MCP, the same method is the [update_folder_slug tool](https://modulify.ai/docs/mcp/folders/update-folder-slug).

## Inputs

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `folderId` | string | Yes | The folder id, from `list_folders`. |
| `slug` | string | Yes | The new slug, 3 to 32 characters of letters, numbers and hyphens. It is lowercased before it is saved. |

## Response

Every call answers with the [JSON envelope](https://modulify.ai/docs/api/requests-and-responses#the-response) of `success`, `message`, `data`, `code` and `version`. `data` holds the result described above, and on a method that returns a total, `count` carries it. The [response headers](https://modulify.ai/docs/api/requests-and-responses#headers-on-every-method-call) carry the call's `X-Request-Id` and what is left of your per-minute budget in `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`. [Errors](https://modulify.ai/docs/api/errors) explains every status code a call can answer with.