Skip to main content
POST
Create a segment

Authorizations

Authorization
string
header
default:App
required

This is the most secure authorization type and the one with the most flexibility.

API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Body

application/json
name
string
required

A unique segment name.

Example:

"VIP Alex Clients"

description
string

Segment description.

Example:

"Persons named Alex with tag \"VIP Client\""

query
object

Allows to filter persons using simple queries.

Supported logical operators
Supported comparison operators
Example:
events
EventClauseDto · object[]

List of events that persons should match.

Response

Created

id
integer<int64>
required

A unique segment identifier.

Example:

42

name
string
required

A unique segment name.

Example:

"VIP Alex Clients"

description
string

Segment description.

Example:

"Persons named Alex with tag \"VIP Client\""

query
object

Allows to filter persons using simple queries.

Supported logical operators
Supported comparison operators
Example:
events
EventClauseDto · object[]

List of events that persons should match.

createdAt
string<date-time>

Date and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.

modifiedAt
string<date-time>

Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.