Emails

Manage individual emails in an Automation workflow.

Subresources

Available methods

    • GET /automations/{workflow_id}/emails Get a list of automated emails in a workflow
      GET /automations/{workflow_id}/emails/{workflow_email_id} Get information about a specific workflow email

      Get a list of automated emails in a workflow

      GET /automations/{workflow_id}/emails

      Get a summary of the emails in an Automation workflow.

      Path parameters

      workflow_id The unique id for the Automation workflow.

      Response body parameters

      emails Type: Array Title: Emails Read only: false An array of objects, each representing an email in an Automation workflow.
      Show properties
      id Type: String Title: Automation Email ID Read only: true A string that uniquely identifies the Automation email.
      workflow_id Type: String Title: Workflow ID Read only: true A string that uniquely identifies an Automation workflow.
      position Type: Integer Title: Email Position Read only: true The position of an Automation email in a workflow.
      delay Type: Object Title: Automation Delay Read only: false The delay settings for an Automation email.
      Show properties
      amount Type: Integer Title: Delay Amount Read only: false The delay amount for an Automation email.
      type Type: String Title: Delay Type Read only: false The type of delay for an Automation email.
      Possible Values:
      • now
      • day
      • hour
      • week
      direction Type: String Title: Delay Direction Read only: false Whether the delay settings describe before or after the delay action of an Automation email.
      Possible Values:
      • before
      • after
      action Type: String Title: Delay Action Read only: false The action that triggers the delay of an Automation email.
      Possible Values:
      • previous_campaign_sent
      • previous_campaign_opened
      • previous_campaign_not_opened
      • previous_campaign_clicked_any
      • previous_campaign_not_clicked_any
      • previous_campaign_specific_clicked
      • ecomm_bought_any
      • ecomm_bought_product
      • ecomm_bought_category
      • ecomm_not_bought_any
      • ecomm_abandoned_cart
      • campaign_sent
      • opened_email
      • not_opened_email
      • clicked_email
      • not_clicked_email
      • campaign_specific_clicked
      • manual
      • signup
      • merge_changed
      • group_add
      • group_remove
      • mandrill_sent
      • mandrill_opened
      • mandrill_clicked
      • mandrill_any
      • api
      • goal
      • annual
      • birthday
      • date
      • date_added
      action_description Type: String Title: Delay Action Description Read only: true The user-friendly description of the action that triggers an Automation email.
      full_description Type: String Title: Full Delay Description Read only: true The user-friendly description of the delay and trigger action settings for an Automation email.
      create_time Type: String Title: Create Time Read only: true The date and time the campaign was created.
      start_time Type: String Title: Start Time Read only: true The date and time the campaign was started.
      archive_url Type: String Title: Archive URL Read only: true The link to the campaign’s archive version.
      status Type: String Title: Campaign Status Read only: true The current status of the campaign.
      Possible Values:
      • save
      • paused
      • sending
      emails_sent Type: Integer Title: Emails Sent Read only: true The total number of emails sent for this campaign.
      send_time Type: String Title: Send Time Read only: true The date and time a campaign was sent.
      content_type Type: String Title: Content Type Read only: true How the campaign’s content is put together (‘template’, ‘drag_and_drop’, ‘html’, ‘url’).
      recipients Type: Object Title: List Read only: false List settings for the campaign.
      Show properties
      list_id Type: String Title: List ID Read only: false The unique list id.
      segment_opts Type: Object Title: Segment Options Read only: false An object representing all segmentation options.
      Show properties
      saved_segment_id Type: Integer Title: Saved Segment ID Read only: false The id for an existing saved segment.
      match Type: String Title: Match Type Read only: false Segment match type.
      Possible Values:
      • any
      • all
      conditions Type: Array Title: No Title Read only: false No Description
      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.
      settings Type: Object Title: Campaign Settings Read only: false Settings for the campaign including the email subject, from name, and from email address.
      Show properties
      subject_line Type: String Title: Campaign Subject Line Read only: false The subject line for the campaign.
      title Type: String Title: Campaign Title Read only: false The title of the campaign.
      from_name Type: String Title: From Name Read only: false The ‘from’ name on the campaign (not an email address).
      reply_to Type: String Title: Reply To Address Read only: false The reply-to email address for the campaign.
      authenticate Type: Boolean Title: Authentication Read only: false Whether MailChimp authenticated the campaign. Defaults to true.
      auto_footer Type: Boolean Title: Auto-Footer Read only: false Automatically append MailChimp’s default footer to the campaign.
      inline_css Type: Boolean Title: Inline CSS Read only: false Automatically inline the CSS included with the campaign content.
      auto_tweet Type: Boolean Title: Auto-Tweet Read only: false Automatically tweet a link to the campaign archive page when the campaign is sent.
      auto_fb_post Type: Array Title: Auto Post to Facebook Read only: false An array of Facebook page ids to auto-post to.
      fb_comments Type: Boolean Title: Facebook Comments Read only: false Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true.
      template_id Type: Integer Title: Template ID Read only: false The id for the template used in this campaign.
      drag_and_drop Type: Boolean Title: Drag And Drop Campaign Read only: true Whether the campaign uses the drag-and-drop editor.
      tracking Type: Object Title: Campaign Tracking Options Read only: false The tracking options for a campaign.
      Show properties
      opens Type: Boolean Title: Opens Read only: false Whether to track opens. Defaults to true.
      html_clicks Type: Boolean Title: HTML Click Tracking Read only: false Whether to track clicks in the HTML version of the campaign. Defaults to true.
      text_clicks Type: Boolean Title: Plain-Text Click Tracking Read only: false Whether to track clicks in the plain-text version of the campaign. Defaults to true.
      goal_tracking Type: Boolean Title: MailChimp Goal Tracking Read only: false Whether to enable Goal tracking.
      ecomm360 Type: Boolean Title: E-commerce Tracking Read only: false Whether to enable eCommerce360 tracking.
      google_analytics Type: String Title: Google Analytics Tracking Read only: false The custom slug for Google Analytics tracking (max of 50 bytes).
      clicktale Type: String Title: ClickTale Analytics Tracking Read only: false The custom slug for Click Tale tracking (max of 50 bytes).
      salesforce Type: Object Title: Salesforce CRM Tracking Read only: false Salesforce tracking options for a campaign. Must be using MailChimp’s built-in Salesforce integration.
      Show properties
      campaign Type: Boolean Title: Salesforce Campaign Read only: false Create a campaign in a connected Salesforce account.
      notes Type: Boolean Title: Salesforce Note Read only: false Update contact notes for a campaign based on a subscriber’s email address.
      capsule Type: Object Title: Capsule CRM Tracking Read only: false Capsule tracking option for a campaign. Must be using MailChimp’s built-in Capsule integration.
      Show properties
      notes Type: Boolean Title: Capsule Note Read only: false Update contact notes for a campaign based on a subscriber’s email address.
      social_card Type: Object Title: Campaign Social Card Read only: false The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more.
      Show properties
      image_url Type: String Title: Image URL Read only: false The url for the header image for the card.
      description Type: String Title: Campaign Description Read only: false A short summary of the campaign to display.
      title Type: String Title: Title Read only: false The title for the card. Typically the subject line of the campaign.
      trigger_settings Type: Object Title: Automation Trigger Read only: false Available triggers for Automation workflows.
      Show items
      workflow_type Type: string Title: Workflow Type The type of Automation workflow.
      Workflow Type
      recurringEvent Type: Object Title: Date Merge Field-Based Trigger Settings - recurringEvent
      Show properties
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      merge_field_trigger Type: String Title: Merge Field Trigger Read only: false The data used to trigger the Automation workflow. For ‘specialEvent’ type workflows, a date merge field is required. For ‘recurringEvent’, a birthday or date merge field are required.
      specialEvent Type: Object Title: Date Merge Field-Based Trigger Settings - specialEvent
      Show properties
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      merge_field_trigger Type: String Title: Merge Field Trigger Read only: false The data used to trigger the Automation workflow. For ‘specialEvent’ type workflows, a date merge field is required. For ‘recurringEvent’, a birthday or date merge field are required.
      dateAdded Type: Object Title: Automation Trigger - dateAdded
      Show properties
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      emailFollowup Type: Object Title: Event-Based Trigger Settings - emailFollowup
      Show properties
      trigger_on_import Type: Boolean Title: Trigger Workflow on Import Read only: false Trigger workflow when subscribers are imported.
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      emailSeries Type: Object Title: Event-Based Trigger Settings - emailSeries
      Show properties
      trigger_on_import Type: Boolean Title: Trigger Workflow on Import Read only: false Trigger workflow when subscribers are imported.
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      welcomeSeries Type: Object Title: Event-Based Trigger Settings - welcomeSeries
      Show properties
      trigger_on_import Type: Boolean Title: Trigger Workflow on Import Read only: false Trigger workflow when subscribers are imported.
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      mandrill Type: Object Title: Mandrill-Based Trigger Settings - mandrill
      Show properties
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      mandrill_tags Type: Array Title: Mandrill Tags Read only: false The Mandrill tags that a workflow will be triggered on.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      visitUrl Type: Object Title: Goal-Based Trigger Settings - visitUrl
      Show properties
      goal_url Type: String Title: Goal Trigger Read only: false The URL subscribers navigate to in order to trigger the workflow.
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      bestCustomers Type: Object Title: Best Customers Workflow Trigger Settings - bestCustomers
      Show properties
      lifetime_purchase_value Type: Number Title: Total Purchase Value Read only: false The lifetime total purchase value needed to trigger a workflow. The workflow will trigger when a lifetime purchase value exceeds this amount.
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      purchase_orders Type: Integer Title: Purchase Orders Read only: false The number of purchase orders needed to trigger a workflow. The workflow will trigger when purchases exceed this amount.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      productFollowup Type: Object Title: Specific Product Purchased Workflow Trigger Settings - productFollowup
      Show properties
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      product_name Type: String Title: Product Name Read only: false The name of the product a workflow is triggered on.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      categoryFollowup Type: Object Title: Purchase Product From Category Workflow Trigger Settings - categoryFollowup
      Show properties
      category_name Type: String Title: Category Name Read only: false The name of the product category a workflow is triggered on.
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      purchaseFollowup Type: Object Title: Any Product Purchased Workflow Trigger Settings - purchaseFollowup
      Show properties
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      api Type: Object Title: Automation Trigger - api
      Show properties
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      groupAdd Type: Object Title: Event-Based Trigger Settings - groupAdd
      Show properties
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      group_id Type: Integer Title: Group ID Read only: false Group ID used by the workflow.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      groupRemove Type: Object Title: Event-Based Trigger Settings - groupRemove
      Show properties
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      group_id Type: Integer Title: Group ID Read only: false Group ID used by the workflow.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      report_summary Type: Object Title: Campaign Report Summary Read only: false For sent campaigns, a summary of opens, clicks, and unsubscribes.
      Show properties
      opens Type: Integer Title: Automation Opens Read only: true The total number of opens for a campaign.
      unique_opens Type: Integer Title: Unique Opens Read only: true The number of unique opens.
      open_rate Type: Number Title: Open Rate Read only: true The number of unique opens divided by the total number of successful deliveries.
      clicks Type: Integer Title: Total Clicks Read only: true The total number of clicks for an campaign.
      subscriber_clicks Type: Integer Title: Unique Subscriber Clicks Read only: true The number of unique clicks.
      click_rate Type: Number Title: Click Rate Read only: true The number of unique clicks divided by the total number of successful deliveries.
      _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.
      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/automations/b0a1c24f1a/emails' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 2385
      Vary: Accept-Encoding
      X-Request-Id: b3d6ed16-c0f0-42c9-aea3-e1ec9f44f64d
      Link: <https://api.mailchimp.com/schema/3.0/Automations/Emails/Collection.json>; rel="describedBy"
      Date: Tue, 15 Sep 2015 17:05:47 GMT
      Connection: keep-alive
      
      
      {
        "workflow_id": "b0a1c24f1a",
        "emails": [
          {
            "id": "491fec26f1",
            "workflow_id": "b0a1c24f1a",
            "position": 1,
            "delay": {
              "amount": 1,
              "type": "day",
              "direction": "after",
              "action": "signup"
            },
            "create_time": "2015-09-15T14:33:20+00:00",
            "start_time": "2015-09-15T15:45:32+00:00",
            "archive_url": "http://eepurl.com/xxxx",
            "status": "paused",
            "emails_sent": 0,
            "send_time": "2015-09-15T15:48:05+00:00",
            "content_type": "template",
            "recipients": {
              "list_id": "57afe96172"
            },
            "settings": {
              "subject_line": "Your first joke from Freddie!",
              "title": "Freddie Likes Jokes",
              "from_name": "Freddie",
              "reply_to": "freddie@freddiesjokes.com",
              "authenticate": false,
              "auto_footer": false,
              "inline_css": false,
              "auto_tweet": false,
              "fb_comments": true,
              "template_id": 2000020,
              "drag_and_drop": true
            },
            "tracking": {
              "opens": true,
              "html_clicks": true,
              "text_clicks": true,
              "goal_tracking": true,
              "ecomm360": true,
              "google_analytics": true,
              "clicktale": ""
            },
            "report_summary": {
              "opens": 0,
              "unique_opens": 0,
              "open_rate": 0,
              "clicks": 0,
              "subscriber_clicks": 0,
              "click_rate": 0
            },
            "_links": [
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/Emails/Collection.json"
              },
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails/491fec26f1",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/Emails/Instance.json"
              },
              {
                "rel": "start",
                "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails/491fec26f1/actions/start",
                "method": "POST"
              },
              {
                "rel": "pause",
                "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails/491fec26f1/actions/pause",
                "method": "POST"
              },
              {
                "rel": "queue",
                "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails/491fec26f1/queue",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/Emails/Queue/Collection.json"
              }
            ]
          }
        ],
        "total_items": 1,
        "_links": [
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/Instance.json"
          },
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/Emails/Collection.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.

      Get information about a specific workflow email

      GET /automations/{workflow_id}/emails/{workflow_email_id}

      Get information about an individual Automation workflow email.

      Path parameters

      workflow_id The unique id for the Automation workflow.
      workflow_email_id The unique id for the Automation workflow email.

      Response body parameters

      id Type: String Title: Automation Email ID Read only: true A string that uniquely identifies the Automation email.
      workflow_id Type: String Title: Workflow ID Read only: true A string that uniquely identifies an Automation workflow.
      position Type: Integer Title: Email Position Read only: true The position of an Automation email in a workflow.
      delay Type: Object Title: Automation Delay Read only: false The delay settings for an Automation email.
      Show properties
      amount Type: Integer Title: Delay Amount Read only: false The delay amount for an Automation email.
      type Type: String Title: Delay Type Read only: false The type of delay for an Automation email.
      Possible Values:
      • now
      • day
      • hour
      • week
      direction Type: String Title: Delay Direction Read only: false Whether the delay settings describe before or after the delay action of an Automation email.
      Possible Values:
      • before
      • after
      action Type: String Title: Delay Action Read only: false The action that triggers the delay of an Automation email.
      Possible Values:
      • previous_campaign_sent
      • previous_campaign_opened
      • previous_campaign_not_opened
      • previous_campaign_clicked_any
      • previous_campaign_not_clicked_any
      • previous_campaign_specific_clicked
      • ecomm_bought_any
      • ecomm_bought_product
      • ecomm_bought_category
      • ecomm_not_bought_any
      • ecomm_abandoned_cart
      • campaign_sent
      • opened_email
      • not_opened_email
      • clicked_email
      • not_clicked_email
      • campaign_specific_clicked
      • manual
      • signup
      • merge_changed
      • group_add
      • group_remove
      • mandrill_sent
      • mandrill_opened
      • mandrill_clicked
      • mandrill_any
      • api
      • goal
      • annual
      • birthday
      • date
      • date_added
      action_description Type: String Title: Delay Action Description Read only: true The user-friendly description of the action that triggers an Automation email.
      full_description Type: String Title: Full Delay Description Read only: true The user-friendly description of the delay and trigger action settings for an Automation email.
      create_time Type: String Title: Create Time Read only: true The date and time the campaign was created.
      start_time Type: String Title: Start Time Read only: true The date and time the campaign was started.
      archive_url Type: String Title: Archive URL Read only: true The link to the campaign’s archive version.
      status Type: String Title: Campaign Status Read only: true The current status of the campaign.
      Possible Values:
      • save
      • paused
      • sending
      emails_sent Type: Integer Title: Emails Sent Read only: true The total number of emails sent for this campaign.
      send_time Type: String Title: Send Time Read only: true The date and time a campaign was sent.
      content_type Type: String Title: Content Type Read only: true How the campaign’s content is put together (‘template’, ‘drag_and_drop’, ‘html’, ‘url’).
      recipients Type: Object Title: List Read only: false List settings for the campaign.
      Show properties
      list_id Type: String Title: List ID Read only: false The unique list id.
      segment_opts Type: Object Title: Segment Options Read only: false An object representing all segmentation options.
      Show properties
      saved_segment_id Type: Integer Title: Saved Segment ID Read only: false The id for an existing saved segment.
      match Type: String Title: Match Type Read only: false Segment match type.
      Possible Values:
      • any
      • all
      conditions Type: Array Title: No Title Read only: false No Description
      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.
      settings Type: Object Title: Campaign Settings Read only: false Settings for the campaign including the email subject, from name, and from email address.
      Show properties
      subject_line Type: String Title: Campaign Subject Line Read only: false The subject line for the campaign.
      title Type: String Title: Campaign Title Read only: false The title of the campaign.
      from_name Type: String Title: From Name Read only: false The ‘from’ name on the campaign (not an email address).
      reply_to Type: String Title: Reply To Address Read only: false The reply-to email address for the campaign.
      authenticate Type: Boolean Title: Authentication Read only: false Whether MailChimp authenticated the campaign. Defaults to true.
      auto_footer Type: Boolean Title: Auto-Footer Read only: false Automatically append MailChimp’s default footer to the campaign.
      inline_css Type: Boolean Title: Inline CSS Read only: false Automatically inline the CSS included with the campaign content.
      auto_tweet Type: Boolean Title: Auto-Tweet Read only: false Automatically tweet a link to the campaign archive page when the campaign is sent.
      auto_fb_post Type: Array Title: Auto Post to Facebook Read only: false An array of Facebook page ids to auto-post to.
      fb_comments Type: Boolean Title: Facebook Comments Read only: false Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true.
      template_id Type: Integer Title: Template ID Read only: false The id for the template used in this campaign.
      drag_and_drop Type: Boolean Title: Drag And Drop Campaign Read only: true Whether the campaign uses the drag-and-drop editor.
      tracking Type: Object Title: Campaign Tracking Options Read only: false The tracking options for a campaign.
      Show properties
      opens Type: Boolean Title: Opens Read only: false Whether to track opens. Defaults to true.
      html_clicks Type: Boolean Title: HTML Click Tracking Read only: false Whether to track clicks in the HTML version of the campaign. Defaults to true.
      text_clicks Type: Boolean Title: Plain-Text Click Tracking Read only: false Whether to track clicks in the plain-text version of the campaign. Defaults to true.
      goal_tracking Type: Boolean Title: MailChimp Goal Tracking Read only: false Whether to enable Goal tracking.
      ecomm360 Type: Boolean Title: E-commerce Tracking Read only: false Whether to enable eCommerce360 tracking.
      google_analytics Type: String Title: Google Analytics Tracking Read only: false The custom slug for Google Analytics tracking (max of 50 bytes).
      clicktale Type: String Title: ClickTale Analytics Tracking Read only: false The custom slug for Click Tale tracking (max of 50 bytes).
      salesforce Type: Object Title: Salesforce CRM Tracking Read only: false Salesforce tracking options for a campaign. Must be using MailChimp’s built-in Salesforce integration.
      Show properties
      campaign Type: Boolean Title: Salesforce Campaign Read only: false Create a campaign in a connected Salesforce account.
      notes Type: Boolean Title: Salesforce Note Read only: false Update contact notes for a campaign based on a subscriber’s email address.
      capsule Type: Object Title: Capsule CRM Tracking Read only: false Capsule tracking option for a campaign. Must be using MailChimp’s built-in Capsule integration.
      Show properties
      notes Type: Boolean Title: Capsule Note Read only: false Update contact notes for a campaign based on a subscriber’s email address.
      social_card Type: Object Title: Campaign Social Card Read only: false The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more.
      Show properties
      image_url Type: String Title: Image URL Read only: false The url for the header image for the card.
      description Type: String Title: Campaign Description Read only: false A short summary of the campaign to display.
      title Type: String Title: Title Read only: false The title for the card. Typically the subject line of the campaign.
      trigger_settings Type: Object Title: Automation Trigger Read only: false Available triggers for Automation workflows.
      Show items
      workflow_type Type: string Title: Workflow Type The type of Automation workflow.
      Workflow Type
      recurringEvent Type: Object Title: Date Merge Field-Based Trigger Settings - recurringEvent
      Show properties
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      merge_field_trigger Type: String Title: Merge Field Trigger Read only: false The data used to trigger the Automation workflow. For ‘specialEvent’ type workflows, a date merge field is required. For ‘recurringEvent’, a birthday or date merge field are required.
      specialEvent Type: Object Title: Date Merge Field-Based Trigger Settings - specialEvent
      Show properties
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      merge_field_trigger Type: String Title: Merge Field Trigger Read only: false The data used to trigger the Automation workflow. For ‘specialEvent’ type workflows, a date merge field is required. For ‘recurringEvent’, a birthday or date merge field are required.
      dateAdded Type: Object Title: Automation Trigger - dateAdded
      Show properties
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      emailFollowup Type: Object Title: Event-Based Trigger Settings - emailFollowup
      Show properties
      trigger_on_import Type: Boolean Title: Trigger Workflow on Import Read only: false Trigger workflow when subscribers are imported.
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      emailSeries Type: Object Title: Event-Based Trigger Settings - emailSeries
      Show properties
      trigger_on_import Type: Boolean Title: Trigger Workflow on Import Read only: false Trigger workflow when subscribers are imported.
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      welcomeSeries Type: Object Title: Event-Based Trigger Settings - welcomeSeries
      Show properties
      trigger_on_import Type: Boolean Title: Trigger Workflow on Import Read only: false Trigger workflow when subscribers are imported.
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      mandrill Type: Object Title: Mandrill-Based Trigger Settings - mandrill
      Show properties
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      mandrill_tags Type: Array Title: Mandrill Tags Read only: false The Mandrill tags that a workflow will be triggered on.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      visitUrl Type: Object Title: Goal-Based Trigger Settings - visitUrl
      Show properties
      goal_url Type: String Title: Goal Trigger Read only: false The URL subscribers navigate to in order to trigger the workflow.
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      bestCustomers Type: Object Title: Best Customers Workflow Trigger Settings - bestCustomers
      Show properties
      lifetime_purchase_value Type: Number Title: Total Purchase Value Read only: false The lifetime total purchase value needed to trigger a workflow. The workflow will trigger when a lifetime purchase value exceeds this amount.
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      purchase_orders Type: Integer Title: Purchase Orders Read only: false The number of purchase orders needed to trigger a workflow. The workflow will trigger when purchases exceed this amount.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      productFollowup Type: Object Title: Specific Product Purchased Workflow Trigger Settings - productFollowup
      Show properties
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      product_name Type: String Title: Product Name Read only: false The name of the product a workflow is triggered on.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      categoryFollowup Type: Object Title: Purchase Product From Category Workflow Trigger Settings - categoryFollowup
      Show properties
      category_name Type: String Title: Category Name Read only: false The name of the product category a workflow is triggered on.
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      purchaseFollowup Type: Object Title: Any Product Purchased Workflow Trigger Settings - purchaseFollowup
      Show properties
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      api Type: Object Title: Automation Trigger - api
      Show properties
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      groupAdd Type: Object Title: Event-Based Trigger Settings - groupAdd
      Show properties
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      group_id Type: Integer Title: Group ID Read only: false Group ID used by the workflow.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      groupRemove Type: Object Title: Event-Based Trigger Settings - groupRemove
      Show properties
      send_immediately Type: Boolean Title: Send First Email Immediately Read only: false Send first email immediately to existing subscribers who meet conditions.
      group_id Type: Integer Title: Group ID Read only: false Group ID used by the workflow.
      runtime Type: Object Title: Automation Workflow Runtime Settings Read only: false A workflow’s runtime settings for an Automation.
      Show properties
      days Type: Array Title: Days Read only: false The days an Automation workflow can send.
      hours Type: Object Title: Hours Read only: false The hours an Automation workflow can send.
      Show items
      type Type: string Title: Email Send Time Settings When to send the Automation email.
      Email Send Time Settings
      send_asap Type: Object Title: Send Hours - send_asap
      Show properties
      send_asap Type: Boolean Title: Send Immediately Read only: false Send the workflow emails as soon as a subscriber meets the appropriate criteria.
      send_between Type: Object Title: Send Hours - send_between
      Show properties
      start Type: String Title: Start Time Read only: false The start of the sending window.
      end Type: String Title: End Time Read only: false The end of the sending window.
      send_at Type: Object Title: Send Hours - send_at
      Show properties
      send_at Type: String Title: Send Time Read only: false The exact time to send the emails.
      workflow_emails_count Type: Integer Title: Workflow Emails Count Read only: true The number of emails in the Automation workflow.
      workflow_title Type: String Title: Workflow Title Read only: true The title of the workflow type.
      report_summary Type: Object Title: Campaign Report Summary Read only: false For sent campaigns, a summary of opens, clicks, and unsubscribes.
      Show properties
      opens Type: Integer Title: Automation Opens Read only: true The total number of opens for a campaign.
      unique_opens Type: Integer Title: Unique Opens Read only: true The number of unique opens.
      open_rate Type: Number Title: Open Rate Read only: true The number of unique opens divided by the total number of successful deliveries.
      clicks Type: Integer Title: Total Clicks Read only: true The total number of clicks for an campaign.
      subscriber_clicks Type: Integer Title: Unique Subscriber Clicks Read only: true The number of unique clicks.
      click_rate Type: Number Title: Click Rate Read only: true The number of unique clicks divided by the total number of successful deliveries.
      _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/automations/b0a1c24f1a/emails/491fec26f1' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1940
      Vary: Accept-Encoding
      X-Request-Id: 80b4a661-3e68-4013-9e91-38df4b0c56e4
      Link: <https://api.mailchimp.com/schema/3.0/Automations/Emails/Instance.json>; rel="describedBy", <https://usX.admin.mailchimp.com/campaigns/show?id=2181901>; rel="dashboard"
      Date: Tue, 15 Sep 2015 17:14:48 GMT
      Connection: keep-alive
      
      
      {
        "id": "491fec26f1",
        "workflow_id": "b0a1c24f1a",
        "position": 1,
        "delay": {
          "amount": 1,
          "type": "day",
          "direction": "after",
          "action": "signup"
        },
        "create_time": "2015-09-15T14:33:20+00:00",
        "start_time": "2015-09-15T15:45:32+00:00",
        "archive_url": "http://eepurl.com/xxxx",
        "status": "paused",
        "emails_sent": 0,
        "send_time": "2015-09-15T15:48:05+00:00",
        "content_type": "template",
        "recipients": {
          "list_id": "57afe96172"
        },
        "settings": {
          "subject_line": "Your first joke from Freddie!",
          "title": "Freddie Likes Jokes",
          "from_name": "Freddie",
          "reply_to": "freddie@freddiesjokes.com",
          "authenticate": false,
          "auto_footer": false,
          "inline_css": false,
          "auto_tweet": false,
          "fb_comments": true,
          "template_id": 2000020,
          "drag_and_drop": true
        },
        "tracking": {
          "opens": true,
          "html_clicks": true,
          "text_clicks": true,
          "goal_tracking": true,
          "ecomm360": true,
          "google_analytics": true,
          "clicktale": ""
        },
        "report_summary": {
          "opens": 0,
          "unique_opens": 0,
          "open_rate": 0,
          "clicks": 0,
          "subscriber_clicks": 0,
          "click_rate": 0
        },
        "_links": [
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/Emails/Collection.json"
          },
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails/491fec26f1",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/Emails/Instance.json"
          },
          {
            "rel": "start",
            "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails/491fec26f1/actions/start",
            "method": "POST"
          },
          {
            "rel": "pause",
            "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails/491fec26f1/actions/pause",
            "method": "POST"
          },
          {
            "rel": "queue",
            "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails/491fec26f1/queue",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/Emails/Queue/Collection.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.
    • Pause an automated email

      POST /automations/{workflow_id}/emails/{workflow_email_id}/actions/pause

      Pause an automated email.

      Path parameters

      workflow_id The unique id for the Automation workflow.
      workflow_email_id The unique id for the Automation workflow email.

      Example request

      
      curl --request POST \
      --url 'https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails/491fec26f1/actions/pause' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --include
                                      

      Example response

      
      HTTP/1.1 204 No Content
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 2
      X-Request-Id: c14b0928-9a26-4070-9a72-dd71dca00034
      Date: Tue, 15 Sep 2015 17:21:00 GMT
      Connection: keep-alive
                                      

      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.

      Start an automated email

      POST /automations/{workflow_id}/emails/{workflow_email_id}/actions/start

      Start an automated email.

      Path parameters

      workflow_id The unique id for the Automation workflow.
      workflow_email_id The unique id for the Automation workflow email.

      Example request

      
      curl --request POST \
      --url 'https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails/491fec26f1/actions/start' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --include
                                      

      Example response

      
      HTTP/1.1 204 No Content
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 2
      X-Request-Id: c14b0928-9a26-4070-9a72-dd71dca00033
      Date: Tue, 15 Sep 2015 17:20:21 GMT
      Connection: keep-alive
                                      

      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.