CustomerGroup Document (Data API 16.9)

(supports custom properties)

Document representing a customer group

Property Type Constraints Description
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.
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.
OCAPI obsolete versions 13.x and 14.x will be end of life in 2020 and versions 15.x and 16.x in 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.