| Field | Type | Required | Description | Example |
|---|---|---|---|---|
organization |
string | ✔️ | The organization segment of a project or org slug, the second of the three. For GitHub OAuth or Bitbucket projects, this is the organization name. For projects that use GitLab or GitHub App, use the organization ID (found in Organization Settings). |
CircleCI-Public |
project |
string | ✔️ | The project segment of a project slug, the third of the three. For GitHub OAuth or Bitbucket projects, this is the repository name. For projects that use GitLab or GitHub App, use the project ID (found in Project Settings). |
api-preview-docs |
projectSettings |
shared.ProjectSettings | ✔️ | The setting(s) to update, including one or more fields in the JSON object. Note that oss: true will only be set on projects whose underlying repositories are actually open source. |
|
provider |
string | ✔️ | The provider segment of a project or org slug, the first of the three. This may be a VCS. For projects that use GitLab or GitHub App, use circleci. |
gh |