customer-segments.md

Customer Segments

customer_segments_api = client.customer_segments

Class Name

CustomerSegmentsApi

Methods

• List Customer Segments
• Retrieve Customer Segment

List Customer Segments

Retrieves the list of customer segments of a business.

def list_customer_segments(cursor: nil)

Parameters

Parameter	Type	Tags	Description
cursor	String	Query, Optional	A pagination cursor returned by previous calls to ListCustomerSegments. This cursor is used to retrieve the next set of query results. For more information, see Pagination.

Response Type

List Customer Segments Response Hash

Example Usage

cursor = 'cursor6'

result = customer_segments_api.list_customer_segments(cursor: cursor)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Retrieve Customer Segment

Retrieves a specific customer segment as identified by the segment_id value.

def retrieve_customer_segment(segment_id:)

Parameters

Parameter	Type	Tags	Description
segment_id	String	Template, Required	The Square-issued ID of the customer segment.

Response Type

Retrieve Customer Segment Response Hash

Example Usage

segment_id = 'segment_id4'

result = customer_segments_api.retrieve_customer_segment(segment_id: segment_id)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end