Ubivox API Documentation

Contents:

• Accessing the API
  • Protocols
  • Location
  • Authentication
  • Throttling
  • Service windows
  • Request log
  • Debugging
• Definitions
  • Date/time formats and time zone
    • Time zone support
  • Error codes
  • Subscriber data
    • Data fields with predefined options
  • Supported hooks for webhooks
  • Stoplist causes
• API Methods
  • system methods
  • subscription methods
  • subscriber methods
  • delivery methods
  • splittest methods
  • maillist methods
  • email methods
  • media methods
  • data methods
  • imports methods
  • exports methods
  • target methods
  • webhook methods
  • account methods
  • sync methods
  • ecommerce methods
  • misc methods
• Partner API Methods
  • partner methods
• Sales tracking
  • Background
  • Adding sales numbers
    • Parameter details
    • Example
  • Ecommerce Tracking
    • Parameter details
      • Order parameters
      • Product parameters
      • Example parameter set
    • Sending order data using the XML-RPC API
    • Sending order data using tracking image
      • Anti-tampering
      • Debugging
• Webhooks
  • Request structure
  • Throttling
  • Delivery guarantee
  • Setting up
  • Supported webhooks
    • subscription
    • updated_email
    • unsubscription
    • remove_subscription
    • suspend_subscription
    • activate_subscription
    • login
    • junk_delivery
    • junk_email
    • bounced_email
    • delivery_started
    • delivery_read
    • link_clicked
• POST Handler
  • Introduction
  • Form fields
    • Subscriber data fields
    • Multiple choice
  • Example HTML forms
    • Subscribe
    • Unsubscribe
  • Your own status pages
  • Error handling
    • Example parameters for custom error pages
  • Internationalization
  • Opt-in scheme
    • Double
    • Single
• Feeds
  • Supported formats
  • Other feed parameters
  • Base URL
  • Example
  • Available feeds
    • archived feeds
    • client feeds
    • contacts feeds
    • course feeds
    • data feeds
    • deliveries feeds
    • delivery feeds
    • email feeds
    • global feeds
    • list feeds
    • lists feeds
    • partner feeds
• Examples
  • Python Examples
    • Creating a new subscription
    • Updating subscriber data
    • Unsubscribing
    • Create and send a delivery
    • Error/Exception handling
  • PHP Examples
    • Creating a new subscription
    • Updating subscriber data
    • Unsubscribing
    • Create and send a delivery
    • Error/Exception handling
  • Node.js Examples
    • Creating a new subscription
    • Updating subscriber data
    • Unsubscribing
    • Create and send a delivery
    • Error/Exception handling
• Changelog
  • 2.34.0 - Sep 20, 2018
  • 2.33.0 - May 3, 2018
  • 2.31.0 - July 17, 2017
  • 2.30.1 - May 23, 2017
  • 2.30.0 - April 6, 2017
  • 2.29.0 - February 2, 2017
  • 2.28.0 - January 19, 2017
  • 2.27.1 - October 6, 2016
  • 2.23.0 - December 27, 2015
  • 2.22.1 - November 24, 2015
  • 2.22.0 - October 27, 2015
  • 2.21.4 - October 22, 2015
  • 2.21.3 - October 8, 2015
  • 2.20.0 - September 3, 2015
  • 2.19.0 - July 30, 2015
  • 2.17.0 - May 12, 2015
  • 2.16.0 - March 12, 2015
  • 2.15.1 - January 20, 2015
  • 2.14.2 - September 9, 2014
  • 2.13.10 - August 12, 2014
  • 2.13.7 - May 6, 2014
  • 2.13.0 - January 27, 2014
  • 2.11.6 - November 19, 2013
  • 2.11.3 - October 22, 2013
  • 2.11.1 - October 1, 2013
  • 2.11.0 - September 11, 2013
  • 2.10.6 - August 20, 2013
  • 2.10.5 - August 13, 2013
  • 2.10.3 - July 18, 2013
  • 2.10.1 - June 25, 2013
  • 2.10.0 - June 19, 2013
  • 2.9.6 - May 27, 2013
  • 2.9.3 - April 22, 2013
  • 2.9.2 - March 26, 2013
  • 2.9.1 - March 11, 2013
  • 2.9.0 - March 6, 2013
  • 2.8.1 - December 18, 2012
  • 2.7.2 - October 24, 2012
  • 2.7.0 - October 11, 2012
  • 2.5.0 - June 14, 2012
  • 2.4.2 - April 19, 2012
  • 2.4.0 - March 15, 2012
• Questions