• 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

Recipients

Recipients are the people you send emails to. At a minimum, a recipient record must have an email address, but may have other fields of data we call Demographics. You can create Demographics using this API. Before an email can be sent to an individual a Recipient record must be created. Symphonie keeps track of those recipients that have unsubscribed, been suppressed, or filed a complaint. This information is maintained even if a Recipient record is imported again. Symphonie will not allow duplicate email addresses to be created.

Recipients can be added to the system and their data edited, but they cannot be deleted. If you do not want to send to a recipient any longer, add them to the global suppression list.