Skip to main content
PATCH
/
v1
/
bulk-redirects
editRedirect
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.bulkRedirects.editRedirect({
    projectId: "<id>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();
{
  "alias": "<string>",
  "version": {
    "id": "<string>",
    "key": "<string>",
    "lastModified": 123,
    "createdBy": "<string>",
    "name": "<string>",
    "isStaging": true,
    "isLive": true,
    "redirectCount": 123,
    "alias": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Default authentication mechanism

Query Parameters

projectId
string
required
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Body

application/json
redirect
object
required

The redirect object to edit. The source field is used to match the redirect to modify.

name
string
Maximum string length: 256
restore
boolean

If true, restores the redirect from the latest production version to staging.

Response

alias
string | null
required
version
object
required