Create a group

Create a user group.

Writable fields: name (required), alias, parent_id, status, data, prompt.

Associations (optional): products (array of product IDs, read back as product_ids), asset_groups (array of asset-group IDs, read back as asset_group_ids), and inherit_products (boolean).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Editable group fields. The model fields (name, alias, parent_id, status, data, prompt) are accepted alongside the association helpers below. name is required on create.

string
length ≤ 128
string | null
integer | null
integer
enum
Defaults to 1

Status (0=unpublished/inactive, 1=published/active)

Allowed:
data
object | null

Data (JSON)

string | null

Returned only when requested with ?expand=prompt.

products
array of integers

Product IDs to associate with the group (read back as product_ids).

products
asset_groups
array of integers

Asset-group IDs to associate with the group (read back as asset_group_ids).

asset_groups
boolean

When true, the group inherits its parent group's products.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json