PATCH /v2/teams/{teamId}

Update the information of a Team specified by the teamId parameter. The request body should contain the information that will be updated on the Team.

Servers

https://api.vercel.com

Path parameters

Name	Type	Required	Description
`teamId`	String	Yes	The Team identifier to perform the request on behalf of.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Query parameters

Name	Type	Required	Description
`slug`	String	No	The Team slug to perform the request on behalf of.

Request body fields

Name	Type	Required	Description
`strictShareableLinks`	Object	No	When enabled, creating shareable links requires Owner role.
`strictShareableLinks.enabled`	Boolean	Yes	Enable or disable requiring Owner role to create shareable links.
`description`	String	No	A short text that describes the team.
`hideIpAddresses`	Boolean	No	Display or hide IP addresses in Monitoring queries.
`nsnbConfig`		No
`regenerateInviteCode`	Boolean	No	Create a new invite code and replace the current one.
`defaultProjectJobs`		No
`strictDeploymentProtectionSettings`	Object	No	When enabled, deployment protection settings require stricter permissions (owner-only).
`strictDeploymentProtectionSettings.enabled`	Boolean	Yes	Enable or disable strict deployment protection settings.
`defaultDeploymentProtection`	Object	No	Default deployment protection settings for new projects.
`defaultDeploymentProtection.ssoProtection`	Object	No	Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team
`defaultDeploymentProtection.ssoProtection.deploymentType`	String	Yes	Specify if the Vercel Authentication (SSO Protection) will apply to every Deployment Target or just Preview Valid values: `"preview"` `"prod_deployment_urls_and_all_previews"` `"all_except_custom_domains"` `"all"` Default value: "preview"
`defaultDeploymentProtection.passwordProtection`	Object	No	Allows to protect project deployments with a password
`defaultDeploymentProtection.passwordProtection.deploymentType`	String	Yes	Specify if the password will apply to every Deployment Target or just Preview Valid values: `"preview"` `"prod_deployment_urls_and_all_previews"` `"all_except_custom_domains"` `"all"`
`defaultDeploymentProtection.passwordProtection.password`	String	No	The password that will be used to protect Project Deployments
`slug`	String	No	A new slug for the team.
`saml`	Object	No
`saml.enforced`	Boolean	No	Require that members of the team use SAML Single Sign-On.
`saml.roles`	Object	No	Directory groups to role or access group mappings.
`dpAccessRequestsMode`	String	No	Controls who can request access to protected deployments. Valid values: `"email-domain"` `"none"` `"all"`
`previewDeploymentSuffix`	String	No	Suffix that will be used for all preview deployments.
`resourceConfig`	Object	No	Resource configuration for the team.
`resourceConfig.buildMachine`	Object	No	Build machine configuration.
`resourceConfig.buildMachine.default`	String	No	Default build machine type for new builds: standard, enhanced, turbo, or elastic. Valid values: `"elastic"` `"standard"` `"enhanced"` `"turbo"`
`remoteCaching`	Object	No	Whether or not remote caching is enabled for the team
`remoteCaching.enabled`	Boolean	No	Enable or disable remote caching for the team.
`hideIpAddressesInLogDrains`	Boolean	No	Display or hide IP addresses in Log Drains.
`defaultExpirationSettings`	Object	No
`defaultExpirationSettings.expiration`	String	No	The time period to keep non-production deployments for Valid values: `"unlimited"` `"1m"` `"2m"` `"3m"` `"1y"` `"2y"` `"6m"` `"3y"` `"1w"` `"2w"` `"1d"`
`defaultExpirationSettings.expirationProduction`	String	No	The time period to keep production deployments for Valid values: `"unlimited"` `"1m"` `"2m"` `"3m"` `"1y"` `"2y"` `"6m"` `"3y"` `"1w"` `"2w"` `"1d"`
`defaultExpirationSettings.expirationCanceled`	String	No	The time period to keep canceled deployments for Valid values: `"unlimited"` `"1m"` `"2m"` `"3m"` `"1y"` `"6m"` `"1w"` `"2w"` `"1d"`
`defaultExpirationSettings.expirationErrored`	String	No	The time period to keep errored deployments for Valid values: `"unlimited"` `"1m"` `"2m"` `"3m"` `"1y"` `"6m"` `"1w"` `"2w"` `"1d"`
`deploymentPolicy`		No
`sensitiveEnvironmentVariablePolicy`	String	No	Sensitive environment variable policy: one of on, off or default.
`enableProductionFeedback`	String	No	Enable production toolbar: one of on, off or default.
`enablePreviewFeedback`	String	No	Enable preview toolbar: one of on, off or default.
`name`	String	No	The name of the team.
`defaultPassport`	Object	No	Default Passport configuration for new projects.
`defaultPassport.connectorId`	String	Yes
`defaultPassport.deploymentType`	String	No	Valid values: `"preview"` `"prod_deployment_urls_and_all_previews"` `"all_except_custom_domains"` `"all"` Default value: "all"
`emailDomain`	String	No
`avatar`	String	No	The hash value of an uploaded image.
`disableRepositoryDispatchEvents`	Boolean	No	Default for projects in the team. When `true`, projects in this team will not emit GitHub repository-dispatch events on deployment events unless the project explicitly overrides this setting.
`requireVerifiedCommits`	Boolean	No	When enabled, all projects in the team require commits to be signed and verified by the git provider before deployments will be created.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.