Manage Segments (iOS SDK)

Adding to a segment

The method allows adding the current user to a segment.

sdk.addToSegment(params)

Name	Type	Requirement	Description
segmentId	string	required	Segment ID. It's available in the PersonaClick account: CRM > Segments.
email	string	optionally	The current user's Email.
phone	string	optionally	The current user's Phone.

sdk.addToSegment(segmentId: "100500", email: "john.doe@examplestore.com", phone: "+10000000000")

sdk.addToSegment(segmentId: "100500", email: "john.doe@examplestore.com")

sdk.addToSegment(segmentId: "100500", phone: "+10000000000")

sdk.addToSegment(segmentId: "100500")

The method allows excluding the current user from a segment.

sdk.removeFromSegment(params)

Name	Type	Requirement	Description
segmentId	string	required	Segment ID. It's available in the PersonaClick account: CRM > Segments.
email	string	optionally	The current user's Email.
phone	string	optionally	The current user's Phone.

sdk.removeFromSegment(segmentId: "100500", email: "john.doe@examplestore.com", phone: "+10000000000")

sdk.removeFromSegment(segmentId: "100500", email: "john.doe@examplestore.com")

sdk.removeFromSegment(segmentId: "100500", phone: "+10000000000")

sdk.removeFromSegment(segmentId: "100500")

The method allows getting a list of segments that include the current user.

sdk.getCurrentSegment()

Name	Type	Requirement	Description
callback	Function	required	The callback function that takes the API response. The API response type is an object.

Type Description

Object array

Object array, each will have the following properties:

id (number) - the Segment ID.
type (string) - the Segment Type. It can have the following values: static, dynamic, rfm.

let segments = sdk.getCurrentSegment()

Page Navigation

Related Pages