Skip to main content
POST
Create a segment

Authorizations

X-API-Key
string
header
required

Project-scoped API key, format rm_(live|test)_... . May also be sent as Authorization: Bearer rm_....

Body

application/json
name
string
required
Maximum string length: 200
description
string | null
Maximum string length: 500
type
enum<string> | null
Available options:
STATIC,
DYNAMIC
rules
string | null

JSON rules definition for DYNAMIC segments.

Response

Segment created

id
string<uuid>
segmentKey
string | null
name
string
description
string | null
type
string
rules
string | null
status
string
memberCount
integer<int64> | null
createdAt
string<date-time>
updatedAt
string<date-time>