---
title: "Update project settings"
method: PATCH
path: "/project/{provider}/{organization}/{project}/settings"
tags: ["Project"]
---

# Update project settings

`PATCH /project/{provider}/{organization}/{project}/settings`

Updates one or more of the advanced settings for a CircleCI project.

## Request body

- ProjectSettings
  - `advanced` object
    - `autocancel_builds` boolean — Except for the default branch, cancel running pipelines on a branch when a new pipeline starts on that branch.
    - `build_fork_prs` boolean — Run builds for pull requests from forks.
    - `build_prs_only` boolean — Once enabled, we will only build branches that have associated pull requests open.
    - `disable_ssh` boolean — When set to true, job re-runs with SSH debugging access will be disabled for the project.
    - `forks_receive_secret_env_vars` boolean — Run builds for forked pull requests with this project's configuration, environment variables, and secrets.
    - `oss` boolean — Free and Open Source. Enabling this grants additional credits, and lets others see your builds, both through the web UI and the API.
    - `set_github_status` boolean — Report the status of every pushed commit to GitHub's status API. Updates reported per job.
    - `setup_workflows` boolean — Enabling allows you to conditionally trigger configurations outside of the primary `.circleci` parent directory.
    - `write_settings_requires_admin` boolean — Whether updating these settings requires a user to be an organization administrator. When disabled, updating settings can be done by any member.
    - `pr_only_branch_overrides` string[] — This field is used in conjunction with the `build_prs_only`, it allows you to specify a list of branches that will always triger a build. The value passed will overwrite the existing value.

## Response `200`

Successful response. Always includes the full advanced settings object. Returned even when the provided updates match the existing settings, but can also be returned when `oss: true` fails to set.

- ProjectSettings
  - `advanced` object
    - `autocancel_builds` boolean — Except for the default branch, cancel running pipelines on a branch when a new pipeline starts on that branch.
    - `build_fork_prs` boolean — Run builds for pull requests from forks.
    - `build_prs_only` boolean — Once enabled, we will only build branches that have associated pull requests open.
    - `disable_ssh` boolean — When set to true, job re-runs with SSH debugging access will be disabled for the project.
    - `forks_receive_secret_env_vars` boolean — Run builds for forked pull requests with this project's configuration, environment variables, and secrets.
    - `oss` boolean — Free and Open Source. Enabling this grants additional credits, and lets others see your builds, both through the web UI and the API.
    - `set_github_status` boolean — Report the status of every pushed commit to GitHub's status API. Updates reported per job.
    - `setup_workflows` boolean — Enabling allows you to conditionally trigger configurations outside of the primary `.circleci` parent directory.
    - `write_settings_requires_admin` boolean — Whether updating these settings requires a user to be an organization administrator. When disabled, updating settings can be done by any member.
    - `pr_only_branch_overrides` string[] — This field is used in conjunction with the `build_prs_only`, it allows you to specify a list of branches that will always triger a build. The value passed will overwrite the existing value.

## Other responses

- `400` — Request is malformed, e.g. with improperly encoded JSON
- `401` — Credentials provided are invalid.
- `403` — None or insufficient credentials provided.
- `404` — Insufficient credentials for a private project, OR the organization, project, or repository does not exist.
- `429` — API rate limits exceeded.
- `500` — Internal server error.

---

[API](https://skmtc.net/circleci/apis/api-v2.md) · [All operations](https://skmtc.net/circleci/apis/api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/circleci/api-v2/versions/b9c0e0c24058/schema)