Update list of current Gate Rules settings

Update list of current Gate Rules settings. It does NOT replace, create or delete if you add more rules and remove rules in the rules object. Please get the current rules through GET and use that as the base object.

Authorizations

STATSIG-API-KEY

string

header

required

Headers

x-respect-review-settings

string

Optional header to respect review settings for mutation endpoints.

Path Parameters

id

string

required

id

Body

application/json

rules

object[]

required

Show child attributes

rules.name

string

The name of this rule.

rules.passPercentage

number

Of the users that meet the conditions of this rule, what percent should return true.

Required range: 0 <= x <= 100Must be a multiple of 0.01

rules.conditions

object[]

An array of Condition objects.

Show child attributes

rules.conditions.type

enum<string>

required

Available options:

app_version,

browser_name,

browser_version,

country,

custom_field,

email,

environment_tier,

fails_gate,

fails_segment,

ip_address,

locale,

os_name,

os_version,

passes_gate,

passes_segment,

public,

time,

unit_id,

user_id,

url,

javascript,

device_model,

target_app

rules.conditions.targetValue

rules.conditions.operator

string

rules.conditions.field

string | null

rules.conditions.customID

string | null

rules.environments

string[] | null

The environments this rule is enabled for.

rules.id

string

The Statsig ID of this rule.

rules.baseID

string

The base ID of this rule, i.e. without any added metadata. Will remain the exact same throughout

rules.returnValue

object

The return value of the rule.

Show child attributes

rules.returnValue.{key}

any

Response

200 - application/json

Update gate response

message

string

required

A simple string explaining the result of the operation.

data

object

required

A single result.

Show child attributes

data.id

string

required

ID

data.description

string

required

Maximum length: 1000

data.lastModifierID

string | null

required

ID of the last modifier.

data.lastModifiedTime

number | null

required

Time of the last modification.

data.lastModifierEmail

string | null

required

Email of the last modifier.

data.lastModifierName

string | null

required

Name of the last modifier.

data.createdTime

number

required

Timestamp when the entity was created.

data.creatorName

string | null

required

Name of the creator.

data.checksPerHour

number | null

required

data.status

enum<string>

required

Available options:

In Progress,

Launched,

Disabled,

Archived

data.type

enum<string>

required

Available options:

TEMPORARY,

PERMANENT,

STALE,

TEMPLATE

data.typeReason

enum<string>

required

Available options:

NONE,

STALE_PROBABLY_LAUNCHED,

STALE_PROBABLY_UNLAUNCHED,

STALE_PROBABLY_FORGOTTEN,

STALE_NO_RULES,

STALE_PROBABLY_DEAD_CHECK,

STALE_EMPTY_CHECKS,

STALE_ALL_TRUE,

STALE_ALL_FALSE

data.isEnabled

boolean

required

data.rules

object[]

required

Show child attributes

data.rules.name

string

required

The name of this rule.

data.rules.passPercentage

number

required

Of the users that meet the conditions of this rule, what percent should return true.

Required range: 0 <= x <= 100Must be a multiple of 0.01

data.rules.conditions

object[]

required

An array of Condition objects.

Show child attributes

data.rules.conditions.type

enum<string>

required

Available options:

app_version,

browser_name,

browser_version,

country,

custom_field,

email,

environment_tier,

fails_gate,

fails_segment,

ip_address,

locale,

os_name,

os_version,

passes_gate,

passes_segment,

public,

time,

unit_id,

user_id,

url,

javascript,

device_model,

target_app

data.rules.conditions.targetValue

data.rules.conditions.operator

string

data.rules.conditions.field

string | null

data.rules.conditions.customID

string | null

data.rules.environments

string[] | null

The environments this rule is enabled for.

data.rules.id

string

The Statsig ID of this rule.

data.rules.baseID

string

The base ID of this rule, i.e. without any added metadata. Will remain the exact same throughout

data.rules.returnValue

object

The return value of the rule.

Show child attributes

data.rules.returnValue.{key}

any

data.name

string

Optional name for the configuration.

data.idType

string

data.creatorID

string | null

data.creatorEmail

string | null

data.tags

string[]

data.targetApps

data.holdoutIDs

string[]

Holdouts applied to this configuration.

data.team

string | null

data.teamID

string | null

data.version

number

Version number

data.owner

object | null

Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.

Show child attributes

data.owner.ownerID

string

ID of the owner

Example:

"abc123"

data.owner.ownerType

string

Type of the owner (e.g., SDK_KEY or USER)

Example:

"USER"

data.owner.ownerName

string

The name of the owner. This field is optional.

Example:

"John Doe"

data.owner.ownerEmail

string

The email of the owner. This field is optional.

Example:

{
  "ownerID": "user123",
  "ownerType": "USER",
  "ownerName": "John Doe",
  "ownerEmail": "[e-mail]"
}

data.measureMetricLifts

boolean

data.monitoringMetrics

object[]

Show child attributes

data.monitoringMetrics.name

string

required

data.monitoringMetrics.type

string

required

data.reviewSettings

object

Show child attributes

data.reviewSettings.requiredReview

boolean

required

data.reviewSettings.allowedReviewers

object[] | null

Show child attributes

data.reviewSettings.allowedReviewers.id

string

required

data.reviewSettings.allowedReviewers.name

string

required

data.reviewSettings.allowedReviewers.email

string

required

data.precommitWebhook

object | null

Show child attributes

data.precommitWebhook.url

string

required

data.precommitWebhook.internalStatusUrl

string

required

data.activeReview

object

Show child attributes

data.activeReview.reviewID

string

required

data.activeReview.reviewStatus

string

required

data.activeReview.description

string

required