Stages new redirects for a project.

APIs & SDKs

PUThttps://api.vercel.com/v1/bulk-redirects

Stages new redirects for a project and returns the new version.

https://api.vercel.com/v1/bulk-redirects

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

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

Response

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

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Body

application/json

projectIdstringRequired

teamIdstringRequired

overwritebooleanOptional

namestringOptional

redirectsarrayOptional

Response

200Success

aliasstringRequired

versionobjectRequired

Errors

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

401The request is not authorized.

403You do not have permission to access this resource.

404Error

410Error

500Error

Cross-link map: Stages new redirects for a project. (/docs/rest-api/bulk-redirects/stages-new-redirects-for-a-project)

From the Vercel docs graph (built 2026-10-14T10:24:21.026Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

Delete project-level redirects. — DELETE /v1/bulk-redirects — Deletes the provided redirects from the latest version of the projects' bulk redirects. Stag
Edit a project-level redirect. — PATCH /v1/bulk-redirects — Edits a single redirect identified by its source path. Stages a new change with the modified
Gets project-level redirects. — GET /v1/bulk-redirects — Get the version history for a project's bulk redirects
Get the version history for a project's redirects. — GET /v1/bulk-redirects/versions — Get the version history for a project's bulk redirects
Restore staged project-level redirects to their production version. — POST /v1/bulk-redirects/restore — Restores the provided redirects in the staging version to the value in the production

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (1)

By site: vercel-docs (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v1/bulk-redirects

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

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

Response

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

OpenAPI Specification