patchteamrequestbody.md

PatchTeamRequestBody

Example Usage

import { PatchTeamRequestBody } from "@vercel/sdk/models/patchteamop.js";

let value: PatchTeamRequestBody = {
  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,
};

Fields

Field	Type	Required	Description	Example
avatar	string	➖	The hash value of an uploaded image.
description	string	➖	A short text that describes the team.	Our mission is to make cloud computing accessible to everyone
emailDomain	string	➖	N/A	example.com
name	string	➖	The name of the team.	My Team
previewDeploymentSuffix	string	➖	Suffix that will be used for all preview deployments.	example.dev
regenerateInviteCode	boolean	➖	Create a new invite code and replace the current one.	true
saml	models.PatchTeamSaml	➖	N/A
slug	string	➖	A new slug for the team.	my-team
enablePreviewFeedback	string	➖	Enable preview toolbar: one of on, off or default.	on
enableProductionFeedback	string	➖	Enable production toolbar: one of on, off or default.	on
sensitiveEnvironmentVariablePolicy	string	➖	Sensitive environment variable policy: one of on, off or default.	on
remoteCaching	models.PatchTeamRemoteCaching	➖	Whether or not remote caching is enabled for the team
hideIpAddresses	boolean	➖	Display or hide IP addresses in Monitoring queries.	false
hideIpAddressesInLogDrains	boolean	➖	Display or hide IP addresses in Log Drains.	false