Skip to content
Docs

Update a microfrontends group

PATCHhttps://api.vercel.com/v1/teams/{teamId}/microfrontends/{groupId}
Updates a microfrontends group's settings.
Request
import { Vercel } from "@vercel/sdk";


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


async function run() {
  const result = await vercel.teams.updateMicrofrontendsGroup({
    groupId: "<id>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      name: "MFE Group 1",
    },
  });


  console.log(result);
}


run();
Response
{
  "updatedMicrofrontendsGroup": {
    "enablePolyrepoBranchRouting": "false",
    "fallbackEnvironment": "string",
    "id": "icfg_1234567890",
    "name": "Example Name",
    "slug": "string"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

groupIdstringRequired
teamIdstringRequired
The Team identifier to perform the request on behalf of.

Query parameters

slugstringOptional
The Team slug to perform the request on behalf of.

Body

application/json
namestringOptional
The new name for the existing microfrontends group.
fallbackEnvironmentstringOptional
The new fallback environment for the microfrontends group. Must be "SAME_ENV", "PRODUCTION", or a valid custom environment slug from the default app.
enablePolyrepoBranchRoutingbooleanOptional
Whether Preview Deployments can link to branches with the same name in other Git repositories.

Response

200Success
updatedMicrofrontendsGroupobjectRequired

Errors

400One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
410Error