PATCH
/
v2
/
teams
/
{teamId}
import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.teams.patchTeam({
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      description: "Our mission is to make cloud computing accessible to everyone",
      emailDomain: "example.com",
      name: "My Team",
      previewDeploymentSuffix: "example.dev",
      regenerateInviteCode: true,
      saml: {
        enforced: true,
      },
      slug: "my-team",
      enablePreviewFeedback: "on",
      enableProductionFeedback: "on",
      sensitiveEnvironmentVariablePolicy: "on",
      remoteCaching: {
        enabled: true,
      },
      hideIpAddresses: false,
      hideIpAddressesInLogDrains: false,
    },
  });

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

run();
{}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
teamId
string
required

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

Query Parameters

​
slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Body

application/json
​
avatar
string

The hash value of an uploaded image.

​
description
string

A short text that describes the team.

Maximum length: 140
Example:

"Our mission is to make cloud computing accessible to everyone"

​
emailDomain
string | null
Example:

"example.com"

​
name
string

The name of the team.

Maximum length: 256
Example:

"My Team"

​
previewDeploymentSuffix
string | null

Suffix that will be used for all preview deployments.

Example:

"example.dev"

​
regenerateInviteCode
boolean

Create a new invite code and replace the current one.

Example:

true

​
saml
object
​
slug
string

A new slug for the team.

Example:

"my-team"

​
enablePreviewFeedback
string

Enable preview toolbar: one of on, off or default.

Example:

"on"

​
enableProductionFeedback
string

Enable production toolbar: one of on, off or default.

Example:

"on"

​
sensitiveEnvironmentVariablePolicy
string

Sensitive environment variable policy: one of on, off or default.

Example:

"on"

​
remoteCaching
object

Whether or not remote caching is enabled for the team

​
hideIpAddresses
boolean

Display or hide IP addresses in Monitoring queries.

Example:

false

​
hideIpAddressesInLogDrains
boolean

Display or hide IP addresses in Log Drains.

Example:

false

Response

200
application/json

Data representing a Team.