Create Segment

This API is used to create a segment. A segment can be created with or without criteria.

📘

Know Your Endpoint

Based on the domain you use to log in to imiconnect, the endpoint for your API varies. See the endpoint section to understand which endpoint to use for your domain.

For Segment:

The following is the error code displayed when the Segment messaging is disabled for your tenant.

{

  "code": 70,

  "description": "Segment based messaging feature is not available for your tenant"

}

📘

Note

To enable the Segment messaging for your tenant, contact your account manager.

Path Params
string
required

The unique identifier corresponding to the app asset

Body Params
string

Specifies the name of the segment

string

Criteria can be used to define a category of a segment, or it can be a combination of topics with logical operators (& | ! symbols). This is an optional parameter. You can add users to a segment and make a group without defining it's criteria . For topic-based criteria, based on the criteria condition the user base will be prepared to send push/in-app messages. For example, if Sports and News are topics, the criteria can be Sports&News *both Sports and News), or, Sports|News (either Sports or News).

Headers
string

Application/JSON

string

Client key that can be accessed from your app asset configuration page on imiconnect platform

Response

Language
Credentials
Header
Request
Response
Choose an example:
application/json