Skip to main content
POST
Update a segment

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The ID of the segment

Body

application/json
name
string

The name of the segment

static_customers
string[]

A list of customer IDs to always include in this segment

customers
string[]

A list of customer IDs to include in this segment

filter
string | null

The filter for this segment

description
string | null

A plain-English description of the segment using bullet-point markdown

metadata
object

Metadata attached to this segment

Response

200 - application/json

The updated Segment object

id
string
required

The ID of the segment

name
string
required

The name of the segment

filter
string | null
required

The filter for this segment

description
string | null
required

A Markdown description of the filter

metadata
object

Metadata attached to this segment

static_customers
string[]

The customers that are always included in this segment