Skip to main content
PUT
Update a contact segment

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

id
string
required

Body

application/json
name
string

New display name (1-200 chars).

description
string

New description (up to 1000 chars).

filters
object

AND/OR filter AST that defines the segment's membership.

rules
object

Legacy { operator, conditions } rule shape, still accepted for backwards compatibility.

auto_refresh
boolean

Whether the scheduler re-materialises membership automatically.

auto_refresh_interval_minutes
integer

Per-segment refresh cadence in minutes (1-1440).

Response

The updated segment, wrapped in the standard { data, meta } envelope.

The updated segment, wrapped in the standard { data, meta } envelope.

data
object
meta
object