# Segment

Segment module can be used to differentiate the Users into groups which can be used in other loyalty modules for offers or campaigns. Define segments and conditions and use them to incentivize your members.

## Create a new user segment

 - [POST /segment](https://annexcloud.redocly.app/loyalty/loyalty/segment/createsegment.md): This API is used to create a new segment of members in the database. The mandatory parameter values are the name of the segment, the defined start date of the segment, and the defined end date of the segment.

## This method retrieves segment details for a specific segment ID

 - [GET /eligiblesegment/{{segmentId}}](https://annexcloud.redocly.app/loyalty/loyalty/segment/eligiblesegment.md): This method retrieves segment details for all members who are eligible to be included in an existing segment. The administrator needs to use the segment ID as a key to fetch all the details of that eligible segment.

## Get the segment details for a specific segment ID

 - [GET /segment/{{segmentId}}](https://annexcloud.redocly.app/loyalty/loyalty/segment/getsegmentid.md): This method retrieves segment details for a specific segment ID. The user needs to use the segment ID as a key to fetch all the details for that particular segment.

## This API is used to update member segment

 - [PATCH /segment/{{segmentId}}](https://annexcloud.redocly.app/loyalty/loyalty/segment/updatesegment.md): The patch method is used to update existing member segments in the database. An update merges the given request parameters into the current segment. The mandatory parameter values are segment ID, segment name, and time duration for the segment.

## This API is used to get all the segments against the site ID

 - [GET /segmentlist/status](https://annexcloud.redocly.app/loyalty/loyalty/segment/getsegmentliststatus.md): This method retrieves details of all segments available against the site ID. The administrator defines the ‘status’ parameter as either ‘all,’ ‘active,’ or ‘inactive’ in order to display a list of all the segments contained within the loyalty program (regardless of status), all the active segments within the program, or all the inactive segments within the program, respectively.

## Add, override, or delete users in bulk

 - [POST /bulksegmentupdate](https://annexcloud.redocly.app/loyalty/loyalty/segment/postbulksegment.md): This API is used to add, override, or delete users in bulk in the database. The segment ID, a list of user IDs, and defining the ‘memberUpdate’ parameter as ‘add’, ‘override,’ or ‘delete’ are required to update the existing segments. ",