Skip to main content
POST
Create Customer Segment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

The name of the segment (case-insensitive unique per org).

Required string length: 1 - 128
priority
integer
required

Lower number = higher priority for conflict resolution when partner matches multiple segments.

Required range: x >= 0
description
string | null

Optional description of what this segment represents.

conditions
SegmentConditionsInput · object | null

Segment filter conditions. Use and_/or_ to combine conditions.

Response

Successful Response

created_at
string<date-time>
required
modified_at
string<date-time> | null
required
id
string
required
name
string
required

The name of the segment (case-insensitive unique per org).

description
string | null
required

Optional description of what this segment represents.

priority
integer
required

Lower number = higher priority for conflict resolution when partner matches multiple segments.

conditions
object | null
required

Rules that determine which partners belong to this segment.

partner_count
integer | null
required

Cached number of partners whose highest-priority matching segment is this one.

partner_count_refreshed_at
string<date-time> | null
required

When partner_count was last recomputed.

object
string
required
read-only

String representing the object's type. Objects of the same type share the same value.