CustomerAttributeDefinition

A company-defined custom attribute that can be set on customers (e.g. "Region", "Account Tier").

type CustomerAttributeDefinition {
  archivedAt: ISO8601DateTime
  attributeGroup: String
  attributeType: CustomerAttributeTypeEnum!
  createdAt: ISO8601DateTime!
  description: String
  favorite: Boolean!
  handle: String
  id: ID!
  name: String!
  showInCustomerList: Boolean!
  updatedAt: ISO8601DateTime!
  useInFilters: Boolean!
}

Fields

CustomerAttributeDefinition.archivedAt ● ISO8601DateTime scalar common

When the definition was archived, if archived.

CustomerAttributeDefinition.attributeGroup ● String scalar common

Optional grouping label for organizing attributes.

CustomerAttributeDefinition.attributeType ● CustomerAttributeTypeEnum! non-null enum people

The kind of value the attribute holds.

CustomerAttributeDefinition.createdAt ● ISO8601DateTime! non-null scalar common

When the definition was created.

CustomerAttributeDefinition.description ● String scalar common

What this attribute captures.

CustomerAttributeDefinition.favorite ● Boolean! non-null scalar common

Whether the attribute is pinned as a favorite.

CustomerAttributeDefinition.handle ● String scalar common

Stable slug identifier, unique within the company.

CustomerAttributeDefinition.id ● ID! non-null scalar common

Unique identifier for the attribute definition.

CustomerAttributeDefinition.name ● String! non-null scalar common

Display name of the attribute.

CustomerAttributeDefinition.showInCustomerList ● Boolean! non-null scalar common

Whether the attribute is shown as a customer list column.

CustomerAttributeDefinition.updatedAt ● ISO8601DateTime! non-null scalar common

When the definition was last updated.

CustomerAttributeDefinition.useInFilters ● Boolean! non-null scalar common

Whether the attribute is offered as a customer list filter.

Returned By

customerAttributeDefinitions query

Member Of

AddCustomerAttributeDefinitionPayload object ● CustomerAttribute object ● UpdateCustomerAttributeDefinitionPayload object