Skip to content
Docs

Updates one or more shared environment variables

PATCHhttps://api.vercel.com/v1/env
Updates a given Shared Environment Variable for a Team.
Request
import { Vercel } from "@vercel/sdk";


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


async function run() {
  const result = await vercel.environment.updateSharedEnvVariable({
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      updates: {
        "env_2WjyKQmM8ZnGcJsPWMrHRHrE": {
          key: "API_URL",
          value: "https://api.vercel.com",
          target: [
            "production",
            "preview",
          ],
          projectIdUpdates: {
            link: [
              "prj_2WjyKQmM8ZnGcJsPWMrHRHrE",
            ],
          },
        },
      },
    },
  });


  console.log(result);
}


run();
Response
{
  "updated": [
    {
      "created": "2021-02-10T13:11:49.180Z",
      "key": "my-api-key",
      "ownerId": "team_LLHUOMOoDlqOp8wPE4kFo9pE",
      "id": "env_XCG7t7AIHuO2SBA8667zNUiM",
      "createdBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
      "deletedBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
      "updatedBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
      "createdAt": "1609492210000",
      "deletedAt": "1609492210000",
      "updatedAt": "1609492210000",
      "value": "string",
      "projectId": [],
      "type": "encrypted",
      "target": [],
      "applyToAllCustomEnvironments": "false",
      "customEnvironmentIds": [],
      "decrypted": "false",
      "comment": "string",
      "lastEditedByDisplayName": "Example Name"
    }
  ],
  "failed": [
    {
      "error": {
        "code": "string",
        "message": "string",
        "key": "string",
        "envVarId": "example_id",
        "envVarKey": "string",
        "action": "string",
        "link": "string",
        "value": "string",
        "gitBranch": "string",
        "target": [],
        "project": "string"
      }
    }
  ]
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

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

Body

application/json
updatesobjectRequired
An object where each key is an environment variable ID (not the key name) and the value is the update to apply

Response

200Success
updatedarrayRequired
failedarrayRequired

Errors

400One of the provided values in the request body is invalid.
401The request is not authorized.
402The account is missing a payment so payment method must be updated
403You do not have permission to access this resource.
410Error