PATCH
/
v9
/
projects
/
{idOrName}
/
custom-environments
/
{environmentSlugOrId}
import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.environment.updateCustomEnvironment({
    idOrName: "<value>",
    environmentSlugOrId: "<id>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  // Handle the result
  console.log(result);
}

run();
{}

Authorizations

Authorization
string
header
required

Default authentication mechanism

Path Parameters

idOrName
string
required

The unique project identifier or the project name

environmentSlugOrId
string
required

The unique custom environment identifier within the project

Query Parameters

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
slug
string

The slug of the custom environment.

Maximum length: 32
description
string

Description of the custom environment. This is optional.

Maximum length: 256
branchMatcher
object | null

How we want to determine a matching branch. This is optional.

Response

200
application/json

The response is of type object.