The customer group object

A comprehensive list of the customer group resource's attributes and relationships

A customer group object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/customer_groups endpoint.

Fields

Field	Type	Description
type	string	customer_groups
id	string	The customer group unique identifier
links.self	string	The customer group endpoint URL
attributes.name	string	The customer group's internal name.
attributes.code	string	A string that you can use to identify the customer group (must be unique within the environment).
attributes.created_at	datetime	Time at which the resource was created.
attributes.updated_at	datetime	Time at which the resource was last updated.
attributes.reference	string	A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin	string	Any identifier of the third party system that defines the reference code.
attributes.metadata	object	Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
relationships.customers	array	The customers belonging to this group.
relationships.markets	array	The markets belonging to this group.
relationships.attachments	array	The associated attachments.
relationships.versions	array	The associated changes.
relationships.event_stores	array	The associated event stores.
meta.mode	string	The resource environment (can be one of test or live)