CustomerGroup document (Data API 23.2)
(supports custom properties)
Document representing a customer group
| Property | Type | Constraints | Description |
|---|---|---|---|
creation_date |
Date | Returns the value of attribute 'creationDate'. | |
description |
String | The description for the customer group. This property is read-only for system groups. | |
id |
String | maxLength=256, minLength=1 | The user specific identifier for the customer group, which must be unique across the organization. Property is read-only. |
in_deletion |
Boolean | The deletion status of this customer group. | |
last_modified |
Date | Returns the value of attribute 'lastModified'. | |
link |
String | URL that is used to get this instance. This property is computed and cannot be modified. | |
member_count |
Integer | The number of members in this customer group. | |
rule |
Rule | The rule of this customer group. Only available for dynamic customer groups. | |
type |
Enum {system, dynamic, static} | The type of the customer group. This property is read-only. |
X
OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
