Update segment

Partially updates an existing segment. Only the fields included in the request body are changed — omitted fields retain their current values.

Updatable Fields

  • name — display name
  • description — internal description
  • backgroundColor — hex color code (e.g. #c3e672)
  • conditions — full replacement of the condition structure. If omitted, existing conditions are preserved.
    Groups may contain one level of subgroups (see Conditions → Subgroups). Rejected with 19006 when the
    segment's current conditions cannot be shown by the API (GET returns conditions.editable: false).

The segment ID is globally unique — no newsletter context is needed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Segment ID (globally unique — no newsletter context needed)

Body Params

All fields are optional — only the provided fields are updated

string

New display name

string

New internal description

string

New background color in #RRGGBB hex format

string
enum

Which subscribers the segment holds by their status. Omit to keep the stored value.

Allowed:
boolean

Count an e-mail address that is on the list several times only once. Omit to keep the stored value.

conditions
object

The filter rules of the segment expressed as groups of conditions

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json