Skip to main content
PUT
Edit Group Definition

Path Parameters

group
integer
required

The group ID

Body

application/json
name
string
Maximum string length: 255
handle
string
Maximum string length: 255
campaign
string | null
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