Skip to main content
PUT
/
v3
/
groups
/
definitions
/
{group}
Edit Group Definition
curl --request PUT \
  --url https://api.{tenant}.getomneo.com/api/v3/groups/definitions/{group} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "handle": "<string>",
  "type": "<string>",
  "source_type": "<string>",
  "source_id": 123,
  "query": "<string>",
  "query_type": "<string>",
  "period": 1,
  "absolute_expiry": "<string>",
  "refresh_period": 1,
  "refresh_absolute_expiry": "<string>",
  "short_description": "<string>",
  "description": "<string>",
  "owner_profile_id": "<string>",
  "meta": [
    "<string>"
  ],
  "is_published": true,
  "is_active": true,
  "is_archived": true,
  "arguments": [
    {
      "name": "<string>"
    }
  ]
}
'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "handle": "<string>",
    "type": "<string>",
    "source_type": "<string>",
    "source_id": 123,
    "query": "<string>",
    "query_type": "<string>",
    "arguments": [
      "<unknown>"
    ],
    "period": 123,
    "period_type": "<string>",
    "absolute_expiry": "<string>",
    "refresh_period": 123,
    "refresh_period_type": "<string>",
    "refresh_absolute_expiry": "<string>",
    "last_refreshed_at": "<string>",
    "next_refresh_at": "<string>",
    "refresh_status": "<string>",
    "refresh_error": "<string>",
    "short_description": "<string>",
    "description": "<string>",
    "owner_profile_id": "<string>",
    "meta": [
      "<unknown>"
    ],
    "is_published": true,
    "is_active": true,
    "is_archived": true,
    "created_at": "<string>",
    "updated_at": "<string>",
    "current_member_count": 123,
    "rules": [
      {
        "id": 123,
        "group_definition_id": 123,
        "group_rule_definition_id": 123,
        "type": "<string>",
        "name": "<string>",
        "arguments": [
          "<unknown>"
        ],
        "sort_order": 123,
        "is_active": true,
        "meta": [
          "<unknown>"
        ],
        "effective": {
          "handle": "<string>",
          "evaluator": "<string>",
          "rule": {},
          "name": "<string>",
          "arguments": [
            "<unknown>"
          ]
        },
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    ]
  }
}

Path Parameters

group
integer
required

The group ID

Body

application/json
name
string
Maximum string length: 255
handle
string
Maximum string length: 255
type
string

Type cannot change on an existing definition — flipping a static group to dynamic (or vice versa) would invalidate every existing group_profile / snapshot row.

source_type
string | null
Maximum string length: 255
source_id
integer | null
query
string | null
Maximum string length: 255
query_type
string | null
Maximum string length: 255
period
integer | null
Required range: x >= 0
period_type
enum<string> | null
Available options:
days,
weeks,
months,
years,
absolute_date,
absolute_week,
absolute_month
absolute_expiry
string | null
refresh_period
integer | null
Required range: x >= 0
refresh_period_type
enum<string> | null
Available options:
days,
weeks,
months,
years,
absolute_date,
absolute_week,
absolute_month
refresh_absolute_expiry
string | null
short_description
string | null
description
string | null
owner_profile_id
string | null
meta
string[] | null
is_published
boolean
is_active
boolean
is_archived
boolean
arguments
object[] | null

Response

GroupDefinition

data
GroupDefinition · object
required