Segments

Manage segments for a specific MailChimp list. A segment is a section of your list that includes only those subscribers who share specific common field information. Learn more about segments in MailChimp.

Subresources

Available methods

    • POST /lists/{list_id}/segments Create a new segment
      POST /lists/{list_id}/segments/{segment_id} Batch add/remove list members to static segment

      Create a new segment

      POST /lists/{list_id}/segments

      Create a new segment in a specific list.

      Path parameters

      list_id The unique id for the list.

      Request body parameters

      name Type: String Title: Segment Name Read only: false The name of the segment.
      static_segment Type: Array Title: Static Segment Read only: false 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 will create a static segment without any subscribers. This field cannot be provided with the options field.
      options Type: Object Title: Conditions Read only: false The conditions of the segment. Static and fuzzy segments don’t have conditions.
      Show properties
      match Type: String Title: Match Read only: false Match type.
      Possible Values:
      • any
      • all
      conditions Type: Array Title: Segment Conditions Read only: false An array of segment conditions.
      Show items
      condition_type Type: string Title: Segment Type The type of segment, for example: date, language, Mandrill, static, and more.
      Segment Type
      Aim Type: Object Title: Automation Segment - Aim
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on their campaign interaction.
      Possible Values:
      • open
      • click
      • sent
      • noopen
      • noclick
      • nosent
      field Type: String Title: Aim Read only: false The segment field, ‘aim’.
      Possible Values:
      • aim
      value Type: String Title: Campaign Web ID Read only: false Either the web id value for a specific campaign or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Automation Type: Object Title: Automation Segment - Automation
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on where they are in an Automation workflow.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Automation Read only: false The field to segment on.
      Possible Values:
      • automation
      value Type: String Title: Automation Web ID Read only: false The web id for the Automation workflow to segment on.
      CampaignPoll Type: Object Title: Poll Activity Segment - CampaignPoll
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not interacted with a specific poll in a MailChimp email.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Campaign Poll Read only: false The field to segment on.
      Possible Values:
      • poll
      value Type: Number Title: Poll ID Read only: false The id for the poll.
      Conversation Type: Object Title: Automation Segment - Conversation
      Show properties
      op Type: String Title: Operator Read only: false The status of a member’s interaction with a conversation.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Conversations Read only: false The field to segment on.
      Possible Values:
      • conversation
      value Type: String Title: Campaign Web ID Read only: false The web id value for a specific campaign, or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Date Type: Object Title: Date Segment - Date
      Show properties
      op Type: String Title: Operator Read only: false When the event took place.
      Possible Values:
      • greater
      • less
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Date Read only: false The date segment field.
      Possible Values:
      • timestamp_opt
      • info_changed
      • ecomm_date
      extra Type: String Title: Date Read only: false When segmenting on ‘date’ or ‘campaign’, the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.
      value Type: String Title: Event Type Read only: false What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.
      Possible Values:
      • date
      • campaign
      • last
      EmailClient Type: Object Title: Automation Segment - EmailClient
      Show properties
      op Type: String Title: Operator Read only: false A member’s status, based on their campaign interactions.
      Possible Values:
      • client_is
      • client_not
      field Type: String Title: Email Client Read only: false The field to segment on.
      Possible Values:
      • email_client
      value Type: String Title: Email Client Read only: false The name of the email client.
      Language Type: Object Title: Automation Segment - Language
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s language is or isn’t set to a specific language.
      Possible Values:
      • is
      • not
      field Type: String Title: Language Read only: false The field to segment on.
      Possible Values:
      • language
      value Type: String Title: Language ID Read only: false A two-letter language identifier.
      Mandrill Type: Object Title: Segment Condition - Mandrill
      Show properties
      op Type: String Title: Segment Operator Read only: false The segment operator.
      field Type: String Title: Segment Field Read only: false The field to segment on.
      MemberRating Type: Object Title: Member Rating Segment - MemberRating
      Show properties
      op Type: String Title: Operator Read only: false Members who have have a rating that is/not exactly a specific number or members who have a rating greater/less than a specific number.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Member Rating Read only: false The field to segment on.
      Possible Values:
      • rating
      value Type: Number Title: Start Rating Read only: false The star rating number to segment on.
      SignupSource Type: Object Title: Signup Source Segment - SignupSource
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s signup source was/was not a particular value.
      Possible Values:
      • source_is
      • source_not
      field Type: String Title: Signup Source Read only: false The field to segment on.
      Possible Values:
      • source
      value Type: String Title: Signup Source Read only: false The signup source.
      SurveyMonkey Type: Object Title: Survey Monkey Segment - SurveyMonkey
      Show properties
      op Type: String Title: Operator Read only: false A member’s status based on whether they have started, completed, not started, or not completed a specific survey.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Survey Monkey Read only: false The field to segment on.
      Possible Values:
      • survey_monkey
      value Type: String Title: Survey ID Read only: false The unique ID of the SurveyMonkey survey.
      VIP Type: Object Title: VIP Segment - VIP
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is or isn’t a VIP.
      Possible Values:
      • member
      • notmember
      field Type: String Title: VIP Read only: false The field to segment on.
      Possible Values:
      • gmonkey
      Interests Type: Object Title: Interests Segment - Interests
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is a part of one, all, or none of the groups.
      Possible Values:
      • interestcontains
      • interestcontainsall
      • interestnotcontains
      field Type: String Title: Interest Group Read only: false The interest group, like “interests-123”
      value Type: Array Title: Segment Value Read only: false An array containing integers, each representing a group id.
      EcommCategory Type: Object Title: Ecomm Category Segment - EcommCategory
      Show properties
      op Type: String Title: Operator Read only: false A member who has purchased from a category or purchased a specific item.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      field Type: String Title: Ecomm Category or Product Read only: false The e-commerce category or product segment field.
      Possible Values:
      • ecomm_cat
      • ecomm_prod
      value Type: String Title: Ecomm Category or Item Read only: false The e-commerce category or item information.
      EcommNumber Type: Object Title: Ecomm Purchased Segment - EcommNumber
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Ecomm Number Read only: false The e-commerce number field to segment on.
      Possible Values:
      • ecomm_spent_avg
      • ecomm_orders
      • ecomm_prod_all
      • ecomm_avg_ord
      value Type: Number Title: Amount Spent Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.
      EcommPurchased Type: Object Title: Ecomm Purchased Segment - EcommPurchased
      Show properties
      op Type: String Title: Operator Read only: false Members who have have (‘member’) or have not (‘notmember’) purchased.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Ecomm Purchased Read only: false The e-commerce purchased field to segment on.
      Possible Values:
      • ecomm_purchased
      EcommSpent Type: Object Title: Ecomm Purchase Segment - EcommSpent
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent more or less than the set value.
      Possible Values:
      • greater
      • less
      field Type: String Title: Ecomm Spent Read only: false The e-commerce spent field to segment on.
      Possible Values:
      • ecomm_spent_one
      • ecomm_spent_all
      value Type: Integer Title: Total Spent Read only: false The total amount a member spent.
      EcommStore Type: Object Title: Ecomm Purchased Store Segment - EcommStore
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not purchased from a specific store.
      Possible Values:
      • is
      • not
      field Type: String Title: Ecomm Store Read only: false The e-commerce store field to segment on.
      Possible Values:
      • ecomm_store
      value Type: String Title: Store ID Read only: false The store id to segment on.
      GoalActivity Type: Object Title: Goal Activity Segment - GoalActivity
      Show properties
      op Type: String Title: Operator Read only: false Whether the website URL is/not exactly, contains/doesn’t contain, starts with/ends with a string.
      Possible Values:
      • is
      • goal_not
      • contains
      • goal_notcontain
      • starts
      • ends
      field Type: String Title: Goal Activity Read only: false The goal activity field to segment on.
      Possible Values:
      • goal
      value Type: String Title: Goal URL Read only: false The URL to check Goal activity against.
      GoalTimestamp Type: Object Title: Goal Timestamp Segment - GoalTimestamp
      Show properties
      op Type: String Title: Operator Read only: false Whether the website activity happened at, after, or before a specific date.
      Possible Values:
      • greater
      • less
      • is
      field Type: String Title: Goal Time Read only: false The goal time field to segment on.
      Possible Values:
      • goal_last_visited
      extra Type: String Title: Date Read only: false The date for the segment, formatted as YYYY-MM-DD.
      value Type: String Title: Event Type Read only: false What type of data to segment on.
      Possible Values:
      • date
      FuzzySegment Type: Object Title: Similar Subscribers Segment Member Segment - FuzzySegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a ‘similar subscribers’ segment.
      Possible Values:
      • fuzzy_is
      • fuzzy_not
      field Type: String Title: Fuzzy Segment Read only: false The fuzzy segment field.
      Possible Values:
      • fuzzy_segment
      value Type: Number Title: Similar Subscribers Segment ID Read only: false The id for the ‘similar subscribers’ segment.
      StaticSegment Type: Object Title: Static Segment Member Segment - StaticSegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a static segment.
      Possible Values:
      • static_is
      • static_not
      field Type: String Title: Static Segment Read only: false The static segment field.
      Possible Values:
      • static_segment
      value Type: Number Title: Static Segment ID Read only: false The id for the static segment.
      IPGeoCountryState Type: Object Title: Location-Based Segment - IPGeoCountryState
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific country or US state.
      Possible Values:
      • ipgeocountry
      • ipgeonotcountry
      • ipgeostate
      • ipgeonotstate
      field Type: String Title: Country State Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: String Title: Country Code or US State Read only: false The two-letter country code or US state abbreviation.
      IPGeoIn Type: Object Title: Geolocation Segment - IPGeoIn
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific geographic region.
      Possible Values:
      • ipgeoin
      • ipgeonotin
      lng Type: String Title: Segment Location Longitude Read only: false The longitude of the target location.
      field Type: String Title: Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      addr Type: String Title: Segment Location Address Read only: false The address of the target location.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      lat Type: String Title: Segment Location Latitude Read only: false The latitude of the target location.
      IPGeoInZip Type: Object Title: US Zip Code Segment - IPGeoInZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific US zip code.
      Possible Values:
      • ipgeoinzip
      field Type: String Title: Location in Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      extra Type: Integer Title: Zip Code Read only: false The zip code to segment on.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      IPGeoUnknown Type: Object Title: Location-Based Segment - IPGeoUnknown
      Show properties
      op Type: String Title: Operator Read only: false Segment members with unknown location information.
      Possible Values:
      • ipgeounknown
      field Type: String Title: Unknown Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      IPGeoZip Type: Object Title: Location-Based Segment - IPGeoZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are or are not in a specific US zip code.
      Possible Values:
      • ipgeoiszip
      • ipgeonotzip
      field Type: String Title: Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: Integer Title: Zip Code Read only: false The 5-digit zip code.
      SocialAge Type: Object Title: Social Profiles Age Segment - SocialAge
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Age Read only: false The social age field to segment on.
      Possible Values:
      • social_age
      value Type: String Title: Age Range Read only: false The age range to segment.
      Possible Values:
      • 18-24
      • 25-34
      • 35-54
      • 55+
      SocialGender Type: Object Title: Social Profiles Gender Segment - SocialGender
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Gender Read only: false The social gender field to segment on.
      Possible Values:
      • social_gender
      value Type: String Title: Social Gender Read only: false The Social Profiles gender to segment.
      Possible Values:
      • male
      • female
      SocialInfluence Type: Object Title: Social Profiles Influence Segment - SocialInfluence
      Show properties
      op Type: String Title: Operator Read only: false Members who have a rating that is/not or greater/less than the rating provided.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Social Influence Read only: false The social influence field to segment on.
      Possible Values:
      • social_influence
      value Type: Number Title: Influence Rating Read only: false The Social Profiles influence rating to segment on.
      SocialNetworkMember Type: Object Title: Social Profiles Social Network Segment - SocialNetworkMember
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not on a specific social network.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Social Network Read only: false The social_network segment field.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter
      • facebook
      • linkedin
      • flickr
      • foursquare
      • lastfm
      • myspace
      • quora
      • vimeo
      • yelp
      • youtube
      SocialNetworkFollow Type: Object Title: Social Profiles Social Network Follow Segment - SocialNetworkFollow
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not following a linked account on a specific social network.
      Possible Values:
      • follow
      • notfollow
      field Type: String Title: Social Network Follow Read only: false The field to segment on.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter_follow
      AddressMerge Type: Object Title: Address/Zip Merge Field Segment - AddressMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value contains, doesn’t contain, is blank, or isn’t blank.
      Possible Values:
      • contains
      • notcontain
      • blank
      • blank_not
      field Type: String Title: Address Merge Read only: false The address merge segment field.
      value Type: String Title: Address Merge Compare Value Read only: false The value to compare.
      ZipMerge Type: Object Title: Address/Zip Merge Field Segment - ZipMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the zip value is in a specific location.
      Possible Values:
      • geoin
      field Type: String Title: Zip Merge Read only: false The zip merge segment field.
      extra Type: String Title: City or Zip Read only: false The city or the zip being used to segment on.
      value Type: String Title: Zip Merge Compare Value Read only: false The value to compare.
      BirthdayMerge Type: Object Title: Birthday Merge Field Segment - BirthdayMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Birthday Merge Read only: false The birthday merge segment field.
      value Type: String Title: Birthday Merge Compare Value Read only: false The value to compare.
      DateMerge Type: Object Title: Date Merge Field Segment - DateMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • less
      • blank
      • blank_not
      field Type: String Title: Date Merge Read only: false The date merge segment field.
      value Type: String Title: Date Merge Compare Value Read only: false The value to compare.
      TextMerge Type: Object Title: Text or Number Merge Field Segment - TextMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      • blank
      • blank_not
      field Type: String Title: Text Merge Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      value Type: String Title: Text Merge Compare Value Read only: false The value to compare.
      SelectMerge Type: Object Title: Dropdown/Radio Merge Field Segment - SelectMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Select Read only: false The select merge segment field.
      value Type: String Title: Select Merge Compare Value Read only: false The value to compare.
      EmailAddress Type: Object Title: Email Segment - EmailAddress
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      field Type: String Title: Email Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      Possible Values:
      • merge0
      • EMAIL
      value Type: String Title: Email Compare Value Read only: false The value to compare the email against.

      Response body parameters

      id Type: Integer Title: Segment ID Read only: true The unique id for the segment.
      name Type: String Title: Segment Name Read only: false The name of the segment.
      member_count Type: Integer Title: Member Count Read only: true The number of active subscribers currently included in the segment.
      type Type: String Title: Type Read only: true The type of segment.
      Possible Values:
      • saved
      • static
      • fuzzy
      created_at Type: String Title: Date Created Read only: true The date and time the segment was created.
      updated_at Type: String Title: Date Updated Read only: true The date and time the segment was last updated.
      options Type: Object Title: Conditions Read only: false The conditions of the segment. Static and fuzzy segments don’t have conditions.
      Show properties
      match Type: String Title: Match Read only: false Match type.
      Possible Values:
      • any
      • all
      conditions Type: Array Title: Segment Conditions Read only: false An array of segment conditions.
      Show items
      condition_type Type: string Title: Segment Type The type of segment, for example: date, language, Mandrill, static, and more.
      Segment Type
      Aim Type: Object Title: Automation Segment - Aim
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on their campaign interaction.
      Possible Values:
      • open
      • click
      • sent
      • noopen
      • noclick
      • nosent
      field Type: String Title: Aim Read only: false The segment field, ‘aim’.
      Possible Values:
      • aim
      value Type: String Title: Campaign Web ID Read only: false Either the web id value for a specific campaign or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Automation Type: Object Title: Automation Segment - Automation
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on where they are in an Automation workflow.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Automation Read only: false The field to segment on.
      Possible Values:
      • automation
      value Type: String Title: Automation Web ID Read only: false The web id for the Automation workflow to segment on.
      CampaignPoll Type: Object Title: Poll Activity Segment - CampaignPoll
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not interacted with a specific poll in a MailChimp email.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Campaign Poll Read only: false The field to segment on.
      Possible Values:
      • poll
      value Type: Number Title: Poll ID Read only: false The id for the poll.
      Conversation Type: Object Title: Automation Segment - Conversation
      Show properties
      op Type: String Title: Operator Read only: false The status of a member’s interaction with a conversation.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Conversations Read only: false The field to segment on.
      Possible Values:
      • conversation
      value Type: String Title: Campaign Web ID Read only: false The web id value for a specific campaign, or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Date Type: Object Title: Date Segment - Date
      Show properties
      op Type: String Title: Operator Read only: false When the event took place.
      Possible Values:
      • greater
      • less
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Date Read only: false The date segment field.
      Possible Values:
      • timestamp_opt
      • info_changed
      • ecomm_date
      extra Type: String Title: Date Read only: false When segmenting on ‘date’ or ‘campaign’, the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.
      value Type: String Title: Event Type Read only: false What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.
      Possible Values:
      • date
      • campaign
      • last
      EmailClient Type: Object Title: Automation Segment - EmailClient
      Show properties
      op Type: String Title: Operator Read only: false A member’s status, based on their campaign interactions.
      Possible Values:
      • client_is
      • client_not
      field Type: String Title: Email Client Read only: false The field to segment on.
      Possible Values:
      • email_client
      value Type: String Title: Email Client Read only: false The name of the email client.
      Language Type: Object Title: Automation Segment - Language
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s language is or isn’t set to a specific language.
      Possible Values:
      • is
      • not
      field Type: String Title: Language Read only: false The field to segment on.
      Possible Values:
      • language
      value Type: String Title: Language ID Read only: false A two-letter language identifier.
      Mandrill Type: Object Title: Segment Condition - Mandrill
      Show properties
      op Type: String Title: Segment Operator Read only: false The segment operator.
      field Type: String Title: Segment Field Read only: false The field to segment on.
      MemberRating Type: Object Title: Member Rating Segment - MemberRating
      Show properties
      op Type: String Title: Operator Read only: false Members who have have a rating that is/not exactly a specific number or members who have a rating greater/less than a specific number.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Member Rating Read only: false The field to segment on.
      Possible Values:
      • rating
      value Type: Number Title: Start Rating Read only: false The star rating number to segment on.
      SignupSource Type: Object Title: Signup Source Segment - SignupSource
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s signup source was/was not a particular value.
      Possible Values:
      • source_is
      • source_not
      field Type: String Title: Signup Source Read only: false The field to segment on.
      Possible Values:
      • source
      value Type: String Title: Signup Source Read only: false The signup source.
      SurveyMonkey Type: Object Title: Survey Monkey Segment - SurveyMonkey
      Show properties
      op Type: String Title: Operator Read only: false A member’s status based on whether they have started, completed, not started, or not completed a specific survey.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Survey Monkey Read only: false The field to segment on.
      Possible Values:
      • survey_monkey
      value Type: String Title: Survey ID Read only: false The unique ID of the SurveyMonkey survey.
      VIP Type: Object Title: VIP Segment - VIP
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is or isn’t a VIP.
      Possible Values:
      • member
      • notmember
      field Type: String Title: VIP Read only: false The field to segment on.
      Possible Values:
      • gmonkey
      Interests Type: Object Title: Interests Segment - Interests
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is a part of one, all, or none of the groups.
      Possible Values:
      • interestcontains
      • interestcontainsall
      • interestnotcontains
      field Type: String Title: Interest Group Read only: false The interest group, like “interests-123”
      value Type: Array Title: Segment Value Read only: false An array containing integers, each representing a group id.
      EcommCategory Type: Object Title: Ecomm Category Segment - EcommCategory
      Show properties
      op Type: String Title: Operator Read only: false A member who has purchased from a category or purchased a specific item.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      field Type: String Title: Ecomm Category or Product Read only: false The e-commerce category or product segment field.
      Possible Values:
      • ecomm_cat
      • ecomm_prod
      value Type: String Title: Ecomm Category or Item Read only: false The e-commerce category or item information.
      EcommNumber Type: Object Title: Ecomm Purchased Segment - EcommNumber
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Ecomm Number Read only: false The e-commerce number field to segment on.
      Possible Values:
      • ecomm_spent_avg
      • ecomm_orders
      • ecomm_prod_all
      • ecomm_avg_ord
      value Type: Number Title: Amount Spent Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.
      EcommPurchased Type: Object Title: Ecomm Purchased Segment - EcommPurchased
      Show properties
      op Type: String Title: Operator Read only: false Members who have have (‘member’) or have not (‘notmember’) purchased.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Ecomm Purchased Read only: false The e-commerce purchased field to segment on.
      Possible Values:
      • ecomm_purchased
      EcommSpent Type: Object Title: Ecomm Purchase Segment - EcommSpent
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent more or less than the set value.
      Possible Values:
      • greater
      • less
      field Type: String Title: Ecomm Spent Read only: false The e-commerce spent field to segment on.
      Possible Values:
      • ecomm_spent_one
      • ecomm_spent_all
      value Type: Integer Title: Total Spent Read only: false The total amount a member spent.
      EcommStore Type: Object Title: Ecomm Purchased Store Segment - EcommStore
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not purchased from a specific store.
      Possible Values:
      • is
      • not
      field Type: String Title: Ecomm Store Read only: false The e-commerce store field to segment on.
      Possible Values:
      • ecomm_store
      value Type: String Title: Store ID Read only: false The store id to segment on.
      GoalActivity Type: Object Title: Goal Activity Segment - GoalActivity
      Show properties
      op Type: String Title: Operator Read only: false Whether the website URL is/not exactly, contains/doesn’t contain, starts with/ends with a string.
      Possible Values:
      • is
      • goal_not
      • contains
      • goal_notcontain
      • starts
      • ends
      field Type: String Title: Goal Activity Read only: false The goal activity field to segment on.
      Possible Values:
      • goal
      value Type: String Title: Goal URL Read only: false The URL to check Goal activity against.
      GoalTimestamp Type: Object Title: Goal Timestamp Segment - GoalTimestamp
      Show properties
      op Type: String Title: Operator Read only: false Whether the website activity happened at, after, or before a specific date.
      Possible Values:
      • greater
      • less
      • is
      field Type: String Title: Goal Time Read only: false The goal time field to segment on.
      Possible Values:
      • goal_last_visited
      extra Type: String Title: Date Read only: false The date for the segment, formatted as YYYY-MM-DD.
      value Type: String Title: Event Type Read only: false What type of data to segment on.
      Possible Values:
      • date
      FuzzySegment Type: Object Title: Similar Subscribers Segment Member Segment - FuzzySegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a ‘similar subscribers’ segment.
      Possible Values:
      • fuzzy_is
      • fuzzy_not
      field Type: String Title: Fuzzy Segment Read only: false The fuzzy segment field.
      Possible Values:
      • fuzzy_segment
      value Type: Number Title: Similar Subscribers Segment ID Read only: false The id for the ‘similar subscribers’ segment.
      StaticSegment Type: Object Title: Static Segment Member Segment - StaticSegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a static segment.
      Possible Values:
      • static_is
      • static_not
      field Type: String Title: Static Segment Read only: false The static segment field.
      Possible Values:
      • static_segment
      value Type: Number Title: Static Segment ID Read only: false The id for the static segment.
      IPGeoCountryState Type: Object Title: Location-Based Segment - IPGeoCountryState
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific country or US state.
      Possible Values:
      • ipgeocountry
      • ipgeonotcountry
      • ipgeostate
      • ipgeonotstate
      field Type: String Title: Country State Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: String Title: Country Code or US State Read only: false The two-letter country code or US state abbreviation.
      IPGeoIn Type: Object Title: Geolocation Segment - IPGeoIn
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific geographic region.
      Possible Values:
      • ipgeoin
      • ipgeonotin
      lng Type: String Title: Segment Location Longitude Read only: false The longitude of the target location.
      field Type: String Title: Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      addr Type: String Title: Segment Location Address Read only: false The address of the target location.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      lat Type: String Title: Segment Location Latitude Read only: false The latitude of the target location.
      IPGeoInZip Type: Object Title: US Zip Code Segment - IPGeoInZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific US zip code.
      Possible Values:
      • ipgeoinzip
      field Type: String Title: Location in Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      extra Type: Integer Title: Zip Code Read only: false The zip code to segment on.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      IPGeoUnknown Type: Object Title: Location-Based Segment - IPGeoUnknown
      Show properties
      op Type: String Title: Operator Read only: false Segment members with unknown location information.
      Possible Values:
      • ipgeounknown
      field Type: String Title: Unknown Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      IPGeoZip Type: Object Title: Location-Based Segment - IPGeoZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are or are not in a specific US zip code.
      Possible Values:
      • ipgeoiszip
      • ipgeonotzip
      field Type: String Title: Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: Integer Title: Zip Code Read only: false The 5-digit zip code.
      SocialAge Type: Object Title: Social Profiles Age Segment - SocialAge
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Age Read only: false The social age field to segment on.
      Possible Values:
      • social_age
      value Type: String Title: Age Range Read only: false The age range to segment.
      Possible Values:
      • 18-24
      • 25-34
      • 35-54
      • 55+
      SocialGender Type: Object Title: Social Profiles Gender Segment - SocialGender
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Gender Read only: false The social gender field to segment on.
      Possible Values:
      • social_gender
      value Type: String Title: Social Gender Read only: false The Social Profiles gender to segment.
      Possible Values:
      • male
      • female
      SocialInfluence Type: Object Title: Social Profiles Influence Segment - SocialInfluence
      Show properties
      op Type: String Title: Operator Read only: false Members who have a rating that is/not or greater/less than the rating provided.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Social Influence Read only: false The social influence field to segment on.
      Possible Values:
      • social_influence
      value Type: Number Title: Influence Rating Read only: false The Social Profiles influence rating to segment on.
      SocialNetworkMember Type: Object Title: Social Profiles Social Network Segment - SocialNetworkMember
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not on a specific social network.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Social Network Read only: false The social_network segment field.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter
      • facebook
      • linkedin
      • flickr
      • foursquare
      • lastfm
      • myspace
      • quora
      • vimeo
      • yelp
      • youtube
      SocialNetworkFollow Type: Object Title: Social Profiles Social Network Follow Segment - SocialNetworkFollow
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not following a linked account on a specific social network.
      Possible Values:
      • follow
      • notfollow
      field Type: String Title: Social Network Follow Read only: false The field to segment on.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter_follow
      AddressMerge Type: Object Title: Address/Zip Merge Field Segment - AddressMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value contains, doesn’t contain, is blank, or isn’t blank.
      Possible Values:
      • contains
      • notcontain
      • blank
      • blank_not
      field Type: String Title: Address Merge Read only: false The address merge segment field.
      value Type: String Title: Address Merge Compare Value Read only: false The value to compare.
      ZipMerge Type: Object Title: Address/Zip Merge Field Segment - ZipMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the zip value is in a specific location.
      Possible Values:
      • geoin
      field Type: String Title: Zip Merge Read only: false The zip merge segment field.
      extra Type: String Title: City or Zip Read only: false The city or the zip being used to segment on.
      value Type: String Title: Zip Merge Compare Value Read only: false The value to compare.
      BirthdayMerge Type: Object Title: Birthday Merge Field Segment - BirthdayMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Birthday Merge Read only: false The birthday merge segment field.
      value Type: String Title: Birthday Merge Compare Value Read only: false The value to compare.
      DateMerge Type: Object Title: Date Merge Field Segment - DateMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • less
      • blank
      • blank_not
      field Type: String Title: Date Merge Read only: false The date merge segment field.
      value Type: String Title: Date Merge Compare Value Read only: false The value to compare.
      TextMerge Type: Object Title: Text or Number Merge Field Segment - TextMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      • blank
      • blank_not
      field Type: String Title: Text Merge Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      value Type: String Title: Text Merge Compare Value Read only: false The value to compare.
      SelectMerge Type: Object Title: Dropdown/Radio Merge Field Segment - SelectMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Select Read only: false The select merge segment field.
      value Type: String Title: Select Merge Compare Value Read only: false The value to compare.
      EmailAddress Type: Object Title: Email Segment - EmailAddress
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      field Type: String Title: Email Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      Possible Values:
      • merge0
      • EMAIL
      value Type: String Title: Email Compare Value Read only: false The value to compare the email against.
      list_id Type: String Title: List ID Read only: true The list id.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request POST \
      --url 'https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"name":"The jokes that didn'\''t quite make it."}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1047
      Vary: Accept-Encoding
      X-Request-Id: 8c39bbce-7e13-464b-b293-c93c7548b5ef
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Segments/Instance.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 21:32:12 GMT
      Connection: keep-alive
      
      
      {
        "id": 49381,
        "name": "The jokes that didn't quite make it.",
        "member_count": 1,
        "type": "saved",
        "created_at": "2015-09-16 21:32:12",
        "updated_at": "2015-09-16 21:32:12",
        "options": {
          "conditions": [
            {
              "field": "timestamp_opt",
              "op": "greater",
              "value": "last"
            }
          ]
        },
        "list_id": "57afe96172",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments/49381",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Segments/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Segments/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Segments.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments/49381",
            "method": "DELETE"
          },
          {
            "rel": "update",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments/49381",
            "method": "PATCH",
            "schema": "https://api.mailchimp.com/schema/3.0/Lists/Segments/Instance.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

      Batch add/remove list members to static segment

      POST /lists/{list_id}/segments/{segment_id}

      Batch add/remove list members to static segment

      Request body parameters

      members_to_add Type: Array Title: Members to add to the static segment Read only: false An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored.
      members_to_remove Type: Array Title: Members to remove from the static segment Read only: false An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored.

      Response body parameters

      members_added Type: Array Title: Members Added Read only: false An array of objects, each representing a new member that was added to the static segment.
      Show properties
      id Type: String Title: Email ID Read only: true The MD5 hash of the lowercase version of the list member’s email address.
      email_address Type: String Title: Email Address Read only: false Email address for a subscriber.
      unique_email_id Type: String Title: Unique Email ID Read only: true An identifier for the address across all of MailChimp.
      email_type Type: String Title: Email Type Read only: false Type of email this member asked to get (‘html’ or ‘text’).
      status Type: String Title: Status Read only: false Subscriber’s current status.
      Possible Values:
      • subscribed
      • unsubscribed
      • cleaned
      • pending
      • transactional
      merge_fields Type: Object Title: Member Merge Var Read only: false An individual merge var and value for a member.
      interests Type: Object Title: Subscriber Interests Read only: false The key of this object’s properties is the ID of the interest in question.
      stats Type: Object Title: Subscriber Stats Read only: true Open and click rates for this subscriber.
      Show properties
      avg_open_rate Type: Number Title: Average Open Rate Read only: true A subscriber’s average open rate.
      avg_click_rate Type: Number Title: Average Click Rate Read only: true A subscriber’s average clickthrough rate.
      ip_signup Type: String Title: Signup IP Read only: true IP address the subscriber signed up from.
      timestamp_signup Type: String Title: Signup Timestamp Read only: true The date and time the subscriber signed up for the list.
      ip_opt Type: String Title: Opt-in IP Read only: true The IP address the subscriber used to confirm their opt-in status.
      timestamp_opt Type: String Title: Opt-in Timestamp Read only: true The date and time the subscribe confirmed their opt-in status.
      member_rating Type: Integer Title: Member Rating Read only: true Star rating for this member, between 1 and 5.
      last_changed Type: String Title: Last Changed Date Read only: true The date and time the member’s info was last changed.
      language Type: String Title: Language Read only: false If set/detected, the subscriber’s language.
      vip Type: Boolean Title: VIP Read only: false VIP status for subscriber.
      email_client Type: String Title: Email Client Read only: true The list member’s email client.
      location Type: Object Title: Location Read only: false Subscriber location information.
      Show properties
      latitude Type: Number Title: Latitude Read only: false The location latitude.
      longitude Type: Number Title: Longitude Read only: false The location longitude.
      gmtoff Type: Integer Title: GMT Offset Read only: true The time difference in hours from GMT.
      dstoff Type: Integer Title: DST Offset Read only: true The offset for timezones where daylight saving time is observed.
      country_code Type: String Title: Country Code Read only: true The unique code for the location country.
      timezone Type: String Title: Timezone Read only: true The timezone for the location.
      last_note Type: Object Title: Notes Read only: true The most recent Note added about this member.
      Show properties
      note_id Type: Integer Title: Note ID Read only: true The note id.
      created_at Type: String Title: Created Time Read only: true The date and time the note was created.
      created_by Type: String Title: Author Read only: true The author of the note.
      note Type: String Title: Note Read only: true The content of the note.
      list_id Type: String Title: List ID Read only: true The list id.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      members_removed Type: Array Title: Members Removed Read only: false An array of objects, each representing an existing list member that got deleted from the static segment.
      Show properties
      id Type: String Title: Email ID Read only: true The MD5 hash of the lowercase version of the list member’s email address.
      email_address Type: String Title: Email Address Read only: false Email address for a subscriber.
      unique_email_id Type: String Title: Unique Email ID Read only: true An identifier for the address across all of MailChimp.
      email_type Type: String Title: Email Type Read only: false Type of email this member asked to get (‘html’ or ‘text’).
      status Type: String Title: Status Read only: false Subscriber’s current status.
      Possible Values:
      • subscribed
      • unsubscribed
      • cleaned
      • pending
      • transactional
      merge_fields Type: Object Title: Member Merge Var Read only: false An individual merge var and value for a member.
      interests Type: Object Title: Subscriber Interests Read only: false The key of this object’s properties is the ID of the interest in question.
      stats Type: Object Title: Subscriber Stats Read only: true Open and click rates for this subscriber.
      Show properties
      avg_open_rate Type: Number Title: Average Open Rate Read only: true A subscriber’s average open rate.
      avg_click_rate Type: Number Title: Average Click Rate Read only: true A subscriber’s average clickthrough rate.
      ip_signup Type: String Title: Signup IP Read only: true IP address the subscriber signed up from.
      timestamp_signup Type: String Title: Signup Timestamp Read only: true The date and time the subscriber signed up for the list.
      ip_opt Type: String Title: Opt-in IP Read only: true The IP address the subscriber used to confirm their opt-in status.
      timestamp_opt Type: String Title: Opt-in Timestamp Read only: true The date and time the subscribe confirmed their opt-in status.
      member_rating Type: Integer Title: Member Rating Read only: true Star rating for this member, between 1 and 5.
      last_changed Type: String Title: Last Changed Date Read only: true The date and time the member’s info was last changed.
      language Type: String Title: Language Read only: false If set/detected, the subscriber’s language.
      vip Type: Boolean Title: VIP Read only: false VIP status for subscriber.
      email_client Type: String Title: Email Client Read only: true The list member’s email client.
      location Type: Object Title: Location Read only: false Subscriber location information.
      Show properties
      latitude Type: Number Title: Latitude Read only: false The location latitude.
      longitude Type: Number Title: Longitude Read only: false The location longitude.
      gmtoff Type: Integer Title: GMT Offset Read only: true The time difference in hours from GMT.
      dstoff Type: Integer Title: DST Offset Read only: true The offset for timezones where daylight saving time is observed.
      country_code Type: String Title: Country Code Read only: true The unique code for the location country.
      timezone Type: String Title: Timezone Read only: true The timezone for the location.
      last_note Type: Object Title: Notes Read only: true The most recent Note added about this member.
      Show properties
      note_id Type: Integer Title: Note ID Read only: true The note id.
      created_at Type: String Title: Created Time Read only: true The date and time the note was created.
      created_by Type: String Title: Author Read only: true The author of the note.
      note Type: String Title: Note Read only: true The content of the note.
      list_id Type: String Title: List ID Read only: true The list id.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      errors Type: Array Title: Errors Read only: false An array of objects, each representing an array of email addresses that could not be added to the segment or removed and an error message providing more details.
      Show properties
      email_addresses Type: Array Title: Email addresses added to the static segment or removed Read only: false Email addresses added to the static segment or removed
      error Type: String Title: Error message Read only: false The error message indicating why the email addresses could not be added or updated.
      total_added Type: Integer Title: Item Count Read only: false The total number of items matching the query, irrespective of pagination.
      total_removed Type: Integer Title: Item Count Read only: false The total number of items matching the query, irrespective of pagination.
      error_count Type: Integer Title: Item Count Read only: false The total number of items matching the query, irrespective of pagination.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request POST \
      --url 'https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/segments/11281' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"members_to_add": ["freddie@mailchimp.com", "freddie@freddiesjokes.com"], "members_to_remove":["freddie@gmail.com", "freddie@yahoo.com", "freddie@hotmail.com"]}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Thu, 29 Sep 2016 12:28:13 GMT
      Content-Type: application/json; charset=utf-8
      Transfer-Encoding: chunked
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: 80c0d21c-a538-4aa9-93d9-299290338b4a
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Segments/Instance.json>; rel="describedBy"
      
      {
        "members_added": [
          {
            "id": "7d4a15254e94d1b5e1c8f0f780b8aabf",
            "email_address": "freddie@mailchimp.com",
            "unique_email_id": "3ae4a8c153",
            "email_type": "html",
            "status": "subscribed",
            "merge_fields": {
              "FNAME": "Freddie",
              "LNAME": "von Chimpenheimer",
              "MMERGE3": "",
              "MMERGE4": ""
            },
            "stats": {
              "avg_open_rate": 0,
              "avg_click_rate": 0
            },
            "ip_signup": "",
            "timestamp_signup": "",
            "ip_opt": "111.11.111.11",
            "timestamp_opt": "2016-09-28T19:46:58+00:00",
            "member_rating": 2,
            "last_changed": "2016-09-28T19:46:58+00:00",
            "language": "",
            "vip": false,
            "email_client": "",
            "location": {
              "latitude": 0,
              "longitude": 0,
              "gmtoff": 0,
              "dstoff": 0,
              "country_code": "",
              "timezone": ""
            },
            "list_id": "3da7c56ccb",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/7d4a15254e94d1b5e1c8f0f780b8aabf",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Collection.json",
                "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Members.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/7d4a15254e94d1b5e1c8f0f780b8aabf",
                "method": "PATCH",
                "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              },
              {
                "rel": "upsert",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/7d4a15254e94d1b5e1c8f0f780b8aabf",
                "method": "PUT",
                "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/7d4a15254e94d1b5e1c8f0f780b8aabf",
                "method": "DELETE"
              },
              {
                "rel": "activity",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/7d4a15254e94d1b5e1c8f0f780b8aabf/activity",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Activity/Collection.json"
              },
              {
                "rel": "goals",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/7d4a15254e94d1b5e1c8f0f780b8aabf/goals",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Goals/Collection.json"
              },
              {
                "rel": "notes",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/7d4a15254e94d1b5e1c8f0f780b8aabf/notes",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Collection.json"
              }
            ]
          },
          {
            "id": "ced754e22cb506c7b9a27b5fc5e97e95",
            "email_address": "freddie@freddiesjokes.com",
            "unique_email_id": "a71c70ab33",
            "email_type": "html",
            "status": "subscribed",
            "merge_fields": {
              "FNAME": "Freddie",
              "LNAME": "von Chimpenheimer",
              "MMERGE3": "",
              "MMERGE4": ""
            },
            "stats": {
              "avg_open_rate": 0,
              "avg_click_rate": 0
            },
            "ip_signup": "",
            "timestamp_signup": "",
            "ip_opt": "111.11.111.11",
            "timestamp_opt": "2016-09-28T19:47:15+00:00",
            "member_rating": 2,
            "last_changed": "2016-09-28T19:47:15+00:00",
            "language": "",
            "vip": false,
            "email_client": "",
            "location": {
              "latitude": 0,
              "longitude": 0,
              "gmtoff": 0,
              "dstoff": 0,
              "country_code": "",
              "timezone": ""
            },
            "list_id": "3da7c56ccb",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/ced754e22cb506c7b9a27b5fc5e97e95",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Collection.json",
                "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Members.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/ced754e22cb506c7b9a27b5fc5e97e95",
                "method": "PATCH",
                "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              },
              {
                "rel": "upsert",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/ced754e22cb506c7b9a27b5fc5e97e95",
                "method": "PUT",
                "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/ced754e22cb506c7b9a27b5fc5e97e95",
                "method": "DELETE"
              },
              {
                "rel": "activity",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/ced754e22cb506c7b9a27b5fc5e97e95/activity",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Activity/Collection.json"
              },
              {
                "rel": "goals",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/ced754e22cb506c7b9a27b5fc5e97e95/goals",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Goals/Collection.json"
              },
              {
                "rel": "notes",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/ced754e22cb506c7b9a27b5fc5e97e95/notes",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Collection.json"
              }
            ]
          }
        ],
        "members_removed": [
          {
            "id": "b4288ec03d2eef27e277d7cd950d45f3",
            "email_address": "freddie@gmail.com",
            "unique_email_id": "2b58f7a3a5",
            "email_type": "html",
            "status": "subscribed",
            "merge_fields": {
              "FNAME": "Freddie",
              "LNAME": "von Chimpenheimer",
              "MMERGE3": "",
              "MMERGE4": ""
            },
            "stats": {
              "avg_open_rate": 0,
              "avg_click_rate": 0
            },
            "ip_signup": "",
            "timestamp_signup": "",
            "ip_opt": "111.11.111.11",
            "timestamp_opt": "2016-09-28T19:47:30+00:00",
            "member_rating": 2,
            "last_changed": "2016-09-28T19:47:30+00:00",
            "language": "",
            "vip": false,
            "email_client": "",
            "location": {
              "latitude": 0,
              "longitude": 0,
              "gmtoff": 0,
              "dstoff": 0,
              "country_code": "",
              "timezone": ""
            },
            "list_id": "3da7c56ccb",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/b4288ec03d2eef27e277d7cd950d45f3",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Collection.json",
                "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Members.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/b4288ec03d2eef27e277d7cd950d45f3",
                "method": "PATCH",
                "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              },
              {
                "rel": "upsert",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/b4288ec03d2eef27e277d7cd950d45f3",
                "method": "PUT",
                "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/b4288ec03d2eef27e277d7cd950d45f3",
                "method": "DELETE"
              },
              {
                "rel": "activity",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/b4288ec03d2eef27e277d7cd950d45f3/activity",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Activity/Collection.json"
              },
              {
                "rel": "goals",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/b4288ec03d2eef27e277d7cd950d45f3/goals",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Goals/Collection.json"
              },
              {
                "rel": "notes",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/b4288ec03d2eef27e277d7cd950d45f3/notes",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Collection.json"
              }
            ]
          },
          {
            "id": "cd194c6f18e0cc38ccc4554c35f8a92e",
            "email_address": "freddie@yahoo.com",
            "unique_email_id": "0ccaefbc93",
            "email_type": "html",
            "status": "subscribed",
            "merge_fields": {
              "FNAME": "Freddie",
              "LNAME": "von Chimpenheimer",
              "MMERGE3": "",
              "MMERGE4": ""
            },
            "stats": {
              "avg_open_rate": 0,
              "avg_click_rate": 0
            },
            "ip_signup": "",
            "timestamp_signup": "",
            "ip_opt": "111.11.111.11",
            "timestamp_opt": "2016-09-28T19:47:40+00:00",
            "member_rating": 2,
            "last_changed": "2016-09-28T19:47:40+00:00",
            "language": "",
            "vip": false,
            "email_client": "",
            "location": {
              "latitude": 0,
              "longitude": 0,
              "gmtoff": 0,
              "dstoff": 0,
              "country_code": "",
              "timezone": ""
            },
            "list_id": "3da7c56ccb",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/cd194c6f18e0cc38ccc4554c35f8a92e",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Collection.json",
                "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Members.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/cd194c6f18e0cc38ccc4554c35f8a92e",
                "method": "PATCH",
                "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              },
              {
                "rel": "upsert",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/cd194c6f18e0cc38ccc4554c35f8a92e",
                "method": "PUT",
                "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/cd194c6f18e0cc38ccc4554c35f8a92e",
                "method": "DELETE"
              },
              {
                "rel": "activity",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/cd194c6f18e0cc38ccc4554c35f8a92e/activity",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Activity/Collection.json"
              },
              {
                "rel": "goals",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/cd194c6f18e0cc38ccc4554c35f8a92e/goals",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Goals/Collection.json"
              },
              {
                "rel": "notes",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/cd194c6f18e0cc38ccc4554c35f8a92e/notes",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Collection.json"
              }
            ]
          },
          {
            "id": "2adee825d79768dc1108d0fdd3af3492",
            "email_address": "freddie@hotmail.com",
            "unique_email_id": "d8742c409f",
            "email_type": "html",
            "status": "subscribed",
            "merge_fields": {
              "FNAME": "Freddie",
              "LNAME": "von Chimpenheimer",
              "MMERGE3": "",
              "MMERGE4": ""
            },
            "stats": {
              "avg_open_rate": 0,
              "avg_click_rate": 0
            },
            "ip_signup": "",
            "timestamp_signup": "",
            "ip_opt": "111.11.111.11",
            "timestamp_opt": "2016-09-28T19:47:55+00:00",
            "member_rating": 2,
            "last_changed": "2016-09-28T19:47:55+00:00",
            "language": "",
            "vip": false,
            "email_client": "",
            "location": {
              "latitude": 0,
              "longitude": 0,
              "gmtoff": 0,
              "dstoff": 0,
              "country_code": "",
              "timezone": ""
            },
            "list_id": "3da7c56ccb",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/2adee825d79768dc1108d0fdd3af3492",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Collection.json",
                "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Members.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/2adee825d79768dc1108d0fdd3af3492",
                "method": "PATCH",
                "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              },
              {
                "rel": "upsert",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/2adee825d79768dc1108d0fdd3af3492",
                "method": "PUT",
                "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/2adee825d79768dc1108d0fdd3af3492",
                "method": "DELETE"
              },
              {
                "rel": "activity",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/2adee825d79768dc1108d0fdd3af3492/activity",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Activity/Collection.json"
              },
              {
                "rel": "goals",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/2adee825d79768dc1108d0fdd3af3492/goals",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Goals/Collection.json"
              },
              {
                "rel": "notes",
                "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/members/2adee825d79768dc1108d0fdd3af3492/notes",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Collection.json"
              }
            ]
          }
        ],
        "errors": [],
        "total_added": 2,
        "total_removed": 3,
        "error_count": 0
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • GET /lists/{list_id}/segments Get information about all segments in a list
      GET /lists/{list_id}/segments/{segment_id} Get information about a specific segment

      Get information about all segments in a list

      GET /lists/{list_id}/segments

      Get information about all available segments for a specific list.

      Path parameters

      list_id The unique id for the list.

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
      count Type: Integer Title: Count Read only: true The number of records to return. Default value is 10.
      offset Type: Integer Title: Offset Read only: false The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. Default value is 0.
      type Type: String Title: Segment Type Read only: false Limit results based on segment type.
      since_created_at Type: String Title: Since Created At Read only: false Restrict results to segments created after the set time.
      before_created_at Type: String Title: Before Created At Read only: false Restrict results to segments created before the set time.
      since_updated_at Type: String Title: Since Updated At Read only: false Restrict results to segments update after the set time.
      before_updated_at Type: String Title: Before Updated At Read only: false Restrict results to segments update before the set time.

      Response body parameters

      segments Type: Array Title: Lists Read only: false An array of objects, each representing a list segment.
      Show properties
      id Type: Integer Title: Segment ID Read only: true The unique id for the segment.
      name Type: String Title: Segment Name Read only: false The name of the segment.
      member_count Type: Integer Title: Member Count Read only: true The number of active subscribers currently included in the segment.
      type Type: String Title: Type Read only: true The type of segment.
      Possible Values:
      • saved
      • static
      • fuzzy
      created_at Type: String Title: Date Created Read only: true The date and time the segment was created.
      updated_at Type: String Title: Date Updated Read only: true The date and time the segment was last updated.
      options Type: Object Title: Conditions Read only: false The conditions of the segment. Static and fuzzy segments don’t have conditions.
      Show properties
      match Type: String Title: Match Read only: false Match type.
      Possible Values:
      • any
      • all
      conditions Type: Array Title: Segment Conditions Read only: false An array of segment conditions.
      Show items
      condition_type Type: string Title: Segment Type The type of segment, for example: date, language, Mandrill, static, and more.
      Segment Type
      Aim Type: Object Title: Automation Segment - Aim
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on their campaign interaction.
      Possible Values:
      • open
      • click
      • sent
      • noopen
      • noclick
      • nosent
      field Type: String Title: Aim Read only: false The segment field, ‘aim’.
      Possible Values:
      • aim
      value Type: String Title: Campaign Web ID Read only: false Either the web id value for a specific campaign or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Automation Type: Object Title: Automation Segment - Automation
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on where they are in an Automation workflow.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Automation Read only: false The field to segment on.
      Possible Values:
      • automation
      value Type: String Title: Automation Web ID Read only: false The web id for the Automation workflow to segment on.
      CampaignPoll Type: Object Title: Poll Activity Segment - CampaignPoll
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not interacted with a specific poll in a MailChimp email.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Campaign Poll Read only: false The field to segment on.
      Possible Values:
      • poll
      value Type: Number Title: Poll ID Read only: false The id for the poll.
      Conversation Type: Object Title: Automation Segment - Conversation
      Show properties
      op Type: String Title: Operator Read only: false The status of a member’s interaction with a conversation.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Conversations Read only: false The field to segment on.
      Possible Values:
      • conversation
      value Type: String Title: Campaign Web ID Read only: false The web id value for a specific campaign, or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Date Type: Object Title: Date Segment - Date
      Show properties
      op Type: String Title: Operator Read only: false When the event took place.
      Possible Values:
      • greater
      • less
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Date Read only: false The date segment field.
      Possible Values:
      • timestamp_opt
      • info_changed
      • ecomm_date
      extra Type: String Title: Date Read only: false When segmenting on ‘date’ or ‘campaign’, the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.
      value Type: String Title: Event Type Read only: false What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.
      Possible Values:
      • date
      • campaign
      • last
      EmailClient Type: Object Title: Automation Segment - EmailClient
      Show properties
      op Type: String Title: Operator Read only: false A member’s status, based on their campaign interactions.
      Possible Values:
      • client_is
      • client_not
      field Type: String Title: Email Client Read only: false The field to segment on.
      Possible Values:
      • email_client
      value Type: String Title: Email Client Read only: false The name of the email client.
      Language Type: Object Title: Automation Segment - Language
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s language is or isn’t set to a specific language.
      Possible Values:
      • is
      • not
      field Type: String Title: Language Read only: false The field to segment on.
      Possible Values:
      • language
      value Type: String Title: Language ID Read only: false A two-letter language identifier.
      Mandrill Type: Object Title: Segment Condition - Mandrill
      Show properties
      op Type: String Title: Segment Operator Read only: false The segment operator.
      field Type: String Title: Segment Field Read only: false The field to segment on.
      MemberRating Type: Object Title: Member Rating Segment - MemberRating
      Show properties
      op Type: String Title: Operator Read only: false Members who have have a rating that is/not exactly a specific number or members who have a rating greater/less than a specific number.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Member Rating Read only: false The field to segment on.
      Possible Values:
      • rating
      value Type: Number Title: Start Rating Read only: false The star rating number to segment on.
      SignupSource Type: Object Title: Signup Source Segment - SignupSource
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s signup source was/was not a particular value.
      Possible Values:
      • source_is
      • source_not
      field Type: String Title: Signup Source Read only: false The field to segment on.
      Possible Values:
      • source
      value Type: String Title: Signup Source Read only: false The signup source.
      SurveyMonkey Type: Object Title: Survey Monkey Segment - SurveyMonkey
      Show properties
      op Type: String Title: Operator Read only: false A member’s status based on whether they have started, completed, not started, or not completed a specific survey.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Survey Monkey Read only: false The field to segment on.
      Possible Values:
      • survey_monkey
      value Type: String Title: Survey ID Read only: false The unique ID of the SurveyMonkey survey.
      VIP Type: Object Title: VIP Segment - VIP
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is or isn’t a VIP.
      Possible Values:
      • member
      • notmember
      field Type: String Title: VIP Read only: false The field to segment on.
      Possible Values:
      • gmonkey
      Interests Type: Object Title: Interests Segment - Interests
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is a part of one, all, or none of the groups.
      Possible Values:
      • interestcontains
      • interestcontainsall
      • interestnotcontains
      field Type: String Title: Interest Group Read only: false The interest group, like “interests-123”
      value Type: Array Title: Segment Value Read only: false An array containing integers, each representing a group id.
      EcommCategory Type: Object Title: Ecomm Category Segment - EcommCategory
      Show properties
      op Type: String Title: Operator Read only: false A member who has purchased from a category or purchased a specific item.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      field Type: String Title: Ecomm Category or Product Read only: false The e-commerce category or product segment field.
      Possible Values:
      • ecomm_cat
      • ecomm_prod
      value Type: String Title: Ecomm Category or Item Read only: false The e-commerce category or item information.
      EcommNumber Type: Object Title: Ecomm Purchased Segment - EcommNumber
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Ecomm Number Read only: false The e-commerce number field to segment on.
      Possible Values:
      • ecomm_spent_avg
      • ecomm_orders
      • ecomm_prod_all
      • ecomm_avg_ord
      value Type: Number Title: Amount Spent Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.
      EcommPurchased Type: Object Title: Ecomm Purchased Segment - EcommPurchased
      Show properties
      op Type: String Title: Operator Read only: false Members who have have (‘member’) or have not (‘notmember’) purchased.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Ecomm Purchased Read only: false The e-commerce purchased field to segment on.
      Possible Values:
      • ecomm_purchased
      EcommSpent Type: Object Title: Ecomm Purchase Segment - EcommSpent
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent more or less than the set value.
      Possible Values:
      • greater
      • less
      field Type: String Title: Ecomm Spent Read only: false The e-commerce spent field to segment on.
      Possible Values:
      • ecomm_spent_one
      • ecomm_spent_all
      value Type: Integer Title: Total Spent Read only: false The total amount a member spent.
      EcommStore Type: Object Title: Ecomm Purchased Store Segment - EcommStore
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not purchased from a specific store.
      Possible Values:
      • is
      • not
      field Type: String Title: Ecomm Store Read only: false The e-commerce store field to segment on.
      Possible Values:
      • ecomm_store
      value Type: String Title: Store ID Read only: false The store id to segment on.
      GoalActivity Type: Object Title: Goal Activity Segment - GoalActivity
      Show properties
      op Type: String Title: Operator Read only: false Whether the website URL is/not exactly, contains/doesn’t contain, starts with/ends with a string.
      Possible Values:
      • is
      • goal_not
      • contains
      • goal_notcontain
      • starts
      • ends
      field Type: String Title: Goal Activity Read only: false The goal activity field to segment on.
      Possible Values:
      • goal
      value Type: String Title: Goal URL Read only: false The URL to check Goal activity against.
      GoalTimestamp Type: Object Title: Goal Timestamp Segment - GoalTimestamp
      Show properties
      op Type: String Title: Operator Read only: false Whether the website activity happened at, after, or before a specific date.
      Possible Values:
      • greater
      • less
      • is
      field Type: String Title: Goal Time Read only: false The goal time field to segment on.
      Possible Values:
      • goal_last_visited
      extra Type: String Title: Date Read only: false The date for the segment, formatted as YYYY-MM-DD.
      value Type: String Title: Event Type Read only: false What type of data to segment on.
      Possible Values:
      • date
      FuzzySegment Type: Object Title: Similar Subscribers Segment Member Segment - FuzzySegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a ‘similar subscribers’ segment.
      Possible Values:
      • fuzzy_is
      • fuzzy_not
      field Type: String Title: Fuzzy Segment Read only: false The fuzzy segment field.
      Possible Values:
      • fuzzy_segment
      value Type: Number Title: Similar Subscribers Segment ID Read only: false The id for the ‘similar subscribers’ segment.
      StaticSegment Type: Object Title: Static Segment Member Segment - StaticSegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a static segment.
      Possible Values:
      • static_is
      • static_not
      field Type: String Title: Static Segment Read only: false The static segment field.
      Possible Values:
      • static_segment
      value Type: Number Title: Static Segment ID Read only: false The id for the static segment.
      IPGeoCountryState Type: Object Title: Location-Based Segment - IPGeoCountryState
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific country or US state.
      Possible Values:
      • ipgeocountry
      • ipgeonotcountry
      • ipgeostate
      • ipgeonotstate
      field Type: String Title: Country State Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: String Title: Country Code or US State Read only: false The two-letter country code or US state abbreviation.
      IPGeoIn Type: Object Title: Geolocation Segment - IPGeoIn
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific geographic region.
      Possible Values:
      • ipgeoin
      • ipgeonotin
      lng Type: String Title: Segment Location Longitude Read only: false The longitude of the target location.
      field Type: String Title: Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      addr Type: String Title: Segment Location Address Read only: false The address of the target location.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      lat Type: String Title: Segment Location Latitude Read only: false The latitude of the target location.
      IPGeoInZip Type: Object Title: US Zip Code Segment - IPGeoInZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific US zip code.
      Possible Values:
      • ipgeoinzip
      field Type: String Title: Location in Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      extra Type: Integer Title: Zip Code Read only: false The zip code to segment on.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      IPGeoUnknown Type: Object Title: Location-Based Segment - IPGeoUnknown
      Show properties
      op Type: String Title: Operator Read only: false Segment members with unknown location information.
      Possible Values:
      • ipgeounknown
      field Type: String Title: Unknown Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      IPGeoZip Type: Object Title: Location-Based Segment - IPGeoZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are or are not in a specific US zip code.
      Possible Values:
      • ipgeoiszip
      • ipgeonotzip
      field Type: String Title: Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: Integer Title: Zip Code Read only: false The 5-digit zip code.
      SocialAge Type: Object Title: Social Profiles Age Segment - SocialAge
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Age Read only: false The social age field to segment on.
      Possible Values:
      • social_age
      value Type: String Title: Age Range Read only: false The age range to segment.
      Possible Values:
      • 18-24
      • 25-34
      • 35-54
      • 55+
      SocialGender Type: Object Title: Social Profiles Gender Segment - SocialGender
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Gender Read only: false The social gender field to segment on.
      Possible Values:
      • social_gender
      value Type: String Title: Social Gender Read only: false The Social Profiles gender to segment.
      Possible Values:
      • male
      • female
      SocialInfluence Type: Object Title: Social Profiles Influence Segment - SocialInfluence
      Show properties
      op Type: String Title: Operator Read only: false Members who have a rating that is/not or greater/less than the rating provided.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Social Influence Read only: false The social influence field to segment on.
      Possible Values:
      • social_influence
      value Type: Number Title: Influence Rating Read only: false The Social Profiles influence rating to segment on.
      SocialNetworkMember Type: Object Title: Social Profiles Social Network Segment - SocialNetworkMember
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not on a specific social network.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Social Network Read only: false The social_network segment field.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter
      • facebook
      • linkedin
      • flickr
      • foursquare
      • lastfm
      • myspace
      • quora
      • vimeo
      • yelp
      • youtube
      SocialNetworkFollow Type: Object Title: Social Profiles Social Network Follow Segment - SocialNetworkFollow
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not following a linked account on a specific social network.
      Possible Values:
      • follow
      • notfollow
      field Type: String Title: Social Network Follow Read only: false The field to segment on.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter_follow
      AddressMerge Type: Object Title: Address/Zip Merge Field Segment - AddressMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value contains, doesn’t contain, is blank, or isn’t blank.
      Possible Values:
      • contains
      • notcontain
      • blank
      • blank_not
      field Type: String Title: Address Merge Read only: false The address merge segment field.
      value Type: String Title: Address Merge Compare Value Read only: false The value to compare.
      ZipMerge Type: Object Title: Address/Zip Merge Field Segment - ZipMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the zip value is in a specific location.
      Possible Values:
      • geoin
      field Type: String Title: Zip Merge Read only: false The zip merge segment field.
      extra Type: String Title: City or Zip Read only: false The city or the zip being used to segment on.
      value Type: String Title: Zip Merge Compare Value Read only: false The value to compare.
      BirthdayMerge Type: Object Title: Birthday Merge Field Segment - BirthdayMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Birthday Merge Read only: false The birthday merge segment field.
      value Type: String Title: Birthday Merge Compare Value Read only: false The value to compare.
      DateMerge Type: Object Title: Date Merge Field Segment - DateMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • less
      • blank
      • blank_not
      field Type: String Title: Date Merge Read only: false The date merge segment field.
      value Type: String Title: Date Merge Compare Value Read only: false The value to compare.
      TextMerge Type: Object Title: Text or Number Merge Field Segment - TextMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      • blank
      • blank_not
      field Type: String Title: Text Merge Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      value Type: String Title: Text Merge Compare Value Read only: false The value to compare.
      SelectMerge Type: Object Title: Dropdown/Radio Merge Field Segment - SelectMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Select Read only: false The select merge segment field.
      value Type: String Title: Select Merge Compare Value Read only: false The value to compare.
      EmailAddress Type: Object Title: Email Segment - EmailAddress
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      field Type: String Title: Email Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      Possible Values:
      • merge0
      • EMAIL
      value Type: String Title: Email Compare Value Read only: false The value to compare the email against.
      list_id Type: String Title: List ID Read only: true The list id.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      list_id Type: String Title: List ID Read only: true The list id.
      total_items Type: Integer Title: Item Count Read only: false The total number of items matching the query regardless of pagination.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request GET \
      --url 'https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1750
      Vary: Accept-Encoding
      X-Request-Id: 11c34056-1dea-4251-a86d-49c1c27e27ec
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Segments/Collection.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 21:23:32 GMT
      Connection: keep-alive
      
      
      {
        "segments": [
          {
            "id": 49377,
            "name": "Freddie's Most Popular Jokes",
            "member_count": 9,
            "type": "static",
            "created_at": "2015-09-16 21:14:46",
            "updated_at": "2015-09-16 21:14:47",
            "options": {
              "match": "any",
              "conditions": [
                {
                  "field": "static_segment",
                  "op": "static_is",
                  "value": 49377
                }
              ]
            },
            "list_id": "57afe96172",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments/49377",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Segments/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Segments/Collection.json",
                "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Segments.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments/49377",
                "method": "DELETE"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments/49377",
                "method": "PATCH",
                "schema": "https://api.mailchimp.com/schema/3.0/Lists/Segments/Instance.json"
              }
            ]
          }
        ],
        "list_id": "57afe96172",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Segments/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Segments.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Instance.json"
          },
          {
            "rel": "create",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments",
            "method": "POST",
            "schema": "https://api.mailchimp.com/schema/3.0/Lists/Segments/Instance.json"
          }
        ],
        "total_items": 1
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

      Get information about a specific segment

      GET /lists/{list_id}/segments/{segment_id}

      Get information about a specific segment.

      Path parameters

      list_id The unique id for the list.
      segment_id The unique id for the segment.

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

      Response body parameters

      id Type: Integer Title: Segment ID Read only: true The unique id for the segment.
      name Type: String Title: Segment Name Read only: false The name of the segment.
      member_count Type: Integer Title: Member Count Read only: true The number of active subscribers currently included in the segment.
      type Type: String Title: Type Read only: true The type of segment.
      Possible Values:
      • saved
      • static
      • fuzzy
      created_at Type: String Title: Date Created Read only: true The date and time the segment was created.
      updated_at Type: String Title: Date Updated Read only: true The date and time the segment was last updated.
      options Type: Object Title: Conditions Read only: false The conditions of the segment. Static and fuzzy segments don’t have conditions.
      Show properties
      match Type: String Title: Match Read only: false Match type.
      Possible Values:
      • any
      • all
      conditions Type: Array Title: Segment Conditions Read only: false An array of segment conditions.
      Show items
      condition_type Type: string Title: Segment Type The type of segment, for example: date, language, Mandrill, static, and more.
      Segment Type
      Aim Type: Object Title: Automation Segment - Aim
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on their campaign interaction.
      Possible Values:
      • open
      • click
      • sent
      • noopen
      • noclick
      • nosent
      field Type: String Title: Aim Read only: false The segment field, ‘aim’.
      Possible Values:
      • aim
      value Type: String Title: Campaign Web ID Read only: false Either the web id value for a specific campaign or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Automation Type: Object Title: Automation Segment - Automation
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on where they are in an Automation workflow.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Automation Read only: false The field to segment on.
      Possible Values:
      • automation
      value Type: String Title: Automation Web ID Read only: false The web id for the Automation workflow to segment on.
      CampaignPoll Type: Object Title: Poll Activity Segment - CampaignPoll
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not interacted with a specific poll in a MailChimp email.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Campaign Poll Read only: false The field to segment on.
      Possible Values:
      • poll
      value Type: Number Title: Poll ID Read only: false The id for the poll.
      Conversation Type: Object Title: Automation Segment - Conversation
      Show properties
      op Type: String Title: Operator Read only: false The status of a member’s interaction with a conversation.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Conversations Read only: false The field to segment on.
      Possible Values:
      • conversation
      value Type: String Title: Campaign Web ID Read only: false The web id value for a specific campaign, or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Date Type: Object Title: Date Segment - Date
      Show properties
      op Type: String Title: Operator Read only: false When the event took place.
      Possible Values:
      • greater
      • less
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Date Read only: false The date segment field.
      Possible Values:
      • timestamp_opt
      • info_changed
      • ecomm_date
      extra Type: String Title: Date Read only: false When segmenting on ‘date’ or ‘campaign’, the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.
      value Type: String Title: Event Type Read only: false What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.
      Possible Values:
      • date
      • campaign
      • last
      EmailClient Type: Object Title: Automation Segment - EmailClient
      Show properties
      op Type: String Title: Operator Read only: false A member’s status, based on their campaign interactions.
      Possible Values:
      • client_is
      • client_not
      field Type: String Title: Email Client Read only: false The field to segment on.
      Possible Values:
      • email_client
      value Type: String Title: Email Client Read only: false The name of the email client.
      Language Type: Object Title: Automation Segment - Language
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s language is or isn’t set to a specific language.
      Possible Values:
      • is
      • not
      field Type: String Title: Language Read only: false The field to segment on.
      Possible Values:
      • language
      value Type: String Title: Language ID Read only: false A two-letter language identifier.
      Mandrill Type: Object Title: Segment Condition - Mandrill
      Show properties
      op Type: String Title: Segment Operator Read only: false The segment operator.
      field Type: String Title: Segment Field Read only: false The field to segment on.
      MemberRating Type: Object Title: Member Rating Segment - MemberRating
      Show properties
      op Type: String Title: Operator Read only: false Members who have have a rating that is/not exactly a specific number or members who have a rating greater/less than a specific number.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Member Rating Read only: false The field to segment on.
      Possible Values:
      • rating
      value Type: Number Title: Start Rating Read only: false The star rating number to segment on.
      SignupSource Type: Object Title: Signup Source Segment - SignupSource
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s signup source was/was not a particular value.
      Possible Values:
      • source_is
      • source_not
      field Type: String Title: Signup Source Read only: false The field to segment on.
      Possible Values:
      • source
      value Type: String Title: Signup Source Read only: false The signup source.
      SurveyMonkey Type: Object Title: Survey Monkey Segment - SurveyMonkey
      Show properties
      op Type: String Title: Operator Read only: false A member’s status based on whether they have started, completed, not started, or not completed a specific survey.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Survey Monkey Read only: false The field to segment on.
      Possible Values:
      • survey_monkey
      value Type: String Title: Survey ID Read only: false The unique ID of the SurveyMonkey survey.
      VIP Type: Object Title: VIP Segment - VIP
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is or isn’t a VIP.
      Possible Values:
      • member
      • notmember
      field Type: String Title: VIP Read only: false The field to segment on.
      Possible Values:
      • gmonkey
      Interests Type: Object Title: Interests Segment - Interests
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is a part of one, all, or none of the groups.
      Possible Values:
      • interestcontains
      • interestcontainsall
      • interestnotcontains
      field Type: String Title: Interest Group Read only: false The interest group, like “interests-123”
      value Type: Array Title: Segment Value Read only: false An array containing integers, each representing a group id.
      EcommCategory Type: Object Title: Ecomm Category Segment - EcommCategory
      Show properties
      op Type: String Title: Operator Read only: false A member who has purchased from a category or purchased a specific item.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      field Type: String Title: Ecomm Category or Product Read only: false The e-commerce category or product segment field.
      Possible Values:
      • ecomm_cat
      • ecomm_prod
      value Type: String Title: Ecomm Category or Item Read only: false The e-commerce category or item information.
      EcommNumber Type: Object Title: Ecomm Purchased Segment - EcommNumber
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Ecomm Number Read only: false The e-commerce number field to segment on.
      Possible Values:
      • ecomm_spent_avg
      • ecomm_orders
      • ecomm_prod_all
      • ecomm_avg_ord
      value Type: Number Title: Amount Spent Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.
      EcommPurchased Type: Object Title: Ecomm Purchased Segment - EcommPurchased
      Show properties
      op Type: String Title: Operator Read only: false Members who have have (‘member’) or have not (‘notmember’) purchased.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Ecomm Purchased Read only: false The e-commerce purchased field to segment on.
      Possible Values:
      • ecomm_purchased
      EcommSpent Type: Object Title: Ecomm Purchase Segment - EcommSpent
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent more or less than the set value.
      Possible Values:
      • greater
      • less
      field Type: String Title: Ecomm Spent Read only: false The e-commerce spent field to segment on.
      Possible Values:
      • ecomm_spent_one
      • ecomm_spent_all
      value Type: Integer Title: Total Spent Read only: false The total amount a member spent.
      EcommStore Type: Object Title: Ecomm Purchased Store Segment - EcommStore
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not purchased from a specific store.
      Possible Values:
      • is
      • not
      field Type: String Title: Ecomm Store Read only: false The e-commerce store field to segment on.
      Possible Values:
      • ecomm_store
      value Type: String Title: Store ID Read only: false The store id to segment on.
      GoalActivity Type: Object Title: Goal Activity Segment - GoalActivity
      Show properties
      op Type: String Title: Operator Read only: false Whether the website URL is/not exactly, contains/doesn’t contain, starts with/ends with a string.
      Possible Values:
      • is
      • goal_not
      • contains
      • goal_notcontain
      • starts
      • ends
      field Type: String Title: Goal Activity Read only: false The goal activity field to segment on.
      Possible Values:
      • goal
      value Type: String Title: Goal URL Read only: false The URL to check Goal activity against.
      GoalTimestamp Type: Object Title: Goal Timestamp Segment - GoalTimestamp
      Show properties
      op Type: String Title: Operator Read only: false Whether the website activity happened at, after, or before a specific date.
      Possible Values:
      • greater
      • less
      • is
      field Type: String Title: Goal Time Read only: false The goal time field to segment on.
      Possible Values:
      • goal_last_visited
      extra Type: String Title: Date Read only: false The date for the segment, formatted as YYYY-MM-DD.
      value Type: String Title: Event Type Read only: false What type of data to segment on.
      Possible Values:
      • date
      FuzzySegment Type: Object Title: Similar Subscribers Segment Member Segment - FuzzySegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a ‘similar subscribers’ segment.
      Possible Values:
      • fuzzy_is
      • fuzzy_not
      field Type: String Title: Fuzzy Segment Read only: false The fuzzy segment field.
      Possible Values:
      • fuzzy_segment
      value Type: Number Title: Similar Subscribers Segment ID Read only: false The id for the ‘similar subscribers’ segment.
      StaticSegment Type: Object Title: Static Segment Member Segment - StaticSegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a static segment.
      Possible Values:
      • static_is
      • static_not
      field Type: String Title: Static Segment Read only: false The static segment field.
      Possible Values:
      • static_segment
      value Type: Number Title: Static Segment ID Read only: false The id for the static segment.
      IPGeoCountryState Type: Object Title: Location-Based Segment - IPGeoCountryState
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific country or US state.
      Possible Values:
      • ipgeocountry
      • ipgeonotcountry
      • ipgeostate
      • ipgeonotstate
      field Type: String Title: Country State Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: String Title: Country Code or US State Read only: false The two-letter country code or US state abbreviation.
      IPGeoIn Type: Object Title: Geolocation Segment - IPGeoIn
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific geographic region.
      Possible Values:
      • ipgeoin
      • ipgeonotin
      lng Type: String Title: Segment Location Longitude Read only: false The longitude of the target location.
      field Type: String Title: Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      addr Type: String Title: Segment Location Address Read only: false The address of the target location.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      lat Type: String Title: Segment Location Latitude Read only: false The latitude of the target location.
      IPGeoInZip Type: Object Title: US Zip Code Segment - IPGeoInZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific US zip code.
      Possible Values:
      • ipgeoinzip
      field Type: String Title: Location in Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      extra Type: Integer Title: Zip Code Read only: false The zip code to segment on.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      IPGeoUnknown Type: Object Title: Location-Based Segment - IPGeoUnknown
      Show properties
      op Type: String Title: Operator Read only: false Segment members with unknown location information.
      Possible Values:
      • ipgeounknown
      field Type: String Title: Unknown Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      IPGeoZip Type: Object Title: Location-Based Segment - IPGeoZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are or are not in a specific US zip code.
      Possible Values:
      • ipgeoiszip
      • ipgeonotzip
      field Type: String Title: Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: Integer Title: Zip Code Read only: false The 5-digit zip code.
      SocialAge Type: Object Title: Social Profiles Age Segment - SocialAge
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Age Read only: false The social age field to segment on.
      Possible Values:
      • social_age
      value Type: String Title: Age Range Read only: false The age range to segment.
      Possible Values:
      • 18-24
      • 25-34
      • 35-54
      • 55+
      SocialGender Type: Object Title: Social Profiles Gender Segment - SocialGender
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Gender Read only: false The social gender field to segment on.
      Possible Values:
      • social_gender
      value Type: String Title: Social Gender Read only: false The Social Profiles gender to segment.
      Possible Values:
      • male
      • female
      SocialInfluence Type: Object Title: Social Profiles Influence Segment - SocialInfluence
      Show properties
      op Type: String Title: Operator Read only: false Members who have a rating that is/not or greater/less than the rating provided.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Social Influence Read only: false The social influence field to segment on.
      Possible Values:
      • social_influence
      value Type: Number Title: Influence Rating Read only: false The Social Profiles influence rating to segment on.
      SocialNetworkMember Type: Object Title: Social Profiles Social Network Segment - SocialNetworkMember
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not on a specific social network.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Social Network Read only: false The social_network segment field.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter
      • facebook
      • linkedin
      • flickr
      • foursquare
      • lastfm
      • myspace
      • quora
      • vimeo
      • yelp
      • youtube
      SocialNetworkFollow Type: Object Title: Social Profiles Social Network Follow Segment - SocialNetworkFollow
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not following a linked account on a specific social network.
      Possible Values:
      • follow
      • notfollow
      field Type: String Title: Social Network Follow Read only: false The field to segment on.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter_follow
      AddressMerge Type: Object Title: Address/Zip Merge Field Segment - AddressMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value contains, doesn’t contain, is blank, or isn’t blank.
      Possible Values:
      • contains
      • notcontain
      • blank
      • blank_not
      field Type: String Title: Address Merge Read only: false The address merge segment field.
      value Type: String Title: Address Merge Compare Value Read only: false The value to compare.
      ZipMerge Type: Object Title: Address/Zip Merge Field Segment - ZipMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the zip value is in a specific location.
      Possible Values:
      • geoin
      field Type: String Title: Zip Merge Read only: false The zip merge segment field.
      extra Type: String Title: City or Zip Read only: false The city or the zip being used to segment on.
      value Type: String Title: Zip Merge Compare Value Read only: false The value to compare.
      BirthdayMerge Type: Object Title: Birthday Merge Field Segment - BirthdayMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Birthday Merge Read only: false The birthday merge segment field.
      value Type: String Title: Birthday Merge Compare Value Read only: false The value to compare.
      DateMerge Type: Object Title: Date Merge Field Segment - DateMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • less
      • blank
      • blank_not
      field Type: String Title: Date Merge Read only: false The date merge segment field.
      value Type: String Title: Date Merge Compare Value Read only: false The value to compare.
      TextMerge Type: Object Title: Text or Number Merge Field Segment - TextMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      • blank
      • blank_not
      field Type: String Title: Text Merge Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      value Type: String Title: Text Merge Compare Value Read only: false The value to compare.
      SelectMerge Type: Object Title: Dropdown/Radio Merge Field Segment - SelectMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Select Read only: false The select merge segment field.
      value Type: String Title: Select Merge Compare Value Read only: false The value to compare.
      EmailAddress Type: Object Title: Email Segment - EmailAddress
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      field Type: String Title: Email Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      Possible Values:
      • merge0
      • EMAIL
      value Type: String Title: Email Compare Value Read only: false The value to compare the email against.
      list_id Type: String Title: List ID Read only: true The list id.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request GET \
      --url 'https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments/49381' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1047
      Vary: Accept-Encoding
      X-Request-Id: 96d0bf26-f262-4967-a1ce-ef1fa4367b96
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Segments/Instance.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 21:36:09 GMT
      Connection: keep-alive
      
      
      {
        "id": 49381,
        "name": "The jokes that didn't quite make it.",
        "member_count": 1,
        "type": "saved",
        "created_at": "2015-09-16 21:32:12",
        "updated_at": "2015-09-16 21:32:12",
        "options": {
          "conditions": [
            {
              "field": "timestamp_opt",
              "op": "greater",
              "value": "last"
            }
          ]
        },
        "list_id": "57afe96172",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments/49381",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Segments/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Segments/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Segments.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments/49381",
            "method": "DELETE"
          },
          {
            "rel": "update",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments/49381",
            "method": "PATCH",
            "schema": "https://api.mailchimp.com/schema/3.0/Lists/Segments/Instance.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • Update a segment

      PATCH /lists/{list_id}/segments/{segment_id}

      Update a specific segment in a list.

      Path parameters

      list_id The unique id for the list.
      segment_id The unique id for the segment.

      Request body parameters

      name Type: String Title: Segment Name Read only: false The name of the segment.
      static_segment Type: Array Title: Static Segment Read only: false 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.
      options Type: Object Title: Conditions Read only: false The conditions of the segment. Static and fuzzy segments don’t have conditions.
      Show properties
      match Type: String Title: Match Read only: false Match type.
      Possible Values:
      • any
      • all
      conditions Type: Array Title: Segment Conditions Read only: false An array of segment conditions.
      Show items
      condition_type Type: string Title: Segment Type The type of segment, for example: date, language, Mandrill, static, and more.
      Segment Type
      Aim Type: Object Title: Automation Segment - Aim
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on their campaign interaction.
      Possible Values:
      • open
      • click
      • sent
      • noopen
      • noclick
      • nosent
      field Type: String Title: Aim Read only: false The segment field, ‘aim’.
      Possible Values:
      • aim
      value Type: String Title: Campaign Web ID Read only: false Either the web id value for a specific campaign or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Automation Type: Object Title: Automation Segment - Automation
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on where they are in an Automation workflow.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Automation Read only: false The field to segment on.
      Possible Values:
      • automation
      value Type: String Title: Automation Web ID Read only: false The web id for the Automation workflow to segment on.
      CampaignPoll Type: Object Title: Poll Activity Segment - CampaignPoll
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not interacted with a specific poll in a MailChimp email.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Campaign Poll Read only: false The field to segment on.
      Possible Values:
      • poll
      value Type: Number Title: Poll ID Read only: false The id for the poll.
      Conversation Type: Object Title: Automation Segment - Conversation
      Show properties
      op Type: String Title: Operator Read only: false The status of a member’s interaction with a conversation.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Conversations Read only: false The field to segment on.
      Possible Values:
      • conversation
      value Type: String Title: Campaign Web ID Read only: false The web id value for a specific campaign, or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Date Type: Object Title: Date Segment - Date
      Show properties
      op Type: String Title: Operator Read only: false When the event took place.
      Possible Values:
      • greater
      • less
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Date Read only: false The date segment field.
      Possible Values:
      • timestamp_opt
      • info_changed
      • ecomm_date
      extra Type: String Title: Date Read only: false When segmenting on ‘date’ or ‘campaign’, the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.
      value Type: String Title: Event Type Read only: false What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.
      Possible Values:
      • date
      • campaign
      • last
      EmailClient Type: Object Title: Automation Segment - EmailClient
      Show properties
      op Type: String Title: Operator Read only: false A member’s status, based on their campaign interactions.
      Possible Values:
      • client_is
      • client_not
      field Type: String Title: Email Client Read only: false The field to segment on.
      Possible Values:
      • email_client
      value Type: String Title: Email Client Read only: false The name of the email client.
      Language Type: Object Title: Automation Segment - Language
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s language is or isn’t set to a specific language.
      Possible Values:
      • is
      • not
      field Type: String Title: Language Read only: false The field to segment on.
      Possible Values:
      • language
      value Type: String Title: Language ID Read only: false A two-letter language identifier.
      Mandrill Type: Object Title: Segment Condition - Mandrill
      Show properties
      op Type: String Title: Segment Operator Read only: false The segment operator.
      field Type: String Title: Segment Field Read only: false The field to segment on.
      MemberRating Type: Object Title: Member Rating Segment - MemberRating
      Show properties
      op Type: String Title: Operator Read only: false Members who have have a rating that is/not exactly a specific number or members who have a rating greater/less than a specific number.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Member Rating Read only: false The field to segment on.
      Possible Values:
      • rating
      value Type: Number Title: Start Rating Read only: false The star rating number to segment on.
      SignupSource Type: Object Title: Signup Source Segment - SignupSource
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s signup source was/was not a particular value.
      Possible Values:
      • source_is
      • source_not
      field Type: String Title: Signup Source Read only: false The field to segment on.
      Possible Values:
      • source
      value Type: String Title: Signup Source Read only: false The signup source.
      SurveyMonkey Type: Object Title: Survey Monkey Segment - SurveyMonkey
      Show properties
      op Type: String Title: Operator Read only: false A member’s status based on whether they have started, completed, not started, or not completed a specific survey.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Survey Monkey Read only: false The field to segment on.
      Possible Values:
      • survey_monkey
      value Type: String Title: Survey ID Read only: false The unique ID of the SurveyMonkey survey.
      VIP Type: Object Title: VIP Segment - VIP
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is or isn’t a VIP.
      Possible Values:
      • member
      • notmember
      field Type: String Title: VIP Read only: false The field to segment on.
      Possible Values:
      • gmonkey
      Interests Type: Object Title: Interests Segment - Interests
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is a part of one, all, or none of the groups.
      Possible Values:
      • interestcontains
      • interestcontainsall
      • interestnotcontains
      field Type: String Title: Interest Group Read only: false The interest group, like “interests-123”
      value Type: Array Title: Segment Value Read only: false An array containing integers, each representing a group id.
      EcommCategory Type: Object Title: Ecomm Category Segment - EcommCategory
      Show properties
      op Type: String Title: Operator Read only: false A member who has purchased from a category or purchased a specific item.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      field Type: String Title: Ecomm Category or Product Read only: false The e-commerce category or product segment field.
      Possible Values:
      • ecomm_cat
      • ecomm_prod
      value Type: String Title: Ecomm Category or Item Read only: false The e-commerce category or item information.
      EcommNumber Type: Object Title: Ecomm Purchased Segment - EcommNumber
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Ecomm Number Read only: false The e-commerce number field to segment on.
      Possible Values:
      • ecomm_spent_avg
      • ecomm_orders
      • ecomm_prod_all
      • ecomm_avg_ord
      value Type: Number Title: Amount Spent Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.
      EcommPurchased Type: Object Title: Ecomm Purchased Segment - EcommPurchased
      Show properties
      op Type: String Title: Operator Read only: false Members who have have (‘member’) or have not (‘notmember’) purchased.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Ecomm Purchased Read only: false The e-commerce purchased field to segment on.
      Possible Values:
      • ecomm_purchased
      EcommSpent Type: Object Title: Ecomm Purchase Segment - EcommSpent
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent more or less than the set value.
      Possible Values:
      • greater
      • less
      field Type: String Title: Ecomm Spent Read only: false The e-commerce spent field to segment on.
      Possible Values:
      • ecomm_spent_one
      • ecomm_spent_all
      value Type: Integer Title: Total Spent Read only: false The total amount a member spent.
      EcommStore Type: Object Title: Ecomm Purchased Store Segment - EcommStore
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not purchased from a specific store.
      Possible Values:
      • is
      • not
      field Type: String Title: Ecomm Store Read only: false The e-commerce store field to segment on.
      Possible Values:
      • ecomm_store
      value Type: String Title: Store ID Read only: false The store id to segment on.
      GoalActivity Type: Object Title: Goal Activity Segment - GoalActivity
      Show properties
      op Type: String Title: Operator Read only: false Whether the website URL is/not exactly, contains/doesn’t contain, starts with/ends with a string.
      Possible Values:
      • is
      • goal_not
      • contains
      • goal_notcontain
      • starts
      • ends
      field Type: String Title: Goal Activity Read only: false The goal activity field to segment on.
      Possible Values:
      • goal
      value Type: String Title: Goal URL Read only: false The URL to check Goal activity against.
      GoalTimestamp Type: Object Title: Goal Timestamp Segment - GoalTimestamp
      Show properties
      op Type: String Title: Operator Read only: false Whether the website activity happened at, after, or before a specific date.
      Possible Values:
      • greater
      • less
      • is
      field Type: String Title: Goal Time Read only: false The goal time field to segment on.
      Possible Values:
      • goal_last_visited
      extra Type: String Title: Date Read only: false The date for the segment, formatted as YYYY-MM-DD.
      value Type: String Title: Event Type Read only: false What type of data to segment on.
      Possible Values:
      • date
      FuzzySegment Type: Object Title: Similar Subscribers Segment Member Segment - FuzzySegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a ‘similar subscribers’ segment.
      Possible Values:
      • fuzzy_is
      • fuzzy_not
      field Type: String Title: Fuzzy Segment Read only: false The fuzzy segment field.
      Possible Values:
      • fuzzy_segment
      value Type: Number Title: Similar Subscribers Segment ID Read only: false The id for the ‘similar subscribers’ segment.
      StaticSegment Type: Object Title: Static Segment Member Segment - StaticSegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a static segment.
      Possible Values:
      • static_is
      • static_not
      field Type: String Title: Static Segment Read only: false The static segment field.
      Possible Values:
      • static_segment
      value Type: Number Title: Static Segment ID Read only: false The id for the static segment.
      IPGeoCountryState Type: Object Title: Location-Based Segment - IPGeoCountryState
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific country or US state.
      Possible Values:
      • ipgeocountry
      • ipgeonotcountry
      • ipgeostate
      • ipgeonotstate
      field Type: String Title: Country State Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: String Title: Country Code or US State Read only: false The two-letter country code or US state abbreviation.
      IPGeoIn Type: Object Title: Geolocation Segment - IPGeoIn
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific geographic region.
      Possible Values:
      • ipgeoin
      • ipgeonotin
      lng Type: String Title: Segment Location Longitude Read only: false The longitude of the target location.
      field Type: String Title: Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      addr Type: String Title: Segment Location Address Read only: false The address of the target location.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      lat Type: String Title: Segment Location Latitude Read only: false The latitude of the target location.
      IPGeoInZip Type: Object Title: US Zip Code Segment - IPGeoInZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific US zip code.
      Possible Values:
      • ipgeoinzip
      field Type: String Title: Location in Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      extra Type: Integer Title: Zip Code Read only: false The zip code to segment on.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      IPGeoUnknown Type: Object Title: Location-Based Segment - IPGeoUnknown
      Show properties
      op Type: String Title: Operator Read only: false Segment members with unknown location information.
      Possible Values:
      • ipgeounknown
      field Type: String Title: Unknown Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      IPGeoZip Type: Object Title: Location-Based Segment - IPGeoZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are or are not in a specific US zip code.
      Possible Values:
      • ipgeoiszip
      • ipgeonotzip
      field Type: String Title: Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: Integer Title: Zip Code Read only: false The 5-digit zip code.
      SocialAge Type: Object Title: Social Profiles Age Segment - SocialAge
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Age Read only: false The social age field to segment on.
      Possible Values:
      • social_age
      value Type: String Title: Age Range Read only: false The age range to segment.
      Possible Values:
      • 18-24
      • 25-34
      • 35-54
      • 55+
      SocialGender Type: Object Title: Social Profiles Gender Segment - SocialGender
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Gender Read only: false The social gender field to segment on.
      Possible Values:
      • social_gender
      value Type: String Title: Social Gender Read only: false The Social Profiles gender to segment.
      Possible Values:
      • male
      • female
      SocialInfluence Type: Object Title: Social Profiles Influence Segment - SocialInfluence
      Show properties
      op Type: String Title: Operator Read only: false Members who have a rating that is/not or greater/less than the rating provided.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Social Influence Read only: false The social influence field to segment on.
      Possible Values:
      • social_influence
      value Type: Number Title: Influence Rating Read only: false The Social Profiles influence rating to segment on.
      SocialNetworkMember Type: Object Title: Social Profiles Social Network Segment - SocialNetworkMember
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not on a specific social network.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Social Network Read only: false The social_network segment field.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter
      • facebook
      • linkedin
      • flickr
      • foursquare
      • lastfm
      • myspace
      • quora
      • vimeo
      • yelp
      • youtube
      SocialNetworkFollow Type: Object Title: Social Profiles Social Network Follow Segment - SocialNetworkFollow
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not following a linked account on a specific social network.
      Possible Values:
      • follow
      • notfollow
      field Type: String Title: Social Network Follow Read only: false The field to segment on.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter_follow
      AddressMerge Type: Object Title: Address/Zip Merge Field Segment - AddressMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value contains, doesn’t contain, is blank, or isn’t blank.
      Possible Values:
      • contains
      • notcontain
      • blank
      • blank_not
      field Type: String Title: Address Merge Read only: false The address merge segment field.
      value Type: String Title: Address Merge Compare Value Read only: false The value to compare.
      ZipMerge Type: Object Title: Address/Zip Merge Field Segment - ZipMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the zip value is in a specific location.
      Possible Values:
      • geoin
      field Type: String Title: Zip Merge Read only: false The zip merge segment field.
      extra Type: String Title: City or Zip Read only: false The city or the zip being used to segment on.
      value Type: String Title: Zip Merge Compare Value Read only: false The value to compare.
      BirthdayMerge Type: Object Title: Birthday Merge Field Segment - BirthdayMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Birthday Merge Read only: false The birthday merge segment field.
      value Type: String Title: Birthday Merge Compare Value Read only: false The value to compare.
      DateMerge Type: Object Title: Date Merge Field Segment - DateMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • less
      • blank
      • blank_not
      field Type: String Title: Date Merge Read only: false The date merge segment field.
      value Type: String Title: Date Merge Compare Value Read only: false The value to compare.
      TextMerge Type: Object Title: Text or Number Merge Field Segment - TextMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      • blank
      • blank_not
      field Type: String Title: Text Merge Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      value Type: String Title: Text Merge Compare Value Read only: false The value to compare.
      SelectMerge Type: Object Title: Dropdown/Radio Merge Field Segment - SelectMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Select Read only: false The select merge segment field.
      value Type: String Title: Select Merge Compare Value Read only: false The value to compare.
      EmailAddress Type: Object Title: Email Segment - EmailAddress
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      field Type: String Title: Email Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      Possible Values:
      • merge0
      • EMAIL
      value Type: String Title: Email Compare Value Read only: false The value to compare the email against.

      Response body parameters

      id Type: Integer Title: Segment ID Read only: true The unique id for the segment.
      name Type: String Title: Segment Name Read only: false The name of the segment.
      member_count Type: Integer Title: Member Count Read only: true The number of active subscribers currently included in the segment.
      type Type: String Title: Type Read only: true The type of segment.
      Possible Values:
      • saved
      • static
      • fuzzy
      created_at Type: String Title: Date Created Read only: true The date and time the segment was created.
      updated_at Type: String Title: Date Updated Read only: true The date and time the segment was last updated.
      options Type: Object Title: Conditions Read only: false The conditions of the segment. Static and fuzzy segments don’t have conditions.
      Show properties
      match Type: String Title: Match Read only: false Match type.
      Possible Values:
      • any
      • all
      conditions Type: Array Title: Segment Conditions Read only: false An array of segment conditions.
      Show items
      condition_type Type: string Title: Segment Type The type of segment, for example: date, language, Mandrill, static, and more.
      Segment Type
      Aim Type: Object Title: Automation Segment - Aim
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on their campaign interaction.
      Possible Values:
      • open
      • click
      • sent
      • noopen
      • noclick
      • nosent
      field Type: String Title: Aim Read only: false The segment field, ‘aim’.
      Possible Values:
      • aim
      value Type: String Title: Campaign Web ID Read only: false Either the web id value for a specific campaign or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Automation Type: Object Title: Automation Segment - Automation
      Show properties
      op Type: String Title: Operator Read only: false The member’s status, based on where they are in an Automation workflow.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Automation Read only: false The field to segment on.
      Possible Values:
      • automation
      value Type: String Title: Automation Web ID Read only: false The web id for the Automation workflow to segment on.
      CampaignPoll Type: Object Title: Poll Activity Segment - CampaignPoll
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not interacted with a specific poll in a MailChimp email.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Campaign Poll Read only: false The field to segment on.
      Possible Values:
      • poll
      value Type: Number Title: Poll ID Read only: false The id for the poll.
      Conversation Type: Object Title: Automation Segment - Conversation
      Show properties
      op Type: String Title: Operator Read only: false The status of a member’s interaction with a conversation.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Conversations Read only: false The field to segment on.
      Possible Values:
      • conversation
      value Type: String Title: Campaign Web ID Read only: false The web id value for a specific campaign, or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
      Date Type: Object Title: Date Segment - Date
      Show properties
      op Type: String Title: Operator Read only: false When the event took place.
      Possible Values:
      • greater
      • less
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Date Read only: false The date segment field.
      Possible Values:
      • timestamp_opt
      • info_changed
      • ecomm_date
      extra Type: String Title: Date Read only: false When segmenting on ‘date’ or ‘campaign’, the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.
      value Type: String Title: Event Type Read only: false What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.
      Possible Values:
      • date
      • campaign
      • last
      EmailClient Type: Object Title: Automation Segment - EmailClient
      Show properties
      op Type: String Title: Operator Read only: false A member’s status, based on their campaign interactions.
      Possible Values:
      • client_is
      • client_not
      field Type: String Title: Email Client Read only: false The field to segment on.
      Possible Values:
      • email_client
      value Type: String Title: Email Client Read only: false The name of the email client.
      Language Type: Object Title: Automation Segment - Language
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s language is or isn’t set to a specific language.
      Possible Values:
      • is
      • not
      field Type: String Title: Language Read only: false The field to segment on.
      Possible Values:
      • language
      value Type: String Title: Language ID Read only: false A two-letter language identifier.
      Mandrill Type: Object Title: Segment Condition - Mandrill
      Show properties
      op Type: String Title: Segment Operator Read only: false The segment operator.
      field Type: String Title: Segment Field Read only: false The field to segment on.
      MemberRating Type: Object Title: Member Rating Segment - MemberRating
      Show properties
      op Type: String Title: Operator Read only: false Members who have have a rating that is/not exactly a specific number or members who have a rating greater/less than a specific number.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Member Rating Read only: false The field to segment on.
      Possible Values:
      • rating
      value Type: Number Title: Start Rating Read only: false The star rating number to segment on.
      SignupSource Type: Object Title: Signup Source Segment - SignupSource
      Show properties
      op Type: String Title: Operator Read only: false Whether the member’s signup source was/was not a particular value.
      Possible Values:
      • source_is
      • source_not
      field Type: String Title: Signup Source Read only: false The field to segment on.
      Possible Values:
      • source
      value Type: String Title: Signup Source Read only: false The signup source.
      SurveyMonkey Type: Object Title: Survey Monkey Segment - SurveyMonkey
      Show properties
      op Type: String Title: Operator Read only: false A member’s status based on whether they have started, completed, not started, or not completed a specific survey.
      Possible Values:
      • started
      • completed
      • not_started
      • not_completed
      field Type: String Title: Survey Monkey Read only: false The field to segment on.
      Possible Values:
      • survey_monkey
      value Type: String Title: Survey ID Read only: false The unique ID of the SurveyMonkey survey.
      VIP Type: Object Title: VIP Segment - VIP
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is or isn’t a VIP.
      Possible Values:
      • member
      • notmember
      field Type: String Title: VIP Read only: false The field to segment on.
      Possible Values:
      • gmonkey
      Interests Type: Object Title: Interests Segment - Interests
      Show properties
      op Type: String Title: Operator Read only: false Whether the member is a part of one, all, or none of the groups.
      Possible Values:
      • interestcontains
      • interestcontainsall
      • interestnotcontains
      field Type: String Title: Interest Group Read only: false The interest group, like “interests-123”
      value Type: Array Title: Segment Value Read only: false An array containing integers, each representing a group id.
      EcommCategory Type: Object Title: Ecomm Category Segment - EcommCategory
      Show properties
      op Type: String Title: Operator Read only: false A member who has purchased from a category or purchased a specific item.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      field Type: String Title: Ecomm Category or Product Read only: false The e-commerce category or product segment field.
      Possible Values:
      • ecomm_cat
      • ecomm_prod
      value Type: String Title: Ecomm Category or Item Read only: false The e-commerce category or item information.
      EcommNumber Type: Object Title: Ecomm Purchased Segment - EcommNumber
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Ecomm Number Read only: false The e-commerce number field to segment on.
      Possible Values:
      • ecomm_spent_avg
      • ecomm_orders
      • ecomm_prod_all
      • ecomm_avg_ord
      value Type: Number Title: Amount Spent Read only: false Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.
      EcommPurchased Type: Object Title: Ecomm Purchased Segment - EcommPurchased
      Show properties
      op Type: String Title: Operator Read only: false Members who have have (‘member’) or have not (‘notmember’) purchased.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Ecomm Purchased Read only: false The e-commerce purchased field to segment on.
      Possible Values:
      • ecomm_purchased
      EcommSpent Type: Object Title: Ecomm Purchase Segment - EcommSpent
      Show properties
      op Type: String Title: Operator Read only: false Members who have spent more or less than the set value.
      Possible Values:
      • greater
      • less
      field Type: String Title: Ecomm Spent Read only: false The e-commerce spent field to segment on.
      Possible Values:
      • ecomm_spent_one
      • ecomm_spent_all
      value Type: Integer Title: Total Spent Read only: false The total amount a member spent.
      EcommStore Type: Object Title: Ecomm Purchased Store Segment - EcommStore
      Show properties
      op Type: String Title: Operator Read only: false Members who have or have not purchased from a specific store.
      Possible Values:
      • is
      • not
      field Type: String Title: Ecomm Store Read only: false The e-commerce store field to segment on.
      Possible Values:
      • ecomm_store
      value Type: String Title: Store ID Read only: false The store id to segment on.
      GoalActivity Type: Object Title: Goal Activity Segment - GoalActivity
      Show properties
      op Type: String Title: Operator Read only: false Whether the website URL is/not exactly, contains/doesn’t contain, starts with/ends with a string.
      Possible Values:
      • is
      • goal_not
      • contains
      • goal_notcontain
      • starts
      • ends
      field Type: String Title: Goal Activity Read only: false The goal activity field to segment on.
      Possible Values:
      • goal
      value Type: String Title: Goal URL Read only: false The URL to check Goal activity against.
      GoalTimestamp Type: Object Title: Goal Timestamp Segment - GoalTimestamp
      Show properties
      op Type: String Title: Operator Read only: false Whether the website activity happened at, after, or before a specific date.
      Possible Values:
      • greater
      • less
      • is
      field Type: String Title: Goal Time Read only: false The goal time field to segment on.
      Possible Values:
      • goal_last_visited
      extra Type: String Title: Date Read only: false The date for the segment, formatted as YYYY-MM-DD.
      value Type: String Title: Event Type Read only: false What type of data to segment on.
      Possible Values:
      • date
      FuzzySegment Type: Object Title: Similar Subscribers Segment Member Segment - FuzzySegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a ‘similar subscribers’ segment.
      Possible Values:
      • fuzzy_is
      • fuzzy_not
      field Type: String Title: Fuzzy Segment Read only: false The fuzzy segment field.
      Possible Values:
      • fuzzy_segment
      value Type: Number Title: Similar Subscribers Segment ID Read only: false The id for the ‘similar subscribers’ segment.
      StaticSegment Type: Object Title: Static Segment Member Segment - StaticSegment
      Show properties
      op Type: String Title: Operator Read only: false Members who are/are not apart of a static segment.
      Possible Values:
      • static_is
      • static_not
      field Type: String Title: Static Segment Read only: false The static segment field.
      Possible Values:
      • static_segment
      value Type: Number Title: Static Segment ID Read only: false The id for the static segment.
      IPGeoCountryState Type: Object Title: Location-Based Segment - IPGeoCountryState
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific country or US state.
      Possible Values:
      • ipgeocountry
      • ipgeonotcountry
      • ipgeostate
      • ipgeonotstate
      field Type: String Title: Country State Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: String Title: Country Code or US State Read only: false The two-letter country code or US state abbreviation.
      IPGeoIn Type: Object Title: Geolocation Segment - IPGeoIn
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific geographic region.
      Possible Values:
      • ipgeoin
      • ipgeonotin
      lng Type: String Title: Segment Location Longitude Read only: false The longitude of the target location.
      field Type: String Title: Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      addr Type: String Title: Segment Location Address Read only: false The address of the target location.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      lat Type: String Title: Segment Location Latitude Read only: false The latitude of the target location.
      IPGeoInZip Type: Object Title: US Zip Code Segment - IPGeoInZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are in a specific US zip code.
      Possible Values:
      • ipgeoinzip
      field Type: String Title: Location in Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      extra Type: Integer Title: Zip Code Read only: false The zip code to segment on.
      value Type: Integer Title: Target Location Radius Read only: false The radius of the target location.
      IPGeoUnknown Type: Object Title: Location-Based Segment - IPGeoUnknown
      Show properties
      op Type: String Title: Operator Read only: false Segment members with unknown location information.
      Possible Values:
      • ipgeounknown
      field Type: String Title: Unknown Location Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      IPGeoZip Type: Object Title: Location-Based Segment - IPGeoZip
      Show properties
      op Type: String Title: Operator Read only: false Segment members who are or are not in a specific US zip code.
      Possible Values:
      • ipgeoiszip
      • ipgeonotzip
      field Type: String Title: Zip Read only: false The field to segment on.
      Possible Values:
      • ipgeo
      value Type: Integer Title: Zip Code Read only: false The 5-digit zip code.
      SocialAge Type: Object Title: Social Profiles Age Segment - SocialAge
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Age Read only: false The social age field to segment on.
      Possible Values:
      • social_age
      value Type: String Title: Age Range Read only: false The age range to segment.
      Possible Values:
      • 18-24
      • 25-34
      • 35-54
      • 55+
      SocialGender Type: Object Title: Social Profiles Gender Segment - SocialGender
      Show properties
      op Type: String Title: Operator Read only: false Members who do or don’t match the exact criteria listed.
      Possible Values:
      • is
      • not
      field Type: String Title: Social Gender Read only: false The social gender field to segment on.
      Possible Values:
      • social_gender
      value Type: String Title: Social Gender Read only: false The Social Profiles gender to segment.
      Possible Values:
      • male
      • female
      SocialInfluence Type: Object Title: Social Profiles Influence Segment - SocialInfluence
      Show properties
      op Type: String Title: Operator Read only: false Members who have a rating that is/not or greater/less than the rating provided.
      Possible Values:
      • is
      • not
      • greater
      • less
      field Type: String Title: Social Influence Read only: false The social influence field to segment on.
      Possible Values:
      • social_influence
      value Type: Number Title: Influence Rating Read only: false The Social Profiles influence rating to segment on.
      SocialNetworkMember Type: Object Title: Social Profiles Social Network Segment - SocialNetworkMember
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not on a specific social network.
      Possible Values:
      • member
      • notmember
      field Type: String Title: Social Network Read only: false The social_network segment field.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter
      • facebook
      • linkedin
      • flickr
      • foursquare
      • lastfm
      • myspace
      • quora
      • vimeo
      • yelp
      • youtube
      SocialNetworkFollow Type: Object Title: Social Profiles Social Network Follow Segment - SocialNetworkFollow
      Show properties
      op Type: String Title: Operator Read only: false Members who are or are not following a linked account on a specific social network.
      Possible Values:
      • follow
      • notfollow
      field Type: String Title: Social Network Follow Read only: false The field to segment on.
      Possible Values:
      • social_network
      value Type: String Title: Social Network Read only: false The social network to segment on.
      Possible Values:
      • twitter_follow
      AddressMerge Type: Object Title: Address/Zip Merge Field Segment - AddressMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value contains, doesn’t contain, is blank, or isn’t blank.
      Possible Values:
      • contains
      • notcontain
      • blank
      • blank_not
      field Type: String Title: Address Merge Read only: false The address merge segment field.
      value Type: String Title: Address Merge Compare Value Read only: false The value to compare.
      ZipMerge Type: Object Title: Address/Zip Merge Field Segment - ZipMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the zip value is in a specific location.
      Possible Values:
      • geoin
      field Type: String Title: Zip Merge Read only: false The zip merge segment field.
      extra Type: String Title: City or Zip Read only: false The city or the zip being used to segment on.
      value Type: String Title: Zip Merge Compare Value Read only: false The value to compare.
      BirthdayMerge Type: Object Title: Birthday Merge Field Segment - BirthdayMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Birthday Merge Read only: false The birthday merge segment field.
      value Type: String Title: Birthday Merge Compare Value Read only: false The value to compare.
      DateMerge Type: Object Title: Date Merge Field Segment - DateMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • less
      • blank
      • blank_not
      field Type: String Title: Date Merge Read only: false The date merge segment field.
      value Type: String Title: Date Merge Compare Value Read only: false The value to compare.
      TextMerge Type: Object Title: Text or Number Merge Field Segment - TextMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      • blank
      • blank_not
      field Type: String Title: Text Merge Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      value Type: String Title: Text Merge Compare Value Read only: false The value to compare.
      SelectMerge Type: Object Title: Dropdown/Radio Merge Field Segment - SelectMerge
      Show properties
      op Type: String Title: Operator Read only: false Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
      Possible Values:
      • is
      • not
      • blank
      • blank_not
      field Type: String Title: Select Read only: false The select merge segment field.
      value Type: String Title: Select Merge Compare Value Read only: false The value to compare.
      EmailAddress Type: Object Title: Email Segment - EmailAddress
      Show properties
      op Type: String Title: Operator Read only: false Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
      Possible Values:
      • is
      • not
      • contains
      • notcontain
      • starts
      • ends
      • greater
      • less
      field Type: String Title: Email Read only: false The segment field, one of ‘merge0’ or ‘EMAIL’.
      Possible Values:
      • merge0
      • EMAIL
      value Type: String Title: Email Compare Value Read only: false The value to compare the email against.
      list_id Type: String Title: List ID Read only: true The list id.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request PATCH \
      --url 'https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments/49381' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"name":"What'\''s your favorite Freddie hat?"}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1044
      Vary: Accept-Encoding
      X-Request-Id: 7ece6bc2-e57e-424d-8f98-b3ce7210628f
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Segments/Instance.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 21:38:25 GMT
      Connection: keep-alive
      
      
      {
        "id": 49381,
        "name": "What's your favorite Freddie hat?",
        "member_count": 1,
        "type": "saved",
        "created_at": "2015-09-16 21:32:12",
        "updated_at": "2015-09-16 21:38:25",
        "options": {
          "conditions": [
            {
              "field": "timestamp_opt",
              "op": "greater",
              "value": "last"
            }
          ]
        },
        "list_id": "57afe96172",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments/49381",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Segments/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Segments/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Segments.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments/49381",
            "method": "DELETE"
          },
          {
            "rel": "update",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments/49381",
            "method": "PATCH",
            "schema": "https://api.mailchimp.com/schema/3.0/Lists/Segments/Instance.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • Delete a segment

      DELETE /lists/{list_id}/segments/{segment_id}

      Delete a specific segment in a list.

      Path parameters

      list_id The unique id for the list.
      segment_id The unique id for the segment.

      Example request

      
      curl --request DELETE \
      --url 'https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/segments/445' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 204 No Content
      Server: nginx
      Date: Thu, 12 May 2016 14:05:04 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 0
      Connection: keep-alive
      X-Request-Id: 1da966ab-8614-4a57-bbb3-1516815828ca
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.