Skip to main content
PATCH
Update an experiment group

Authorizations

Authorization
string
header
required

Bearer authentication using the project Secret Key (prefixed with sk_, or test_sk_ for sandbox). All v4 public endpoints require the Secret Key — see Authentication. Never expose the Secret Key in client-side code.

Path Parameters

experiment_id
string
required

Experiment identifier.

Maximum string length: 256
Pattern: ^[a-zA-Z0-9._-]+$
group_id
string
required

Group identifier.

Maximum string length: 256
Pattern: ^[a-zA-Z0-9._-]+$

Body

application/json
weight
number
required

Relative traffic weight for this group.

name
string | null

Group display name.

is_control
boolean

Whether this is the control group.

remote_config_uid
string | null

Remote config UID to associate with this group.

Response

Updated experiment group.

object
string
Example:

"experiment_group"

id
string

Group identifier.

url
string

Canonical API path.

name
string | null

Group display name.

is_control
boolean

Whether this is the control group.

weight
number

Relative traffic weight for this group.

remote_config_uid
string | null

Remote config UID associated with this group. Mutually exclusive with offering_uid — a group carries at most one payload linkage.

offering_uid
string | null

Offering UID associated with this group (price-split experiments). Mutually exclusive with remote_config_uid.

offering_tag
integer<int16> | null

Tag of the attached offering (0 = default, 1 = variant). Populated only when offering_uid is set.

created_at
string<date-time>

ISO 8601 creation timestamp.

updated_at
string<date-time>

ISO 8601 last update timestamp.