• Introduction
  • Introduction
  • Logins
  • Standard arguments
  • Passing the password
  • Determining the audience
  • Mail merge and dynamic content
  • Storing information about recipients
  • Internationalization
  • Your URL
  • Names VS IDs
  • Adding recipients
  • Large result sets
  • Mail merge delimiters
  • Security and Permissions
  • Content and templates
  • Errors
• Mail Merge Tags
• Examples
  • Example 1
  • Example 2
  • Example 3
  • Example 4
  • Example 5
  • Example 6
• Functions
  • Complaints
  • Confirmations
    • Accept
    • Get data
    • Send one
    • Send many
    • Remove
  • Content Blocks
    • Create or Edit
    • Delete
    • Retrieve
  • Demographics
    • Add
    • Delete
    • Retrieve
  • Documents
    • Complaints
    • Create
    • Edit
    • Preview (simple)
    • Preview (complex)
    • Queue (simple)
    • Queue (complex)
    • Report
    • Retrieve one
    • Retrieve many
    • Test send (simple)
    • Test send (complex)
  • Global Unsubscribes
    • Add one address
    • Add multiple addresses
    • Check if an address is on the list
    • Remove one address
    • Remove multiple addresses
    • Retrieve the recipients
  • Held Recipients
    • Add
    • Remove
    • Retrieve
  • Mailings
    • Audience retrieve
    • Audience add
    • Check queue results
    • Create
    • Preview
    • Queue
    • Remove
    • Report
    • Retrieve many
    • Retrieve one
    • Test send
  • Offline Events
    • Retrieve general info
    • Retrieve all recipients
    • Retrieve column specific info
    • Add new recipient row
    • Remove a recipient row
    • Edit a recipient row
    • Delete an offline event
    • Create a new offline event
  • Recipients
    • Add Many
    • Add One
    • Search
  • Referrals
    • Check
    • Create
    • List
  • Segments
    • Add Recipients
    • Create Fixed
    • Delete
    • Execute
    • List
    • Remove Recipients
  • Subscriptions
    • Change
    • List by email
    • List by topic
    • Subscribe
    • Unsubscribe
    • Unsubscribes list
  • Suppression
    • Global
      • Add Many
      • Add One
      • Check
      • Remove many
      • Remove one
    • Topic
      • Add Many
      • Add One
      • Check
      • Remove many
      • Remove one
  • Topics
    • Create
    • List
    • Remove
  • Utility
    • Check system
    • Get large data
  • Workflows
    • Add recipients
    • List
    • Remove many recipients
    • Status

REST Email Marketing API Documentation

Segments

Segments are a method to define an audience for a Mailing. Symphonie supports four segment types: a wizard-based segment, a fixed segment, a SQL segment, and a stored procedure segment. Wizard segments can be created in the web site interface and allow conditions to be defined for the selection, like Age is between 20 and 30 and it's within two weeks of their birthday. Do to the complexity of these conditions, wizard segments cannot be created using the API. Fixed segments are a 'fixed' set of email addresses that you upload and remain constant. The results of a wizard-based segment may change over time as different recipients meet the conditions, but a fixed segment will always be the same recipients. SQL and stored procedure segments can be created using the web site interface.

The recipient list for a mailing can be uploaded to the mailing itself, but if you are send to the same group of recipients over and over, you may find it easier to define the group of recipients as a segment, and then set the audience of the Mailing to that Segment.

Segments in Symphonie are not constained to a 'list'. You can target any recipient in the system with a segment. Symphonie will automatically remove any recipients that have unsubscribed.