Overview

The Create Segment API allows you to create new user segments within CleverTap, enabling personalized and targeted engagement strategies. The API automates the creation of user segments, streamlining your efforts to improve user engagement and retention.

This API is useful for:

• Creating dynamic user groups for targeted marketing or messaging campaigns.
• Enhancing the segment creation process via APIs to scale marketing efforts across multiple channels.

Base URL

Here is an example base URL from the account in the India region:

https://in1.api.clevertap.com/api/createSegment

Region

To identify the API endpoint for the region of your account, refer to Region.

Headers

For more information about API headers used while processing API requests, refer to Headers.

HTTP Method

POST

Body Parameters

The request body contains an array of customer segments, each defined by a segment_name and a customer_segment_id. Each object in the segments array represents a customer segment with a unique identifier.

📘

Naming Conventions for Creating API Segment

To optimize the usage of the Create Segment API, follow these best practices:

• Use clear, consistent naming conventions for segment names. For example, Premium Users 2024, Active Buyers.
• Avoid special characters or spaces in segment names.
• Maintain a structured approach to naming to easily track and reference segments.

Sample Request

[
    {
      "segment_name": "Premium Users",
      "customer_segment_id": "SEG12345"
    },{
      "segment_name": "Frequent Buyers",
      "customer_segment_id": "SEG67890"
    }
  ]

Sample Response

{
  Segments: [
  	{
    	"segment_name": "Premium Users",
    	"customer_segment_id": "SEG12345",
    	"id": 123
},
    {
    	"segment_name": "Frequent Buyers",
    	"customer_segment_id": "SEG67890",
    	"id": 456
  	]
}

Request Limit

For information on request limit for Create Segment API, refer to API Request Limit.

Errors

The following are the API errors that you may encounter upon failure requests of the Create Segments API: