Skip to main content
PATCH
Update 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_....

Path Parameters

segmentId
string<uuid>
required

Segment id (UUID).

Body

application/json
name
string | null
Maximum string length: 200
description
string | null
Maximum string length: 500
status
enum<string> | null
Available options:
ACTIVE,
INACTIVE,
ARCHIVED
rules
string | null

Response

Updated segment

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>