---
title: update-project-flag-settings
product: vercel
url: /docs/rest-api/feature-flags/update-project-flag-settings
canonical_url: "https://vercel.com/docs/rest-api/feature-flags/update-project-flag-settings"
last_updated: 2026-09-14
type: reference
prerequisites:
  []
related:
  - /docs/rest-api
summary: Learn about update-project-flag-settings on Vercel.
install_vercel_plugin: npx plugins add vercel/vercel-plugin
---

# Update project flag settings

```http
PATCH /v1/projects/{projectIdOrName}/feature-flags/settings
```

Update feature flag settings for a project.

## Authentication

**bearerToken**: HTTP bearer

## Path parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `projectIdOrName` | string | Yes | The project id or name |


## Query parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `teamId` | string | No | The Team identifier to perform the request on behalf of. |
| `slug` | string | No | The Team slug to perform the request on behalf of. |


## Request body

Required: No

Content-Type: `application/json`

```json
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "entities": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "kind",
          "label",
          "attributes"
        ],
        "properties": {
          "kind": {
            "type": "string",
            "maxLength": 128
          },
          "label": {
            "type": "string",
            "maxLength": 128
          },
          "attributes": {
            "type": "array"
          }
        }
      }
    },
    "environments": {
      "type": "array",
      "description": "The environments to sync",
      "items": {
        "type": "string"
      }
    }
  }
}
```

## Example request

### TypeScript

```typescript
const response = await fetch('https://api.vercel.com/v1/projects/projectIdOrName/feature-flags/settings?teamId=string&slug=string', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "enabled": "true",
    "entities": [
      {
        "kind": "string",
        "label": "string",
        "attributes": [
          {
            "key": "string",
            "type": "string",
            "labels": [
              {}
            ]
          }
        ]
      }
    ],
    "environments": []
  }),
});

const data = await response.json();
console.log(data);
```

### Next.js

```typescript
'use server';

export async function callEndpoint() {
  const response = await fetch('https://api.vercel.com/v1/projects/projectIdOrName/feature-flags/settings?teamId=string&slug=string', {
    method: 'PATCH',
    headers: {
      'Authorization': `Bearer ${process.env.VERCEL_ACCESS_TOKEN}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      "enabled": "true",
      "entities": [
        {
          "kind": "string",
          "label": "string",
          "attributes": [
            {
              "key": "string",
              "type": "string",
              "labels": [
                {}
              ]
            }
          ]
        }
      ],
      "environments": []
    }),
    next: { revalidate: 3600 }
  });

  if (!response.ok) {
    throw new Error('Request failed');
  }

  return response.json();
}
```

### cURL

```bash
curl -X PATCH 'https://api.vercel.com/v1/projects/projectIdOrName/feature-flags/settings?teamId=string&slug=string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d "{
    \"enabled\": \"true\",
    \"entities\": [
      {
        \"kind\": \"string\",
        \"label\": \"string\",
        \"attributes\": [
          {
            \"key\": \"string\",
            \"type\": \"string\",
            \"labels\": [
              {}
            ]
          }
        ]
      }
    ],
    \"environments\": []
  }"
```

## Example response

```json
{
  "typeName": "settings",
  "projectId": "example_id",
  "ownerId": "example_id",
  "enabled": "false",
  "environments": [],
  "entities": [
    {
      "kind": "string",
      "label": "string",
      "attributes": [
        {
          "key": "string",
          "type": "string",
          "labels": [
            {}
          ]
        }
      ]
    }
  ],
  "createdAt": "123",
  "updatedAt": "123",
  "metadata": {
    "activeFlagCount": "123",
    "archivedFlagCount": "123",
    "segmentCount": "123",
    "packSizeInBytes": "123",
    "packRevision": "123",
    "configUpdatedAt": "123"
  }
}
```

## Responses

### 200: No description

Content-Type: `application/json`

```json
{
  "type": "object",
  "required": [
    "enabled",
    "entities",
    "environments",
    "metadata",
    "projectId",
    "typeName"
  ],
  "properties": {
    "typeName": {
      "type": "string",
      "enum": [
        "settings"
      ]
    },
    "projectId": {
      "type": "string"
    },
    "ownerId": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean",
      "enum": [
        false,
        true
      ]
    },
    "environments": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "entities": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "attributes",
          "kind",
          "label"
        ],
        "properties": {
          "kind": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "attributes": {
            "type": "array"
          }
        }
      }
    },
    "createdAt": {
      "type": "number"
    },
    "updatedAt": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "required": [
        "activeFlagCount",
        "archivedFlagCount",
        "packSizeInBytes",
        "segmentCount"
      ],
      "properties": {
        "activeFlagCount": {
          "type": "number"
        },
        "archivedFlagCount": {
          "type": "number"
        },
        "segmentCount": {
          "type": "number"
        },
        "packSizeInBytes": {
          "type": "number"
        },
        "packRevision": {
          "type": "number"
        },
        "configUpdatedAt": {
          "type": "number"
        }
      }
    }
  }
}
```

### 201: No description

Content-Type: `application/json`

```json
{
  "type": "object",
  "required": [
    "enabled",
    "entities",
    "environments",
    "metadata",
    "projectId",
    "typeName"
  ],
  "properties": {
    "typeName": {
      "type": "string",
      "enum": [
        "settings"
      ]
    },
    "projectId": {
      "type": "string"
    },
    "ownerId": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean",
      "enum": [
        false,
        true
      ]
    },
    "environments": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "entities": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "attributes",
          "kind",
          "label"
        ],
        "properties": {
          "kind": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "attributes": {
            "type": "array"
          }
        }
      }
    },
    "createdAt": {
      "type": "number"
    },
    "updatedAt": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "required": [
        "activeFlagCount",
        "archivedFlagCount",
        "packSizeInBytes",
        "segmentCount"
      ],
      "properties": {
        "activeFlagCount": {
          "type": "number"
        },
        "archivedFlagCount": {
          "type": "number"
        },
        "segmentCount": {
          "type": "number"
        },
        "packSizeInBytes": {
          "type": "number"
        },
        "packRevision": {
          "type": "number"
        },
        "configUpdatedAt": {
          "type": "number"
        }
      }
    }
  }
}
```

### 400: One of the provided values in the request body is invalid.
One of the provided values in the request query is invalid.

### 401: The request is not authorized.

### 402: The account is missing a payment so payment method must be updated

### 403: You do not have permission to access this resource.

### 404: No description

### 409: No description

### 410: No description

---

## Related

- [feature-flags endpoints](/docs/rest-api#feature-flags)

- [REST API overview](/docs/rest-api)

- [OpenAPI spec](https://openapi.vercel.sh/) (machine-readable, all endpoints)

---

[View full sitemap](/docs/sitemap)