---
title: edit-a-project-level-redirect
product: vercel
url: /docs/rest-api/bulk-redirects/edit-a-project-level-redirect
canonical_url: "https://vercel.com/docs/rest-api/bulk-redirects/edit-a-project-level-redirect"
last_updated: 2026-09-15
type: reference
prerequisites:
  []
related:
  - /docs/rest-api
summary: Learn about edit-a-project-level-redirect on Vercel.
install_vercel_plugin: npx plugins add vercel/vercel-plugin
---

# Edit a project-level redirect.

```http
PATCH /v1/bulk-redirects
```

Edits a single redirect identified by its source path. Stages a new change with the modified redirect and returns the alias for the new version in the response.

## Authentication

**bearerToken**: HTTP bearer

## Query parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `projectId` | string | Yes |  |
| `teamId` | string | No | The Team identifier to perform the request on behalf of. |
| `slug` | string | No | The Team slug to perform the request on behalf of. |


## Request body

Required: No

Content-Type: `application/json`

```json
{
  "type": "object",
  "required": [
    "redirect"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 256
    },
    "redirect": {
      "type": "object",
      "description": "The redirect object to edit. The source field is used to match the redirect to modify.",
      "required": [
        "source"
      ],
      "properties": {
        "source": {
          "type": "string"
        },
        "destination": {
          "type": "string"
        },
        "statusCode": {
          "type": "number"
        },
        "permanent": {
          "type": "boolean"
        },
        "caseSensitive": {
          "type": "boolean"
        },
        "query": {
          "type": "boolean"
        },
        "preserveQueryParams": {
          "type": "boolean"
        }
      }
    },
    "restore": {
      "type": "boolean",
      "description": "If true, restores the redirect from the latest production version to staging."
    }
  }
}
```

## Example request

### TypeScript

```typescript
const response = await fetch('https://api.vercel.com/v1/bulk-redirects?projectId=string&teamId=string&slug=string', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Example Name",
    "redirect": {
      "source": "string",
      "destination": "string",
      "statusCode": "123",
      "permanent": "true",
      "caseSensitive": "true",
      "query": "true",
      "preserveQueryParams": "true"
    },
    "restore": "true"
  }),
});

const data = await response.json();
console.log(data);
```

### Next.js

```typescript
'use server';

export async function callEndpoint() {
  const response = await fetch('https://api.vercel.com/v1/bulk-redirects?projectId=string&teamId=string&slug=string', {
    method: 'PATCH',
    headers: {
      'Authorization': `Bearer ${process.env.VERCEL_ACCESS_TOKEN}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      "name": "Example Name",
      "redirect": {
        "source": "string",
        "destination": "string",
        "statusCode": "123",
        "permanent": "true",
        "caseSensitive": "true",
        "query": "true",
        "preserveQueryParams": "true"
      },
      "restore": "true"
    }),
    next: { revalidate: 3600 }
  });

  if (!response.ok) {
    throw new Error('Request failed');
  }

  return response.json();
}
```

### cURL

```bash
curl -X PATCH 'https://api.vercel.com/v1/bulk-redirects?projectId=string&teamId=string&slug=string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d "{
    \"name\": \"Example Name\",
    \"redirect\": {
      \"source\": \"string\",
      \"destination\": \"string\",
      \"statusCode\": \"123\",
      \"permanent\": \"true\",
      \"caseSensitive\": \"true\",
      \"query\": \"true\",
      \"preserveQueryParams\": \"true\"
    },
    \"restore\": \"true\"
  }"
```

## Example response

```json
{
  "alias": "string",
  "version": {
    "id": "icfg_1234567890",
    "key": "string",
    "lastModified": "123",
    "createdBy": "string",
    "name": "Example Name",
    "isStaging": "false",
    "isLive": "false",
    "redirectCount": "123",
    "alias": "string"
  }
}
```

## Responses

### 200: No description

Content-Type: `application/json`

```json
{
  "type": "object",
  "required": [
    "alias",
    "version"
  ],
  "properties": {
    "alias": {
      "type": "string",
      "nullable": true
    },
    "version": {
      "type": "object",
      "required": [
        "createdBy",
        "id",
        "key",
        "lastModified"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique identifier for the version."
        },
        "key": {
          "type": "string",
          "description": "The key of the version. The key may be duplicated across versions if the contents are the same as a different version."
        },
        "lastModified": {
          "type": "number"
        },
        "createdBy": {
          "type": "string"
        },
        "name": {
          "type": "string",
          "description": "Optional name for the version. If not provided, defaults to an ISO timestamp string."
        },
        "isStaging": {
          "type": "boolean",
          "description": "Whether this version has not been promoted to production yet and is not serving end users.",
          "enum": [
            false,
            true
          ]
        },
        "isLive": {
          "type": "boolean",
          "description": "Whether this version is currently live in production.",
          "enum": [
            false,
            true
          ]
        },
        "redirectCount": {
          "type": "number",
          "description": "The number of redirects in this version."
        },
        "alias": {
          "type": "string",
          "description": "The staging link for previewing redirects in this version."
        }
      }
    }
  }
}
```

### 400: One of the provided values in the request body is invalid.
One of the provided values in the request query is invalid.

### 401: The request is not authorized.

### 403: You do not have permission to access this resource.

### 404: No description

### 410: No description

### 500: No description

---

## Related

- [bulk-redirects endpoints](/docs/rest-api#bulk-redirects)

- [REST API overview](/docs/rest-api)

- [OpenAPI spec](https://openapi.vercel.sh/) (machine-readable, all endpoints)

---

[View full sitemap](/docs/sitemap)