Skip to main content
PUT
Update Policy

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orgId
string
required

The organization's id (UUID) or slug — either form is accepted.

projectId
string
required

The project's id (UUID) or slug — either form is accepted.

Body

application/json
mode
enum<string>
required
Available options:
public,
authenticated,
organization,
invite_only
previewMode
enum<string>
required
Available options:
inherit,
public,
authenticated,
organization,
invite_only
environmentOverrides
object[]
required
Maximum array length: 100

Response

Updated policy.

mode
enum<string>
required
Available options:
public,
authenticated,
organization,
invite_only
previewMode
enum<string>
required

Access for pull-request previews. Inherit uses the project mode.

Available options:
inherit,
public,
authenticated,
organization,
invite_only
environmentOverrides
object[]
required
version
integer
required
Required range: x >= 1
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
enforcement
object
required