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 |
|---|---|---|---|
previewDeploymentSuffix |
String | No |
Suffix that will be used for all preview deployments. |
description |
String | No |
A short text that describes the team. |
hideIpAddresses |
Boolean | No |
Display or hide IP addresses in Monitoring queries. |
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. |
regenerateInviteCode |
Boolean | No |
Create a new invite code and replace the current one. |
hideIpAddressesInLogDrains |
Boolean | No |
Display or hide IP addresses in Log Drains. |
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. |
slug |
String | No |
A new slug for the team. |
emailDomain |
String | No | |
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. |
avatar |
String | No |
The hash value of an uploaded image. |
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.