Object Index

You are viewing an old version of the API

All Versions

CustomerSegment BETA

Represents a group of customer profiles that match one or more predefined filter criteria.

Segments (also known as Smart Groups) are defined and created within Customer Directory in the Square Dashboard or Point of Sale.

Properties

Name	Description
`id string`	Read only Unique Square-generated ID for the segment. Max Length 255
`name string` Required	Read only Name of the segment.
`created_at string`	Read only The timestamp when the segment was created, in RFC 3339 format. Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00
`updated_at string`	Read only The timestamp when the segment was last updated, in RFC 3339 format. Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00