---
title: update-project-flag-settings
product: vercel
url: /docs/rest-api/feature-flags/update-project-flag-settings
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",
            "items": {
              "type": "object",
              "required": [
                "key",
                "type"
              ],
              "properties": {
                "key": {
                  "type": "string",
                  "maxLength": 128
                },
                "type": {
                  "type": "string",
                  "maxLength": 128
                },
                "labels": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "label",
                      "value"
                    ],
                    "properties": {
                      "label": {
                        "type": "string",
                        "maxLength": 128
                      },
                      "value": {
                        "type": "string",
                        "maxLength": 128
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "environments": {
      "type": "array",
      "description": "The environments to sync",
      "items": {
        "type": "string"
      }
    }
  }
}
```

## Responses

### 200: No description

Content-Type: `application/json`

```json
{
  "type": "object",
  "description": "Syncs direct the synchronization of Flags to Edge Configs",
  "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"
      }
    },
    "connections": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "edgeConfigId",
          "edgeConfigItemKey"
        ],
        "properties": {
          "edgeConfigId": {
            "type": "string"
          },
          "edgeConfigItemKey": {
            "type": "string"
          }
        }
      }
    },
    "entities": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "attributes",
          "kind",
          "label"
        ],
        "properties": {
          "kind": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "attributes": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "key",
                "type"
              ],
              "properties": {
                "key": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                },
                "labels": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "label",
                      "value"
                    ],
                    "properties": {
                      "label": {
                        "type": "string"
                      },
                      "value": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "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",
  "description": "Syncs direct the synchronization of Flags to Edge Configs",
  "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"
      }
    },
    "connections": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "edgeConfigId",
          "edgeConfigItemKey"
        ],
        "properties": {
          "edgeConfigId": {
            "type": "string"
          },
          "edgeConfigItemKey": {
            "type": "string"
          }
        }
      }
    },
    "entities": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "attributes",
          "kind",
          "label"
        ],
        "properties": {
          "kind": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "attributes": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "key",
                "type"
              ],
              "properties": {
                "key": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                },
                "labels": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "label",
                      "value"
                    ],
                    "properties": {
                      "label": {
                        "type": "string"
                      },
                      "value": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "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 was soft-blocked for an unhandled reason.
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

### 412: 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)