v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

Create a Profile Group

post/applications/{client_id}/profile-groups/

Path parameters

client_idstring required

Request body

namestring required

Group Name

descriptionstring

Description for the Group

membership_type'dynamic' | 'manual'

Membership type for user groups. Can be "dynamic" or "manual"

rule_treestring json

Definition of rules for the profiles in the profile group to follow. Required with membership_type as dynamic

Response

201

idstring

namestring

is_activeboolean

descriptionstring

profile_countinteger

created_atstring

Example response

{
  "id": "21fd0075-853f-49f4-a790-52c92e08d4cb",
  "name": "Test Group",
  "is_active": true,
  "description": "Group for testing",
  "created_at": "2025-01-05T15:16:15.137935Z",
  "attributes": [
    {
      "key": "group_key_1",
      "value": "01"
    }
  ]
}