• 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
    • 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

Subscriptions

Subscriptions refer to the ability to mark a recipient as 'subscribed' to a topic. You can set the subscription status of a recipient when they are imported, but that information can be changed using these APIs. When a recipient is unsubscribed from a topic, Symphonie will automatically remove them from any emails sent with that topic as the unsubscribe topic. This is an automatic process that is always done for you, and cannot be overridden.

Symphonie can be used without specifically marking recipients as subscribed. Recipients can always be targeted for sending and will only be removed if they are marked as unsubscribed (or on-hold or suppressed). Marketers who prefer to choose recipients to target more dynamically using segmentation or other options do not need to bother marking each recipient as 'subscribed'.

These API allow you to change a recipient from unsubscribed back to subscribed status, but we encourage you to be careful when doing this and to be completely certain this is the action the recipient wants.

Symphonie features built-in mail-merge tags to allow recipients to unsubscribe, but you don't have to use these. The pages Symphonie uses are designed to be easy to customize, but if you already have your own subscription center, for example, you may want to manage all subscriptions through that page. In that case use these APIs to tell Symphonie what changes to make in the subscription settings.

Changes to a recipient's subscription settings take effect immediately with the next Mailing or Document sent to them.