MAmailchimp
lists

Update segment

Update a specific segment in a list.

patch/3.0/lists/{list_id}/segments/{segment_id}

Request

Path parameters

list_idstring required

The unique ID for the list.

segment_idstring required

The unique id for the segment.

Request body

namestring

The name of the segment.

static_segmentstring[]

An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. Passing an empty array for an existing static segment will reset that segment and remove all members. This field cannot be provided with the options field.

Example request

{
  "options": {
    "conditions": [
      {
        "field": "aim",
        "op": "open",
        "value": "any"
      }
    ]
  }
}

Response

created_atstring date-time

The date and time the segment was created in ISO 8601 format.

idinteger

The unique id for the segment.

list_idstring

The list id.

member_countinteger

The number of active subscribers currently included in the segment.

namestring

The name of the segment.

type'saved' | 'static' | 'fuzzy'

The type of segment. Static segments are now known as tags. Learn more about tags.

updated_atstring date-time

The date and time the segment was last updated in ISO 8601 format.

Example response

{
  "options": {
    "conditions": [
      {
        "field": "aim",
        "op": "open",
        "value": "any"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.