Model: Group

1 min

Model Parameters

Group

Example

{
  "archive_url": "/projects/12345/groups/archived",
  "archived": false,
  "created_time": "2019-05-08T00:00:00.000Z",
  "description": "Promo group description",
  "environment_key": "production",
  "id": 1,
  "name": "Promo group",
  "project_id": 12345,
  "revision": 1,
  "role": "viewer",
  "rules": {
    "321": {
      "created_time": "2022-01-08T00:00:00.000Z",
      "flag_key": "recurring_revenue",
      "flag_name": "Recurring Revenue",
      "flag_status": "unarchived",
      "rule_key": "experiment_one",
      "rule_name": "Experiment One",
      "traffic_allocation": 2000,
      "updated_time": "2022-01-08T00:00:00.000Z"
    }
  },
  "unarchive_url": "/projects/12345/groups/unarchived",
  "update_url": "/projects/12345/groups",
  "updated_time": "2019-05-08T00:00:00.000Z",
  "url": "/projects/12345/groups/123",
  "urn": "groups.flag.optimizely.com::1"
}

archive_urlobject
- UrlValue
archivedboolean
created_timestring<date-time>required
Example
2019-05-08T00:00:00.000Z
Format
date-time
delete_urlobject
- UrlValue
descriptionstring
Example
promotion group
environment_keystringrequired
Example
production
Min Length
1
idintegerrequired
Example
1
namestringrequired
Example
PromoGroup
project_idinteger<int64>
Description
The ID of the Project this Group belongs to
Format
int64
revisioninteger
Description
Revision number for tracking changes
rolestring
Example
admin
Description
Granular permission role
rulesobject
- GroupRuleMap
unarchive_urlobject
- UrlValue
update_urlobject
- UrlValue
updated_timestring<date-time>required
Example
2019-05-08T00:00:00.000Z
Format
date-time
urlobject
Description
Link to self
- UrlValue
urnstringrequired
Example
groups.flag.optimizely.com::1
Description
The URN for the Group